Currencies API

The Currencies API allows you to retrieve information about all supported currencies in the system, including their supported trading pairs. This is useful for building currency selection dropdowns, validating currency codes, understanding exchange capabilities, and determining which currencies can be exchanged with each other.

List All Currencies

Retrieve a list of all available currencies with their supported trading pairs. Returns active currencies with metadata including currency code, name, active status, and supported currency pairs for exchange operations.

Endpoint

Client API Endpoint: GET /api/v1/client/currencies

Public Endpoint: GET /api/v1/currencies (no authentication required)

Note: The client API endpoint is recommended for business integrations as it provides consistent authentication and access control.

Authentication

Client API Endpoint requires HMAC authentication (Business API Key). Include your API key and signature in the request headers:

x-api-key: <your-api-key>
x-timestamp: <RFC3339-timestamp>
x-signature: <HMAC-signature>

Public Endpoint does not require authentication.

Note: For HMAC authentication details, see the Authentication guide.

Success Response (200 OK)

Returns an array of currency objects with supported trading pairs:

[
  {
    "code": "USD",
    "name": "US Dollar",
    "active": true,
    "supported_pairs": ["USD", "CAD", "EUR", "GBP", "NGN"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "code": "NGN",
    "name": "Nigerian Naira",
    "active": true,
    "supported_pairs": ["NGN", "CAD", "USD", "GBP", "EUR"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "code": "EUR",
    "name": "Euro",
    "active": true,
    "supported_pairs": ["EUR", "CAD", "USD", "GBP", "NGN"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "code": "GBP",
    "name": "British Pound",
    "active": false,
    "supported_pairs": ["GBP", "CAD", "USD", "EUR", "NGN"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:20:00Z"
  }
]

Response Fields

Field	Type	Description
`code`	string	Three-letter currency code (ISO 4217 standard, e.g., "USD", "EUR", "NGN")
`name`	string	Full name of the currency
`active`	boolean	Whether the currency is currently active and available for transactions
`supported_pairs`	array of strings	Array of currency codes that this currency can be exchanged with. Useful for validating exchange capabilities before creating quotes.
`created_at`	string (ISO 8601)	Timestamp when the currency was added to the system
`updated_at`	string (ISO 8601)	Timestamp when the currency was last updated

Error Responses

Status Code	Description
`401`	Unauthorized - Invalid or missing API key or signature
`500`	Internal server error

Example: cURL

# Client API endpoint (HMAC authentication required)
curl -X GET "https://api.sznd.app/api/v1/client/currencies" \
  -H "x-api-key: your_api_key_here" \
  -H "x-timestamp: 2025-01-30T12:20:15Z" \
  -H "x-signature: generated_signature_here"
 
# Public endpoint (no authentication required)
curl -X GET "https://api.sznd.app/api/v1/currencies"

Example: HTTP Request

GET /api/v1/client/currencies HTTP/1.1
Host: api.sznd.app
x-api-key: your_api_key_here
x-timestamp: 2025-01-30T12:20:15Z
x-signature: generated_signature_here
Content-Type: application/json

Use Cases

Currency Selection - Populate currency dropdowns in your application with active currencies
Exchange Validation - Validate which currencies can be exchanged with each other using the supported_pairs field
Display Names - Show user-friendly currency names instead of codes
Active Status Check - Filter out inactive currencies from user selections
Currency Lookup - Create lookup tables for currency code to name mapping
Exchange Capability - Determine if a currency pair is supported before creating exchange quotes

Best Practices

Cache Results - Currency lists don't change frequently, so cache the response
Filter Active Only - Only show active currencies to users in selection dropdowns
Store Currency Codes - Use ISO 4217 currency codes consistently throughout your application
Handle Inactive Currencies - If a previously active currency becomes inactive, handle it gracefully in your UI

Supported Currency Codes

Common currency codes include:

USD - US Dollar
EUR - Euro
GBP - British Pound
NGN - Nigerian Naira
CAD - Canadian Dollar
KES - Kenyan Shilling
GHS - Ghanaian Cedi
XOF - West African CFA franc (e.g., Republic of Benin, Côte d'Ivoire)
XAF - Central African CFA franc (e.g., Cameroon)
UGX - Ugandan Shilling
TZS - Tanzanian Shilling
SLE - Sierra Leonean Leone
ZAR - South African Rand

Note: The full list of supported currencies may vary. Always use the API to get the current list of available currencies.

Next Steps

Exchange Rates - Get current exchange rates between currencies
Virtual Wallets API - View virtual wallet balances for different currencies
Quotes API - Create quotes for currency conversions

💳 Cards 👤 Customers