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

Wallet Payment

Create a payment transaction for paying from a prepaid Wallet. Once you have the response, depending on the “method” attribute, you will have to take the next step. If you receive GET, then take the value in the “URL” attribute and redirect the user to this location. If you receive POST, then “params” attribute will hold a map containing key-value pairs.

For Web, you can create a form with these parameters as hidden variables and auto submit the form. Example code in Javascript: Serialize Parameters.

For Android, serialize this data such that it can be loaded to WebView directly via postData. Example code in Java: Serialize Parameters.

Scroll inside to view more

payment_method	Wallet name
ALIPAY	ALIPAY Wallet
APPLEPAY	APPLEPAY
GOOGLEPAY	Googlepay Wallet
GRABPAY	GRABPAY WALLET
WECHATPAY	WeChat Pay
ALIPAY	ALIPAY Wallet
GOPAY	GOPAY WALLET
GRABPAY	GRABPAY WALLET
GOOGLEWALLET	Google Wallet
APPLEPAY	APPLEPAY
ZALOPAY	ZaloPay Wallet
VNPAY	VNPAY Wallet
SHOPEEPAY	SHOPEEPAY WALLET
QR_SHOPEEPAY	SHOPEEPAY QR WALLET
QR_GOPAY	GOPAY QR WALLET
GOPAY	GOPAY WALLET
SHOPEEPAY_QR	Shopeepay QR
GOPAY_QR	GoPay QR
DANA	Dana Wallet
DANA_QR	Dana QR
LINKAJA	Linkaja Wallet
LINKAJA_QR	Linkaja QR
OVO_COLLECT	Ovo Collect
GOOGLEWALLET	Google Wallet
LAZADAPAY	LAZADAPAY
LINEPAY	LinePay
WECHATPAY	WeChat Pay
PAOTANGPAY	PAOTANGPAY
GOOGLEWALLET	Google Wallet
GRABPAY	GRABPAY WALLET
APPLEPAY	APPLEPAY
TRUEMONEY	TrueMoney
PAYPAL	PayPal
KBANK_CARD	KBANK Card
FIB	FIB
PAYME	PAYME wallet
STCPAY	StcPay wallet
MWALLET_QR	MWALLET QR wallet

HANDLING POST

When you get POST as the authentication method in the response, then the customer must be redirected using a form. Example HTML code is given to you. Depending on your client language, choose the appropriate way to create the form.

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 sending 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

Production Link

POST

https://api.juspay.in/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

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      version
                      
                      

string

Pass the date in YYYY-MM-DD format.
Note: If a version is provided, the response will include data corresponding to that specific version date.

