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
currencyCodeandprotocolcombination is supported before you callPOST /api/payments/crypto-payout/execute.ORPOST /api/payments/crypto-payout/executeb2b
How it works
- Call
GET /api/crypto-currency-protocol-processorwith optional filters. - Read the returned
currencyCodeandprotocolpairs frompayload. - Use one supported pair when you call
POST /api/payments/crypto-payout/executeORPOST /api/payments/crypto-payout/executeb2b
Endpoint
| Field | Value |
|---|---|
| Method | GET |
| 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.
| Parameter | Type | Default | Description |
|---|---|---|---|
countryCode | String | None | Filter by crypto country code, for example IE or IN |
page | Integer | 0 | Page index, zero-based. |
size | Integer | 10 | Number 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.
| Field | Description |
|---|---|
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. |
countryCode | Display name of the country. |
page | Pagination metadata for the current response. |
Use the returned currencyCode and protocol values when you call POST /api/payments/crypto-payout/execute.
Updated 5 days ago
What’s Next
Did this page help you?