v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Sale

API to create new order/sale

post/tsp/pg/api/v2/initiateSale

Request body

merchantIdstring required

Merchant account ID, size- 12

merchantTxnNostring required

Txn ref Number, size- 20

amountstring required

Transaction amount, size- 9 significant and 2 decimal point

currencyCodestring required

Transaction Currency, size- 3

payTypestring required

Possible values are 0, 1 Where 0 = Standard (Hosted Checkout) 1 = Direct (Merchant Checkout)

customerEmailIDstring required

Email id of customer. In case Customer email ID is not available, send guest@jiopay.com, size- 48

transactionTypestring required

Pass SALE, PREAUTH based on the preffered flow

paymentModestring

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

paymentOptionCodesstring

To be used to specify providers where paymentMode is NB or WALLET

returnURLstring required

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

txnDatestring required

Date of transaction. YYYYMMDDHHMISS

cardNostring

Card Number / token Number (in case of tokenized card). This will be Mandatory, If payType is ‘1’ and paymentMode is CARD, Size-19

cardExpirystring

Card expiration (YYYYMM). This will be Mandatory, If payType is ‘1’ and paymentMode is CARD

nameOnCardstring

Name on Card. This will be Mandatory, If payType is ‘1’ and paymentMode is CARD, Size-45

cvvstring

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

tokenCryptogramstring

Cryptogram / TAVV received from TRG/TR for transacting using token number, Size-128

tokenRefIdstring

Token ReferenceID corresponding to the token number, Size-64

saveCardIndicatorstring

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

authOnlyIndicatorstring

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

tokenizeOnAuthstring

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

panReferenceIdstring

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

customerUPIAliasstring

If paymentMode is UPI then this field will be used to pass the payer’s UPI Alias (VPA), Size-45

aggregatorIDstring

Merchant Aggregator ID

customerNamestring

Customer Name, size-45

customerMobileNostring

Customer Mobile No, size-15

invoiceNostring

Merchant Invoice No, Size-32

orderDescstring

This variable is for future use. Short description of the purchased items, size-45

addlParam1string

Additional info 1, size-45

addlParam2string

Additional info 2, size-45

addline1string

Address line 1, size-45

addline2string

Address line 2, size-45

citynamestring

City name, size-32

statestring

State code, size-32

zipCodestring

Pin code of the location, size-12

countrystring

Two digit country code, size-2

txnChannelstring
  1. WEB 2) MOBILE 3) IVR 4) POS
terminalIDstring

Terminal ID provided by acquirer, size-8

settlementProdCodestring

Size-12

customerIDstring

ID of customer as identified by Merchant, size-48

accountNostring

Size-16

accountIFSCstring

Size-12

gstInstring

GSTIN of the merchant. Required if gst details are passed by the merchant. Size-15

gststring

The GST amount calculated by the merchant

cgststring

The CGST amount

sgststring

The SGST amount

igststring

The IGST amount

cessstring

CESS amount

gstIncentivestring

GST Incentive

gstPercentagestring

GST Percentage used.

secureHashstring required

Check the Secure Hash logic. Size-64

Response

Successful response

responseCodestring

Response code indicating success/failure. R1000 – Request Initiated successfully Any other value indicates failure

responseDescriptionstring

Description of failure. Ignore for success response.

merchantIdstring

Merchant account ID

aggregatorIDstring

Merchant aggregator ID

merchantTxnNostring

Merchant Txn ref Number

redirectURIstring

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.

generateOTPURIstring

generateOTP . Will be available when showOTPCaptureP age is ’Y’

verifyOTPURIstring

verifyOTPURI, Will be available when showOTPCaptureP age is ’Y’

authorizeURIstring

authorizeURL, Will be available when showOTPCaptureP age is ’Y’

showOTPCapturePagestring

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

tranCtxstring

The transaction context generated by the PG, Needs to be sent as is to the redirectURI / authorizeURI endpoint

secureHashstring

Hash value

oth_chargenumber

OTH charge

All 27 operations