Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Get

Get the wallet details. If the wallet is linked, a one-time use token is generated for it, which 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 link the wallet by using the Authenticate and Link APIs.

  Returns:   Wallet Object     (click to view)
   Provides details of a selected wallet of a customer:
ParameterTypeDescription
idStringThe unique identifier generated by Juspay for a particular wallet
objectStringMust be "wallet_account"
walletStringName of the Wallet Provider
tokenStringOne time token used to initiate a wallet transaction (expires after 15 minutes)
current_balanceStringThe balance available in the wallet as of the last refresh update. Available only for linked wallets.
linkedbooleanIf true, wallet is linked with the respective customer account.
Merchant can then use the given token to debit directly from the wallet.
last_refreshedStringRepresents the date & time when the balance was updated last.
metadata:wwwwwww
  {param1, param2,...}
ObjectCustom key-value sets can be passed here.
Example: {"mobile_number": "9999999999"}
gateway_reference_idStringUnique string identifier for the gateway supplying the wallet. Required in case of multiple MID setup
NOTE:  For linked wallets, the balance in the response may not be the current balance. The last_refreshed field represents the date & time when the balance was updated last. Use Refresh wallet API to update the balance for individual wallets. This results in a network call to the wallet provider and hence the response might be slow.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!