Headers

x-api-key
Required

Your shop API key

x-signature
Required

HMAC-SHA256 of timestamp|method|fullUrl|body signed with your secret key, sent as 64 hex characters

How to create the signature
x-timestamp
Required

Current Unix time in milliseconds — must be the same value used to create x-signature

Parameters (Request Body)

withdrawal_mode
string Optional

Withdrawal type. Optional — this endpoint always records it as "FIAT". If you send it, it must be "FIAT".

order_id
string Required

A unique order reference ID from your system (e.g., mystore_order_1234, uuid). Please use the same Order ID for the same transaction and do not generate a new one.

order_user_reference
string Optional

Your own reference for the end user, e.g. a member or player ID. It is stored with the withdrawal and checked against the withdrawal block list; a blocked request gets error 10051.

amount
number Required

Withdrawal amount in THB. Must be a whole multiple of 100, e.g. 500 or 1100. Amounts such as 567 or 1105 are rejected with error 10067. Each request must also stay within the per-request ceiling (50,000 THB by default, error 10044) and at or above the minimum set for your shop (error 10028).

currency
string Required

Withdrawal currency. Only "THB" is accepted.

PromptPay
receiver_bank
string Required

Destination bank code, e.g. "SCB" (case-insensitive), or the bank's 3-digit number such as "022" for CIMB. Set "PromptPay" to withdraw via PromptPay — this single field decides the payout rail. An unknown code returns 422 with the list of accepted codes (live list: GET /v1/ebank/bankConfig).

receiver_name
string Required

Name of the destination account holder. Validation counts only Thai and English letters, spaces and dots (1–200 characters after that), but the name is stored exactly as sent — send the plain account name.

withdrawal_address
string Required

Destination bank account number, or the PromptPay number when receiver_bank is "PromptPay". Validation looks at the digits only, and a bank account number must have exactly as many digits as that bank uses (e.g. 10 for SCB). Send digits only, because the value is stored as sent.

promptpay_id_type
string Optional

PromptPay number type. Use it only when receiver_bank is "PromptPay"; sending it with any other bank returns 422. Leave it out (or send null / "") and the system detects the type from withdrawal_address. NATID and TAXID are interchangeable, but a type that contradicts the number (e.g. MSISDN with a 13-digit ID) returns 422.

chain
string Optional

Not used for THB withdrawals, so it is optional. Whatever you send, the withdrawal is recorded with chain "offchain".

asset_type
string Optional

Not used for THB withdrawals, so it is optional. Whatever you send, the withdrawal is recorded with asset_type "native".

additional
object Optional

Optional JSON object for your own data, such as a note or your user ID. It is stored with the withdrawal and returned in the withdrawal data.

PromptPay

The same endpoint supports PromptPay withdrawals — set receiver_bank to "PromptPay" (case-insensitive) and put the PromptPay number in withdrawal_address. The system reads its format for you.

Accepted numberFormat
Thai mobile phone10 digits, starts with 06, 08, or 09
Thai citizen national ID13 digits (mod-11 checksum)
Thai juristic tax ID13 digits (mod-11 checksum)
BOT-issued e-wallet ID15 digits, digits only