Disbursement¶
Tip
Payout API is used to initiate transfer requests to bank accounts.
- All requests are
Postrequests, and the data format isjson
Account Type Description¶
| accountType | Description |
|---|---|
| CORRIENTE | Current account (Corriente), account number is 8-12 digits |
| AHORRO | Savings account (Ahorro), account number is 8-12 digits |
| VISTA | Basic current account (Vista), account number is 7-8 digits plus 1 check digit |
| CUENTA_RUT | Cuenta RUT basic current account, account number is 7-8 digits plus 1 check digit |
ID Type Description¶
| idType | Description |
|---|---|
| RUT | National ID, usually 7-8 digits plus a check digit |
| PAS | Passport, usually 9-16 digits or an alphanumeric combination |
Request URL¶
/v1/vexora/disbursements
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| header | Required | Type | Description |
|---|---|---|---|
| merchantNo | yes | String | Merchant number |
Request Body Parameters¶
| Parameter name | 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 | Transaction number (unique (recommended year month day hour minute second + random number)) |
| amount | Yes | String | Payment amount (integer only, unit: CLP) |
| idType | Yes | String | Beneficiary ID type. Refer to the ID Type Description table. |
| idCardNumber | Yes | String | Beneficiary ID card number. The value must match the selected idType. |
| accountType | Yes | String | Beneficiary account type. Refer to the Account Type Description table. |
| bankCode | Yes | String | Beneficiary bank code. Refer to the bank enumeration module. |
| bankNumber | Yes | String | Beneficiary bank account number. |
| firstname | Yes | String | Beneficiary's first name. |
| lastname | Yes | String | Beneficiary's last name. |
| Yes | String | Beneficiary's email address | |
| mobile | Yes | String | Beneficiary's mobile number. Must be a 9-digit number without the international country code. |
| notifyUrl | Yes | String | Asynchronous callback URL |
| remark | No | String | Remarks (this field will be returned asโis) |
Request Parameter Example¶
{
"amount": "100",
"idType": "RUT",
"idCardNumber": "12345678-9",
"accountType": "CORRIENTE",
"bankCode": "0001",
"bankNumber": "123456789012",
"firstname": "Juan",
"lastname": "Perez",
"email": "juan.perez@example.com",
"mobile": "912345678",
"tradeNo": "VX20260331008901",
"notifyUrl": "https://api.merchant.com/vexora/disbursement/notify",
"sign": "7c6a180b36896a0a8c02787eeafb0e4c",
"timestamp": "1719876543210"
}
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 | Boolean | Transaction result |
| data | yes | Object | Return Object |
| data.tradeNo | yes | String | Merchant transaction number |
| data.platFormTradeNo | yes | String | vexora transaction number, unique |
| 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.message | yes | String | Error description |
| data.remark | yes | String | remark |