Listing invoice currency pairs

GET /api/public/v1/invoices/currency_pairs

Returns all available invoice currency pairs. Use this endpoint to discover which currencies (billedCurrency) can be used to denominate an invoice and which cryptocurrencies (chargedCurrency) the customer can pay with, along with the networks available for each.

To construct a Create Invoice request from the response:

1. Choose a pair — billedCurrency gives you the billedCurrency parameter, chargedCurrency gives you the chargedCurrency parameter.

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

3. Find the matching network objects in included — the code is the network 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 invoiceCurrencyPairs.
data[].attributes.direction	string	Always sell — the platform sells the chargedCurrency received from the customer and settles the invoice in billedCurrency.
data[].attributes.enabled	boolean	Whether this pair is currently available for invoices.
data[].relationships.billedCurrency.data.id	string	Currency code of the invoice denomination. Use as the billedCurrency parameter in Create Invoice.
data[].relationships.chargedCurrency.data.id	string	Currency code of the cryptocurrency the customer pays with. Use as the chargedCurrency parameter in Create Invoice.
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 network codes.
included[].type(network).attributes.code	string	Network code. Use as the network parameter in Create Invoice.
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": "b5871e76-9609-4a54-af18-b8979a2e663e",
      "type": "invoiceCurrencyPairs",
      "attributes": {
        "direction": "sell",
        "enabled": true
      },
      "relationships": {
        "billedCurrency": {
          "data": { "type": "currencies", "id": "EUR" }
        },
        "chargedCurrency": {
          "data": { "type": "currencies", "id": "USDT" }
        }
      }
    },
    {
      "id": "d7a631bd-dd67-4d5f-a8ef-d50e1a5bbfca",
      "type": "invoiceCurrencyPairs",
      "attributes": {
        "direction": "sell",
        "enabled": true
      },
      "relationships": {
        "billedCurrency": {
          "data": { "type": "currencies", "id": "EUR" }
        },
        "chargedCurrency": {
          "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"
  }
}