Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Crypto Withdrawals

Create Crypto Withdrawal

Withdraw a cryptocurrency asset to a specified destination address.

Important for Stellar Network (PYUSD):

When withdrawing PYUSD on the Stellar network, the destination address must have an established trustline with the PYUSD issuer:

  • PYUSD Issuer: GDQE7IXJ4HUHV6RQHIUPRJSEZE4DRS5WY577O2FY6YQ5LVWZ7JZTU2V5 (mainnet)
  • Asset Code: PYUSD

How to Establish a Trustline:

The recipient must use a Stellar wallet or the Stellar SDK to:

  1. Ensure their account has minimum XLM balance (at least 1 XLM recommended)
  2. Create a trustline to the PYUSD issuer for the PYUSD asset
  3. Confirm the trustline is active before requesting withdrawal

Verifying Trustline Status:

You can verify if an address has the required trustline by:

  • Using Stellar blockchain explorers (e.g., stellar.expert)
  • Querying the Stellar Horizon API
  • Using the Stellar SDK to check account balances
post/transfer/crypto-withdrawals

Request body

ref_idstring

Client-specified ID for replay protection and lookup.

profile_idstring required

The profile from which to withdraw.

identity_idstring

The Identity of the user making the withdrawal.

destination_addressstring required

The destination address.

assetstring required

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

balance_assetstring

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

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.

account_idstring

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

fee_idstring

Optional id of the guaranteed fee.

crypto_network'BITCOIN' | 'ETHEREUM' | 'BITCOIN_CASH' | 'LITECOIN' | 'SOLANA' | 'POLYGON_POS' | 'BASE' | 'ARBITRUM_ONE' | 'STELLAR' | 'INK' | 'XLAYER' | 'AVALANCHE' | 'DOGECOIN' | 'SUI' | 'ROBINHOOD' | 'BNB' required

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

amountstring

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

totalstring

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

memostring

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

Example request

{
  "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"
}

Response

A successful response.

idstring required

The Paxos transfer ID.

customer_idstring required

The Paxos customer ID.

profile_idstring required

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

identity_idstring

The Paxos ID of the Identity associated with the transfer.

ref_idstring

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

amountstring required

The amount sent in the transfer.

totalstring required

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

feestring required

The fee paid for the transfer.

assetstring required

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

balance_assetstring

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.

direction'CREDIT' | 'DEBIT' required

Direction of the transfer.

type'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' | 'RTP_DEPOSIT' required

Type of transfer.

status'PENDING' | 'COMPLETED' | 'FAILED' required
created_atstring date-time required

The time at which this transfer record was created.

updated_atstring date-time required

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

metadataobject

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_addressstring

The destination crypto address.

crypto_network'BITCOIN' | 'ETHEREUM' | 'BITCOIN_CASH' | 'LITECOIN' | 'SOLANA' | 'POLYGON_POS' | 'BASE' | 'ARBITRUM_ONE' | 'STELLAR' | 'INK' | 'XLAYER' | 'AVALANCHE' | 'DOGECOIN' | 'SUI' | 'ROBINHOOD' | 'BNB'

A CryptoNetwork is a blockchain transmitting cryptocurrencies.

crypto_tx_hashstring

For crypto transactions, the on-chain transaction hash.

crypto_tx_indexstring

For crypto transactions, the output index or output address.

account_idstring

The Paxos ID of the Account associated with the transfer.

group_idstring

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

fiat_account_idstring

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

notional_valuestring decimal

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

memostring

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

Example response

{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "ref_id": "idempotence_id",
  "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339",
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "amount": "0.10000000",
  "total": "0.10000023",
  "fee": "0.00000023",
  "asset": "BTC",
  "balance_asset": "BTC",
  "direction": "WITHDRAWAL",
  "type": "CRYPTO_WITHDRAWAL",
  "status": "COMPLETED",
  "created_at": "2020-01-17T18:36:08.737Z",
  "updated_at": "2020-01-17T18:37:08.737Z",
  "crypto_network": "BITCOIN",
  "crypto_tx_hash": "f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16",
  "crypto_tx_index": "0",
  "destination_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
  "notional_value": "1.02",
  "metadata": {
    "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
  }
}