Introduction

Generate Virtual Accounts from Multiple Banks with Our API. Simplify fund acceptance with our efficient API solution. Streamline your payment processes and expand your options for accepting funds seamlessly.

Bank List

List of supported banks in virtual account:

Bank Code	Bank	Capability
008	Mandiri	One-off / Persistent - Open Amount, Closed Amount
014	BCA	One-off / Persistent - Open Amount, Closed Amount
002	BRI	One-off / Persistent - Open Amount, Closed Amount
009	BNI	One-off - Closed Amount
013	Permata	One-off / Persistent - Open Amount, Closed Amount
011	Danamon	Persistent - Open Amount
022	CIMB	One-off - Closed Amount
153	Sahabat Sampoerna	One-off / Persistent - Open Amount, Closed Amount

POST{{HOST}}/virtual-account

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. you can find the list of bank codes above the table.
Name
singleUse
Type
mandatory
Description
A boolean value indicates whether the generated API parameter can be used for a single transaction only. true / false
Name
type
Type
mandatory
Description
ClosedAmount/OpenAmount
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
expiryMinutes
Type
opsional
Description
If you want the transaction to last for 1 hour, you would set the value of the expiryMinutes parameter to 60.
Name
viewName
Type
mandatory
Description
The name or identifier of the receiver for 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}}/virtual-account

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '{{HOST}}/virtual-account',
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",
    "singleUse": true,
    "type": "ClosedAmount",
    "reference": "REFF012",
    "amount": 10000,
    "expiryMinutes": 30,
    "viewName": "Merchant Name",
        "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

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.virtualAccount.bankCode
Description: The code representing the bank associated with the virtual account.

Name: responseData.virtualAccount.vaNumber
Description: The virtual account number for the transaction.

Name: responseData.virtualAccount.viewName
Description: The name or identifier associated with the virtual account.

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

Response Json

POST

{{HOST}}/virtual-account

{
    "responseCode": 200,
    "responseMessage": "success",
        "responseData": {
        "id": "66e934f6-f5d6-4f1c-bb3d-450ec2873782",
        "merchantRef": "REFF012",
        "status": "pending",
        "feePayer": "customer",
        "amount": 10000,
        "fee": 4000,
        "totalAmount": 14000,
        "expiredDate": "2025-03-23T10:24:58+07:00",
        "additionalInfo": {
            "callback": "http://your-site-callback.com/notify"
        },
        "virtualAccount": {
            "bankCode": "014",
            "vaNumber": "666555440021",
            "viewName": "Merchant Name"
        }
    }
}