Get Wallet Balances - Yala Payout APIs

Get wallet balances

curl --request GET \
  --url https://gateway.useyala.com/v1/payout-api/payouts/wallets \
  --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/wallets', 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/wallets",
  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/wallets"

	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/wallets")

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

{
  "data": [
    {
      "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "NGN",
      "balance": 123,
      "availableBalance": 123
    }
  ]
}

GET

payout-api

payouts

wallets

Get wallet balances

curl --request GET \
  --url https://gateway.useyala.com/v1/payout-api/payouts/wallets \
  --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/wallets', 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/wallets",
  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/wallets"

	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/wallets")

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

{
  "data": [
    {
      "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "NGN",
      "balance": 123,
      "availableBalance": 123
    }
  ]
}

Overview

Returns all business wallet balances for your account. Use this endpoint to:

Display available balances per currency before initiating payouts
See which source currencies you can pay out from (e.g. NGN, USD)
Check balance sufficiency before calling POST /quote or POST /initiate

Only business wallets are returned (one per currency your business holds).

Request

GET /v1/payout-api/payouts/wallets 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

{
  "data": [
    {
      "walletId": "550e8400-e29b-41d4-a716-446655440000",
      "currency": "NGN",
      "balance": 100000.5,
      "availableBalance": 100000.5
    },
    {
      "walletId": "660e8400-e29b-41d4-a716-446655440001",
      "currency": "USD",
      "balance": 5000.0,
      "availableBalance": 5000.0
    }
  ]
}

Response Fields

Field	Type	Description
`data`	array	List of wallet balance objects
`data[].walletId`	string (UUID)	Wallet identifier
`data[].currency`	string	Currency code (e.g. NGN, USD)
`data[].balance`	number	Current balance in that currency
`data[].availableBalance`	number	Available balance (same as balance for business wallets)

Error Responses

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/wallets', {
  method: 'GET',
  headers: {
    'x-api-key': 'your-api-key'
  }
});

const { data: wallets } = await response.json();
// Show balances per currency before user selects source currency for payout
wallets.forEach(w => {
  console.log(`${w.currency}: ${w.balance} (available: ${w.availableBalance})`);
});

Notes

Returns only business wallets (one per currency). Collection and suspense wallets are not included.
Use the returned currency and balance to validate sufficient funds before initiating a payout; debit always comes from the sourceCurrency wallet.
If you have no wallets, data is an empty array [].

Authorizations

x-api-key

string

header

required

Response

Wallet balances retrieved successfully

data

object[]

List of wallet balances for the tenant

Show child attributes

​Overview

​Request

​Headers

​Response

​Response Fields

​Error Responses

​401 Unauthorized

​Usage Example

​Notes

Authorizations

Response

Overview

Request

Headers

Response

Response Fields

Error Responses

401 Unauthorized

Usage Example

Notes