v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB

Fiat Transfers

Create Fiat Deposit Instructions

Create instructions for depositing fiat.

post/transfer/fiat-deposit-instructions

Request body

ref_idstring

The optional client-specified ID (for idempotence).

profile_idstring required

The Profile (profile_id) to deposit to.

identity_idstring

The Identity (identity_id) of the user making the deposit. Required only for customers with 3rd-Party integrations making deposits on behalf of their end users.

account_idstring

The Account (account_id) associated with the Identity of the user making the deposit. Required only for customers with 3rd-Party integrations making deposits on behalf of their end users.

fiat_network'WIRE' | 'DBS_ACT' | 'CUBIX' | 'SCB' | 'RTP' required

routing_number_type'ABA' | 'SWIFT'

metadataobject

Optional client-specified metadata. Up to 6 key/value pairs may be provided. Each key and value must be less than or equal to 100 characters.

Response

A successful response.

idstring required

The Fiat Deposit Instructions ID (id) is provided in the response of the Create Fiat Deposit Instructions. Use this ID to retrieve the instructions using Get Fiat Deposit Instructions & List Fiat Deposit Instructions.

profile_idstring required

The Profile (profile_id) to deposit to.

identity_idstring required

The Identity (identity_id) of the user making the deposit.

account_idstring

The Account (account_id) associated with the Identity of the user making the deposit. Required only for customers with 3rd-Party integrations making deposits on behalf of their end users.

ref_idstring

The optional client-specified ID (for idempotence).

status'VALID' | 'DEPRECATED' required

memo_idstring required

The string, unique to the request. To deposit funds into an account, the memo ID must be provided when initiating a WIRE transfer to Paxos. This is provided after creating Fiat Deposit Instructions The memo_id can also be found from either Get Fiat Deposit Instructions or List Fiat Deposit Instructions for the corresponding ID (Fiat Deposit Instructions ID).

metadataobject

Optional client-specified metadata.

created_atstring date-time required

The time at which these instructions were created.