Skip to main content
POST
Mock a payout
This endpoint mocks a payout so you can test payout.created webhooks and list charges. It is sandbox only. Production returns 404.

Headers

X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
currency
string

Wallet currency to pay out. Defaults to the business home currency.

Example:

"sgd"

Response

Payout created

Settlement of the business's available balance to its linked bank account.

id
string<uuid>
required
status
enum<string>
required
Available options:
scheduled,
processing,
paid,
failed,
canceled,
pending
currency
string
required
Example:

"sgd"

amount
number
required

Payout amount in major units

source_currency
string
required
Example:

"sgd"

source_amount
number
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
bank_name
string | null
bank_account
string | null

Masked bank account number

remark
string | null
reference
string | null
failure_code
string | null

Present when status is failed

failure_message
string | null
arrival_date
string<date> | null
Last modified on September 30, 2026