Get Enabled Currency Pairs - Yala Payout APIs

Get enabled currency pairs

curl --request GET \
  --url https://gateway.useyala.com/v1/payout-api/payouts/pairs \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://gateway.useyala.com/v1/payout-api/payouts/pairs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.useyala.com/v1/payout-api/payouts/pairs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.useyala.com/v1/payout-api/payouts/pairs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://gateway.useyala.com/v1/payout-api/payouts/pairs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

GET

payout-api

payouts

pairs

Get enabled currency pairs

curl --request GET \
  --url https://gateway.useyala.com/v1/payout-api/payouts/pairs \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://gateway.useyala.com/v1/payout-api/payouts/pairs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.useyala.com/v1/payout-api/payouts/pairs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.useyala.com/v1/payout-api/payouts/pairs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://gateway.useyala.com/v1/payout-api/payouts/pairs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

GET /v1/payout-api/payouts/pairs HTTP/1.1
Host: gateway.staging.useyala.com
x-api-key: <YOUR_API_KEY>

Headers

Header	Required	Description
`x-api-key`	Yes	Your API key

Response

[
  {
    "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

{
  "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

{
  "statusCode": 401,
  "message": "Unauthorized"
}

Solution: Verify your API key is correct.

Usage Example

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)

Authorizations

x-api-key

string

header

required

Response

Pairs fetched successfully

​Overview

​Request

​Headers

​Response

​Response Fields

​Error Responses

​400 Bad Request - No Pairs Enabled

​401 Unauthorized

​Usage Example

​Exchange Rate Behavior

​Notes

Authorizations

Response

Overview

Request

Headers

Response

Response Fields

Error Responses

400 Bad Request - No Pairs Enabled

401 Unauthorized

Usage Example

Exchange Rate Behavior

Notes