API ReferenceWithdraws
Withdraws Overview
Withdraws (also called payouts) allow you to send money from your merchant account to customer bank accounts.
What are Withdraws?
Withdraws enable you to:
- Send payouts to customer bank accounts
- Process refunds by withdrawing funds back to customers
- Distribute funds to multiple recipients
- Automate payouts based on your business logic
Withdraw Flow
Withdraw Statuses
Withdraws progress through the following statuses:
| Status | Description |
|---|---|
pending | Withdraw created, waiting to be processed |
processing | Withdraw is being processed by provider |
paid | Withdraw completed successfully |
failed | Withdraw failed (e.g., insufficient balance) |
canceled | Withdraw was cancelled |
Status Flow
Use Cases
Customer Payouts
Send money to customers for:
- Refunds
- Rewards
- Commissions
- Earnings
Automated Withdraws
Automate withdraws based on:
- Order completion
- Subscription renewals
- Scheduled payouts
- Event triggers
Destination Types
Currently supported destination types:
bank_account- Withdraw to Thai bank account (required for customer withdrawals)
Bank Account Requirements
To create a withdraw, you need:
- Customer Bank Account Name - Account holder name
- Customer Bank Account Number - Bank account number
- Customer Bank Code - 3-digit Thai bank code (e.g.,
004for KBANK)