Mock a payout
Payouts
Mock Payout
Mock a payout of available balance. Sandbox only.
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
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Body
application/json
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.
Available options:
scheduled, processing, paid, failed, canceled, pending Example:
"sgd"
Payout amount in major units
Example:
"sgd"
Masked bank account number
Present when status is failed
Last modified on September 30, 2026