List payout methods

Lists the currencies enabled for your account and, for each, the payout methods and the recipient details they need. Use it before Create payout order to choose paymentMethod and the fields to send.

POST/api/open/order/getPaymentMethods

Full URL = your API base URL + this path. The base URL is shown in the merchant console under Developers → API & callbacks.

Request parameters

Parameter	Type	Required	Description
merchantNo	string	Yes	Merchant number
currencyType	string	No	Only this currency; omit to list all enabled currencies

Response

Field	Type	Description
currencies[].currency	string	Currency code
currencies[].symbol	string	Currency symbol
currencies[].decimals	int	Decimal places for amounts
currencies[].methods[].paymentMethod	int	Method code, pass it as paymentMethod
currencies[].methods[].name	string	Method name
currencies[].methods[].kind	string	bank transfer, wallet e-wallet, qrcode QR payment
currencies[].methods[].fields[]	array	Recipient details required
fields[].key	string	Field key
fields[].apiParam	string	Matching parameter of Create payout order; empty means it can't be sent via the API
fields[].label	string	Field label
fields[].required	bool	Required or not
fields[].pattern	string	Format rule (regular expression); empty means no rule
fields[].hint	string	Hint
currencies[].methods[].banks[]	array	Allowed banks (name, code); if present, choose bankName from this list

{
  "code": 0,
  "message": "success",
  "data": {
    "currencies": [
      {
        "currency": "THB",
        "symbol": "฿",
        "decimals": 2,
        "methods": [
          {
            "paymentMethod": 1,
            "name": "Bank transfer",
            "kind": "bank",
            "fields": [
              { "key": "owner", "apiParam": "bankAccountName", "label": "Account name", "required": true, "pattern": "", "hint": "" },
              { "key": "account", "apiParam": "bankAccountNumber", "label": "Account number", "required": true, "pattern": "^[0-9]{10,12}$", "hint": "" }
            ],
            "banks": [ { "name": "Kasikornbank", "code": "KBANK" } ]
          }
        ]
      }
    ]
  }
}

This only illustrates the format; the actual methods, fields and banks come from the API.

Common errors

40010, 40017.