1. Create Payout
Request URL
{domain}/open-api/disbursement/transfer
Request Method
Parameter name | Required | Type of data | Description |
Content-Type | Y | string | application/json |
Request Param
Parameter name | Required | Type of data | Length | Example | Description |
appId | Y | string | - | - | Application ID |
param | Y | string | - | - | Parameter Body |
sign | Y | string | - | 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 | Sign |
param
Parameter name | Required | Type of data | Length | Example | Description |
timestamp | Y | long | - | 1678356680000 | Current timestamp |
mchOrderId | Y | string | 10-32 | CCP20220428011068111 | Merchant order id (unique for merchant), 1-32 characters |
idempotencyId | Y | string | 10-32 | - | Idempotency ID KEY, format:letter + space,10-30 characters |
amount | Y | long | - | 50000 | Payout amount (unit: cents) THB:500.20, should set 50020 cents |
payMethodCode | Y | string | - | Reference List | Platform payMethodCode |
transferCode | N | string | - | Reference List | Transfer code. Required when payMethodCode is 'BANK' |
promptpayAccountType | N | string | - | - | PromptPay Account Type. Required when payMethodCode is 'PROMPTPAY'. value is 'NATID' or 'MSISDN' |
accountNo | Y | string | 1-50 | - | Beneficiary account. |
accountName | N | string | 1-128 | - | Payee Name. Required when payMethodCode is 'BANK' |
accountType | N | string | - | - | Receiver Type value is 'INDIVIDUAL' or 'ORGANIZATION'. Required when payMethodCode is 'BANK' |
accountTaxId | N | string | 1-50 | - | ID Card Number / Business Registration No. Required when payMethodCode is 'BANK' |
mobile | N | string | 10 | - | Receiver mobile (format: start with 06, 08 or 09). Required when payMethodCode is 'BANK' |
relationship | N | string | 1-50 | - | relationship |
remark | N | string | 1-256 | - | remark |
Request Example
Request Body
How to construct request body
Response Param
Parameter Name | Type | Description |
code | integer | response code |
message | string | response message |
data | Object | data |
data
Parameter Name | Type | Example | Description |
mchOrderId | String | - | mch order id |
transactionId | String | D1656505190221611009 | Platform transaction id |
transactionStatus | String | Reference List | transaction status |
transactionTime | String | 2023-05-04 11:43:08 | transaction create time |
Response Example
Code Collection
Failed Response Example