Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Deposit Addresses

Create Deposit Address

Create a deposit address on a blockchain network for depositing to a profile.

Important for Stellar Network (PYUSD):

When creating a deposit address for PYUSD on the Stellar network:

  • Paxos automatically handles all necessary setup including trustline establishment
  • The deposit address is immediately ready to receive PYUSD tokens
  • No additional configuration is required by the user
  • The PYUSD issuer address on Stellar mainnet is: GDQE7IXJ4HUHV6RQHIUPRJSEZE4DRS5WY577O2FY6YQ5LVWZ7JZTU2V5
  • The PYUSD asset code is: PYUSD
post/transfer/deposit-addresses

Request body

profile_idstring required

The target profile for deposit crediting.

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.

identity_idstring

The Paxos Identity associated with this deposit address.

ref_idstring

Client-specified ID for replay protection and lookup.

metadataobject

Optional client-specified metadata, which will be added to both the deposit address itself and transfers to the created address. 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 Paxos Account associated with this deposit address.

conversion_target_asset'NO_CONVERSION' | 'USD'

Asset to credit for deposits of Paxos-minted USD stablecoin.

Example request

{
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "crypto_network": "ETHEREUM",
  "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264",
  "ref_id": "deposit_address_0",
  "metadata": {
    "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
  }
}

Response

A successful response.

idstring required

The UUID of the deposit address.

profile_idstring required

The ID of the profile that will be credited when a deposit arrives with this address.

customer_idstring required

The Paxos Customer to which the profile belongs.

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.

identity_idstring

The Identity of the end user who will make deposits to this address.

ref_idstring

Client-specified ID for replay protection and lookup.

metadataobject

Optional client-specified metadata, which is set on deposit address creation. Up to 6 key/value pairs may be returned. Each key and value must be less than or equal to 100 characters.

addressstring required

The crypto address to send to for deposits.

account_idstring

The Account associated to the identity of the user that will be linked to the created address.

conversion_target_asset'NO_CONVERSION' | 'USD' required

Asset to credit for deposits of Paxos-minted USD stablecoin.

compatible_crypto_networksCryptoNetwork[]

List of networks compatible with the created address. Any of these networks can be used to deposit to the address.

created_atstring date-time required

The time at which this address was created.

Example response

{
  "id": "34bd61ed-cf0a-4012-8be4-d347667b6154",
  "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339",
  "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264",
  "ref_id": "deposit_address_0",
  "crypto_network": "ETHEREUM",
  "address": "0x89205A3A3b2A69De6Dbf7f01ED13B2108B2c43e7",
  "conversion_target_asset": "USD",
  "compatible_crypto_networks": [
    "ETHEREUM"
  ],
  "metadata": {
    "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
  },
  "created_at": "2020-01-17T18:36:08.737Z"
}