Skip to main content
POST
Create a fiat payout

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

For Managed Payments entities sending fiat payouts to a registered beneficiary. Set destination.type to fiat_address_book and supply a locked quote from POST /v1/payouts/quotes. The beneficiary must be in ACTIVE status.

idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

destination
object
required
amount
object
required
quoteId
string<uuid>
required

Locked quote identifier from POST /v1/payouts/quotes. Quotes expire at expiresAt; submitting an expired quote returns a 400.

Example:

"66666666-7777-8888-9999-000000000000"

useCase
enum<string>
required

Use case describing the originator and recipient relationship.

  • B2B — business originator, business recipient.
  • B2C — business originator, individual recipient.
  • C2B — individual originator, business recipient.
  • C2C — individual originator, individual recipient.
Available options:
B2B,
B2C,
C2B,
C2C
Example:

"B2C"

reasonForPayment
string
required

Payment reason code. See Crypto Payouts payment reason codes.

Example:

"PMT001"

customerRefId
string
required

Customer-provided reference identifier for this payout.

Example:

"order-9876"

source
object
originatorMode
integer
default:0

Travel rule originator nesting mode. 0 = standalone (default), 1 = nested (originator is acting on behalf of another party).

Example:

0

travelRule
object

Originator travel rule information. Required fields depend on originatorMode and the destination corridor. Keys match the field names returned by GET /v1/beneficiaries/requirements.

Example:

Response

Successfully created a fiat payout.

data
object