Body
Create Wallet
Wallet account can be created only for an existing customer. Please use POST /customers API to create customer objects as needed.
Creating the wallet with command=authenticate parameter will trigger an OTP which will be used for linking the wallet thereby enabling direct debit authorization. You also have the option of deferring the authentication to a later point of time by omitting the command=authenticate parameter. In case you decide to defer it, Please use the authenticate
and link API to authenticate and link the wallet.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/customers/{customer_id}/wallets
Production Link
POST
https://api.juspay.io/customers/{customer_id}/wallets
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
gateway
*
string
Required
Name of the gateway supplying the wallet.
command
string
Send it as authenticate if you want to start the authentication/linking process as soon as the wallet gets created.
mobile_number
string
Mobile number against which wallet has to be linked. The param can be used if the customer wants to link a different number than the one registered at merchant.
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 for the wallet (e.g., PAYTM, AMAZONPAY)
token
null
Authentication token for accessing wallet operations (present when wallet is linked)
current_balance
null
Current available balance in the wallet (present when wallet is linked)
linked
*
boolean
Required
Boolean indicating whether the wallet is successfully linked and ready for transactions
last_refreshed
null
Timestamp of the last balance refresh operation (null if never refreshed)
metadata
Object
Additional wallet information including mobile number and device ID
mobile_number
String
device_id
String
gateway_reference_id
String
Reference identifier provided by the payment gateway (may be null)
sub_details
array of objects
Array of subscription details for wallet payment methods
400 : Invalid Input data
Response Body
error_message
String
status
String
error_code
String
error_info
String
Have questions?
- Need help? Contact support
- LLM? Read llms.txt