Crypto currency — protocol pairs (catalog)

List enabled crypto currency and protocol pairs before you create a PAYC crypto payout.

Use this read-only catalog to:

Populate currency and protocol dropdowns.
Pre-validate payout inputs before submission.
Confirm that a currencyCode and protocol combination is supported before you call POST /api/payments/crypto-payout/.

How it works

Call GET /api/crypto-currency-protocol-maps with optional filters.
Read the returned currencyCode and protocol pairs from payload.
Use one supported pair when you call POST /payments/crypto-payout/.

Endpoint

Field	Value
Method	`GET`
Path	`/api/crypto-currency-protocol-maps`

📘
Prepend your environment’s context path or gateway prefix if your deployment does not mount the API at /api.

Query parameters

All query parameters are optional. You can combine currencyCode and currencyName in the same request.

Parameter	Type	Default	Description
`currencyCode`	String	None	Filter by crypto currency code, for example `USDT` or `USDC`.
`currencyName`	String	None	Filter by display name, for example `Tether USD`.
`page`	Integer	`0`	Page index, zero-based.
`size`	Integer	`10`	Number of records to return per page.

If a filtered lookup matches no configured pairs, the API responds with HTTP 404 and error code CRYPTO_CURRENCY_NOT_SUPPORTED. This is the same behavior as requesting a currency that does not exist.

Example requests

  GET /api/crypto-currency-protocol-maps?page=0&size=20
  Authorization: Bearer …

Example response: success

Paginated results use the standard success envelope. payload contains the current page of maps, and page contains pagination metadata.

{
  "payload": [
    {
      "id": { "id": "…encrypted-entity-id…" },
      "currencyName": "Tether USD",
      "currencyCode": "USDT",
      "protocol": "TRC20",
      "disabled": false
    },
    {
      "id": { "id": "…encrypted-entity-id…" },
      "currencyName": "Tether USD",
      "currencyCode": "USDT",
      "protocol": "ERC20",
      "disabled": false
    }
  ],
  "page": {
    "size": 10,
    "page": 0,
    "total": 2
  }
}

Each item in payload represents one supported currencyCode and protocol pair.

Field	Description
`id.id`	Encrypted entity identifier for the mapping.
`currencyName`	Display name of the crypto currency.
`currencyCode`	Crypto currency code to use in the payout request.
`protocol`	Blockchain protocol to use in the payout request.
`disabled`	Indicates whether the pair is disabled. Successful catalog responses return enabled pairs.
`page`	Pagination metadata for the current response.

Use the returned currencyCode and protocol values when you call POST /api/payments/crypto-payout/.

Example response: no matching currency

When the filters yield no supported mapping, the API returns HTTP 404.

{
  "errors": [
    {
      "errorCode": "CRYPTO_CURRENCY_NOT_SUPPORTED"
    }
  ]
}

How it works

Endpoint

Query parameters

Example requests

Example response: success

Example response: no matching currency

What’s Next