Wallet

Get Wallet Balance

Retrieve the merchant's wallet balance across all supported currencies.

GET /v1/wallet/balance

Code Samples

const axios = require("axios");

const response = await axios.get(
  "https://sandbox.hitchpay.ng/v1/wallet/balance",
  {
    headers: {
      Authorization: `Bearer ${process.env.ACCESS_TOKEN}`
    }
  }
);

console.log(response.data);

<?php

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/wallet/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

url = "https://sandbox.hitchpay.ng/v1/wallet/balance"

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

Response

200 — Success

{
  "status": "success",
  "message": "Wallet balance retrieved successfully.",
  "data": {
    "balances": [
      {
        "currency": "NGN",
        "available_balance": 38646.97,
        "ledger_balance": 79975.00
      },
      {
        "currency": "USD",
        "available_balance": 2000.00,
        "ledger_balance": 0.00
      },
      {
        "currency": "KES",
        "available_balance": 15000.00,
        "ledger_balance": 15000.00
      },
      {
        "currency": "GHS",
        "available_balance": 500.00,
        "ledger_balance": 500.00
      }
    ]
  }
}

Field	Description
`available_balance`	Funds available for immediate use
`ledger_balance`	Total balance including pending settlements

Questions? Email [email protected]. Also on GitBook.