> ## Documentation Index > Fetch the complete documentation index at: https://docs.useyala.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Enabled Currency Pairs > Retrieve enabled currency pairs with current exchange rates for your business. ## Overview Returns all currency pairs that your business has enabled in the dashboard, along with current exchange rates. Use this endpoint to display available payout corridors to your users. ## Request ```http theme={null} GET /v1/payout-api/payouts/pairs HTTP/1.1 Host: gateway.staging.useyala.com x-api-key: ``` ### Headers | Header | Required | Description | | ----------- | -------- | ------------ | | `x-api-key` | Yes | Your API key | ## Response ```json theme={null} [ { "id": "123e4567-e89b-12d3-a456-426614174000", "code": "CNY/NGN", "baseCurrency": "CNY", "quoteCurrency": "NGN", "rate": 235.0 }, { "id": "223e4567-e89b-12d3-a456-426614174001", "code": "USD/NGN", "baseCurrency": "USD", "quoteCurrency": "NGN", "rate": 1625.64 } ] ``` ### Response Fields | Field | Type | Description | | --------------- | ------------- | ----------------------------------------------------------------------------------------------------------------- | | `id` | string (UUID) | Currency pair identifier | | `code` | string | Pair code (e.g., "CNY/NGN") | | `baseCurrency` | string | Base currency | | `quoteCurrency` | string | Quote currency | | `rate` | number | Exchange rate for converting baseCurrency to quoteCurrency (automatically selected based on conversion direction) | ## Error Responses ### 400 Bad Request - No Pairs Enabled ```json theme={null} { "statusCode": 400, "message": "No currency pairs enabled. Please enable currency pairs in your dashboard.", "error": "NO_CURRENCY_PAIRS_ENABLED" } ``` **Solution**: Enable currency pairs in your Yala dashboard before using the payout API. ### 401 Unauthorized ```json theme={null} { "statusCode": 401, "message": "Unauthorized" } ``` **Solution**: Verify your API key is correct. ## Usage Example ```javascript theme={null} const response = await fetch('https://gateway.staging.useyala.com/v1/payout-api/payouts/pairs', { method: 'GET', headers: { 'x-api-key': 'your-api-key' } }); const pairs = await response.json(); // Display pairs to your users for selection ``` ## Exchange Rate Behavior **Important:** Exchange rates are real-time and may change between API calls. * **Rates shown here are current at the time of request** - The rate displayed in the `rate` field reflects the exchange rate at the moment you call this endpoint * **Rates are not locked or guaranteed** - If you view rates via this endpoint and then call `POST /initiate` later, the rate may have changed * **Always check the actual rate used** - The `POST /initiate` response includes an `exchangeRate` field showing the rate that was actually applied to your payout * **Rate may differ** - The rate in the `/initiate` response may differ from what you saw in `/pairs` if rates changed between calls **Best Practice:** Display rates to users as "current rates" and inform them that the final rate will be confirmed in the payout response. ## Notes * Rates are real-time and may change between calls * Only pairs enabled in your dashboard are returned * The `rate` field is automatically selected based on conversion direction (you don't need to choose between buy/sell rates) ## OpenAPI ````yaml GET /v1/payout-api/payouts/pairs openapi: 3.0.3 info: title: Yala Payout APIs description: >- Yala Payout API documentation. This comprehensive API suite enables seamless integration with our financial services platform, providing secure and efficient access to cross-border payment solutions.
✨ Key Features - Real-time payment processing - Secure wallet management - Comprehensive exchange rate calculations - Robust transaction monitoring
💰 Payment Methods and Fees ## USD Payments | Destination | Method | Fees | Settlement Time | |------------|---------|------|-----------------| | United States | Wire | $20 | 1 day | | | ACH | $5.00 | 1 to 3 days | | China, Hong Kong | China wire/HK FPS | $20 | 24 to 72 hours | | Other Countries | Swift | $50 (<$2k)
$40 ($2k-$10k)
$0 (≥$10k) | 24 to 72 hours | ### EUR Payments | Destination | Method | Fees | Settlement Time | |------------|---------|------|-----------------| | EU Countries | SEPA | $5.00 | < 48 hrs | | Other Countries | Swift | $50 (<$2k)
$40 ($2k-$10k)
$0 (≥$10k) | 24 to 72 hours | ### GBP Payments | Destination | Method | Fees | Settlement Time | |------------|---------|------|-----------------| | United Kingdom | Faster Payments/BACS | $2.00 | < 24 hrs | | Other Countries | Swift | $50 (<$2k)
$40 ($2k-$10k)
$0 (≥$10k) | 24 to 72 hours | ### Other Currencies | Currency | Destination | Method | Fees | Settlement Time | |----------|------------|---------|------|-----------------| | NGN | Nigeria | NIP | N100 | < 24 hrs | | CNY | All countries | Swift | $50 (<$2k)
$40 ($2k-$10k)
$0 (≥$10k) | 24 to 72 hours | | HKD | Hong Kong | FPS | $20 | < 24 hrs | | Multiple* | Any Country | Swift | $50 (<$2k)
$40 ($2k-$10k)
$0 (≥$10k) | 24 to 72 hours | *Includes: GHS, XAF, ZAR, XOF, CAD, KES, UGX, INR
For additional support or integration assistance, please contact our developer support team. version: 1.0.0 termsOfService: https://useyala.com/ contact: name: API Support email: developers@useyala.com servers: - url: https://gateway.useyala.com description: Production server - url: https://gateway.staging.useyala.com description: Staging (Sandbox) server security: - ApiKeyAuth: [] tags: - name: Payouts description: Operations related to payouts - name: Countries description: Operations to fetch supported countries and currency information - name: Transactions description: Operations to fetch transaction history and details - name: Webhooks description: Register and manage webhook URLs for payout status notifications paths: /v1/payout-api/payouts/pairs: get: tags: - Payouts summary: Get enabled currency pairs description: Get enabled FX pairs with current rates for the authenticated business. operationId: getPairs responses: '200': description: Pairs fetched successfully '401': description: Unauthorized components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````