Payouts & Settlement

/docs/global/api-reference/payoutsGlobal

Collected balances settle to your linked bank account on your payout schedule. Use this API to check available balance and request an off-cycle payout.

Authenticated by dashboard session, not an API key

Authorized by your dashboard session bearer token, not an sk_ key — see Authentication. Paths below are relative to https://binkpay.net/api/v1.

Check balance

GET/api/v1/merchant/balances

Returns available, pending, and reserve balance per currency your account holds.

Request a payout

POST/api/v1/merchant/payouts

Parameter	Type	Required	Description
amountMinor	string	Required	Amount to withdraw, in minor units. Must not exceed available balance.
currency	string	Required	Currency to pay out.

List payouts

GET/api/v1/merchant/payouts

Retrieve a payout

GET/api/v1/merchant/payouts/:id

Cancel a payout

POST/api/v1/merchant/payouts/:id/cancel

Only valid before the payout has been dispatched to your bank.

Automatic payout schedule

Most accounts settle automatically on a fixed cadence (daily, weekly, or monthly) configured during onboarding — you only need this API for off-cycle, on-demand withdrawals.

Related resources

Payments — the collected balance a payout draws from.
Webhooks — get notified on payout.completed and payout.failed instead of polling.

Was this page helpful?