Skip to main content
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 '
{
  "profile_id": "<string>",
  "destination_address": "<string>",
  "asset": "<string>",
  "ref_id": "<string>",
  "identity_id": "<string>",
  "account_id": "<string>",
  "balance_asset": "<string>",
  "amount": "<string>",
  "total": "<string>",
  "fee_id": "<string>",
  "memo": "<string>",
  "metadata": {},
  "beneficiary": {
    "self": true
  }
}
'
{
  "id": "<string>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://paxos-0ac97319-travel-rule-api-enhancements.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

OAuth Scope
transfer:write_crypto_withdrawal

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
profile_id
string
required
destination_address
string
required
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,
STELLAR,
INK,
XLAYER
asset
string
required
ref_id
string

Client-specified idempotency ID. Retries must reuse the same ref_id.

identity_id
string

The identity of the end user making the withdrawal. Required in 3P flows so Paxos can resolve the associated CryptoDestinationAddress and its Travel Rule metadata.

account_id
string
balance_asset
string
amount
string

The amount to withdraw. Specify exactly one of amount or total.

Pattern: ^[0-9]*\.?[0-9]+$
total
string

Total amount to withdraw, including fees. Specify exactly one of amount or total.

Pattern: ^[0-9]*\.?[0-9]+$
fee_id
string
memo
string
metadata
object
beneficiary
object

Deprecated. Persist Travel Rule metadata on the destination address via PutCryptoDestinationAddress instead. Retained for backwards compatibility; inline beneficiary data is not recommended for new integrations.

Response

The created withdrawal.

id
string
status
string