Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nurfaizfy/digiflazz-php-library

Simple Unofficial Digiflazz API Library written with PHP
https://github.com/nurfaizfy/digiflazz-php-library

api digiflazz php ppob

Last synced: 2 months ago
JSON representation

Simple Unofficial Digiflazz API Library written with PHP

Host: GitHub
URL: https://github.com/nurfaizfy/digiflazz-php-library
Owner: nurfaizfy
License: mit
Created: 2022-06-12T08:02:33.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-05-31T16:11:27.000Z (over 1 year ago)
Last Synced: 2024-10-10T14:19:52.717Z (3 months ago)
Topics: api, digiflazz, php, ppob
Language: PHP
Homepage: https://packagist.org/packages/nurfaizfy/digiflazz-php-library
Size: 21.5 KB
Stars: 10
Watchers: 1
Forks: 10
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Digiflazz PHP Library

[![Latest Stable Version](http://poser.pugx.org/nurfaizfy/digiflazz-php-library/v)](https://packagist.org/packages/nurfaizfy/digiflazz-php-library)

[![Total Downloads](http://poser.pugx.org/nurfaizfy/digiflazz-php-library/downloads)](https://packagist.org/packages/nurfaizfy/digiflazz-php-library)

[![License](http://poser.pugx.org/nurfaizfy/digiflazz-php-library/license)](https://packagist.org/packages/nurfaizfy/digiflazz-php-library)

This library is unofficial Digiflazz API written with PHP.

-   [Documentation](#documentation)

-   [Installation](#installation)

-   [Usage](#usage)

-   [Methods' Signature and Examples](#methods-signature-and-examples)

    -   [Balance](#balance)

        -   [Get Balance](#get-balance)

    -   [Price List](#price-list)

        -   [Get Price List](#get-price-list)

    -   [Deposit](#deposit)

        -   [Create Deposit Ticket](#create-deposit-ticket)

    -   [Transaction](#transaction)

        -   [Create Transaction](#create-transaction)

        -   [Inquiry Postpaid](#inquiry-postpaid)

        -   [Pay Postpaid](#pay-postpaid)

        -   [Inquiry PLN](#inquiry-pln)

    -   [Callback](#callback)

        -   [Get Callback](#get-callback)

-   [Exceptions](#exceptions)

    -   [InvalidArgumentException](#invalidargumentexception)

    -   [ApiException](#apiexception)

-   [Contributing](#contributing)

---

## Documentation

For the API documentation, check [Digiflazz API Reference](https://developer.digiflazz.com/api/).

## Installation

Install digiflazz-php-library with composer by following command:

```bash

composer require nurfaizfy/digiflazz-php-library

```

or add it manually in your `composer.json` file.

## Usage

Configure package with your account's secret key obtained from [Digiflazz Dashboard](https://member.digiflazz.com/buyer-area/connection/api).

```php

use Gonon\Digiflazz\Digiflazz;

Digiflazz::initDigiflazz('username', 'apikey');

```

## Methods' Signature and Examples

### Balance

#### Get Balance

```php

\Gonon\Digiflazz\Balance::getBalance();

```

Usage example:

```php

$getBalance = \Gonon\Digiflazz\Balance::getBalance();

var_dump($getBalance);

```

### Price List

#### Get Price List

```php

\Gonon\Digiflazz\PriceList::getPrePaid(); // Prepaid product

\Gonon\Digiflazz\PriceList::getPostPaid(); // Postpaid product

```

Usage example:

```php

$priceList = \Gonon\Digiflazz\PriceList::getPrePaid();

var_dump($priceList);

```

### Deposit

#### Create Deposit Ticket

```php

\Gonon\Digiflazz\Deposit::createDeposit(array $params);

```

Parameters for this method

| Name | Required | Description |

| --- | --- | --- |

| `amount_bank` | `yes` | The deposit amount |

| `bank` | `yes` | The name of the destination bank to which your transfer will be made (BRI, BCA, MANDIRI) |

| `owner_name` | `yes` | The name of the account holder who made the deposit transfer to Digiflazz |

Usage example:

```php

$params = [

    'amount' => '200000',

    'bank' => 'BCA',

    'owner_name' => 'Digiflazz',

];

$createDeposit = \Gonon\Digiflazz\Deposit::createDeposit($params);

var_dump($createDeposit);

```

### Transaction

#### Create Transaction

```php

\Gonon\Digiflazz\Transaction::createTransaction(array $params);

```

Parameters for this method

| Name | Required | Description |

| --- | --- | --- |

| `buyer_sku_code` | `yes` | Product SKU |

| `customer_no` | `yes` | Customer number |

| `ref_id` | `yes` | Your unique reference ID |

Usage example:

```php

$params = [

    'buyer_sku_code' => 'xl10',

    'customer_no' => '08123456789',

    'ref_id' => 'some1d',

];

$createTrasaction = \Gonon\Digiflazz\Transaction::createTransaction($params);

var_dump($createTrasaction);

```

#### Inquiry Postpaid

```php

\Gonon\Digiflazz\Transaction::inquiryPostpaid(array $params);

```

Parameters for this method

| Name | Required | Description |

| --- | --- | --- |

| `buyer_sku_code` | `yes` | Product SKU |

| `customer_no` | `yes` | Customer number |

| `ref_id` | `yes` | Your unique reference ID |

Usage example:

```php

$params = [

    'buyer_sku_code' => 'xl10',

    'customer_no' => '08123456789',

    'ref_id' => 'some1d',

];

$pascaInquiry = \Gonon\Digiflazz\Transaction::inquiryPostpaid($params);

var_dump($pascaInquiry);

```

#### Pay Postpaid

```php

\Gonon\Digiflazz\Transaction::payPostpaid(array $params);

```

Parameters for this method

| Name | Required | Description |

| --- | --- | --- |

| `buyer_sku_code` | `yes` | Product SKU |

| `customer_no` | `yes` | Customer number |

| `ref_id` | `yes` | Your unique reference ID |

Usage example:

```php

$params = [

    'buyer_sku_code' => 'xl10',

    'customer_no' => '08123456789',

    'ref_id' => 'some1d',

];

$payPasca = \Gonon\Digiflazz\Transaction::payPostpaid($params);

var_dump($payPasca);

```

#### Inquiry PLN

```php

\Gonon\Digiflazz\Transaction::inquiryPLN(array $params);

```

Parameters for this method

| Name | Required | Description |

| --- | --- | --- |

| `customer_no` | `yes` | Customer number |

Usage example:

```php

$params = [

    'customer_no' => '123456789',

];

$iquiryPLN = \Gonon\Digiflazz\Transaction::inquiryPLN($params);

var_dump($iquiryPLN);

```

### Callback

#### Get Callback

Use this method to get Callback

```php

\Gonon\Digiflazz\Callback::getCallback();

```

Use this method to get JSON Callback

```php

\Gonon\Digiflazz\Callback::getJsonCallback();

```

## Exceptions

### InvalidArgumentException

`InvalidArgumentException` will be thrown if the argument provided by user is not sufficient to create the request.

For example, there are required arguments such as `ref_id`, `customer_no`, and `buyer_sku_code` to create an transaction. If user lacks one or more arguments when attempting to create one, `InvalidArgumentException` will be thrown.

`InvalidArgumentException` is derived from PHP's `InvalidArgumentException`. For more information about this Exception methods and properties, please check [PHP Documentation](https://www.php.net/manual/en/class.invalidargumentexception.php).

### ApiException

`ApiException` wraps up Digiflazz API error. This exception will be thrown if there are errors from Digiflazz API side.

To get exception message:

```php

try {

    $transaction = \Gonon\Digiflazz\Transaction::createTransaction(array $params);

} catch (\Gonon\Digiflazz\Exceptions\ApiException $e) {

    var_dump($e->getMessage());

}

```

To get exception HTTP error code:

```php

try {

    $transaction = \Gonon\Digiflazz\Transaction::createTransaction(array $params);

} catch (\Gonon\Digiflazz\Exceptions\ApiException $e) {

    var_dump($e->getCode());

}

```

To get exception Digiflazz API error code:

```php

try {

    $transaction = \Gonon\Digiflazz\Transaction::createTransaction(array $params);

} catch (\Gonon\Digiflazz\Exceptions\ApiException $e) {

    var_dump($e->getErrorCode());

}

```

## Contributing

For any requests, bugs, or comments, please open an [issue](https://github.com/nurfaizfy/digiflazz-php-library/issues)

### Installing Packages

Before you start to code, run this command to install all of the required packages. Make sure you have `composer` installed in your computer

```bash

composer install

```

There is a pre-commit hook to run phpcs and phpcbf. Please make sure they passed before making commits/pushes.