SI Registration Transaction API

post https://areionsbi.pc.enstage-sas.com/saleservice/api/v1/sale

The Sale API can be used for SI registration with action=SERVICE_POST_MPI_SI and other fields to collect the SI details.

📘
Note:
This API endpoint is same as Sale API, but with action=SERVICE_POST_MPI_SI and transactionTypeCode=0. For more information, refer to Sale using Visa Card API.

Endpoint


Production	https://pginstance/saleservice/api/v1/sale
Test	https://areionsbi.pc.enstage-sas.com/saleservice/api/v1/sale

Sample request

Response parameters

Parameter	M/O/C	Description	Example
transactionId	M	Unique value generated for each transaction internally by the PG	123456
status	M	Transaction Status	50020 = SUCCESS (any other value is a failure, full status codes shall be provided in appendix A)
pgErrorCode	M	PG Error Code	0 = No Error (any other value means some kind of error, full error codes list shall be provided in appendix B)
pgErrorDetail	M	PG Error detail	pg error detail was not set
orderDesc	M	Brief description of items purchased. Len: 0-50 chars	Apple iPOD 20GB
merchantReferenceNo	M	Merchant reference number	AX143565
approvalCode	C	Approval code of Transaction	560252
rrn	O	RRN no for reference	104013006601
creditDebitCardFlag	O	Flag to say whether its credit card or debit card	‘C’ – Credit card ‘D’ – Debit Card ‘P’ – Prepaid Card
ext1	O	Same value will be sent back as pg has received from merchant in the request.
ext2	O	Same value will be sent back as pg has received from merchant in the request.
ext3	O	Same value will be sent back as pg has received from merchant in the request.
ext4	O	Same value will be sent back as pg has received from merchant in the request.
ext5	O	Same value will be sent back as pg has received from merchant in the request.
ext6	O	Same value will be sent back as pg has received from merchant in the request.
ext7	O	Same value will be sent back as pg has received from merchant in the request

Sample response

Request parameters

Body Params

pgInstanceId

string

required

This field must contain the PG instance ID.

merchantId

string

required

This field must contain the merchant ID.

action

const

required

This field must contain the value as SERVICE_POST_MPI_SI for SI transaction.

transactionTypeCode

const

Defaults to 0

This field includes code of transaction types and This field includes code of transaction types and value is 0 for SI transaction.

currencyCode

string

required

This field includes the ISO Code for the currency of amount field. For INR this is 356. If not passed default currency would be used. Length: 3 characters.

acquiringBankId

string

required

This field must include PG acquiring Bank ID.

pan

string

required

This field must include the Visa/Master card number. All the digits as a continuous string without formatting ALT ID to be passed for domestic guest checkout transactions.

altIdFlag

string

required

This field is Mandatory for Domestic guest checkout transactions.

ext6

string

This is used to pass Stored Card Credential Indicator. 1 - First transaction of Recurring Payment – Registration (normal PAN and token PAN) 2 - Subsequent transaction (normal PAN and token PAN) 3 - When capturing a stored credential for the first time i.e., Storing PAN for the first time 4 - When initiating a transaction using an already stored credential 5 - If the token credential is getting stored for first time i.e., Post Successful Authorization, Token will be generated & stored. 6 - When initiating a Normal ecommerce transaction using an already Token stored credential 0/no value - Normal eCommerce transaction

cryptogram

string

This field must include Cryptogram value, which is received from Token Vault for only Tokenized transactions. Cryptogram is mandatory for Token transactions and ALT ID transactions. Cryptogram is optional for Subsequent recurring transactions.

expiryDateYYYY

string

required

This field includes a valid card expiry year in the format yyyy .ALT ID expiry to be passed for domestic guest checkout transactions.

expiryDateMM

string

required

This field includes a valid card expiry month in the format MM. ALT ID expiry to be passed for domestic guest checkout transactions

nameOnCard

string

required

This field is must contain the name on card.

string

This field is must contain the valid customer email ID.

amount

integer

required

This field must include purchase amount including the minor units of currency with all punctuation removed, i.e., implied decimals and no formatting.

merchantReferenceNo

string

required

This field must include merchant reference number

orderDesc

string

required

This field must include brief description of items purchased. Character Limit: 0-50 characters.

cvv2

string

This field must include the CVV printed at the back of the card.

mpiTransactionId

string

This field includes a Transaction ID from MPI. This is mandatory for Pre-auth & Sale and optional for recurring transactions

threeDsXid

string

This field includes a status from MPI. It is mandatory for Pre-auth & Sale and optional for recurring transactions.

threeDsEci

string

This field includes a ECI from MPI. It is mandatory for Pre-auth & Sale and optional for recurring transactions.

threeDsCavvAav

string

This field includes a CAVV or AVV from MPI. It is an encoded value. It is mandatory for Pre-auth & Sale and optional for recurring transactions.

threeDsStatus

string

This field includes status from MPI. It is mandatory for Pre-auth & Sale and optional for recurring transactions.

messageHash

string

installment

string

required

This field includes the maximum number of permitted authorizations for installment/recurring payments. This field must be > 1(if not empty).

installmentFrequency

string

This field includes the frequency for paying the installments and can be any of the following: 'DAILY','WEEKLY','FORTNIGH TLY',’MONTHLY','QUARTERLY', 'HALFYEARLY','YEARLY','ADH OC'

maxDebitAmount

string

This field includes the indicates the maximum amount which can be debited for each installment/recurring payments i.e., amount to be stored with implied decimals

siUniqueRefNum

string

This field includes the unique reference number used to uniquely identify SI registration and recurring payments

siValidated

string

required

This field includes whether the SI was validated.

customerDeviceId

string

This field includes the customer device ID Unique ID that identifies customer device used – IP or Mobile Number or MAC or IMEA

ext1

string

This field captures ctx id, which is unique for every transaction.

ext2

string

This field captures mtx id

ext3

string

For internal use only.

ext4

string

For internal use only.

ext5

string

Merchant can pass any additional data( specific to merchant) not included in the message hash.

ext7

string

This is used to pass DCC or MCP indicator, 1 – DCC indicator 2 – MCP indicator Null/no value – Normal ecommerce transaction

ext8

string

This field can be used to pass any additional data( specific to merchant) not included in the message hash

ext9

string

For internal purposes only.

ext10

string

For internal purposes only.

Headers

x-api-key

string

required

This parameter must contain the API key provided by Wibmo.

pgInstanceId

integer

required

This parameter must contain the PG instance ID.

mle-enabled

integer

required

This parameter must contain the message level encryption (MLE) keyId.

Response

200

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://areionsbi.pc.enstage-sas.com/saleservice/api/v1/sale \
3
     --header 'content-type: application/json' \
4
     --data '
5
{
6
  "transactionTypeCode": 0
7
}
8
'

Click Try It! to start a request and see the response here!

📘Note:

Endpoint

Request parameters

📘
Note: