Execute a payout
Send money out of a virtual account, from its balance or from a deposit you make. mode chooses which.
Every payout redeems a quote_id from POST /v1/quotations and settles at exactly that price.
Authorizations
The data.access_token value from Get access token.
Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
"2026-04-14"
Body
The quote_id of a quotation from POST /v1/quotations, made with X-Api-Version: 2026-06-01 or later. The payout settles at exactly the amounts, fees and rate you were quoted, so your own markup and an exact amount for the recipient (inverse: true) are set on the quotation. Without it the payout is refused with quote_required; an id that is not one of your quotations is refused with quote_not_found.
Who gets paid. Required on a FIAT payout. Where the rail accepts only Latin characters, creating the payout rejects a recipient name or address field written entirely in another script with a 400 naming the field (for example address.street_name); accented characters pass (José becomes Jose).
What the payout is for. It decides whether a supporting document is required and, on a wire from an austin_capital_trust account, the purpose the bank receives. See Payout values.
vendor, import_export, first_party, spot_3p, spot_1p, related_entities, other true to pay on behalf of one of the sub-client's own customers, the ultimate payor named in ultimate_payor_id — see Pay on behalf of your customers.
On a crypto-funded payout or a payout from the virtual account's USD balance, to a SWIFT recipient whose bank is in a country these payments reach, for a sub-client that holds the pobo capability. It is priced with a quote_id from Create a quotation made with pobo: true at version 2026-06-01 for this virtual account, with from_held_balance: true for a payout from the balance, whichever version the payout is made at.
Proof of what the payout is for. One to five files, each at most 3 MB and together at most 7 MB before encoding; several may be invoices, as when one payout settles more than one invoice. A CRYPTO payout needs one unless nature_of_payment is first_party; leaving nature_of_payment out does not exempt it. Some accounts are set up without the requirement. A payout to a SWIFT recipient from an austin_capital_trust account always needs one, whatever its nature_of_payment and however the account is set up; without one it is refused with a 400 rather than the 422 document_required.
1 - 5 elementsResponse
Success.
Every amount is a decimal string.
Where the payout has got to — see Payout values.