README

A small PHP library/package that uses the Glade API to make payments using the bank transfer option.

Getting Started

You need to have PHP and composer installed on your machine to use this package. The latest versions of both are recommended.

Installation

You can clone this project and include the class in your project or add the dependency in your composer.json file as in the example below:

{
    "require": {
        "onubrooks/glade-pay": "^1.0.0"
    }
}

Or run the following command in your project:

composer require onubrooks/glade-pay

Usage

Instantiate the GladePay Class:

require_once __DIR__ . '/vendor/autoload.php';

use onubrooks\GladePay\GladePay;

$glade = new GladePay();

Pay Using Bank Transfer

$amount = 30000;
$user_data = '
{
    "firstname":"John",
    "lastname":"Wick",
    "email":"wick@gladeuniverse.com",
    "ip":"192.168.10.5",
    "fingerprint": "cccvxbxbxbc"
}
';
$business_name = "Happy Glade Customer";
$user = json_decode($user_data);

//Initiate a bank transfer Transaction, country and currency are optional and defaults to 'NG' and 'NGN'
// user and business_name are also optional
$transaction = $glade->bankTransfer($amount, $user, $business_name);

//After the transaction is completed, verify to confirm final status.
$verification = $glade->verify("GP61548131820210220X");

Return Values

All methods return an array.

Below are the fields returned in the array from the bankTransfer method with sample return values:

{
  "status": 202,
  "txnRef": "GP61548131820210220X",
  "auth_type": "device",
  "accountNumber": "9922554842",
  "accountName": "GladePay Demo",
  "bankName": "Providus Bank",
  "accountExpires": 600,
  "message": "Make a transfer into the following account using your bank app or internet banking platfrom to complete the transaction"
}

For the verify method, here's a sample of the returned values in the array:

{
  "status": 200,
  "txnStatus": "pending",
  "txnRef": "GP9225324020210220G",
  "message": "PENDING",
  "chargedAmount": 0,
  "currency": "NGN",
  "payment_method": "bank_transfer",
  "fullname": "John Wick",
  "email": "wick@gladeuniverse.com",
  "bank_message": "Awaiting Validation"
}

Running Tests

The test cases can be run using the following command on windows command line:

php vendor/phpunit/phpunit/phpunit --bootstrap vendor/autoload.php tests

For bash users, use the following command:

php vendor/bin/phpunit --bootstrap vendor/autoload.php tests

Find other repos by the same author at this github profile.

onubrooks / glade-pay

Maintainers

Details