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

Real Time Payments

Create an order with payment transaction for Real-Time Payments. The response of this API includes a QRString and an authentication URL. Once the response is received, the QR code can be displayed to users based on your use case.

Handling QRString
qrstring from the response can be directly retrieved and embedded into your application for display.

Handling Authentication URL
If you prefer not to manage the QRString, the URL provided in the response can be loaded directly in a browser, where Juspay will handle the QR code display for the user.

The default timer value is set to 10 minutes and is configurable. If you need to adjust the timer value, please contact the Juspay team for assistance.
Logo update on the timer screen is feasible and can be easily managed through the Juspay Dashboard:
1. Log in to the Juspay Dashboard.
2. Navigate to "Payments" → "Settings" → "General"
3. Update the logo under the "Your Company Logo" section.

Supported Payment Methods:

Scroll inside to view more

payment_method	RTP
PAYNOW	PayNow
DUITNOW	Duitnow
PROMPTPAY	PromptPay
FPS_QR	FPS QR

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

Optional

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.

Body

                      order.order_id 
                      *
                      

string

Mandatory

order_id pertaining to the order for which the payment is started.

                      payment_method_type
                      *
                      

string

Mandatory

Must be RTP

                      payment_method
                      *
                      

string

Mandatory

The actual RTP payment method that was selected by the user.

                      redirect_after_payment
                      *
                      

string

Mandatory

This is a boolean variable and accepts true/false. We recommend that you set this to true and use the redirection flow. 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
                      *
                      

Json

Mandatory

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

                      sdk_params
                      
                      

Boolean

It accepts a Boolean value.
- Set sdk_params to true to retrieve both qrString and url.
- Set sdk_params to false to retrieve only authentication url in the response.

                      merchant_id
                      *
                      

String

Mandatory

ID of the merchant_account that you hold with us.
(Merchant ID provided by Juspay or Juspay's merchant id)

                      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.currency
                      *
                      

String

Mandatory

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

                      order.return_url
                      *
                      

String

Mandatory

A fully qualified URL which the customer will be redirected after payment completion. It is also required to provide the control back to SDK after the completion of transaction. This URL shouldn't contain any query parameters or Ip address. This URL takes higher precedence over the common return URL configured in your account settings.

Example:- https://shop.merchant.com

                      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

Mandatory

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

Example: 9999999912

                      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

                      sdk_params.tag
                      *
                      

String

Mandatory

Refers to the category of sdk_params fields

                      sdk_params.qrString
                      *
                      

String

Mandatory

Qrcode String generated for the input RTP method which can be direct used in your application

                      txn_uuid
                      *
                      

String

Mandatory

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of RTP transaction

Response Body

                      error_message
                      
                      

String

Provides the reason for the error

Example:- Response: Bad request.

                      status
                      
                      

String

Error status

Example:- Response:ERROR

                      error_code
                      
                      

String

Specifies the Error code

Example:- Sample Response:Bad request.

                      error_info
                      
                      

JSON

Additional information on the error message

                      user_message
                      
                      

String

Error message can be displayed to the user

Example:- Sample Response:Bad request.

                      fields
                      
                      

Array

Details on the missing field with which the error occurred

                      developer_message
                      
                      

String

Detailed info on the error

Example:- Sample Response:Failed while parsing your request.

                      category
                      
                      

String

category of the error

Example:- Sample Response: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 sending 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"}}
Not passing order id	400	{"error_message":"[order id] cannot be null","status":"invalid_request_error","error_code":"blank","error_info": {"user_message":"Cannot process your request. Please contact support team for assistance.","fields": [{"field_name":"order_id","reason":"Missing field."}],"developer_message":"Missing order id. Please pass order_id or order payload.","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}
Not passing merchant_id	400	{"error_message":"Bad request.","status":"ERROR","error_code":"Bad request.","error_info": {"user_message":"Bad request.","fields": [{"field_name":"merchant_id","reason":"Field required but not passed."}],"developer_message":"Failed while parsing your request.","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}
Passing MID as Empty	400	{"user_message":"Invalid merchant id. Cannot process your request.","error_message":"Invalid Request","error": true,"error_info": {"user_message":"Please pass valid merchant_id in request.","fields": [{"field_name":"merchant_id","reason":"Invalid merchant_id."}],"developer_message":"merchant_id is invalid.","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"}}
Passing invalid MID	400	{"user_message":"Invalid merchant id. Cannot process your request.","error_message":"Invalid Request","error": true,"error_info": {"user_message":"Please pass valid merchant_id in request.","fields": [{"field_name":"merchant_id","reason":"Invalid merchant_id."}],"developer_message":"merchant_id is invalid.","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"}}
Passing wrong endpoint	404	Response will be empty
Not passing gateway reference id but gateway configured with gateway reference ID on Juspay dashboard	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"}}
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"}}

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