Skip to main content
POST
Create Virtual Account Payout

Authorizations

X-API-KEY
string
header
required
X-API-Nonce
string
header
required
X-API-Signature
string
header
required

Body

application/json

body

amount
string
required

Amount to pay out, in major units of currency.

Example:

"100.00"

currency
string
required

Currency symbol to pay out. A fiat symbol takes the bank rail, a digital one the chain rail.

Example:

"EUR"

account_id
integer

Account to pay out FROM: a virtual account, or one specific sub-account under it for a caller that wants to choose the custodian. Optional — omitted, the org's primary virtual account is used and the funding wallet is chosen for you.

Example:

42

account_reference
string

Merchant's own reference for the VIRTUAL account to pay out from, for orgs holding more than one. Mutually exclusive with account_id.

Maximum string length: 255
chain_id
integer

Chain id. Required for a digital currency, must be omitted for fiat.

Example:

8453

destination_account_id
integer

Destination account id as returned by the accounts APIs. Mutually exclusive with destination_account_reference.

Example:

123

destination_account_reference
string

Merchant's own reference for the destination account. Mutually exclusive with destination_account_id.

Maximum string length: 255
metadata
object

Optional caller metadata returned on the payment record (maximum 2 KiB).

reference
string

Optional payment reference passed through to the destination rail.

Maximum string length: 1024
token_address
string

Token contract address. Optional: resolved from the currency cache, and only required when the symbol maps to several tokens on the chain.

Response

OK

data
object

Response payload when the request succeeded.

error
boolean

True when the request failed.

message
string

Human-readable status or error message.