Standard Checkout API Specifications


Introduction

We created a complete and detailed description of the Standard Workflow. Here you can find all parameter descriptions.


Hosts

  • Test:
  • Live:

Security / Authentication

All requests must be sent over SSL (Secure Socket Layer).

The memberId and checksum are in need to authenticate every request against a particular terminal. And the POST parameters are used to send the authentication data.


Testing

For testing purpose you can use below card/account details:


Test Card Details

Brand Number CVV Expiry Date
VISA 4000000000000051 745 Add Any Future Date
MASTER 5101082187256503
5101080000000009
123 Add Any Future Date
AMEX 375510513169537
378282246310005
123 Add Any Future Date

Test 3D Card Details

Brand Number CVV Expiry Date
VISA 4000000000000002 237 Add Any Future Date

Test Bank Accounts (SEPA)

Country IBAN BIC
Germany (DE) DE09100100101234567893 PBNKDEFFXXX


Payment Parameters

This reference lists all the Standard flow parameters to be send in request.

Parameter Description Format Required
memberId Merchant’s unique ID – assigned by .
Required to authenticate a transaction's request.
N10
[0-9]
Yes
totype Merchant's Partner name.
Required to authenticate a transaction's request
AN30
[a-zA-Z0-9]
Yes
amount Amount of the transaction. The dot needs to add to separate the decimal N11
[0-9]{1,8}\.[0-9]{2}
Yes
TMPL_AMOUNT Customized amount of customer, template amount can be same as transaction amount, Accept only [0-9] and ‘.’ (Single point) N11
[0-9]{1,8}\.[0-9]{2}
No
currency Currency of the transaction. AN3
[a-zA-Z0-9]{3}
Conditional
TMPL_CURRENCY Currency of the customized amount to facilitate customer, template currency can be same as transaction currency, Accept only 3 character currency code in capital letters. AN3
[a-zA-Z0-9]{3}
No
merchantTransactionId This reference number is provided by the merchant, should be unique for the transactions and is visible on the end customer’s statement. AN100
[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,100}
Yes
checksum Cryptographic hash generated by MD5 as follows.
All the processes has different combination of
parameters to generate hash (all values
separated by pipe). Kindly refer sample
given in tutorial for each case
AN32
[a-zA-Z0-9]
Yes
merchantRedirectUrl Redirect url where the customer to be redirected after processing. Redirect URL provided in request will redirect customer on merchant's website. AN100
[a-zA-Z0-9.:/]
Yes
notificationUrl URL to which the transaction details are posted once our server notified. If left blank, no transaction details are sent AN100
[a-zA-Z0-9.:/]
Yes
orderDescription Description of the Order. AN255
[\p{L}\P{M}\p{M}\n\ra-zA-Z0-9:\\!@#$%^&{}\[\]()_+\-=,*.~'` ]
No
ip Merchant’s IP Address. N46
(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
No
firstName Customer’s first name. AN255
[a-zA-Z0-9]
No
lastName Customer’s last name. AN255
[a-zA-Z0-9]
No
dateOfBirth Customer’s birth date. Birth date should be in YYYYmmDD format. N8
[0-9]
No
country Customer’s Country Code (ISO). AN3
[a-zA-Z0-9]{2,3}
No
city City of the customer's shipping address. A30
[a-zA-Z0-9\\\\#&\\p{Space}\\p{L}\\p{M}\\-;.,~` ]{0,30}
No
state State or region of the customer's shipping address. A30
[\\ra-zA-Z0-9\\\\!@#$*%^&{}\\[\\]()_+\\p{L}\\p{M}\\-=,.~'` ]{0,30}
No
postcode Postal code/ Zip code of the customer's shipping address. AN10
[A-Za-z0-9]{1,10}
No
street Building name, and/or street name of the customer's shipping address. A100
[a-zA-Z0-9\\p{Space}\\,]+
No
phone Phone number of the customer. N15
[0-9\+-. ]{6,25}
No
telnocc Country code of the customer. N4
[0-9\+-. ]{1,4}
No
email Email address of the customer. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
No
terminalid Merchant’s terminal ID provided by N6
[0-9]{1,4}
Conditional
paymentMode Payment method for paying amount.
For ex: CC for Credit Cards
AN10
[a-zA-Z0-9] {1,10}
Conditional
paymentBrand Type of Card while placing the transaction.
For ex: VISA, MASTER
AN10
[a-zA-Z0-9] {1,10}
Conditional
customerId Customer ID in merchant's system. AN20
[a-zA-Z0-9]{1,20}
Conditional
customerBankId Customer ID in bank's system. AN20
[a-zA-Z0-9]{1,20}
Conditional
lang Language of payment page (By default it will be English).
For e.g. ja - Japanese, en-us - English
A3
[a-zA-Z]{2,3}
No



Response Parameters

Parameter Description Format Required
paymentId/trackingid Unique transactionId sent by . N10
[0-9]
Yes
registrationId/token Unique token sent by . AN255
[a-zA-Z0-9]
Conditional
(If tokenization feature is allowed)
merchantTransactionId/desc Unique id sent at the time of transaction. AN100
[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,100}
Yes
amount Amount of the transaction N10
[0-9]{1,7}\.[0-9]{2}
Yes
checksum Response checksum for security
the combination of checksum is "paymentId|merchantTransactionId|amount|status|key"
AN32
[a-zA-Z]{1,32}
Yes
descriptor DisplayName of the merchant AN30
[a-zA-Z0-9]{1,20}
No
currency Currency of the transaction A3
[a-zA-Z\\p{Space}\\,]+
Conditional
status Status of the transaction processed. Possible values are,
‘Y’ – Successfully processed
‘N’ – Failed
‘P’ – Pending
‘3D’ – Pending for 3D authentication
‘C’ – Cancelled
AN2
[Y|N|P|3D|C]
Yes
resultCode Unique response code for successful or failed transaction.See the Response codes for more detailed information. N10
[0-9]
Yes
resultDescription Response description of the response code. AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Yes
cardBin First six digits of the card number N6
[0-9]{6}
No
cardLast4Digits Last four digits of the card number N4
[0-9]{4}
No
bankAccountBIC The BIC (Bank Identifier Code) of the merchant's bank account AN11
[a-zA-Z0-9]{8}|[a-zA-Z0-9]{11}
Conditional
bankIBAN The IBAN number of the merchant's bank account AN11
[a-zA-Z0-9]{8}|[a-zA-Z0-9]{11}
Conditional
bankAccountNumber The account number of the merchant's bank account N10
[0-9]{10}
Conditional
bankRoutingNumer The routing number of the merchant's bank account N9
[0-9]{9}
Conditional
bankAccountType The account type of the merchant's bank account A2
(PC|PS|CC)
Conditional
tmpl_amount Customized amount of customer, template amount can be same as transaction amount N10
[0-9]{1,7}\.[0-9]{2}
No
tmpl_currency Currency of the customized amount to facilitate customer, template currency can be same as transaction currency, Accept only 3 character currency code in capital letters. A3
[a-zA-Z]{3}
No
paymentMode Payment method for paying amount.
For ex: CC for Credit Cards
AN10
[a-zA-Z0-9] {1,10}
Conditional
paymentBrand Type of Card being used by Customer for the payment AN10
[a-zA-Z0-9] {1,10}
Conditional
custEmail Email address of the customer. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Conditional
custBankId Customer ID in bank's system. AN20
[a-zA-Z0-9]{1,20}
Conditional
custMerchantId Customer ID in merchant’s system. AN15
[a-zA-Z0-9]{1,15}
Conditional
eci eci is the two or three digit code that is returned by the credit card processing networks and issuing banks.For VISA eci code is (05,06,07)and for MasterCard eci code is(01,02). N3
[0-9]
Optional
firstName First name of the cardholder. AN20
[A-Za-z0-9]
Optional
lastName Last name of the cardholder. AN20
[A-Za-z0-9]
Optional
timestamp Shows at what time the transaction has been placed. date
yyyy-MM-dd hh:mm:ss
Yes
mandateid MandateID for the Merchant's Bank Account AN40
[A-Za-z0-9]{1,40}
Conditional


ECI values(Electronic Commerce Indicator) For VISA CARD

ECI value Description
05 Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful
06 Either cardholder or card issuing bank is not 3D enrolled. 3D card authentication is unsuccessful,
in sample situations as:
1. 3D cardholder not enrolled
2. Card issuing bank is not 3D Secure ready
07 Authentication is unsuccessful or not attempted. The credit card is either a non-3D card or card issuing bank does not handle it as a 3D transaction


ECI values(Electronic Commerce Indicator) For MASTER CARD

ECI value Description
00 Authentication is unsuccessful or not attempted. The credit card is either a non-3D card or card issuing bank does not handle it as a 3D transaction
01 Either cardholder or card issuing bank is not 3D enrolled. 3D card authentication is unsuccessful,
in sample situations as:
1. 3D Cardholder not enrolled
2. Card issuing bank is not 3D Secure ready
02 Both cardholder and card issuing bank are 3D enabled. 3D card authentication is successful
Copyright © . All Rights Reserved