GET
/
transfer
/
fiat-deposit-instructions
/
{id}
Get Fiat Deposit Instructions
curl --request GET \
  --url https://api.paxos.com/v2/transfer/fiat-deposit-instructions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "profile_id": "5fc6d191-193c-4e28-94fa-656bbdbdfaad",
  "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339",
  "ref_id": "idempotence_id",
  "status": "VALID",
  "memo_id": "9CFXQSCMSPLFHXLZ",
  "fiat_network_instructions": {
    "wire": {
      "account_number": "12345678",
      "fiat_account_owner_address": {
        "country": "USA",
        "address1": "456 Main Street, NY",
        "city": "New York",
        "province": "NY",
        "address2": "",
        "zip_code": "10101"
      },
      "routing_details": {
        "routing_number_type": "ABA",
        "routing_number": "123456789",
        "bank_name": "Customers Bank",
        "bank_address": {
          "country": "USA",
          "address1": "123 Bank Street",
          "city": "New York",
          "province": "NY",
          "address2": "",
          "zip_code": "10101"
        }
      }
    },
    "fiat_account_owner": {
      "person_details": {
        "first_name": "Jane",
        "last_name": "Doe"
      }
    },
    "metadata": {
      "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
    }
  }
}
OAuth Scope
transfer:read_fiat_deposit_instructions

Authorizations

​
Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Path Parameters

​
id
string
required

Retrieve the Paxos Fiat Deposit Instructions for the given id.

Response

A successful response.

​
id
string
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_id
string
required

The Profile (profile_id) to deposit to.

​
identity_id
string
required

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

​
status
enum<string>
required
Available options:
VALID,
DEPRECATED
​
memo_id
string
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).

​
fiat_network_instructions
object
required
​
created_at
string<date-time>
required

The time at which these instructions were created.

​
account_id
string

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_id
string

The optional client-specified ID (for idempotence).

​
fiat_account_owner
object
​
metadata
object

Optional client-specified metadata.