GETGet Settlement Account Balance

Fetch the settlement-account (wallet) balance for a user.

GET/user/account/balance

Returns the current settlement-account balance for the given registered mobile number.

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`customer_id_type`	string	required	Identifier type. Fixed value: mobile_number.e.g. mobile_number
`customer_id`	string	required	Registered mobile number for the wallet.e.g. 9910028267

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

customer_id_typestringRequired

Identifier type. Fixed value: mobile_number.

example: mobile_number

customer_idstringRequired

Registered mobile number for the wallet.

example: 9910028267

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- balancestring
  Settlement-account balance (INR).
- currencystring
  Currency.
- customer_idstring
  Registered mobile number (echoed back).