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

Authenticate

Starts the authentication and linking process of the wallet with the customer. This API is used if the wallet was delinked earlier by the customer or you decided to skip authentication during wallet creation. The customer will get an OTP on his registered mobile number on successful completion of this step. This OTP will be used for linking the wallet - thereby enabling direct debit authorization.

  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.
Note: The Create, Authenticate, and Delink APIs will always return "false" for this parameter.
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:
A value for OTP should be returned also (not shown in main document), so it can be sent with Link API later for linking.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!