Skip to content
Authorization<token>

Use a public key (pk./pk_test.) for payment initialization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment — there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

currency?string | null

Must be 3 characters.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/balance" \  -H "Content-Type: application/json" \  -d '{}'
GET
/balance
{
  "code": 200,
  "status": "OK",
  "message": "Balance retrieved",
  "balance": {
    "total": 1325000,
    "available": 1250000,
    "pending": 75000,
    "reserved": 0,
    "credit": 0,
    "currency": "XAF",
    "environment": "live"
  }
}
{
  "code": 401,
  "status": "Unauthorized",
  "message": "Invalid API credentials"
}
{
  "code": 406,
  "status": "Not Acceptable",
  "message": "Private Key Required"
}
{
  "code": 429,
  "status": "Too Many Requests"
}