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://sandbox.juspay.in/customers/{customer_id}/wallets
Production Link
POST
https://api.juspay.in/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==
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Path Params
customer_id
*
String
Mandatory
Customer Id
Example:- cust387465
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
wlt_q23xzki3pazgtezo
object
string
wallet_account
wallet
string
MOBIKWIK
token
null
current_balance
null
linked
boolean
last_refreshed
null
metadata.mobile_number
String
gateway_reference_id
String
400 : Invalid Input data
Response Body
object
object
{}
Have questions?
- Need help? Contact support
- LLM? Read llms.txt