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.

Flow directive: If opting for direct debit flow: along with direct_wallet_token, customer_id is necessary to be passed (ideally in the Create Order API)

Wallet APIs : Link

Payments API :

Note: This is an authenticated call unlike other transaction APIs. This API must be invoked from your server directly. DO NOT send the API Key to client.

Scroll inside to view more

payment_method	Bank
GOPAY	GoPay Wallet
DANA	Dana Wallet
SHOPEE	Shopee Wallet
GRABPAY	GrabPay Wallet

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://api.sandbox.juspay.io/txns

Production Link

POST

https://api.juspay.io/txns

                      Basic Auth
                      *
                      

Base64 Encoded username:password

required

Consists of two parts.

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

Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      *
                      

string

required

Merchant ID provided by Juspay

Example:-
merchant-id

                      version
                      
                      

string

Pass the date in YYYY-MM-DD format

Example:-
2023-01-01

                      Content-Type
                      
                      

String

application/x-www-form-urlencoded

Body

                      order.order_id
                      *
                      

string

Required

Unique Identifier for the order. Should be Alphanumeric with character length less than 21.

                      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, the values will be shared by Juspay team.

                      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.

                      order.amount
                      *
                      

Double

Required

Amount that the customer has to pay. Will accept stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.

                      order.customer_id
                      
                      

String

It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
In case of guest login it should be an empty string.

Example:- customer-id-007

                      order.customer_email
                      
                      

String

Email address of the customer. If the backend gateway requires it, then you must send this value.

Example:- test@gmail.com

                      order.customer_phone
                      
                      

String

Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must send this value.

Example:- 9999999912

                      order.currency
                      
                      

String

ISO string of the currency. Accepted values are EUR, USD, GBP,HKD. Default value: INR

Response Body

                      order_id
                      *
                      

string

Required

order_id

                      txn_id
                      *
                      

string

Required

txn_id

                      status
                      *
                      

string

Required

Example : CHARGED

                      payment
                      *
                      

object

Required

                      authentication.method
                      *
                      

String

Required

                      authentication.url
                      *
                      

String

Required

Response Body

                      status
                      
                      

string

error

                      error_message
                      
                      

string

Order timed out

                      error_code
                      
                      

string

invalid_request

Have questions?
Need help? Contact support
LLM? Read llms.txt