Get account balance

GET

/api/global/accounts/{vendor_id}/balance

curl -X GET "https://api.payhero.africa/api/global/accounts/{vendor_id}/balance" \
  -u "API_USERNAME:API_PASSWORD"

<?php
$ch = curl_init("https://api.payhero.africa/api/global/accounts/{vendor_id}/balance");
$options = [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "API_USERNAME:API_PASSWORD",
];
curl_setopt_array($ch, $options);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

const auth = Buffer.from("API_USERNAME:API_PASSWORD").toString("base64");

const response = await fetch("https://api.payhero.africa/api/global/accounts/{vendor_id}/balance", {
  method: "GET",
  headers: {
    Authorization: `Basic ${auth}`,
  },
});

const data = await response.json();
console.log(data);

Retrieve the available balance for an account.

Authorizations

basicAuth

Parameters

Path Parameters

vendor_id

required

integer

Example

Your vendor ID.

Responses

200

Account balance retrieved.

401

Missing or invalid Basic auth credentials.

application/json

object

error_code

string

error_message

string

status_code

integer

Example

{
  "error_code": "invalid_argument",
  "error_message": "the transaction amount is insufficient as it wont cater for cost: (4.62)",
  "status_code": 400
}