Crypto currency — protocol pairs (catalog)

List supported crypto currency and protocol pairs before calling PAYC crypto payouts.

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/execute. OR POST /api/payments/crypto-payout/executeb2b

How it works

  1. Call GET /api/crypto-currency-protocol-processor with optional filters.
  2. Read the returned currencyCode and protocol pairs from payload.
  3. Use one supported pair when you call POST /api/payments/crypto-payout/execute OR POST /api/payments/crypto-payout/executeb2b

Endpoint

FieldValue
MethodGET
Path/api/crypto-currency-protocol-processor
📘

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


Query parameters

Provide with a country as input, returns all stablecoins available for the specified country.

ParameterTypeDefaultDescription
countryCodeStringNoneFilter by crypto country code, for example IE or IN
pageInteger0Page index, zero-based.
sizeInteger10Number of records to return per page.

Example requests

Example response: success

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

{
  "payload": [
    {
      "currencyCode": "USDT",
      "currencyName": "Tether USD",
      "protocol": "TRC20",
      "countryCode": "IE"
    }
  ],
  "page": {
    "size": 50,
    "page": 0,
    "total": 1
  }
}

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

FieldDescription
currencyNameDisplay name of the crypto currency.
currencyCodeCrypto currency code to use in the payout request.
protocolBlockchain protocol to use in the payout request.
countryCodeDisplay name of the country.
pagePagination metadata for the current response.

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



What’s Next

Did this page help you?