Disbursement¶
Brief Description¶
- Disbursement APIs allow you to send fund to any bank accounts in Indonesia easily and real-time.
- Use this API to start disbursing money to a specific beneficiary account.
Request URL¶
/v1/vexora/disbursements
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | Merchant Number๏ผMID๏ผ |
Request Body Parameters¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| sign | Yes | String | Except for sign, the remaining fields are sorted by first letter to form key1=value1key2=value2, and app secrect is used as salt for md5 encryption. The sign is finally lowercase. |
| timestamp | Yes | String | Timestamp๏ผ1715941383720๏ผ |
| tradeNo | Yes | String | Unique disbursement ID for a specific request, generated by partner. |
| amount | Yes | float | Amount of disbursement, the minimum amount for Rp10.000 |
| customerName | Yes | String | User Name |
| mobile | Yes | String | Userโs mobile phone number (starting with 08 or 628, a total of 10-13 digits of Indonesian mobile phone number) |
| Yes | String | Email of user, using email standard format. | |
| bankAccountNo | Yes | String | Recipient bank account number, numeric only. |
| bankCode | Yes | String | Please refer to the Disbursement Bank Codes section for the recipient's bank account code. |
| notifyUrl | Yes | String | The URL used by the system to send an automatic response or N otification after a transaction or process is completed. |
| remark | No | String | Note: This field will be returned in its original path |
Request Parameter Example¶
{
"amount": 100000,
"bankAccountNo": "5464438554636",
"bankCode": "0002",
"customerName": "jack",
"email": "user@gmail.com",
"mobile": "6281245907765",
"notifyUrl": "https://google.com",
"remark": "remark",
"sign": "5aa258e8b5d28150097b86f55c2d2307",
"timestamp": 1732985021335,
"tradeNo": "39fa354542824ee789faf526f27c024f"
}
Response Results¶
| Parameter name | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | Request result (when success is returned, it only means that the request for this time is successful and cannot be used for merchant-side logical judgment) |
| code | Yes | String | Request response code (when 0000 is returned, it only means that the request for this time is successful, and cannot be used for merchant-side logical judgment). For specific status/error codes, please check the status/error code directory |
| timestamp | Yes | String | Transaction timestamp |
| success | Yes | String | Transaction result |
| data | Yes | Object | Return Object |
| data.tradeNo | Yes | String | Unique disbursement ID which partner put on the request. |
| data.platFormTradeNo | Yes | String | Unique disbursement ID from vexora, partners can use this ID for reconciliation. |
| data.status | Yes | String | Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table. |
| data.desc | Yes | String | Error description |
| data.remark | Yes | String | remark |