GET
/
balance
Retrieve account balance
curl --request GET \
  --url https://api.notchpay.co/balance \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Balance retrieved",
  "balance": {
    "reserved": 1000,
    "total": 50000,
    "pending": 2000,
    "available": 47000,
    "currency": "XAF",
    "environment": "live"
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
currency
string
default:XAF

Currency code

Response

200
application/json

Balance retrieved

The response is of type object.