v1
latestOpenAPI 3.0.02026-07-24270120.1 KBSale
API to create new order/sale
Request body
Merchant account ID, size- 12
Txn ref Number, size- 20
Transaction amount, size- 9 significant and 2 decimal point
Transaction Currency, size- 3
Possible values are 0, 1 Where 0 = Standard (Hosted Checkout) 1 = Direct (Merchant Checkout)
Email id of customer. In case Customer email ID is not available, send guest@jiopay.com, size- 48
Pass SALE, PREAUTH based on the preffered flow
Payment instrument restriction list CARD, NB, WALLET, UPI, Sodexo. Can be used to restrict the payment options. For payType = 1, this field should indicate the exact paymentMode For AADHAAR the payType has to be 1
To be used to specify providers where paymentMode is NB or WALLET
Call back url on which the response will be posted on payment success/rejection. If available in request, the same would be used for response else the preconfigured URL of the merchant would be used. In case the transaction involves OTP capture on merchant page then the return URL is not used. Size-64
Date of transaction. YYYYMMDDHHMISS
Card Number / token Number (in case of tokenized card). This will be Mandatory, If payType is ‘1’ and paymentMode is CARD, Size-19
Card expiration (YYYYMM). This will be Mandatory, If payType is ‘1’ and paymentMode is CARD
Name on Card. This will be Mandatory, If payType is ‘1’ and paymentMode is CARD, Size-45
Card Verification Value. This will be Mandatory, If payType is ‘1’ and paymentMode is CARD Optional in case token number is passed in cardNo field, Size-4
Cryptogram / TAVV received from TRG/TR for transacting using token number, Size-128
Token ReferenceID corresponding to the token number, Size-64
Y / N. Y – Indicates that the customer has opted to tokenize the card. Applicable only if the cardNo passed is an actual card no (Not applicable for token card No), Size-1
Y / N. Default is N. Y – The transaction is only for authentication. Save card indicator would also needs to be sent as Y for authOnly to work. This field is for supporting Rupay tokenization with Authentication (no authorization). Note: amount field is not required for authOnly transaction, Size-1
Y / N. Default is N. Y – Tokenize the card during the transaction. Auth only indicator would also need to be sent as Y for this to work.. This field is for supporting Rupay tokenization with Authentication (no authorization). Size-1
PAN reference Id of the card generated during the earlier tokenization call. "This will be used for authentication & tokenization. Either card number or panReferenceId should be present in the request. Auth Only indicator would also need to be Y for this to work." Size-64
If paymentMode is UPI then this field will be used to pass the payer’s UPI Alias (VPA), Size-45
Merchant Aggregator ID
Customer Name, size-45
Customer Mobile No, size-15
Merchant Invoice No, Size-32
This variable is for future use. Short description of the purchased items, size-45
Additional info 1, size-45
Additional info 2, size-45
Address line 1, size-45
Address line 2, size-45
City name, size-32
State code, size-32
Pin code of the location, size-12
Two digit country code, size-2
- WEB 2) MOBILE 3) IVR 4) POS
Terminal ID provided by acquirer, size-8
Size-12
ID of customer as identified by Merchant, size-48
Size-16
Size-12
GSTIN of the merchant. Required if gst details are passed by the merchant. Size-15
The GST amount calculated by the merchant
The CGST amount
The SGST amount
The IGST amount
CESS amount
GST Incentive
GST Percentage used.
Check the Secure Hash logic. Size-64
Response
Successful response
Response code indicating success/failure. R1000 – Request Initiated successfully Any other value indicates failure
Description of failure. Ignore for success response.
Merchant account ID
Merchant aggregator ID
Merchant Txn ref Number
Redirection URL. Will be available in case merchant is required to redirect to complete payment authorization. Either this field or showOTPCaptureP age field will be available in response.
generateOTP . Will be available when showOTPCaptureP age is ’Y’
verifyOTPURI, Will be available when showOTPCaptureP age is ’Y’
authorizeURL, Will be available when showOTPCaptureP age is ’Y’
Show OTP Page indicator, Y / N. Y – Merchant should display a page to ask for OTP. Please do contact integration team for OTP capture page requirements
The transaction context generated by the PG, Needs to be sent as is to the redirectURI / authorizeURI endpoint
Hash value
OTH charge