Update Fiat Account

Change an existing value or add a new value on one or more fields for the given Fiat Account and return the modified Fiat Account in PENDING status. Update fields in either fiat_account_owner.person_details or fiat_account_owner.institution_details. Attempts to convert the fiat_account_owner type results in an error. Empty strings or null values are ignored.

Upon successful response, Paxos initiates an automated review of the requested changes and then either sets the status to APPROVED or REJECTED. Occasionally, a manual review may be required. Use Get Fiat Account to check for status changes.

PUT /transfer/fiat-accounts/{id}

Try it

cURL

Update fiat account owner person details

curl --request PUT \
  --url https://api.paxos.com/v2/transfer/fiat-accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fiat_account_owner": {
    "person_details": {
      "first_name": "John",
      "last_name": "Smith"
    }
  }
}
'

200

{
  "id": "dde1b3c5-d02a-48f6-8d11-16b4f532ea49",
  "ref_id": "test_ref_id_1",
  "identity_id": "c6ea91da-8f33-4545-9bdf-3cf29b4041d7",
  "account_id": "91f91384-30d4-46c2-9118-7f3cec676a2c",
  "fiat_account_owner": {
    "person_details": {
      "first_name": "John",
      "last_name": "Smith"
    },
    "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"
          }
        }
      },
      "status": "PENDING",
      "metadata": {
        "test_ref_id": "47aa7538-e2d2-47b3-8600-44a7965dd357",
        "transaction_attempt": 1
      }
    }
  },
  "created_at": "2023-09-24T14:15:22Z",
  "updated_at": "2023-09-24T14:15:22Z"
}

OAuth Scope

transfer:write_fiat_account

Authorizations

Authorization · string · header · required

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

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

id · string · required

The Paxos fiat account ID (UUID). The Fiat Account ID (id) is provided in the response of the Create Fiat Account. Use this ID to retrieve the instructions using Get Fiat Account & List Fiat Accounts.

Body

application/json

fiat_account_owner · object

Show child attributes

fiat_account_owner. person_details · object

Show child attributes

fiat_account_owner.person_details. first_name · string · required

fiat_account_owner.person_details. last_name · string · required

fiat_account_owner. institution_details · object

Show child attributes

fiat_account_owner.institution_details. name · string · required

fiat_network_instructions · FiatNetworkInstructions · object

Show child attributes

fiat_network_instructions. wire · Wire · object

Show child attributes

fiat_network_instructions.wire. fiat_account_owner_address · object

A mailing address.

Show child attributes

fiat_network_instructions.wire.fiat_account_owner_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. zip_code · string

Maximum string length: 35

fiat_network_instructions.wire. routing_details · RoutingDetails · object

Show child attributes

fiat_network_instructions.wire.routing_details. bank_name · string

The name of the bank.

fiat_network_instructions.wire.routing_details. bank_address · object

A mailing address.

Show child attributes

fiat_network_instructions.wire.routing_details.bank_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. zip_code · string

Maximum string length: 35

fiat_network_instructions.wire. intermediary_routing_details · RoutingDetails · object

Show child attributes

fiat_network_instructions.wire.intermediary_routing_details. bank_name · string

The name of the bank.

fiat_network_instructions.wire.intermediary_routing_details. bank_address · object

A mailing address.

Show child attributes

fiat_network_instructions.wire.intermediary_routing_details.bank_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. zip_code · string

Maximum string length: 35

metadata · object

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.

Show child attributes

metadata. {key} · string

Response

200

application/json

A successful response.

id · string · required

The Paxos FiatAccount ID (UUID).

fiat_network_instructions · object · required

Show child attributes

fiat_network_instructions. wire · object

Show child attributes

fiat_network_instructions.wire. account_number · string · required

The FiatAccount owner's bank account number.

fiat_network_instructions.wire. fiat_account_owner_address · object · required

A mailing address.

Show child attributes

fiat_network_instructions.wire.fiat_account_owner_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.fiat_account_owner_address. zip_code · string

Maximum string length: 35

fiat_network_instructions.wire. routing_details · object · required

Show child attributes

fiat_network_instructions.wire.routing_details. routing_number_type · enum<string> · required

Available options: ABA, SWIFT

fiat_network_instructions.wire.routing_details. routing_number · string · required

The routing number.

fiat_network_instructions.wire.routing_details. bank_name · string · required

The name of the bank.

fiat_network_instructions.wire.routing_details. bank_address · object · required

A mailing address.

Show child attributes

fiat_network_instructions.wire.routing_details.bank_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.routing_details.bank_address. zip_code · string

Maximum string length: 35

fiat_network_instructions.wire. intermediary_routing_details · object

Show child attributes

fiat_network_instructions.wire.intermediary_routing_details. routing_number_type · enum<string> · required

Available options: ABA, SWIFT

fiat_network_instructions.wire.intermediary_routing_details. routing_number · string · required

The routing number.

fiat_network_instructions.wire.intermediary_routing_details. bank_name · string · required

The name of the bank.

fiat_network_instructions.wire.intermediary_routing_details. bank_address · object · required

A mailing address.

Show child attributes

fiat_network_instructions.wire.intermediary_routing_details.bank_address. country · string · required

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. address1 · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. address2 · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. city · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. province · string

Maximum string length: 35

fiat_network_instructions.wire.intermediary_routing_details.bank_address. zip_code · string

Maximum string length: 35

fiat_network_instructions. cbit · object

Show child attributes

fiat_network_instructions.cbit. wallet_address · string · required

The wallet address of the CBIT account.

fiat_network_instructions. dbs_act · object

Show child attributes

fiat_network_instructions.dbs_act. account_number · string · required

The account number of the DBS account.

fiat_network_instructions. cubix · object

Show child attributes

fiat_network_instructions.cubix. account_id · string · required

The uuid account id of the CUBIX account.

fiat_network_instructions. scb · object

Show child attributes

fiat_network_instructions.scb. account_number · string · required

The account number of the StandChart account.

status · enum<string> · required

Available options: PENDING, APPROVED, REJECTED

created_at · string<date-time> · required

The time at which this FiatAccount was created.

ref_id · string

The optional client-specified ID (for idempotence).

identity_id · string

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

account_id · string

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.

fiat_account_owner · object

Show child attributes

fiat_account_owner. person_details · object

Show child attributes

fiat_account_owner.person_details. first_name · string · required

fiat_account_owner.person_details. last_name · string · required

fiat_account_owner. institution_details · object

Show child attributes

fiat_account_owner.institution_details. name · string · required

metadata · object

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.

Show child attributes

metadata. {key} · string

updated_at · string<date-time>

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