GET
/
v1
/
balance
Retrieve merchant account balance
curl --request GET \
  --url https://staging-vouchers.ventogram.com/api/v1/balance \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "currency": "<string>",
    "merchant": "<string>",
    "amount": 123,
    "txnCount": 123
  }
}

Authorizations

​
X-Api-User
string
header
required
​
X-Api-Key
string
header
required

Query Parameters

​
currency
enum<string>
required

One of supported currencies

Available options:
NGN,
USD

Response

200 - application/json

successful operation

The response is of type object.