List Transfers

curl --request GET \
  --url https://api.paxos.com/v2/transfer/transfers \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "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"
      }
    }
  ],
  "next_page_cursor": "<string>"
}

Transfers

List Transfers

List all transfers, optionally filtering and paging the results.

By default, transfers are returned in reverse chronological (descending) order by creation time.

The recommended polling workflow is to query the results in ascending order (by setting order_by to CREATED_AT), keeping track of the created_at timestamp of the most recent transfer in the paged results. Once transfers are discovered, the caller should store the returned ID and query GetTransfer to retrieve status updates.

GET

transfer

transfers

List Transfers

curl --request GET \
  --url https://api.paxos.com/v2/transfer/transfers \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "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"
      }
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

transfer:read_transfer

Authorizations

Authorization

string

header

required

Query Parameters

profile_ids

string[]

identity_ids

string[]

ref_ids

string[]

created_at.lt

string<date-time>

created_at.lte

string<date-time>

created_at.eq

string<date-time>

created_at.gte

string<date-time>

created_at.gt

string<date-time>

updated_at.lt

string<date-time>

updated_at.lte

string<date-time>

updated_at.eq

string<date-time>

updated_at.gte

string<date-time>

updated_at.gt

string<date-time>

limit

integer

order

enum<string>

Available options:

DESC,

ASC

order_by

enum<string>

Available options:

CREATED_AT,

UPDATED_AT

page_cursor

string

account_ids

string[]

ids

string[]

type

enum<string>[]

Show child attributes

group_ids

string[]

crypto_tx_hashes

string[]

secondary_statuses

enum<string>[]

Show child attributes

statuses

enum<string>[]

Show child attributes

Response

200 - application/json

items

object[]

Show child attributes

next_page_cursor

string

Overview Get Transfer

⌘I

API Documentation

Deposits and Withdrawals

Identity

Profiles

Sandbox

Settlements

Orchestrations / Conversions

Taxes

Trading

Rewards

Events

API Credentials

Websockets

Webhooks

Problems

List Transfers

Authorizations

Query Parameters

Response