Listing payout currency pairs

GET /api/public/v1/payouts/currency_pairs

Returns all available payout currency pairs. Use this endpoint to discover which account currencies (displayCurrency) can fund a payout and which cryptocurrencies (payCurrency) can be sent, along with the networks available for each.

To construct a Create Payout request from the response:

1. Choose a pair — displayCurrency gives you the currency parameter, payCurrency gives you the cryptocurrency that will be sent.

2. Find the payCurrency entry in included and follow its networks references.

3. Find the matching network objects in included — the code is the payNetwork value to use.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Response Body

Name	Type	Description
data[].id	string	Currency pair ID.
data[].type	string	Always payoutCurrencyPairs.
data[].attributes.direction	string	Always buy — the platform buys the payCurrency on your behalf to send to the recipient.
data[].attributes.enabled	boolean	Whether this pair is currently available for payouts.
data[].relationships.displayCurrency.data.id	string	Currency code of the account to debit. Use as the currency parameter in Create Payout.
data[].relationships.payCurrency.data.id	string	Currency code of the cryptocurrency sent to the recipient.
data[].relationships.chargeCurrency	object	Deprecated. Use displayCurrency instead.
included[].type(currencies).attributes.code	string	Currency code.
included[].type(currencies).attributes.crypto	boolean	true for cryptocurrencies, false for fiat.
included[].type(currencies).attributes.symbol	string	Display symbol for the currency.
included[].type(currencies).attributes.subunitToUnit	number	Number of smallest units in one whole unit (e.g. 100000000 for BTC, 100 for EUR).
included[].type(currencies).relationships.networks	array	Network references for this currency. Resolve against network objects in included to get the payNetwork codes.
included[].type(network).attributes.code	string	Network code. Use as the payNetwork parameter in Create Payout.
included[].type(network).attributes.name	string	Human-readable network name.
included[].type(network).attributes.currencyCode	string	Currency code this network belongs to.

Response

HTTP 200

{
  "data": [
    {
      "id": "bbe5124a-5f43-4b7e-9d49-eb88d7a4537b",
      "type": "payoutCurrencyPairs",
      "attributes": {
        "direction": "buy",
        "enabled": true
      },
      "relationships": {
        "chargeCurrency": {
          "data": { "type": "currencies", "id": "EUR" },
          "meta": { "deprecated": true }
        },
        "displayCurrency": {
          "data": { "type": "currencies", "id": "EUR" }
        },
        "payCurrency": {
          "data": { "type": "currencies", "id": "USDT" }
        }
      }
    },
    {
      "id": "ad07045e-823c-4ab4-ad75-9d1df1f5a1dc",
      "type": "payoutCurrencyPairs",
      "attributes": {
        "direction": "buy",
        "enabled": true
      },
      "relationships": {
        "chargeCurrency": {
          "data": { "type": "currencies", "id": "EUR" },
          "meta": { "deprecated": true }
        },
        "displayCurrency": {
          "data": { "type": "currencies", "id": "EUR" }
        },
        "payCurrency": {
          "data": { "type": "currencies", "id": "BTC" }
        }
      }
    }
  ],
  "included": [
    {
      "id": "EUR",
      "type": "currencies",
      "attributes": {
        "code": "EUR",
        "crypto": false,
        "symbol": "€",
        "subunitToUnit": 100
      },
      "relationships": {
        "networks": { "data": [] }
      }
    },
    {
      "id": "USDT",
      "type": "currencies",
      "attributes": {
        "code": "USDT",
        "crypto": true,
        "symbol": "₮",
        "subunitToUnit": 1000000
      },
      "relationships": {
        "networks": {
          "data": [
            { "type": "network", "id": "2cfea86d-f334-4bd2-99ac-e74281520c95" },
            { "type": "network", "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2" },
            { "type": "network", "id": "490f02d4-b09a-4486-a469-d10c2ea43638" },
            { "type": "network", "id": "927d49d4-f4b2-48dc-876d-ac375337ec2a" },
            { "type": "network", "id": "4a1ec40b-8656-437c-ae79-4dd5435b53a5" }
          ]
        }
      }
    },
    {
      "id": "BTC",
      "type": "currencies",
      "attributes": {
        "code": "BTC",
        "crypto": true,
        "symbol": "฿",
        "subunitToUnit": 100000000
      },
      "relationships": {
        "networks": {
          "data": [
            { "type": "network", "id": "c0369c57-da08-4c60-b5ee-63e1e43d5ae4" }
          ]
        }
      }
    },
    {
      "id": "2cfea86d-f334-4bd2-99ac-e74281520c95",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Ethereum (ERC20)",
        "code": "hterc6dp"
      }
    },
    {
      "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Tron (TRC20)",
        "code": "ttrx:usdt"
      }
    },
    {
      "id": "490f02d4-b09a-4486-a469-d10c2ea43638",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Polygon (ERC20)",
        "code": "tpolygon:usdt"
      }
    },
    {
      "id": "927d49d4-f4b2-48dc-876d-ac375337ec2a",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Binance Smart Chain (BEP20)",
        "code": "tbsc:usdt"
      }
    },
    {
      "id": "4a1ec40b-8656-437c-ae79-4dd5435b53a5",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Solana",
        "code": "tsol:usdt"
      }
    },
    {
      "id": "c0369c57-da08-4c60-b5ee-63e1e43d5ae4",
      "type": "network",
      "attributes": {
        "currencyCode": "BTC",
        "name": "Bitcoin",
        "code": "tbtc"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}