Account Balance API

LIVE
Endpoint

Send a GET request to the endpoint below. No query parameters or request body is required.

Production URL
https://pairgate.com/api/v1/wallet/balance
Method GET
Headers

Include the following headers with your request. The Authorization header is mandatory.

Header Value Description
Authorization
Bearer {token}
Your unique API authorization token
Cache-Control
no-cache
Ensures you always get the latest balance
Code Examples

Choose your preferred language below. Each example includes the required headers and endpoint URL. Remember to replace YOUR_API_KEY with your actual API key.

PHP (Laravel)
// Check Wallet Balance
$response = Http::withHeaders([
    'Authorization' => 'Bearer YOUR_API_KEY',
    'Cache-Control' => 'no-cache',
])->get('https://pairgate.com/api/v1/wallet/balance');

$result = $response->json();

dd($result);
cURL
curl -X GET "https://pairgate.com/api/v1/wallet/balance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Cache-Control: no-cache"
Node.js
const axios = require('axios');

const checkBalance = async () => {
    try {
        const response = await axios.get(
            'https://pairgate.com/api/v1/wallet/balance',
            {
                headers: {
                    'Authorization': 'Bearer YOUR_API_KEY',
                    'Cache-Control': 'no-cache'
                }
            }
        );
        
        console.log(response.data);
    } catch (error) {
        console.error(error.response?.data || error.message);
    }
};

checkBalance();
Python
import requests

url = "https://pairgate.com/api/v1/wallet/balance"

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Cache-Control": "no-cache"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://pairgate.com/api/v1/wallet/balance"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .header("Cache-Control", "no-cache")
    .GET()
    .build();

try {
    HttpResponse response = client.send(request, 
        HttpResponse.BodyHandlers.ofString());
    
    System.out.println(response.body());
} catch (Exception e) {
    System.err.println("Error: " + e.getMessage());
}
Response Format

A successful request returns a 200 status with your current balance details.

Success Response
{
  "code": 200,
  "status": "success",
  "data": {
    "balance": 1500.00,
    "currency": "NGN",
    "retrieved_at": "2026-06-19T12:00:00+01:00"
  }
}
Error Response
{
  "code": 401,
  "status": "error",
  "message": "Invalid API key"
}
Error Responses

The following errors may occur when calling this endpoint.

Status Code Description
401 Missing API key No Bearer token provided
401 Invalid API key Token does not match any active key
403 Suspended API key or account has been suspended
429 Rate limited Too many requests