get https://sandbox.juspay.in/customers//wallets/refresh-balances
The API can be used to fetch the list of all the wallets created against a customer and also provides the balances (wherever applicable).
Response Parameters for the Refresh All Wallets API: (click to open table)
Parameter | Type | Description |
---|---|---|
object | String | "list" |
list: [{...},{...},..] | Array | An array of Wallet Objects (see table below) |
total | Int | Total wallets set against customer_id |
offset | Int | Offset from start (default is 0) |
count | Int | Count of wallet objects to be included in response Default is same as total |
The elements returned in the list array are Wallet Objects, that provide details of each wallet of a customer:
Parameter | Type | Description |
---|---|---|
id | String | The unique identifier generated by Juspay for a particular wallet |
object | String | Must be "wallet_account" |
wallet | String | Name of the Wallet Provider |
juspay_bank_code | String | The bank code provided by Juspay. |
token | String | One time token used to initiate a wallet transaction (expires after 15 minutes) |
current_balance | String | The balance available in the wallet as of the last refresh update. Available only for linked wallets. |
linked | boolean | If true, wallet is linked with the respective customer account. Merchant can then use the given token to debit directly from the wallet. |
last_refreshed | String | Represents the date & time when the balance was updated last. |
metadata:wwwwwww {param1, param2,...} | Object | Custom key-value sets can be passed here. In this case, the mobile_number currently associated with the wallet is passed.Example: {"mobile_number": "9999999999"} |
gateway_reference_id | String | Unique string identifier for the gateway against which the wallet is created. Required in case of multiple MID setup. |
⭣
The request consists of customer_id, and other parameters, as listed below:
Note: version and Content-Type should be listed as Optional.