JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Topup Wallet

Topup wallet API can be used to add money to the customer wallet. This API is applicable only for linked wallets.

Currently, the supported options for wallet Topup API only includes Paytm, AmazonPay, Freecharge Wallet

In the case of other wallets we support Direct Debit Wallet Direct Debit API that efficiently manages both the top-up and wallet debit.

Both Topup and Wallet Direct Debit APIs is supported by Paytm, AmazonPay, and Freecharge wallets.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/wallets/{wallet_id}

Production Link

POST

https://api.juspay.in/wallets/{wallet_id}/topup

                      Basic Auth
                      *
                      

String

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      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.

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

                      wallet_id
                      *
                      

String

Mandatory

Wallet Id of the wallet

Body

                      amount
                      *
                      

number

Required

Amount that has to be added to the wallet

                      topup_txn_id
                      *
                      

string

Required

Merchant transaction id for topup request

                      return_url
                      
                      

string

A fully qualified URL such as https://shop.merchant.com/ to which the customer will be redirected after payment completion. This URL shouldn’t contain any query parameters. This URL takes higher precedence over the common return URL configured in your account settings.

Response Body

                      topup_txn_id
                      
                      

string

topup_sdj4kjr8

                      wallet_id
                      
                      

string

wlt_q23xzki3pazgtezo

                      status
                      
                      

string

PENDING

                      payment_url
                      
                      

string

https://api.juspay.in/wallets/topup/start/wtpup_g6kasufbfsre1ntb