Disburse
Endpoint:
https://api.cronosengine.com/api/disburse
Method : POST
Request Parameters
| Parameter | Mandatory | Description |
|---|---|---|
| bankCode | Yes | The code representing the bank to be used for the transaction. you can find the list of available bank codes here. |
| recipientAccount | Yes | The bank account number of the customer, which will be the receiver of the transaction. |
| reference | Yes | A unique reference number or identifier for the transaction. all transaction references should be unique. |
| amount | Yes | Amount your user should paid to complete the transaction. |
| additionalInfo.callback | Yes | The callback URL where notifications or updates related to the transaction will be sent. |
Headers
| Key | Value |
|---|---|
| On-Key | Project Key |
| On-Token | Project Token |
| On-Signature | Generated using : hash_hmac('sha512', key + json_encode(body), token) |
| Accept | application/json |
Response Parameters
| Parameter | Description |
|---|---|
| responseCode | The HTTP response code indicating the status of the request. you can see the detailed information in the Error Codes Section. |
| responseMessage | A descriptive message indicating the status of the request. |
| responseData | An object containing the data related to the transaction response. |
| responseData.id | Cronos unique identifier for the transaction. |
| responseData.status | The current status of the transaction. success, pending, expired, failed |
| responseData.feePayer | The party responsible for paying the transaction fee. customer, merchant |
| responseData.amount | The original amount associated with the transaction. |
| responseData.fee | The fee charged for the transaction. |
| responseData.totalAmount | The total amount (original amount + fee) for the transaction. |
| responseData.expiredDate | The date and time when the transaction will expire. |
| responseData.additionalInfo.callback | The callback URL where notifications or updates related to the transaction will be sent. |
| responseData.disbursement.bankCode | The code representing the bank destination of the disbursement. |
| responseData.disbursement.recipientAccount | The bank account number destination for the disbursement. |
| responseData.disbursement.recipientName | The name or identifier associated with the bank account. |
Example
Request
- cURL
curl --location 'https://api.cronosengine.com/api/disburse' \
--header 'On-Key;' \
--header 'On-Token;' \
--header 'On-Signature;' \
--data '{
"bankCode": "014",
"recipientAccount":"0821837182312831",
"reference": "123456",
"amount": 10000,
"additionalInfo": {
"callback": "http://your-site-callback.com/notify"
}
}'
Response
{
"responseCode": 200,
"responseMessage": "success",
"responseData": {
"id": "757cc3c7-fb6a-4c4b-bc99-0928ca398a9d",
"merchantRef": "123456",
"status": "pending",
"feePayer": "customer",
"amount": 10000,
"fee": 3000,
"totalAmount": 13000,
"expiredDate": "2023-07-13T11:51:41+07:00",
"additionalInfo": {
"callback": "https://kraken.free.beeceptor.com/notify"
},
"disbursement": {
"bankCode": "014",
"recipientAccount": "0821837182312831",
"recipientName": "Mr. Gentur"
}
}
}