POST
/
transfer
/
fiat-withdrawals
Create Fiat Withdrawal
curl --request POST \
  --url https://api.paxos.com/v2/transfer/fiat-withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "12.34",
  "asset": "USD",
  "fiat_account_id": "caa82b32-8abd-4899-afdc-f9d4bf9b4e98",
  "profile_id": "5fc6d191-193c-4e28-94fa-656bbdbdfaad",
  "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264"
}'
{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339",
  "profile_id": "5fc6d191-193c-4e28-94fa-656bbdbdfaad",
  "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264",
  "amount": "10.00",
  "total": "10.00",
  "fee": "0.0000000",
  "asset": "USD",
  "balance_asset": "USD",
  "direction": "DEBIT",
  "type": "CUBIX_WITHDRAWAL",
  "status": "PENDING",
  "created_at": "2023-07-13T18:36:08.737Z",
  "updated_at": "2023-07-13T18:36:08.737Z",
  "fiat_account_id": "caa82b32-8abd-4899-afdc-f9d4bf9b4e98"
}
OAuth Scope
transfer:write_fiat_withdrawal

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 →

Body

application/json
​
asset
string
required

The asset to withdraw. Current supported asset: "USD".

​
fiat_account_id
string
required

The fiat account (fiat_account_id) destination.

​
profile_id
string
required

The Profile (profile_id) to withdraw from.

​
ref_id
string

The optional client-specified ID (for idempotence).

​
amount
string

Amount to withdraw, excluding fees. Specify exactly one of amount or total. When amount is specified, Paxos initiates the withdrawal for amount and then charges fees.

​
identity_id
string

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

​
account_id
string

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

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

​
memo
string

Optional additional memo to be set on the outgoing withdrawal. For wire withdrawals the character limit is 100. For CUBIX intrabank withdrawals, the character limit is 40. For DBS intrabank withdrawals, the character limit is 100. For SCB intrabank withdrawals, the character limit is 140.

Maximum length: 500
​
total
string

Total to withdraw, including fees. Specify exactly one of amount or total. When total is specified, Paxos initiates the withdrawal for total minus the fee.

Response

A successful response.

​
id
string
required

The Paxos transfer ID.

​
customer_id
string
required

The Paxos customer ID.

​
profile_id
string
required

The target Profile of the transfer. The profile asset balance is debited or credited by the transfer.

​
amount
string
required

The amount sent in the transfer.

​
total
string
required

The balance change from this transfer: amount - fee for deposits, and amount + fee for withdrawals. Unsigned.

​
fee
string
required

The fee paid for the transfer.

​
asset
string
required

The asset for this transfer. This profile's balance of this asset will be debited or credited.

​
direction
enum<string>
required

Direction of the transfer.

Available options:
CREDIT,
DEBIT
​
type
enum<string>
required

Type of transfer.

Available options:
INTERNAL_TRANSFER_DEBIT,
INTERNAL_TRANSFER_CREDIT,
CRYPTO_DEPOSIT,
CRYPTO_WITHDRAWAL,
WIRE_DEPOSIT,
WIRE_WITHDRAWAL,
SEN_DEPOSIT,
SEN_WITHDRAWAL,
BANK_DEPOSIT,
BANK_WITHDRAWAL,
PAXOS_TRANSFER_DEBIT,
PAXOS_TRANSFER_CREDIT,
SIGNET_DEPOSIT,
SIGNET_WITHDRAWAL,
CBIT_WITHDRAWAL,
CBIT_DEPOSIT,
CUBIX_DEPOSIT,
CUBIX_WITHDRAWAL
​
status
enum<string>
required
Available options:
PENDING,
COMPLETED,
FAILED
​
created_at
string<date-time>
required

The time at which this transfer record was created.

​
updated_at
string<date-time>
required

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

​
identity_id
string

The Paxos ID of the Identity associated with the transfer.

​
ref_id
string

The optional client-specified ID for replay protection and lookup.

​
balance_asset
string

The balance_asset represents what asset's balance was affected at Paxos with this transfer. It only differs from Asset when the transfer includes conversion.

​
metadata
object

Optional client-specified stored metadata. For deposit event transfers this metadata is copied from the crypto deposit address or fiat deposit memo used for attribution. Up to 6 key/value pairs may be returned. Each key and value must be less than or equal to 100 characters.

​
destination_address
string

The destination crypto address.

​
crypto_network
enum<string>

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

Available options:
BITCOIN,
ETHEREUM,
BITCOIN_CASH,
LITECOIN,
SOLANA,
POLYGON_POS,
BASE,
ARBITRUM_ONE,
INK
​
crypto_tx_hash
string

For crypto transactions, the on-chain transaction hash.

​
crypto_tx_index
string

For crypto transactions, the output index or output address.

​
account_id
string

The Paxos ID of the Account associated with the transfer.

​
auto_conversion
object
​
group_id
string

Unique identifier linking the debit and credit sides of an internal or Paxos transfer.

​
fiat_account_id
string

For fiat withdrawals, the Paxos ID of the owner's fiat account (UUID).

​
secondary_status
object

Secondary status for the transfer, used for more granular explanation of the transfer status.

​
notional_value
string

For crypto withdrawals and deposits, the USD value of the combined amount and fee at the time of the transfer.

​
memo
string

An optional memo to be included with the transfer as an identifier.

​
status_details
object

Example: { "max_rent_exceeded": { "message": "Transfer cancelled due to suspected system abuse", "destination_address": "7Vbsn3YqXb7kDFvEHCWZRh5osSQXzjYkeFnRhh2Mz5vT" } }

Supported error types:

  • "max_rent_exceeded": Transfer cancelled due to suspected system abuse