CreatePayoutDto

amount
Type: number
required

USD to send (amount_type source, default) or, for bank payouts, the local amount to deliver (amount_type destination).
reference
Type: string
required

Your own reference, and the handle you will find this by. Required: we never invent one, because a reference we made up is not one you can reconcile against.

This is not an idempotency key — send Idempotency-Key to make a retry safe. This says which of your records the money belongs to.
address
Type: string

Destination wallet address (crypto payouts).
amount_type
Type: "source" or "destination"enum
asset_id
Type: string

The asset to send, from the supported crypto assets list (crypto payouts).
country
Type: string

Corridor country (bank payouts).
currency
Type: string

Local currency the recipient receives (bank payouts).
customer_id
Type: string

The customer this payout is for.
method
Type: string

Payout method: bank, momo or swift. A SWIFT payout needs the recipient's identity (or a business's registration) and supporting_document_id.
rail
Type: "bank" or "crypto"enum

Payout rail. bank (default) pays local currency to a bank/mobile-money account; crypto sends a digital asset to a wallet address. You always send USD.
recipient
Type:

Bank/mobile-money recipient.

Properties: 18
supporting_document_id
Type: string

The invoice, contract or receipt behind this payout, from POST /v1/payouts/documents. Required for SWIFT payouts.