Create Merchant Payout
POST/api/partner/v1/merchants/:ref/payouts
Requests a payout of the merchant's entire available balance to the merchant's verified bank account on file. Requires scope payouts:write and the merchant's separate payout opt-in (confirmed by SMS in the account frame) - the read/payment delegation does not cover payouts.
The request body is empty. You do not - and cannot - supply an amount, currency, or destination account: dpay always pays out the full available balance to the account on file. You only decide when.
A success returns 200 with status: "queued". If a payout for this merchant is already running, 200 with status: "in_progress" (no available). Sandbox partner accounts get a simulated 200 response with simulated: true and no real transfer. The payout identifier is not returned here - it arrives later in the payout.* webhooks.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 422
Payout accepted (queued), already running (in_progress), or simulated in sandbox (simulated: true).
Missing or invalid partner key.
The partner key lacks the payouts:write scope, the merchant has not opted in to payouts, or dpay Connect is currently unavailable.
No merchant with this ref belongs to your partner account.
Payout cannot be requested right now: the merchant is on automatic-payout mode (on-behalf payouts work only in manual mode) or is under a reverification restriction.
No available balance to pay out.