The following parameters are expected in the form submitted to the Gateway and / or returned by the Gateway in the response to the cardholder via the Merchant's website.
Note: Not all of the fields in this specification are mandatory. Fields which are marked in grey are the only mandatory fields.
| Descriptor | Name | Length | Values | Request | Response | Notes |
| Version | Lite_Version | 5 | 2.0 | Yes | Yes | Set to current Version number ex. 2.0, for Old Version left blank – Not available. |
| iVeri Status | Lite_Payment_ Card_Status |
10 | Yes | Yes | Status of transaction received in response | |
| iVeri Application id | Lite_Merchant_ ApplicationId |
36 | Yes | Yes | Allocated to the Merchant during Registration | |
| Amount to authorize | Lite_Order_Amount | 10 | Yes | Yes | 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 | |
| MerchantTrace | Lite_Merchant_Trace | 64 | Yes | Yes | Optional. 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 | |
| CardHolder Presence | Lite_Recurring_Payment | 5 | False | Yes | Yes | Set to True or False. If True, then If your application id has been enabled for Recurring transactions then this will be the first transaction. Note: Your application id has to be enabled for recurring payments otherwise this indicator will be ignored. |
| Terminal on the Web | Lite_Order_Terminal | 8 | Yes | Yes | Optional | |
| Discount | Lite_Order_ DiscountAmount |
10 | Yes | Yes | 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 | |
| Authorisation Code | Lite_Order_ AuthorisationCode |
6 | Yes | Yes | Optional. Pre-authorisation code received from a financial institution | |
| Budget Period | Lite_Order_ BudgetPeriod |
2 | 0 | Yes | Yes | Optional. 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. |
| Success End Url | Lite_Website_ Successful_Url |
255 | Yes | Yes | 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 | |
| Failed End Url | Lite_Website_Fail_Url | 255 | Yes | Yes | 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 | |
| Network error End Url | Lite_Website_TryLater _Url | 255 | Yes | Yes | 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 | |
| Code error End Url | Lite_Website_Error_Url | 255 | Yes | Yes | 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 | |
| LineItem | Lite_Order_LineItems _Product_# | 255 | Yes | Yes | 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. | |
| LineQuantity | Lite_Order_LineItems _Quantity_# | 10 | Yes | Yes | 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. | |
| LineAmount | Lite_Order_LineItems _Amount_# | 10 | Yes | Yes | 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. | |
| Autogenerate Invoice Extension | Lite_ConsumerOrderID_ PreFix |
5 | Yes | Yes | 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. | |
| Card Pre-Auth Mode | Lite_Authorisation | 5 | Yes | Yes | 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 | |
| Transaction Token | Lite_Transaction_Token | 32 | Merchant should generate the token: Encoded data should be Lite_Order_Amount, Lite_Merchant_ApplicationId, Ecom_BillTo_Online_Email & TimeStamp | |||
| ship to title | Ecom_ShipTo_Postal_ Name_Prefix |
4 | Yes | Yes | e.g., Mr., Mrs., Ms.; field commonly not used | |
| ship to first name | Ecom_ShipTo_Postal_ Name_First | 15 | Yes | Yes | ||
| ship to middle name | Ecom_ShipTo_Postal_ Name_Middle | 15 | Yes | Yes | May also be used for middle initial | |
| ship to last name | Ecom_ShipTo_Postal_ Name_Last | 15 | Yes | Yes | ||
| ship to name suffix | Ecom_ShipTo_Postal_ Name_Suffix | 4 | Yes | Yes | e.g., Ph.D., Junior, Esquire; field commonly not used | |
| ship to street1 | Ecom_ShipTo_Postal_ Street_Line1 | 20 | Yes | Yes | ||
| ship to street2 | Ecom_ShipTo_Postal_ Street_Line2 | 20 | Yes | Yes | ||
| ship to street3 | Ecom_ShipTo_Postal_ Street_Line3 | 20 | Yes | Yes | ||
| ship to city | Ecom_ShipTo_Postal_ City | 22 | Yes | Yes | ||
| ship to state or province | Ecom_ShipTo_Postal_ StateProv | 2 | Yes | Yes | 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 | |
| ship to zip or postal code | Ecom_ShipTo_Postal_ PostalCode | 14 | Yes | Yes | ||
| ship to country | Ecom_ShipTo_Postal_ CountryCode | 2 | Yes | Yes | use ISO 3166 2 letter codes for country names | |
| ship to phone | Ecom_ShipTo_Telecom_ Phone_Number |
10 | Yes | Yes | 10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension | |
| ship to email | Ecom_ShipTo_Online _Email | 40 | Yes | Yes | e.g., jsmith@isp.com | |
| bill to title | Ecom_BillTo_Postal_ Name_Prefix | 4 | Yes | Yes | e.g., Mr., Mrs., Ms.; field commonly not used | |
| bill to first name | Ecom_BillTo_Postal_ Name_First | 15 | Yes | Yes | If this is blank your invoice would read Dear Customer. | |
| bill to middle name | Ecom_BillTo_Postal_ Name_Middle | 15 | Yes | Yes | May also be used for middle initial | |
| bill to last name | Ecom_BillTo_Postal_ Name_Last | 15 | Yes | Yes | ||
| bill to name suffix | Ecom_BillTo_Postal_ Name_Suffix | 4 | Yes | Yes | e.g., Ph.D., Junior, Esquire; field commonly not used | |
| bill to street1 | Ecom_BillTo_Postal_S treet_Line1 | 20 | Yes | Yes | ||
| bill to street2 | Ecom_BillTo_Postal_S treet_Line2 | 20 | Yes | Yes | ||
| bill to street3 | Ecom_BillTo_Postal_S treet_Line3 | 20 | Yes | Yes | ||
| bill to city | Ecom_BillTo_Postal_ City | 22 | Yes | Yes | ||
| bill to state or province |
Ecom_BillTo_Postal_S tateProv | 2 | Yes | Yes | 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 | |
| bill to zip or postal code | Ecom_BillTo_Postal_ PostalCode |
14 | Yes | Yes | ||
| bill to country | Ecom_BillTo_Postal_ CountryCode | 2 | Yes | Yes | Use ISO 3166 2 letter codes for country names | |
| bill to phone | Ecom_BillTo_Telecom _Phone_Number | 10 | Yes | Yes | 10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension | |
| bill to email | Ecom_BillTo_Online_ Email | 40 | Yes | Yes | This is the email address the invoice would be mailed to. e.g., jsmith@isp.com | |
| receipt to title | Ecom_ReceiptTo_ Postal_Name_Prefix |
4 | Yes | Yes | e.g., Mr., Mrs., Ms.; field commonly not used | |
| receipt to first name | Ecom_ReceiptTo_ Postal_Name_First |
15 | Yes | Yes | ||
| receipt to middle name | Ecom_ReceiptTo_ Postal_Name_Middle |
15 | Yes | Yes | May also be used for middle initial | |
| receipt to last name | Ecom_ReceiptTo_ Postal_Name_Last |
15 | Yes | Yes | ||
| receipt to name suffix | Ecom_ReceiptTo_ Postal_Name_Suffix |
4 | Yes | Yes | e.g., Ph.D., Junior, Esquire; field commonly not used | |
| receipt to street1 | Ecom_ReceiptTo_ Postal_Street_Line1 |
20 | Yes | Yes | ||
| receipt to street2 | Ecom_ReceiptTo_Pos tal_Street_Line2 | 20 | Yes | Yes | ||
| receipt to street3 | Ecom_ReceiptTo_Pos tal_Street_Line3 | 20 | Yes | Yes | ||
| receipt to city | Ecom_ReceiptTo_ Postal_City |
22 | Yes | Yes | ||
| receipt to state or province | Ecom_ReceiptTo_Pos tal_StateProv | 2 | Yes | Yes | 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 | |
| receipt to zip or postal code | Ecom_ReceiptTo_Pos tal_PostalCode | 14 | Yes | Yes | ||
| receipt to country | Ecom_ReceiptTo_Pos tal_CountryCode | 2 | Yes | Yes | Use ISO 3166 2 letter codes for country names | |
| receipt to phone | Ecom_ReceiptTo_Tele com_Phone_Number | 10 | Yes | Yes | 10 digits are the minimum for the US and Canada, other countries may require longer fields, recommend placing on "x" before an extension | |
| receipt to email | Ecom_ReceiptTo_Onli ne_Email | 40 | Yes | Yes | e.g., jsmith@isp.com | |
| card type | Ecom_Payment_Card _Type | 4 | Yes | Yes | 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 | |
| payment protocols available | Ecom_Payment_Card _Protocols | 20 | IVERI | Yes | Yes | A space seperated 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. |
| consumer generated order ID | Ecom_ConsumerOrderID | 20 | Yes | Yes | 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. | |
| schema version number | Ecom_SchemaVersion | 30 | 1.0 | Yes | Yes | 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. |
| end transaction flag | Ecom_TransactionCo mplete | - | FALSE | Yes | Yes | A flag to indicate that this web page/aggregate is the final one for this transaction. Usually a hidden field. |
| Description lite transaction | Lite_Result_Description |
255 | Yes | Status of transaction described, if any error – error description. | ||
| Index | Lite_TransactionIndex | 36 | Yes | This is a globally unique number generated by iVeri and is iVeri unique number to identify this transaction. | ||
| consumer generated order ID | MerchantReference | 20 | Yes | 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. | ||
| Bank Reference | Lite_BankReference | 11 | Yes | Cycle, Trace number eg. 12345,12345 | ||
| Transaction Date | Lite_TransactionDate | Yes | The date the authorisation took place | |||
| Referrer | Lite_Referrer | Yes | The Website Referrer where the merchants Transaction started. | |||
| Currency | Lite_Currency_ AlphaCode |
3 | Yes | Yes |
The Currency in which the transaction will be processed
|
The below fields are required when implementing Tokenisation: TransactionIndex on Subsequent Transactions
| Descriptor | Name | Length | Values | Request | Response | Notes |
| PanFormat | Lite_PanFormat | 64 | Methodology that specifies how to obtain the PAN details | |||
| TransactionIndex | Lite_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. | |||
| CardNumber | Ecom_Payment_ Card_Number |
20 | A dotted Pan number as returned in a previous transaction would have to be passed in this field |
The following fields will be used when submitting to CyberSource for Advanced Fraud Screening and will not be saved on the iVeri system:
| Descriptor | Name | Length | Values | Request | Response | Notes |
| Passenger FirstName | Lite_Order_LineItems _PassengerFirstName _# | 60 | Yes | Yes | Passenger's first name | |
| Passenger LastName | Lite_Order_LineItems _PassengerLastName _# | 60 | Yes | Yes | Passenger's last name | |
| Passenger ID | Lite_Order_LineItems _PassengerID_# | 32 | Yes | Yes | ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number | |
| Passenger Status | Lite_Order_LineItems _PassengerStatus_# | 32 | Yes | Yes | 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. | |
| Passenger Type | Lite_Order_LineItems _PassengerType_# | 32 | Yes | Yes |
Passenger classification associated with the price of the ticket. You can use one of the following values:
|
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:
| Descriptor | Name | Length | Values | Request | Response | Notes |
| Passenger Name | Airline_PassengerName | 20 | Yes | Yes | Passenger name as printed on ticket. | |
| Primary Ticket Number | Airline_PrimaryTicket Number | 15 | Yes | Yes | The ticket number | |
| First Departure LocationCode | Airline_FirstDeparture LocationCode |
3 | Yes | Yes | Code for departure airport location, eg. JNB for Johannesburg | |
| First Arrival LocationCode | Airline_FirstArrival LocationCode |
3 | Yes | Yes | Code for destination airport location, eg. JNB for Johannesburg | |
| PNR Number | Airline_PNRNumber | 6 | Yes | Yes | ||
| Office IATA Number | Airline_OfficeIATANu mber | 8 | Yes | Yes | The office IATA number | |
| Order Number | Airline_OrderNumber | 8 | Yes | Yes | The order number | |
| Place of Issue | Airline_PlaceOfIssue | 20 | Yes | Yes | The ticket office location | |
| Departure Date | Airline_DepartureDate | 8 | Yes | Yes | Date of departure in yyyymmdd format | |
| Departure Time | Airline_DepartureTime | 15 | Yes | Yes |
Departure time of the first leg of the trip. Use one of the following formats:
Important For travel information, use GMT instead of UTC or use the local time zone. Examples 19:55 GMT+02:00 19:55 GMT+0200 11:25 GMT-03:00 11:25 GMT-0300 Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. |
|
| Complete Route | Airline_CompleteRoute | 25 | Yes | Yes | Concatenation of individual travel legs in the format ORIG1-DEST1[: ORIG2-DEST2...:ORIGn-DESTn], f or example:CPT-JNB :JNB-:NBO. For airport codes | |
| Journey Type | Airline_JourneyType | 25 | Yes | Yes | Type of travel, for example: One way or round trip |
The following fields will be captured when the merchant’s website transfers control to the Lite web page on the iVeri Gateway:
| Descriptor | Name | Length | Values | Request | Response | Notes |
| card number | Ecom_Payment_ Card_Number |
19 | Yes | Yes | The card number embossed on the cardholder’s card | |
| cardholder verification value | Ecom_Payment_ Card_Verification |
4 | Yes | Yes | Additional cardholder verification number such as American Express' CIV, MasterCard's CVC2, and Visa's CVV2 value | |
| card expiration date month | Ecom_Payment_ Card_ExpDate_Month |
2 | 1-12 | Yes | Yes | Jan - 1, Feb - 2, March - 3, etc. |
| card expiration date year | Ecom_Payment_Ca rd_ExpDate_Year | 4 | Yes | Yes | Value in wallet cell is always 4 digits, e.g., 1999, 2000, 2001. | |
| name on card | Ecom_Payment_ Card_Name |
30 | Yes | Yes | 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.