POST
/
transfer
/
crypto-withdrawals
Create Crypto Withdrawal
curl --request POST \
  --url https://api.paxos.com/v2/transfer/crypto-withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ref_id": "idempotence_id",
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "asset": "BTC",
  "amount": "0.05",
  "destination_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
  "metadata": {
    "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
  },
  "crypto_network": "BITCOIN"
}'
{
  "id": "373b7966-4290-4be3-a604-51929173437b",
  "customer_id": "72b2b4e6-d395-43d2-9b09-690fa6c1a664",
  "profile_id": "1db50793-0a22-4d2a-8696-66fc4fd8e360",
  "ref_id": "ABCZYX123",
  "amount": "0.001",
  "total": "0.00100223",
  "fee": "0.00000223",
  "asset": "BTC",
  "balance_asset": "BTC",
  "direction": "DEBIT",
  "type": "CRYPTO_WITHDRAWAL",
  "status": "PENDING",
  "created_at": "2022-06-14T15:19:20.034294Z",
  "updated_at": "2022-06-14T15:19:20.034294Z",
  "destination_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
  "crypto_network": "BITCOIN",
  "auto_conversion": {}
}
OAuth Scope
transfer:write_crypto_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
​
profile_id
string
required

The profile from which to withdraw.

​
destination_address
string
required

The destination address.

​
asset
string
required

The asset to withdraw, e.g. "BTC" , "ETH". Always specify the crypto_network for all withdrawals.

​
crypto_network
enum<string>
required

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

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

Client-specified ID for replay protection and lookup.

​
identity_id
string

The Identity of the user making the withdrawal.

​
balance_asset
string

The asset's balance to debit for withdrawals of Paxos-minted USD stablecoin.

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

​
account_id
string

The Account associated to the identity of the user making the withdrawal.

​
fee_id
string

Optional id of the guaranteed fee.

​
amount
string

The amount to withdraw. Specify exactly one of amount or total, otherwise an error is returned.

​
total
string

Total amount to withdraw, including fees. Specify exactly one of amount or total, otherwise an error is returned.

​
beneficiary
object
​
memo
string

Optional additional memo to be included with the withdrawal as an identifier.

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