Query Balance

This interface empowers you to review your account balance directly within your business operating system, providing the necessary financial insights to inform your subsequent actions and decisions. You can use this endpoint to check your total balance or any branch account balance under your management.

Query Account Balance

URL: https://payapi.opayweb.com/openApi/merchant/queryMerchantBalance

Request Parameters

ParameterTypeRequiredDescription
opayMerchantIdStringYesYour Business ID or Branch ID

POST
{
  "opayMerchantId":"256621072768092"
}
1
2
3

Response

ParameterTypeRequiredDescription
opayMerchantIdStringYesYour Business ID or Branch ID
opayMerchantNameStringYesYour business name
usableAmountStringYesAvailable balance of the OPay account, in Kobo
currencyStringYesCurrency: NGN
opayAccountNoStringYesOPay account
queryTimeStringYesTime of query (Nigerian time, format: yyyy-MM-dd HH:mm:ss)

POST
{
  "opayMerchantId": "256621072768092",
  "opayMerchantName": "MERCHANT name",
  "usableAmount": "1000000",
  "currency": "NGN",
  "opayAccountNo": "6126390625",
  "queryTime": "2022-09-29 08:47:55"
}
1
2
3
4
5
6
7
8
Last Updated: 11/7/2024, 3:43:34 AM