Body
Check Balance
This api can be used to get the balance for a customer bank account. balance is sent in response only when gatewayResponseCode = "00".
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/accounts/balance
Headers
Content-Type
*
string
Required
application/json
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
integer
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-merchant-checksum
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch for the request
Constraints: 35 character alphanumeric. Should always start with merchant prefix provided.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Constraints: bankAccountUniqueId in the response of Fetch Accounts api call.
customerVpa
*
String
Mandatory
VPA of the customer linked to the account
credBlock
*
String
Mandatory
Encrypted credblock containing user mpin
Constraints:As returned by Common Library
clVersion
String
Optional
Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values:SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values:Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values:Refer error code section
payload
json
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
customerMobileNumber
*
String
Mandatory
Customer mobile number
Values:12 digits mobile number string
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Values:As passed in the request
bankCode
*
String
Mandatory
Bank code of the account which was used
Values:Valid bank IIN
customerVpa
*
String
Mandatory
Vpa of the customer linked to this account
Values:As passed in the request
maskedAccountNumber
*
String
Mandatory
Masked account number of the account which was used
Values:XXXX123456
balance
*
String
Mandatory
Balance of the bank account used
Values:1234.00
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values:SUCCESS, FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway
Response message for code returned by gateway
String
optional
Used amount out of the available credit limit in case of a CREDIT or OD account
udfParameters
json String
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt