An action corresponds to the combination of a payment mechanism and a command. The concept of an action is used within the documentation and examples as a means of describing functionality. The Enterprise API and iVeri Gateway use the concepts payment mechanism and command instead of Action.
The iVeri Gateway allows for the following actions:
Authorisation with PAN
Reserve
funds when a card is not present.
This
action is commonly known as a "Pre-Auth/Pre-Authorisation"
Authorisation with Track2
Reserve
funds when a card is present. Funds reservation is not applicable for cards requiring
a PIN.
This action is commonly known
as a "Pre-Auth/Pre-Authorisation"
Authorisation with
VisaCheckoutCallID
Reserve
funds when a card is present. Funds reservation is not applicable for cards
requiring a P
Merchants are required to enter into a “agreement” with an authorized acquiring institution. Once there is a merchant agreement in place, a merchant profile can be created. With Enterprise calls to the Gateway, the presence of a certificate ID is required in the body of the request. While the inclusion of the AuthenticationToken and AuthenticationKey in the headers is optional. Test Mode should be used during integration, testing, and validation. Test application ID must be used with Mode Test Test cards should be used during integration testing and validation
Transaction Sequence **
Authorisation Flow *
The possible transaction sequence flow with an initial Authorization is the following:
Image [1]
Debit/Sale * *
The possible transaction sequence flow with an initial Debit is the following Image [2]
Refund/Credit * *
The possible transaction sequence flow with an initial Credit is the following: Image [3]
Transaction Commands *** The following transaction types encompasses the payment mechanism which the iVeri Gateway supports and may cause the transfer of funds from cardholder to merchant or vise-versa.
Transaction
Commands*
Description*
Authorisation (also known as
“Preauthorisation”)
Causes a reservation of funds on the cardholder’s account.
Authorisation Reversal
Unreserve the funds previously reserved on the cardholder’s account.
De
This document uses certain iVeri specific terminology which can be referenced in Parameter Description [1]
[1] /docs/enterprise-developer-guide-58#parameter-description-1330-0
Subsequent Transactions* **
When TransactionIndex is used on subsequent transactions, regular customers do not have to re-supply the card data details however this ONLY works if the merchant developer has made provisions for the following:
Ability for the merchant to identify the customer, usually by means of user sign-in The merchant has successfully processed a transaction on the customers card at some point in time using the iVeri Gateway That the customer's profile is mapped to the correct Tokenised card details (TransactionIndex, Expiry date etc) returned on the initial or previously processed transaction
Once the above provisions are made, the merchant developer would be able to display to the cardholder a masked/dotted card number and the expiry date of the card. The cardholder wo
3D secure transaction process flow *
**
Image [1]
Cardholder is on the merchant’s checkout page, ready to pay for their order. They will input and submit their card details on the payment page hosted by the Gateway. The Gateway will proceed to check if the card in use is enrolled in 3DS by sending a request to the Directory Server. Directory Server will respond with enrollment status.
Considering the response is positive and the card is enrolled for 3DS, The Gateway will redirect to the issuer ACS for authentication
The ACS will prompt the cardholder to insert and submit OTP/Password/credential(etc.) Considering the authentication was successful, the response is returned to the gateway to confirm successful authentication Gateway then forwards the transaction details to the acquirer for a
* Parameters *
**
The following parameters are expected in the form submitted to the Gateway at step 3 of the iVeri Lite None [1] process flow and/or returned by the Gateway in the response at step 6 to the cardholder via the merchant's website.
Note: Not all of the fields in this specification are mandatory.The list of parameters below has been split to reflect mandatory and optional data.
You can simulate a test form post, using data corresponding to your request, on None [2] this link
*Mandatory Parameters:*
* Name *
*General Description*
*Length*
* Notes *
Lite_Merchant_ApplicationId
iVeri Application id
36
Allocated to the Merchant during registration
Lite_Order_Amount
Amount to authorize
10
The total amount for the order including tax in cents. This must be equal to the sum of the
Delete Code *
**
Function: Delete a code that has been created
Delete Code Parameters *
Request
Parameter
Description
MasterPassAction
Mandatory, The action to perform.
MasterPassMerchantID
Mandatory, The merchant id as captured on MasterPass.
MasterPassCode
Mandatory, The result code that must be deleted
Response Parameter
Description
MasterPassAction
The action that was performed
Delete Code – REST Sample *
Request
Response
{
"Version" : "2.0" ,
"CertificateID" : "{xxxxxxxx-71dd-4044-802d-xxxxxxxxxxxx}" ,
"ProductType" : "Enterprise" ,
"Direction" : "Request" ,
"Enquiry" : {
"ApplicationID" : "{xxxxxxxx-68e0-42eb-aba9-xxxxxxxxxxxx}" ,
"Mode" : "Live" ,
"command" : "MasterPassQuickResponseCode" ,
"MasterPassMerchantID" : "xxxxx" ,
"MasterPassAction" : "DeleteCode" ,
"MerchantRefer
Query Code *
**
Function: Query a code that has been created.
Query Code Parameters *
Request
Parameter
Description
MasterPassAction
Mandatory, The action to perform.
MasterPassMerchantID
Mandatory, The merchant id as captured on MasterPass.
MasterPassCode
Mandatory, The result code that must be queried
Response
Parameter
Description
MasterPassAction
The action that was performed
MasterPassShortDescription
Short decription linked to the code
MasterPassCodeExpiryDate
Date until the code is valid. This is in epoch time.
MasterPassMerchantName
The name of the merchant as captured on MasterPass
Amount
Amount linked to the code.
Currency
The currency is tied to the merchant setup.
MerchantReference
Linked to the code.
Query Code – REST Sample *
Request
Response
{
"Version" : "2.0" ,
"Certifica
Create Code *
**
Function: Generate a transactional code that can then be paid for by a cardholder. This code can be represented as a QR code, transferred using NFC or manually entered a device. The code can also be used as part of an In-App payment.
/Create Code Parameters/*
Request
Parameter
Description
MasterPassAction
Mandatory, The action to perform.
MasterPassMerchantID
Mandatory, The merchant id as captured on MasterPass.
MasterPassShortDescription
Mandatory, This will be displayed to the consumer at the time a code
is scanned. Length is 5 to 45 characters
MasterPassCodeExpiryDate
Optional. If this is empty the code will by default expire in 30
minutes from issue. If this value is 0 the code will never expire. This time
is specified in epoch.
Amount
Mandatory, To use a variable amou