Get One Balance by Id

GET /api/payments/balance

Balance retrieval by id

Query Parameters

• balanceId int64 required

Header Parameters

• api-key string required
• api-secret string required

Responses

• 200
• 401
• 404

---

Balance information

*/*

Schema

Schema

• id int64 required

  Unique identifier of the balance.

• balanceName string required

  Balance name.

• balanceAmount double required

  Amount held for this balance.

• active boolean

Example (from schema)

{
  "id": 100121,
  "balanceName": "Jamal's KES balance",
  "balanceAmount": 12332.11,
  "active": true
}

API keys not valid

*/*

Schema

Schema

• detail string

  Detail of the message.

• status string

  Possible values: [SUCCESS, FAILED, API_KEYS_INVALID, INSUFFICIENT_FUNDS, NOT_FOUND, MALFORMED_URL, INTERNAL_ERROR, NOT_SUPPORTED, CURRENCY_NOT_SUPPORTED, MOBILE_MONEY_NOT_WHOLE_NUMBER, BALANCE_NOT_FOUND, BALANCE_NOT_AUTHORISED, BALANCE_NOT_NUMERIC, WEB_HOOK_NOT_SPECIFIED_FOR_OTP]

Example (from schema)

{
  "detail": "API key not valid or Insufficient funds",
  "status": "SUCCESS"
}

Balance not found

*/*

Schema

Schema

• detail string

  Detail of the message.

• status string

  Possible values: [SUCCESS, FAILED, API_KEYS_INVALID, INSUFFICIENT_FUNDS, NOT_FOUND, MALFORMED_URL, INTERNAL_ERROR, NOT_SUPPORTED, CURRENCY_NOT_SUPPORTED, MOBILE_MONEY_NOT_WHOLE_NUMBER, BALANCE_NOT_FOUND, BALANCE_NOT_AUTHORISED, BALANCE_NOT_NUMERIC, WEB_HOOK_NOT_SPECIFIED_FOR_OTP]

Example (from schema)

{
  "detail": "API key not valid or Insufficient funds",
  "status": "SUCCESS"
}

Loading...