GuidesAPI ReferenceChangelog
API Reference

Create Payout

Creates a fiat payout, crypto payout, or 1Money Internal Transfer.

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

Account funding the payout, in the form BZ-XXXX-XXXX (business) or IN-XXXX-XXXX (individual). Required without quote_id or when on_behalf_of_account is provided. Otherwise, defaults to the quote's owner and must match that owner if supplied.

string | null

Quote ID to execute. Omit or set to null to create a payout without a prior quote. The quote must be unexpired and unused; an already executed quote returns HTTP 409.

source
object

Asset and total amount to debit. Required without quote_id. Do not send this field with quote_id, including null.

destination
object

Asset and amount to receive. Required without quote_id. Do not send this field with quote_id, including null.

string | null
enum

Required when providing a crypto address or a 1Money Internal Transfer destination in to_account. Omit for registered fiat bank accounts. With quote_id, must match the quoted network when provided.

to_account
object | null

Destination account details. Required without quote_id. With quote_id, may be omitted if the quote already identifies the destination; if provided, must match any destination bound to the quote.

string | null

Account on whose behalf the payout is executed. Optional. When provided, from_account is required and must identify a different account. With quote_id, the quote must belong to on_behalf_of_account.

string | null

Your payment reference. Can be used to filter List Payouts.

string | null

Payment memo, returned in withdrawal.memo.

string | null

Payment purpose code, when required by the destination. See Local Payment Code for supported values.

Headers
uuid
required

Canonical lowercase UUID v4 or v7, unique per account.

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