v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB

Fiat Transfers

Create Fiat Account

Create an account to initiate a fiat withdrawal.

For U.S. wires, set fiat_network_instructions > wire > routing_details > routing_number_type to ABA. For international (SWIFT) wires, set fiat_network_instructions > wire > routing_details > routing_number_type to SWIFT. For CUBIX, set fiat_network_instructions > cubix > account_id, and do not specify routing_number_type. For CUBIX, the account_id is the CUBIX account ID.

post/transfer/fiat-accounts

Request body

ref_idstring

The optional client-specified ID (for idempotence).

identity_idstring

The Paxos Identity (identity_id) of the user's FiatAccount. Required only for customers with 3rd-Party integrations initiating transfers on behalf of their end users.

account_idstring

The Paxos Account (account_id) of the user's FiatAccount. Required only for customers with 3rd-Party integrations initiating transfers on behalf of their end users.

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.

Example request

{
  "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264",
  "fiat_network_instructions": {
    "wire": {
      "account_number": "12345678",
      "routing_details": {
        "routing_number": "031302971",
        "bank_name": "Customers Bank",
        "bank_address": {
          "country": "USA"
        }
      },
      "fiat_account_owner_address": {
        "address1": "456 Main Street",
        "city": "NY",
        "country": "USA"
      }
    }
  },
  "fiat_account_owner": {
    "person_details": {
      "first_name": "Jane",
      "last_name": "Doe"
    }
  }
}

Response

A successful response.

idstring required

The Paxos FiatAccount ID (UUID).

ref_idstring

The optional client-specified ID (for idempotence).

identity_idstring

The Paxos Identity (identity_id) of the user's FiatAccount.

account_idstring

The Paxos Account (account_id) of the user's FiatAccount. Required only for customers with 3rd-Party integrations initiating transfers on behalf of their end users.

status'PENDING' | 'APPROVED' | 'REJECTED' required

metadataobject

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

created_atstring date-time required

The time at which this FiatAccount was created.

updated_atstring date-time

The time at which this FiatAccount record was most recently updated.