Skip to main content
POST
Create Payment Instructions

Authorizations

Authorization
string
header
required

Bearer authentication with an API token

Path Parameters

identity_id
string
required

Identity id to create payment instructions for

Body

application/json
country
enum<string>
required

Country of the bank account (ISO 3166-1 alpha-2).

Available options:
US
Example:

"US"

fiat_currency_symbol
enum<string>
required

Currency symbol of the fiat transaction

Available options:
USD
Example:

"USD"

account_name
string
required

Friendly name for the payment instructions

payment_method
enum<string>
required

Payment method

Available options:
WIRE
Example:

"WIRE"

bank_account_details
wire_details · object
required

Bank account details

beneficiary_type
enum<string>
required

Whether these instructions pay the sender (FIRST_PARTY) or someone else (THIRD_PARTY).

Available options:
FIRST_PARTY,
THIRD_PARTY
Example:

"FIRST_PARTY"

recipient
business · object
required

Recipient information.

request_id
string
required

Client-provided idempotency key (UUID). Must be unique per request and included on every call to prevent duplicate payment instructions from being created. Re-submitting the same request_id returns the original response without creating a duplicate.

Response

Success

Payment instructions for a conversion.

country
enum<string>
required

Country of the bank account (ISO 3166-1 alpha-2).

Available options:
US
Example:

"US"

fiat_currency_symbol
enum<string>
required

Currency symbol of the fiat transaction

Available options:
USD
Example:

"USD"

account_name
string
required

Friendly name for the payment instructions (e.g., "John's Chase Account")

payment_method
enum<string>
required

Payment method for the fiat transaction

Available options:
WIRE
Example:

"WIRE"

bank_account_details
wire_details · object
required

Bank account details

beneficiary_type
enum<string>
required

Whether these instructions pay the sender (FIRST_PARTY) or someone else (THIRD_PARTY).

Available options:
FIRST_PARTY,
THIRD_PARTY
Example:

"FIRST_PARTY"

recipient
business · object
required

Recipient information.

id
string
read-only

Payment instructions ID