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

Wallet Direct Debit

Directly debit the amount from a Wallet that is linked to a Customer’s account. If the status in the response is CHARGED, then the payment is immediatley successful. If the status in the response is PENDING, then the user wallet doesn’t have sufficient balance for the payment and the topup URL is returned in the response.

Wallet Direct Debit transaction API calls are authenticated, unlike other transaction API calls. This API must be invoked directly from your server. DO NOT send the API key to the client.
In case you are calling the transaction API from the client side, kindly include client_auth_token in the API request. Please note that client_auth_token can be fetched from the Create Customer API, Get Customer API or Create Order API.

HANDLING GET

When you get GET as the authentication method in the response, you may load the URL directly into the customer’s browser. You can easily achieve this by send HTTP 302 from your server. However, if the API call was made from the browser, then you can utilize the code snippet provided.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/txns

Production Link

POST

https://api.juspay.in/txns

                      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

Body

                      order_id
                      *
                      

string

Required

order\_id pertaining to the order for which the payment is started.

                      merchant_id
                      *
                      

string

Required

ID of the merchant_account that you hold with us.

                      direct_wallet_token
                      *
                      

string

Required

Juspay wallet token for linked wallets. This is available in the /customers/:id/wallets API or /wallets/:id API.

                      payment_method_type
                      *
                      

string

Required

Must be WALLET

                      payment_method
                      *
                      

string

Required

The actual payment method that was selected by the user. For WALLET transactions, it must be one of the supported wallets from the table.

                      redirect_after_payment
                      *
                      

string

Required

This is a boolean variable and accepts true/false. We recommend that you set this to true. If set to true, then the user is redirected to the return\_url configured for the order. If set to false, then the user will be stopped at the response page from the gateway. Your client should be able to read the page/title to infer that the user has completed the transaction.

                      format
                      *
                      

string

Required

If it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.

Response Body

                      order_id
                      
                      

string

:order_id

                      txn_id
                      
                      

string

:txn_id

                      status
                      
                      

string

CHARGED

                      payment
                      
                      

object

                      authentication.method
                      
                      

String

                      authentication.url
                      
                      

String

Response Body

                      status
                      
                      

string

error

                      error_message
                      
                      

string

Order timed out

                      error_code
                      
                      

string

invalid_request