OVA Balance

Query the live balance of your OVA (Partner Wallet) at any time. Use this endpoint before initiating large disbursements to confirm sufficient funds, or to surface your wallet balance in an internal dashboard.

POST https://testxchange.korba365.com/api/v1.0/get_ova_balance/

Overview

The OVA Balance endpoint returns the current available balance for the Partner Wallet associated with your client_id. The balance is expressed in Ghanaian Cedi (GHS) as a floating-point number rounded to two decimal places.

This is a lightweight, read-only call — it does not initiate any transaction or alter your wallet state. It is safe to call frequently; however, for high-frequency polling scenarios consider caching the result for a short interval rather than querying on every page load.

Pre-disbursement balance check. Always verify your OVA balance before initiating disbursements at scale. Transactions that fail due to insufficient funds after partial processing may require manual reconciliation. A proactive balance check prevents unexpected failures mid-batch.

Request Body

Only your client_id is required. No additional parameters are needed.

Parameter	Type	Required	Description
client_id	string	Mandatory	Your unique client identifier, available from the dashboard under API/Website Creds.

Request Example

import hmac, hashlib, requests

secret_key = "YOUR_SECRET_KEY"
client_key = "YOUR_CLIENT_KEY"

payload = {
    "client_id": "YOUR_CLIENT_ID",
}

message = "&".join(f"{k}={v}" for k, v in sorted(payload.items()))
signature = hmac.new(secret_key.encode(), message.encode(), hashlib.sha256).hexdigest()

response = requests.post(
    "https://testxchange.korba365.com/api/v1.0/get_ova_balance/",
    json=payload,
    headers={"Authorization": f"HMAC {client_key}:{signature}"},
)
print(response.json())

const crypto = require('crypto');
const axios  = require('axios');

const secretKey = 'YOUR_SECRET_KEY';
const clientKey = 'YOUR_CLIENT_KEY';

const payload = {
  client_id: 'YOUR_CLIENT_ID',
};

const message = Object.keys(payload).sort().map(k => `${k}=${payload[k]}`).join('&');
const signature = crypto.createHmac('sha256', secretKey).update(message).digest('hex');

axios.post('https://testxchange.korba365.com/api/v1.0/get_ova_balance/', payload, {
  headers: { 'Authorization': `HMAC ${clientKey}:${signature}` },
}).then(r => console.log(r.data));

curl -X POST \
  -H "Authorization: HMAC YOUR_CLIENT_KEY:YOUR_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{"client_id": "YOUR_CLIENT_ID"}' \
  https://testxchange.korba365.com/api/v1.0/get_ova_balance/

$secretKey = 'YOUR_SECRET_KEY';
$clientKey = 'YOUR_CLIENT_KEY';

$payload = [
    'client_id' => 'YOUR_CLIENT_ID',
];

// 1. Sort keys ascending, build message string
ksort($payload);
$parts = [];
foreach ($payload as $k => $v) {
    $parts[] = "$k=$v";
}
$message = implode('&', $parts);

// 2. Compute HMAC-SHA256 and hex-encode
$signature = hash_hmac('sha256', $message, $secretKey);

// 3. Send the authenticated request
$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL            => 'https://testxchange.korba365.com/api/v1.0/get_ova_balance/',
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode($payload),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        "Authorization: HMAC $clientKey:$signature",
        "Content-Type: application/json",
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));

Response

A successful request returns HTTP 200 with the current OVA balance. The ova_balance field is a floating-point number representing Ghanaian Cedi. An ova_balance of 0 means the wallet is empty; top up via your dashboard before initiating disbursements.

200 OK Success

{
  "success":     true,
  "ova_balance": 1480.5
}

Previous SMS Next Transactions