Body
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.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/wallets/{wallet_id}
Production Link
POST
https://api.juspay.io/wallets/{wallet_id}
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Parameters
command
*
string
Required
Send it as authenticate if you want to start the authentication/linking process.
gateway_reference_id
string
Required in case of multiple MID setup
client_auth_token
string
Required for client side authentication
200 : Success
Response Body
id
*
string
Required
Unique identifier for the wallet account
Example : wlt_q23xzki3pazgtezo
object
*
string
Required
wallet_account
wallet
*
string
Required
Payment gateway provider (e.g., PAYTM, AMAZONPAY, MOBIKWIK)
token
null
Authentication token for the linked wallet (null if unlinked)
current_balance
null
Current available balance in the wallet (null if unlinked or unavailable)
linked
*
boolean
Required
Boolean indicating if the wallet is successfully linked to the gateway
last_refreshed
String
Timestamp of when the wallet balance was last refreshed
gateway_reference_id
String
Reference ID provided by the payment gateway
metadata
Object
Additional wallet-specific data including mobile number and device ID
mobile_number
String
device_id
String
sub_details
String
payment_method_type
String
payment_method
String
current_balance
String
last_refreshed
String
400 : Invalid Input data
Response Body
status
String
error_code
String
error_info
object
Have questions?
- Need help? Contact support
- LLM? Read llms.txt