DevelopersPayoutCheck Balance

Check Balance

Retrieves the current balance for a payout virtual account.

GET{{base_url}}/request/company/get-user-account?accountId={accountNumber}

Example Request

GET https://staging-eagle.kongapay.com/request/company/get-user-account?accountId=1000572816

Required Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Query Parameters

Parameter	Required	Description
accountId	Yes	The payout virtual account number whose balance is being queried.

Sample Response

The endpoint returns the account details, including a balances array containing the available balance and other balance types.

Sample Response

{
  "id": "1000572816",
  "iban": null,
  "currency": 566,
  "userId": 56095,
  "ownerName": "Test Business",
  "name": "Test Business Account",
  "productId": "123",
  "type": "CURRENT",
  "status": "OPENED",
  "balances": [
    {
      "balanceType": "AvailableBalance",
      "value": 100000,
      "currency": "NGN",
      "display": "NGN 1,000.00"
    },
    {
      "balanceType": "SettlementPositionBalance",
      "value": 100000,
      "currency": "NGN",
      "display": "NGN 1,000.00"
    }
  ],
  "externalData": {}
}

Balance to Use

Use the balance object where balanceType is AvailableBalance.

Available Balance Object

{
  "balanceType": "AvailableBalance",
  "value": 100000,
  "currency": "NGN",
  "display": "NGN 1,000.00"
}

Balance Object Fields

Field	Description
balanceType	The type of balance returned. Use AvailableBalance for payout operations.
value	Balance amount in minor units (kobo).
currency	Currency code of the balance.
display	Human-readable formatted balance.

Notes

ℹ️

The AvailableBalance represents the amount currently available for payouts. The value field is returned in minor currency units (kobo), while display contains the formatted balance for display purposes.

Examples

Value	Equivalent Amount
100	NGN 1.00
1,000	NGN 10.00
100,000	NGN 1,000.00
250,500	NGN 2,505.00

💡

Always use the AvailableBalance object when determining the amount available for payout transactions.

← PreviousGet Transaction Status