get https://api.juspay.in/customers//wallets#list
Wallets can be listed only in the context of a Customer. This API will return the list of wallets (in object format) which may or may not be linked. If a wallet is linked, a token is generated for it, and can be used immediately for a direct debit transaction. If a wallet is not linked, and a direct debit is enabled by the provider for your setup, you can activate the same for customers using the Authenticate and Link APIs.
Response Parameters for the List 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. (click to open table)
Wallet Object:
| Parameter | Type | Description |
|---|---|---|
| id | String | The ID of the wallet |
| object | String | "wallet_account" |
| wallet | String | Name of wallet |
| token | String | One time token used to debit from wallet (expires after ?? minutes) |
| current_balance | String | Wallet balance as of last balance update with the "Refresh Wallet API". |
| 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. Note: The Create, Authenticate, and Delink APIs will always return "false" for this parameter. |
| last_refreshed | String | Represents the date & time when the balance was updated last. |