Skip to main content

Balance inquiry

About 2 min

India region balance inquiry API (INR).

Request

POST/v2.0/inquiry-balance

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-balance
production: https://gateway.smilepayz.com/v2.0/inquiry-balance

Header Parameters

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringSignature of JSON body (see product Signature doc).
X-PARTNER-IDMStringYour merchantID

Body Parameters

FieldRequiredTypeDescription
accountNoMString(128)Merchant settlement account for this currency (Pay-in or Pay-out).
balanceTypesMList(String)e.g. ["BALANCE"]; types to return.

accountNo

  • Sandbox: any non-empty string (≤128). You can reuse the sample value in the example body below.
  • Production: Merchant Portal → Finance → Balance. Each currency has separate Pay-in / Pay-out numbers — send the one you want to query. See How to get production accountNo.

Example Body – Balance Inquiry Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+05:30
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

Responses

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 success, other values error.
messageMStringUTF-8 human-readable result line.
accountInfosMObjectbalanceType, amount, availableBalance.
    balanceTypeMStringe.g. BALANCE.
    amountMObjectMoney object (currency + amount). Decimal places: Money
        currencyMStringFixed to INR.
        valueMStringBalance as string (e.g. "250000").
    availableBalanceMObjectAvailable balance; same shape as amount.
        currencyMStringFixed to INR.
        valueMStringAvailable as string.
accountNoMStringEcho of the request accountNo.
balanceTypesOListBalance types returned.
nameOStringAccount display name when returned.

Example Body – Balance Inquiry Response:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+05:30