88mids

Balance API

Balance API information

FieldData Description
Request methodGET
Balance Request URLhttps://<url-provided>/api/v1/external/balance/status?currency={currency}&method={method}
Data format:All data is sent and received in the JSON format.
Content-Type:application/json
Headers:‘apikey’: <value-provided-by-admin>

Balance API Request Fields

Merchant must provide currency and method.

currencyCurrency. Example: INR, BDT.
methodPayment method. Example: BANK_TRANSFER, UPI.

Balance API Response Fields

balanceTotal aggregated balance in currency units, not minor units, as a number: 100032 is 100,032, not 1,000.32.

Balance API Response Sample

{
  "balance": 100032
}

On this page