Create Pay-out Order
Merchants initiate pay-out (remittance/transfer) requests to specified bank accounts via this interface.
Interface Info
- Endpoint:
/payout/create - HTTP Method:
POST - Content-Type:
application/json; charset=utf-8
Request Header Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | string | Merchant Number |
| sign | Yes | string | RSA Signature (Refer to Global Specification) |
Request Body Parameters
| Parameter | Example Value | Required | Type | Description |
|---|---|---|---|---|
| timestamp | 1639466186292 | Yes | Long | Millisecond timestamp |
| merchantOrderNo | 20211215114318859 | Yes | string | Merchant order number (Unique, letters + numbers, max length 32) |
| amount | 220.00 | Yes | string | Pay-out amount (up to 2 decimal places) |
| payType | BANK | Yes | string | Payment Type: Currently fixed to BANK (Bank Transfer) |
| bankCode | SCB | Yes | string | Payer's destination Bank Code (Refer to Bank Code List below) |
| accountNo | 1234567890 | Yes | string | Recipient Bank Account Number |
| accountName | Somchai | Yes | string | Recipient Account Name |
| mobile | 0612345678 | Yes | string | Recipient mobile number. Format: must start with 06, 08, or 09 |
| notifyUrl | https://... | Yes | string | Asynchronous callback notification URL |
| accountType | INDIVIDUAL | No | string | Recipient Type: INDIVIDUAL, ORGANIZATION |
| accountTaxId | 1234567890123 | No | string | Recipient ID / Tax ID or Corporate Registration Number |
test@example.com | No | string | Recipient Email | |
| remark | payout remark | No | string | Remarks |
Response Examples
json
{
"code": 1,
"msg": "success",
"data": {
"merchantNo": "M1639466186292",
"merchantOrderNo": "202112151143188593456",
"platOrderNo": "876324486452871168",
"amount": "220.00",
"fee": "220.00",
"status": "0"
}
}json
{
"code": 0,
"msg": "param merchant error"
}Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | number | 1 for Success, 0 for Failure |
| msg | string | Message explanation |
| data | object | Returned data payload |
| └ merchantNo | string | Merchant Number |
| └ merchantOrderNo | string | Merchant Order Number |
| └ platOrderNo | string | Platform Order Number |
| └ amount | string | Transaction Amount |
| └ fee | string | Service Fee |
| └ status | string | Status: 0 Created, 1 Processing, 2 Failed, 3 Success |
Bank Code List
When initiating a pay-out transfer, the bankCode must be chosen from the following list:
Supported Time Slots:
- Daytime: View in Backend System - Merchant Information
- Nighttime: Other time slots
| bankCode | Bank Name (EN) | Bank Name (TH) | Supported Time Slots |
|---|---|---|---|
| BAAC | BANK FOR AGRICULTURE AND AGRICULTURAL COOPERATIVES | ธ. เพื่อการเกษตรและสหกรณ์การเกษตร | Daytime |
| BAY | BANK OF AYUDHYA PUBLIC COMPANY LIMITED | ธ. กรุงศรีอยุธยา จำกัด (มหาชน) | Daytime |
| BBL | BANGKOK BANK PUBLIC COMPANY LTD. | ธ. กรุงเทพ จำกัด (มหาชน) | Daytime |
| CIMBT | CIMB THAI BANK PUPBLIC COMPANY LTD. | ธ. ซีไอเอ็มบี ไทย จำกัด (มหาชน) | Daytime |
| CITI | CITIBANK, N.A. | ธ. ซิตี้แบงก์ | Daytime |
| GHB | THE GOVERNMENT HOUSING BANK | ธ. อาคารสงเคราะห์ | Daytime |
| GSB | THE GOVERNMENT SAVINGS BANK | ธ. ออมสิน | Daytime |
| ISBT | ISLAMIC BANK OF THAILAND | ธ. อิสลามแห่งประเทศไทย | Daytime |
| ICBCT | INDUSTRIAL AND COMMERCIAL BANK OF CHINA (THAI) PUBLIC COMPANY LIMITED | ธ. ไอซีบีซี (ไทย) จำกัด (มหาชน) | Daytime |
| KBANK | KASIKORNBANK PUBLIC COMPANY LTD. | ธ. กสิกรไทย จำกัด (มหาชน) | Daytime |
| KK | KIATNAKIN BANK PUBLIC COMPANY LIMITED | ธ. เกียรตินาคิน จำกัด (มหาชน) | Daytime |
| KTB | KRUNG THAI BANK PUBLIC COMPANY LTD. | ธ. กรุงไทย จำกัด (มหาชน) | Daytime |
| LHBANK | LAND AND HOUSES BANK PUBLIC COMPANY LIMITED | ธ. แลนด์แอนด์เฮ้าส์ จำกัด (มหาชน) | Daytime |
| MIZUHO | MIZUHO CORPORATE BANK, LTD. | ธ. มิซูโฮ คอร์ปอเรต จำกัด | Daytime |
| SCB | SIAM COMMERCIAL BANK PUBLIC COMPANY LTD | ธ. ไทยพาณิชย์ จำกัด (มหาชน) | Daytime |
| SCBT | STANDARD CHARTERED BANK (THAI) PUBLIC COMPANY LIMITED | ธ. สแตนดาร์ดชาร์เตอร์ด (ไทย) จำกัด (มหาชน) | Daytime |
| SMBC | SUMITOMO MITSUI BANKING CORPORATION | ธ. ซูมิโตโม มิตซุย แบงกิ้ง คอร์ปอเรชั่น | Daytime |
| TBANK | THANACHART BANK PUBLIC COMPANY LTD. | ธ. ธนชาต จำกัด (มหาชน) | Daytime |
| TCR | THE THAI CREDIT RETAIL BANK PUBLIC COMPANY LIMITED | ธ. ไทยเครดิต เพื่อรายย่อย จำกัด (มหาชน) | Daytime |
| TISCO | TISCO BANK PUBLIC COMPANY LIMITED | ธ. ทิสโก้ จำกัด (มหาชน) | Daytime |
| TMB | TMB BANK PUBLIC COMPANY LIMITED | ธ. ทหารไทย จำกัด (มหาชน) | Daytime |
| TTB | TMBTHANACHART BANK PUBLIC COMPANY LIMITED | ธ. ทหารไทยธนชาต จำกัด (มหาชน) | Daytime |
| UOBT | UNITED OVERSEAS BANK (THAI) PUBLIC COMPANY LIMITED | ธ. ยูโอบี จำกัด (มหาชน) | Daytime |
