Introduction

Simplify the process of fund disbursement with our comprehensive API solution. Seamlessly transfer funds to recipients with ease and efficiency. Streamline your disbursement operations, whether it's for vendor payments, employee salaries, or other financial transactions. Our API empowers you to securely and accurately distribute funds, reducing manual effort and saving valuable time

Request

You need to authenticate your requests to access any endpoint in the 98Pays API.

Request

Name
bankCode
Type
mandatory
Description
The code representing the bank to be used for the transaction. To find the bank code, please refer to the Bank Codes section.
Name
recipientAccount
Type
mandatory
Description
The bank account number of the customer, which will be the receiver of the transaction.
Name
reference
Type
mandatory
Description
A unique reference number or identifier for the transaction. all transaction references should be unique.
Name
amount
Type
mandatory
Description
Amount your user should paid to complete the transaction
Name
additionalInfo.callback
Type
mandatory
Description
The callback URL where notifications or updates related to the transaction will be sent.

You need to authenticate your Headers request to access any endpoint in the 98Pays API, to see the authentication documentation please read the Authentication section.

Request Json

POST

{{HOST}}/disburse

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '{{HOST}}/disburse',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
    "bankCode": "014",
    "recipientAccount":"1234567890",
    "reference": "REF1234",
    "amount": 10000,
    "additionalInfo": {
        "callback": "http://your-site-callback.com/notify"
    }
}
}',
CURLOPT_HTTPHEADER => array(
    'X-Client-Key: ',
    'X-Client-Token: ',
    'X-Signature: '
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response Details

Name: responseCode
Description: The HTTP response code indicating the status of the request. See the Error Codes section for details.

Name: responseMessage
Description: A descriptive message indicating the status of the request.

Name: responseData
Description: An object containing the data related to the transaction response.

Name: responseData.id
Description: 98Pays unique identifier for the transaction.

Name: responseData.status
Description: The current status of the transaction. success, pending, expired, failed.

Name: responseData.feePayer
Description: The party responsible for paying the transaction fee. customer or merchant.

Name: responseData.amount
Description: The original amount associated with the transaction.

Name: responseData.fee
Description: The fee charged for the transaction.

Name: responseData.totalAmount
Description: The total amount (original amount + fee) for the transaction.

Name: responseData.expiredDate
Description: The date and time when the transaction will expire.

Name: responseData.additionalInfo.callback
Description: The callback URL where notifications or updates related to the transaction will be sent.

Name: responseData.disbursement.bankCode
Description: The code representing the bank destination of the disbursement.

Name: responseData.disbursement.recipientAccount
Description: The bank account number destination for the disbursement.

Name: responseData.disbursement.recipientName
Description: The name or identifier associated with the bank account.

If you want to see the error code status, please read the Extras >> Error Code section.

Response Json

POST

{{HOST}}/disburse

{
    "responseCode": 200,
    "responseMessage": "success",
    "responseData": {
        "id": "66e934f6-f5d6-4f1c-bb3d-450ec2873782",
        "merchantRef": "REFF012",
        "status": "pending",
        "feePayer": "merchant",
        "amount": 10000,
        "fee": 3000,
        "totalAmount": 13000,
        "expiredDate": "2025-03-23T10:24:58+07:00",
        "additionalInfo": {
        "callback": "http://your-site-callback.com/notify"
    },
    "disbursement": {
        "bankCode": "014",
        "recipientAccount": "1234567890",
        "recipientName": "98Pays Disburstment"
    }
  }
}