It is recommended not to enforce strict validation on the entire response on the merchant's side to allow for future key additions.

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.(Merchant ID provided by Juspay or Juspay's merchant id)

                      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
                      *
                      

String

Mandatory

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.

Creating an order with a "0" amount is feasible. Please contact the Juspay team for internal enablement.

                      order.customer_id
                      *
                      

String

Mandatory

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

                      order.udf1
                      
                      

String

User Defined Functions (UDF). This field can be used to send any user defined parameters. The UDF parameters for orders can be seen in the JUSPAY dashboard under each order.
User Defined parameters can be passed in any of the 10 supported fields from udf1 to udf10.

                      order.metadata.JUSPAY:gateway_reference_id
                      
                      

String

conditional

You will have to mandatorily pass this reference id if you created a gateway with gateway reference id on Juspay's dashboard. For detailed information check here.

                      order.metadata.webhook_url
                      
                      

String

Merchant can pass dynamic webhook URL in this field. The webhook authentication would be same as the one configured on the dashboard. Ex: metadata.webhook_url=https://merchant.juspay/response

Response Body

                      order_id
                      
                      

string

Unique Identifier for the order which is passed in the api request

                      txn_id
                      
                      

string

Transaction ID for the order.

                      status
                      
                      

string

Refers to status of the order

                      payment
                      
                      

object

                      authentication.method
                      
                      

string

It provides the details about the type of authentication method. It can be either GET or POST

                      authentication.url
                      
                      

String

User can be directed to the targeted payment method page by loading the URL in the browser

                      authentication.params
                      
                      

Object

Only when you have POST as the authentication method

                      key1
                      
                      

String

Using the key value pair, form must be created and direct the user appropriately.

Response Body

                      user_message
                      
                      

String

Error message can be displayed to the user

Example:- Invalid merchant id. Cannot process your request.

                      error_message
                      
                      

String

Provides the reason for the error

Example:- Invalid Request

                      error
                      
                      

Boolean

Denotes whether error is present or not

Example:- true

                      error_info
                      
                      

JSON

Additional information on the error message

                      user_message
                      
                      

String

Error message can be displayed to the user

Example:- Please pass valid merchant_id in request.

                      fields
                      
                      

Array

Details on the missing field with which the error occurred

                      developer_message
                      
                      

String

Detailed info on the error

Example:- merchant_id is invalid.

                      category
                      
                      

String

category of the error

Example:- USER_ERROR

Error Codes:

Scroll inside to view more

Scenario	Error Codes	Sample Error Message
Not passing the currency value	400	{"error_message":"Bad Request.","status":"Bad Request","error_code":"INVALID_REQUEST","error_info":{"user_message":"Invalid input data","fields":[{"field_name":"currency","reason":"Missing field or Invalid Value"}],"developer_message":"Invalid input data","code":"INVALID_INPUT","category":"USER_ERROR"}}
Not passing the amount value	400	{"error_message":"Bad Request.","status":"Bad Request","error_code":"INVALID_REQUEST","error_info":{"user_message":"Invalid input data","fields":[{"field_name":"amount","reason":"Missing field or Invalid Value"}],"developer_message":"Invalid input data","code":"INVALID_INPUT","category":"USER_ERROR"}
Passing the amount in negative Integer	400	{"error_message":"Bad Request.","status":"Bad Request","error_code":"INVALID_REQUEST","error_info":{"user_message":"Invalid input data","fields":[{"field_name":"amount","reason":"Invalid amount"}],"developer_message":"Invalid input data","code":"INVALID_INPUT","category":"USER_ERROR"}}
Passing the amount in Positive Integer	400	{"error_message":"BadRequest.","status":"Bad Request","error_code":"INVALID_REQUEST","error_info":{"user_message":"Invalid input data","fields":[{"field_name":"amount","reason":"Missing field or Invalid Value"}],"developer_message":"Invalid input data","code":"INVALID_INPUT","category":"USER_ERROR"}}
Not passing the customer_email	400	{"status":"error","error_code":"invalid_request","error_info":{"user_message":"Invalid customer Email","fields":[{"field_name":"customerEmail","reason":"Invalid value."}],"developer_message":"customerEmail shouldn't have any special chars","code":"INVALID_INPUT","category":"USER_ERROR"}}
Not passing the orderId	400	{"error_message":"order_id is missing","status":"Bad Request","error_code":"order_id is missing","error_info":{"user_message":"Please pass order_id in request","fields":[{"field_name":"order_id","reason":"Missing field."}],"developer_message":"order_id is missing in request","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}
Not passing API key	403	{"error":true,"error_message":"Forbidden.No valid API key or client auth token is present in Authorization header or client_auth_token query parameter","user_message":"Access Denied.Unable to proceed.","userMessage":"Access Denied.Unable to proceed.","error_info":{"code":"UNAUTHORIZED","category":"USER_ERROR","user_message":"AccessDenied","developer_message":"No valid API key or client auth token is present in Authorization header or client_auth_token query parameter"}}
Invalid API key	401	{"status":"error","error_code":"access_denied","error_info":{"user_message":"Unauthorized.","developer_message":"Invalid API Key.Please pass a valid and active apikey.","code":"UNAUTHORIZED","category":"USER_ERROR"}}
Whitelisting of IP in dashboard	403	{"error":true,"error_message":"Internal Server error.","user_message":"Bad Origin.","error_info":{"code":"BAD_ORIGIN","category":"USER_ERROR","user_message":"Bad Origin.","developer_message":"IP Verification Failed"}}
Passing amount as 0(without Juspay internal enablement)	400	{"error_message":"Bad Request.","status":"ERROR","error_code":"INVALID_REQUEST","error_info":{"user_message":"Invalid input data","fields":[{"field_name":"amount","reason":"Invalid amount"}],"developer_message":"Invalid input data","code":"INVALID_INPUT","category":"USER_ERROR"}}'
Passing a non configured currency	400	{"error_message":"Can't find a suitable gateway to process the transaction","status":"Bad Request","error_code":"invalid_request_error","error_info":{"user_message":"Gateway not found to process the transaction request.","developer_message":"No functional gateways after filtering for currency THB","code":"GATEWAY_NOT_FOUND","category":"CONFIG_ERROR"}}
Not passing payment method	400	{"error_message":"Payment method type cannot be null","status":"invalid_request_error","error_code":"missing_payment_method_type","error_info":{"user_message":"Please pass payment method type in the request.","fields":[{"field_name":"payment_method_type","reason":"Missing field."}],"developer_message":"Missing payment method type in the request. Payment method type is a mandatory parametere.","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}
Not passing payment method type	400	{"error_message":"Payment method cannot be null","status":"invalid_request_error","error_code":"missing_payment_method","error_info":{"user_message":"Cannot process your request. Please contact support team for assistance.","fields":[{"field_name":"payment_method","reason":"Missing field."}],"developer_message":"Missing payment method. Payment method is required for provided payment method type.","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}