Key concepts
This page explains the terms you meet in the console and in the Partner API. For a full Thai–English list see the glossary.
Partner and partner group
Section titled “Partner and partner group”A partner is one business account on the platform, with its own partner code, balance, API keys and team.
A partner group joins several partner accounts that have the same owner. Group users see the payments and balances of every partner in the group.
A payer is your customer. Each payer is tied to one bank account: bank, account number, Thai account name and, if available, the English account name.
This matters because the platform uses the account the payer transfers from to match pay-ins, and uses the same account as the destination of payouts. Payers must transfer from their registered account only.
- An Inactive payer cannot make payments.
- A payer can have one pay-in waiting for payment and one unfinished payout at a time.
- Payers on the provider’s blocked list are refused when they are created or when they pay.
Pay-ins and payouts
Section titled “Pay-ins and payouts”| Term | Meaning |
|---|---|
| Pay-in | The payer transfers money to you. When it succeeds, the amount minus fees goes to your balance |
| Payout | The platform transfers money from your balance to the payer’s account |
| Requested amount | The amount you sent when you created the payment |
| Transfer amount | The amount the payer must transfer (including extra satang), or the amount sent out |
| Partner order ID | Your own reference (reference in the API); you can search by it |
| UUID | The payment ID shown in the console |
Every payment has a status. The meaning of each status and its API value are in the status reference.
Balance and available balance
Section titled “Balance and available balance”| Term | Meaning |
|---|---|
| Balance | All the money in your partner account |
| Available balance | Balance minus amounts on hold. Usable right away for payouts and withdrawals |
| Withdrawal | A request to transfer money from your balance to your company’s bank account or crypto wallet |
| Add funds | Money you transfer in to increase your balance, for example to cover payouts |
Amounts on hold are unfinished payouts and withdrawals that are awaiting approval or processing. See balance, withdrawals and add funds.
Your rates come from the fee plan the provider assigns to your account. There are separate fees for pay-ins, payouts, withdrawals and add funds, each either a fixed amount or a percentage. The fee of each payment is shown on its detail page.
Referrer
Section titled “Referrer”A referrer brings partners or payers to the platform and receives a share of the fees. Each referrer has a referral code, which you can enter when creating a payer.
Webhooks
Section titled “Webhooks”When a payment reaches a final status, such as succeeded, expired or canceled, the platform sends a webhook (callback) to the URL you gave when creating the payment. In the console this is the callback history of a payment, where you can also send the callback again. See Webhooks for how to receive and verify them.
Reference ID
Section titled “Reference ID”Error messages in the console end with a reference ID (for example req_GJZe...), and every API response has the same kind of requestId. Quote it when you contact support so the team can find the request straight away.