Headers

x-api-key
Required

API Key for authentication

x-signature
Required

HMAC-SHA256 signature for authentication

x-timestamp
Required

Timestamp (milliseconds) for signature

Parameters (Request Body)

withdrawal_mode
string Required

Withdrawal Status

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.

amount
number Required

Withdrawal Amount

currency
string Required

Currency

PromptPay
receiver_bank
string Required

Destination bank code, e.g. "SCB", or set "PromptPay" to withdraw via PromptPay (case-insensitive) — this single field decides the payout rail.

receiver_name
string Required

Recipient

withdrawal_address
string Required

Destination bank account number, or a PromptPay number. Non-digit characters are stripped before validation.

chain
string Required

Type

asset_type
string Required

Type

additional
object Required

Metadata

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