v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Fiat Transfers

Get Fiat Account

Get a single Fiat Account by ID.

In the polling workflow, this endpoint can be called to monitor a FiatAccount's status. The Fiat Account response includes the full account number, beneficiary name and address details.

get/transfer/fiat-accounts/{id}

Path parameters

idstring 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.

Query parameters

include_deletedboolean

Used to include deleted accounts in the response.

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.