Parameters
The following parameters are expected in the form submitted to the Gateway at step 3 of the iVeri Lite 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 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 lineamount*linequantity for each line item |
Lite_Website_Successful_Url |
Success End Url | 255 |
URL to pass control back to upon successful completion of a transaction. Control of the transaction is passed back to this URL if the Lite_Payment_Card_Status = 0 |
Lite_Website_Fail_Url |
Failed End Url |
255 |
URL to pass control back to if the authorisation is refused by the financial institution. Control of the transaction is passed back to this URL if the Lite_Payment_Card_Status is anything other than 0, 1, 2, 5, 9 or 255 |
Lite_Website_TryLater_Url |
Network error End Url | 255 |
URL to pass control back to if there is a system error which could be overcome by trying again later. Control of the transaction is passed back to this URL if the Lite_Payment_Card_Status = 1, 2, 5 or 9 |
Lite_Website_Error_Url |
Code error End Url | 255 |
URL to pass control back to if the form has not been filled in correctly of there is an inconsistency in the form. Control of the transaction is passed back to this URL if the Lite_Payment_Card_Status = 255 |
Lite_Order_LineItems_Product_# |
LineItem | 255 |
Line item of what is being ordered. The # indicates a number starting at 1 and incrementing by 1 for every line item. This is essentially a description of the item being ordered |
Lite_Order_LineItems_Quantity_# |
LineQuantity | 10 |
Line item Quantity of what is being ordered. The # indicates a number starting at 1 and incrementing by 1 for every line item. This is the number of units being ordered. |
Lite_Order_LineItems_Amount_# |
LineAmount | 10 |
Line item cost including tax if any of what is being ordered. The # indicates a number starting at 1 and incrementing by 1 for every line item. This is the unit price for this particular item. |
Lite_ConsumerOrderID_PreFix |
Autogenerate Invoice Extension | 5 |
If the Merchant sets the ECOM_CounsuremOrderID to “AUTOGENERATE" then this field is used to control the first 3 to 6 characters of the autogenerated consumerorderid E.g. “INV” set in this field will result in an autogenerated consumerorderid of “INV0001”, “INV0002” and so on. |
Ecom_BillTo_Online_Email |
Bill to email | 40 |
This is the email address the invoice would be mailed to. e.g., jsmith@isp.com |
Ecom_Payment_Card_Protocols |
Payment protocols available | 20 |
A space separated list of protocols available for a specified card. Initial list of case insensitive tokens: "none", "set", or "setcert". "Set" indicates usable with SET Protocol (i.e., is in a SET wallet) without a SET certificate. "Setcert" indicates same but does have a SET certificate. "None" indicates standard is being used but wallet is not SET capable or the card has not been entered into the SET wallet. Usually a hidden field. |
Ecom_ConsumerOrderID |
Consumer generated order ID | 20 |
unique order ID generated by the consumer software. If at all possible, this should be filled out. If it is impossible iVeri will generate one for you but it should preferably be filled out by the merchant. For iVeri to create a unique ordered for you please set this to "AUTOGENERATE" and refer to the Lite_ConsumerID_PreFix which enables you to specify the first few letters of the invoice |
Ecom_TransactionComplete |
End transaction flag | - |
A flag to indicate that this web page/aggregate is the final one for this transaction. Usually a hidden field. |
Optional Parameters:
Name |
General Description |
Length |
Notes |
Lite_Version |
Version |
5 |
Set to current Version number ex. 4.0, for Old Version left blank – Not available. |
Lite_Payment_Card_Status |
iVeri Status |
10 |
Status of transaction received in response |
Lite_Merchant_Trace |
MerchantTrace |
64 |
Unique merchant identification for the request. This value can be used by the merchant to confirm the status of the transaction if need be. Appendix D |
Lite_Recurring_Payment |
CardHolderPresence |
5 |
Set to True or False. If True, then if your ApplicationID has been enabled for Recurring transactions, this will be the first transaction. Note: Your ApplicationID has to be enabled for recurring payments otherwise this indicator will be ignored. |
Lite_Order_Terminal |
Terminal on the Web |
8 |
|
Lite_Order_DiscountAmount |
Discount |
10 |
this is the discount field for iVeri lite, this field should be used as a discount field for the entire shopping basket. Please make use of this field and remember to adjust the Lite_Order_Amount |
Lite_Order_AuthorisationCode |
Authorisation Code |
6 |
Pre-authorisation code received from a financial institution |
Lite_Order_BudgetPeriod |
Budget Period |
2 |
Request to put this order onto a budget plan. The normal options for this are 0, 6, 12, 18, 24 and 36. 0 indicating to budget period. Specifying this field does not guarantee that the request will be granted a budget period |
Lite_Authorisation |
Card Pre-Auth Mode |
5 |
Set to True or False. If True then a Authorisation will be made, if false a Debit will be made. The Authorisation code will be stored for 3 weeks before you need to confirm the transaction in the BackOffice under view orders. |
Lite_Transaction_Token |
Transaction Token |
32 |
Merchant should generate the token: Encoded data should be Lite_Order_Amount, Lite_Merchant_ApplicationId, Ecom_BillTo_Online_Email & TimeStamp |
Ecom_ShipTo_Postal_Name_Prefix |
Ship-to title |
4 |
e.g., Mr., Mrs., Ms.; field commonly not used |
Ecom_ShipTo_Postal_Name_First |
Ship-to first name |
15 |
|
Ecom_ShipTo_Postal_Name_Middle |
Ship-to middle name |
15 |
|
Ecom_ShipTo_Postal_Name_Last |
Ship-to last name |
15 |
|
Ecom_ShipTo_Postal_Name_Suffix |
Ship-to name suffix |
4 |
e.g., Ph.D., Junior, Esquire; field commonly not used |
Ecom_ShipTo_Postal_Street_Line1 |
Ship-to street1 |
20 |
|
Ecom_ShipTo_Postal_Street_Line2 |
Ship-to street2 |
20 |
|
Ecom_ShipTo_Postal_Street_Line3 |
Ship-to street3 |
20 |
|
Ecom_ShipTo_Postal_City |
Ship-to city |
22 |
|
Ecom_ShipTo_Postal_StateProv |
Ship-to state or province |
2 |
2 characters are the minimum for the US and Canada, other countries may require longer fields; for the US use 2-character US Postal state abbr |
Ecom_ShipTo_Postal_PostalCode |
Ship-to zip or postal code |
14 |
|
Ecom_ShipTo_Postal_CountryCode |
Ship-to country |
2 |
use ISO 3166 2 letter codes for country names |
Ecom_ShipTo_Telecom_Phone_Number |
Ship-to phone |
10 |
10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension |
Ecom_ShipTo_Online_Email |
Ship-to email |
40 |
e.g., jsmith@isp.com |
Ecom_BillTo_Postal_Name_Prefix |
Bill-to title |
4 |
e.g., Mr., Mrs., Ms.; field commonly not used |
Ecom_BillTo_Postal_Name_First |
Bill-to first name |
15 |
If this is blank your invoice would read Dear Customer |
Ecom_BillTo_Postal_Name_Middle |
Bill-to middle name |
15 |
may also be used for middle initial |
Ecom_BillTo_Postal_Name_Last |
Bill-to last name |
15 |
|
Ecom_BillTo_Postal_Name_Suffix |
Bill-to name suffix |
4 |
e.g., Ph.D., Junior, Esquire; field commonly not used |
Ecom_BillTo_Postal_Street_Line1 |
Bill-to street1 |
20 |
|
Ecom_BillTo_Postal_Street_Line2 |
Bill-to street2 |
20 |
|
Ecom_BillTo_Postal_Street_Line3 |
Bill-to street3 |
20 |
|
Ecom_BillTo_Postal_City |
Bill-to city |
22 |
|
Ecom_BillTo_Postal_StateProv |
Bill-to state or province |
2 |
2 characters are the minimum for the US and Canada, other countries may require longer fields; for the US use 2-character US Postal state abbr |
Ecom_BillTo_Postal_PostalCode |
Bill-to zip or postal code |
14 |
|
Ecom_BillTo_Postal_CountryCode |
Bill-to country |
2 |
use ISO 3166 2 letter codes for country names |
Ecom_BillTo_Telecom_Phone_Number |
Bill-to phone |
10 |
10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension |
Ecom_ReceiptTo_Postal_Name_Prefix |
Receipt-to title |
4 |
e.g., Mr., Mrs., Ms.; field commonly not used |
Ecom_ReceiptTo_Postal_Name_First |
Receipt-to first name |
15 |
|
Ecom_ReceiptTo_Postal_Name_Middle |
Receipt-to middle name |
15 |
may also be used for middle initial |
Ecom_ReceiptTo_Postal_Name_Last |
Receipt-to last name |
15 |
|
Ecom_ReceiptTo_Postal_Name_Suffix |
Receipt-to name suffix |
4 |
e.g., Ph.D., Junior, Esquire; field commonly not used |
Ecom_ReceiptTo_Postal_Street_Line1 |
Receipt-to street1 |
20 |
|
Ecom_ReceiptTo_Postal_Street_Line2 |
Receipt-to street2 |
20 |
|
Ecom_ReceiptTo_Postal_Street_Line3 |
Receipt-to street3 |
20 |
|
Ecom_ReceiptTo_Postal_City |
Receipt-to city |
22 |
|
Ecom_ReceiptTo_Postal_StateProv |
Receipt-to state or province |
2 |
2 characters are the minimum for the US and Canada, other countries may require longer fields; for the US use 2-character US Postal state abbr |
Ecom_ReceiptTo_Postal_PostalCode |
Receipt-to zip or postal code |
14 |
|
Ecom_ReceiptTo_Postal_CountryCode |
Receipt-to country |
2 |
use ISO 3166 2 letter codes for country names |
Ecom_ReceiptTo_Telecom_Phone_Number |
Receipt-to phone |
10 |
10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension |
Ecom_ReceiptTo_Online_Email |
Receipt-to email |
40 |
e.g., jsmith@isp.com |
Ecom_Payment_Card_Type |
Card type |
4 |
use the first 4 letters of the association name: American Express=AMER; Diners Club=DINE; Discover=DISC; JCB=JCB; Mastercard=MAST; Visa=VISA; other association names may require more than 4 characters. You can tell card numbers apart from the first digit of a credit card number. 3 - American Express 4 - Visa 5 - MasterCard |
Ecom_SchemaVersion |
schema version number |
30 |
Identifies the ecom schema version number; format 999_99; digit (3) _digit (2); defined within a URL (e.g. http://www.w3c.org/ecom/1_0). Field should be included on every page with an ECML field on it and is usually a hidden field. |
Lite_Result_Description |
Description lite transaction |
255 |
Status of transaction described, if any error – error description. |
MerchantReference |
consumer generated order ID |
20 |
unique order ID generated by the consumer software. If at all possible, this should be filled out. If it is impossible iVeri will generate one for you but it should preferably be filled out by the merchant. For iVeri to create a unique ordered for you please set Lite_ConsumerID to "AUTOGENERATE" and refer to the Lite_ ConsumerOrderID PreFix which enables you to specify the first few letters of the invoice. |
Lite_BankReference |
Bank Reference |
11 |
Cycle, Trace number eg. 12345,12345 |
Lite_TransactionDate |
Transaction Date |
|
The date the authorisation took place |
Lite_Referrer |
Referrer |
|
The Website Referrer where the merchants Transaction started |
Lite_Currency_AlphaCode |
Currency |
3 |
The Currency in which the transaction will be processed |
Note: The below fields are required when Implementing
section Tokenisation: TransactionIndex on Subsequent Transactions
Name |
General Description |
Length |
Notes |
Lite_PanFormat |
PanFormat |
64 |
Methodology that specifies how to obtain the PAN details |
Lite_TransactionIndex |
TransactionIndex |
38 |
Unique identifier allocated by iVeri for a series of related transactions. If PANFormat is 'TransactionIndex', TransactionIndex is used to locate a previous transaction for the PAN to be resolved. |
Ecom_Payment_Card_Number |
CardNumber |
20 |
A dotted Pan number as returned in a previous transaction would have to be passed in this field |
Note: The following fields will be used when submitting to CyberSource for Advanced Fraud Screening and will not be saved to the iVeri system.
Name |
General Description |
Length |
Notes |
Lite_Order_LineItems_PassengerFirstName_# |
Passenger FirstName |
60 |
Passenger's first name |
Lite_Order_LineItems_PassengerLastName_# |
Passenger LastName |
60 |
Passenger's last name |
Lite_Order_LineItems_PassengerID_# |
Passenger ID |
32 |
ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number |
Lite_Order_LineItems_PassengerStatus_# |
Passenger Status |
32 |
Your company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as standard, gold, or platinum. |
Lite_Order_LineItems_PassengerType_# |
Passenger Type |
32 |
Passenger classification associated with the price of the ticket. You can use one of the following values: • ADT: Adult • CNN: Child • INF: Infant • YTH: Youth • STU: Student • SCR: Senior Citizen • MIL: Military |
Note: The following Airline addendum data is additional transaction data which appear on a card holder's statement when buying a ticket from an airline merchant who include this data in a transaction request
Name |
General Description |
Length |
Notes |
Airline_PassengerName |
Passenger Name |
20 |
Passenger name as printed on ticket. |
Airline_PrimaryTicketNumber |
Primary TicketNumber |
15 |
The ticket numbers. |
Airline_FirstDepartureLocationCode |
First Departure LocationCode |
3 |
Code for departure airport location, eg. JNB for Johannesburg |
Airline_FirstArrivalLocationCode |
First Arrival LocationCode |
3 |
Code for destination airport location, eg. JNB for Johannesburg |
Airline_PNRNumber |
PNR Number |
6 |
|
Airline_OfficeIATANumber |
Office IATA Number |
8 |
The office IATA number |
Airline_OrderNumber |
Order Number |
8 |
The order number |
Airline_PlaceOfIssue |
Place of Issue |
20 |
The ticket office location |
Airline_DepartureDate |
Departure Date |
8 |
Date of departure in yyyymmdd format |
Airline_DepartureTime |
Departure Time |
15 |
Departure time of the first leg of the trip. Use one of the following formats: |
Airline_CompleteRoute |
Complete Route |
25 |
Concatenation of individual travel legs in the format ORIG1-DEST1[: ORIG2-DEST2...:ORIGn-DESTn], f or example:CPT-JNB :JNB-:NBO. For airport codes |
Airline_JourneyType |
Journey Type |
25 |
Type of travel, for example: one way or round trip. |
Note: The following fields will be captured when the merchant’s website transfers control to the Lite web page on the iVeri Gateway.
Name |
General Description |
Length |
Notes |
Ecom_Payment_Card_Number |
card number |
19 |
The card number embossed on the cardholder’s card |
Ecom_Payment_Card_Verification |
cardholder verification value |
4 |
additional cardholder verification number such as American Express' CIV, MasterCard's CVC2, and Visa's CVV2 values |
Ecom_Payment_Card_ExpDate_Month |
card expiration date month |
2 |
Jan - 1, Feb - 2, March - 3, etc. |
Ecom_Payment_Card_ExpDate_Year |
card expiration date year |
4 |
Value in wallet cell is always 4 digits, e.g., 1999, 2000, 2001 |
Ecom_Payment_Card_Name |
name on card |
30 |
name of cardholder |
NOTE: Please remember to do the relevant configuration of the card capture page in BackOffice.
Refer to the Lite BackOffice user guide.