Create a payout

Creates and triggers a payout from the merchant custodial balance to a previously-registered destination account (bank or wallet). When X-On-Behalf-Of is set to a sub-merchant id, the payout is debited from the sub-merchant's custodial wallet and uses the sub-merchant's destination accounts. The destination account must belong to the merchant (or sub-merchant) identified by the request.

This endpoint is intended for custodial (Inflow-managed) wallets. Non-custodial (Privy-based) merchants must use the dashboard flow that includes an explicit signature step.

Supporting documents (e.g. invoices) can be attached by sending the request as multipart/form-data with up to 3 files fields (pdf/jpeg/jpg/png, 10KB-5MB each). They are forwarded to the payout provider; some destination countries require one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Identifier of the payout destination (bank or wallet account). Must belong to the merchant (or the sub-merchant when X-On-Behalf-Of is used).

number
required

Payout amount in cents of the source currency.

string
enum
required

Source currency used to debit the merchant balance.

Allowed:
string
enum

Destination network. Required when the destination account is a crypto wallet.

Allowed:
string

Custom SEPA reference that will appear on the beneficiary bank statement. Only used for EUR/SEPA payouts. Max 140 characters, alphanumeric.

string

Name or legal business name of the invoice issuer (the merchant). Only used for payouts to Align-supported countries: a payout invoice is generated automatically and attached to the transfer. Falls back to the merchant KYB/profile data when omitted.

string

Street address of the invoice issuer. Only used for Align payouts.

string

City of the invoice issuer. Only used for Align payouts.

string

Postal code of the invoice issuer. Only used for Align payouts.

string

Country of the invoice issuer. Only used for Align payouts.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json