Sale

API to create new order/sale

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Merchant account ID, size- 12

string
required

Txn ref Number, size- 20

string
required

Transaction amount, size- 9 significant and 2 decimal point

string
required
Defaults to 356

Transaction Currency, size- 3

string
required
Defaults to 1

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

string
required
Defaults to [email protected]

Email id of customer. In case Customer email ID is not available, send [email protected], size- 48

string
required
Defaults to SALE

Pass SALE, PREAUTH based on the preffered flow

string

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

string

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

string
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

string
required

Date of transaction. YYYYMMDDHHMISS

string

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

string

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

string

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

string

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

string

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

string

Token ReferenceID corresponding to the token number, Size-64

string

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

string

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

string

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

string

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

string

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

string

Merchant Aggregator ID

string

Customer Name, size-45

string

Customer Mobile No, size-15

string

Merchant Invoice No, Size-32

string

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

string

Additional info 1, size-45

string

Additional info 2, size-45

string

Address line 1, size-45

string

Address line 2, size-45

string

City name, size-32

string

State code, size-32

string

Pin code of the location, size-12

string

Two digit country code, size-2

string
  1. WEB 2) MOBILE 3) IVR 4) POS
string

Terminal ID provided by acquirer, size-8

string

Size-12

string

ID of customer as identified by Merchant, size-48

string

Size-16

string

Size-12

string

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

string

The GST amount calculated by the merchant

string

The CGST amount

string

The SGST amount

string

The IGST amount

string

CESS amount

string

GST Incentive

string

GST Percentage used.

string
required

Check the Secure Hash logic. Size-64

string
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json