- KnowSystem
- Parameter Description
Parameter Description
Core Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
ApplicationID | Attribute parameter | GUid | 38 | 38 | Identification of the merchant’s configuration within the iVeri Gateway |
CertificateID | property |
| 38 | 38 | The iVeri CertificateID installed on the server communicating with the iVeri Gateway |
CertificatePath | Property | A |
|
| Valid Path to directory where the KeyStoreFile or CertificateFile exists on the filesystem |
CertificateFile | Property | A |
|
| Existing certificate file |
CertificatePassword | Property | A |
|
| Password of the certificate |
Gateway | Property | A |
|
| The name of the gateway connecting to. If not explicitly set, the default gateway is used. |
RequestID | Attribute
|
| 38 | 38 | A unique identifier generated by the iVeri Gateway for this request |
Mode | Attribute parameter |
| 4 | 4 | The mode of the corresponding ApplicationID. See section 10.2 |
| TEST | ||||
LIVE | |||||
Category | parameter |
|
| 50 | A categorisation of the request. Only required in conjunction with a prepare method. |
| Transaction | use if Command = 'Debit' or 'Credit' or 'Authorisation' or 'AuthorisationReversal' or 'Void' | |||
Enquiry | use if Command = 'Balance', 'PAN' or 'PANToken' or ' ‘AuthenticatedCollection' or ‘RequestForDebit’ OR ‘AccountValidation’
| ||||
System | use if Command = 'Ping' | ||||
Security | use if Command = 'GetDevicePINKey' | ||||
Command | Attribute parameter | A |
|
| The command specifying what should be done by the iVeri Gateway |
| GetDevicePINKey | Get DevicePINKey (use Category='Security') | |||
Ping | Ping (use Category='System') | ||||
Authorisation | Authorisation (use Category='Transaction') | ||||
AuthorisationReversal | Authorisation Reversal (use Category='Transaction') | ||||
Credit | Credit (use Category='Transaction') | ||||
Debit | Debit (use Category='Transaction') | ||||
Void | Void (use Category='Transaction') | ||||
Balance | Balance Enquiry (use Category='Enquiry') | ||||
PAN | PAN Enquiry (use Category='Enquiry') | ||||
PANToken | PANToken Enquiry (use Category='Enquiry') | ||||
AuthenticatedCollection | AuthenticatedCollection:Enquiry (use Category='Enquiry') | ||||
AccountValidation | AccountValidation Enquiry (use Category = ‘Enquiry’) | ||||
RequestForDebit | RequestForDebit Enquiry (use Category = ‘Enquiry’) | ||||
MasterPassQuickResponseCode | MasterPass QuickResponseCode Enquiry (use Category = ‘Enquiry’) | ||||
DynamicCurrencyConversion | DynamicCurrencyConversion |
Common Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description | |
Acquirer | tag | A | 3 | 32 | The Acquiring system to which this transaction was routed by iVeri | |
| NBPostllionNBSA |
| ||||
NBPostilion NB Zimbabwe |
| |||||
NBPostilionUSD NB Zimbabwe |
| |||||
CBZPostilion CBZ Zimbabwe |
| |||||
CSCFIS CSC Lebanon |
| |||||
NBPostilion iVeri SouthAfrica |
| |||||
ICPSPwC CIM Mauritius |
| |||||
OWWay4 IM Kenya |
| |||||
NBPostilion NB Namibia |
| |||||
|
| |||||
AcquirerDate | tag | N |
| 64 | The date that the Acquirer allocated to this transaction | |
YYYYMMDD | YearMonthDay | |||||
AcquirerReference | tag | N |
| 64 | A reference allocated by the Acquirer to this transaction with format specific to the acqiurer. It is a composite element consisting of a settlement cycle and a transaction trace. The cycle can be 5 digits (the acquirer batch number) or 8 digits (cycle end date). The trace is the significant part of the acquirer Retrieval Reference Number (RRN). The trace can be 8 digits (if the RRN starts with 0000) or 12 digits (the full RRN). | |
| CCCCC: TTTTTTTT | CycleNumber: RRN8 (for Nedbank providers) | ||||
yyyyMMdd:tttttttt | CycleEndDate: RRN8 (for the TMS provider) | |||||
yyyyMMdd:ydddhhtttttt | CycleEndDate:RRN (for providers in general) | |||||
|
| |||||
AcquirerTime | tag | N |
| 6 | The time that the Acquirer allocated to this transaction | |
HHMMSS | HourMinuteSecond | |||||
Amount | tag | N | 0 | 12 | The total value of the transaction in the smallest unit of the currency specified (eg in cents) | |
AuthorisationCode | Tag | AN | 0 | 6 | The Authorisation Code issued by the Issuer to the Merchant either telephonically or electronically | |
BudgetPeriod | Tag | N | 0 | 2 | The number of months over which the cardholder would like to pay the transaction off. See section 10.4 | |
| 0 | Default | ||||
3 |
| |||||
6 |
| |||||
9 |
| |||||
12 |
| |||||
18 |
| |||||
24 |
| |||||
36 |
| |||||
| ||||||
CardSecurityCode | Tag | N | 3 | 4 | The 3 or 4 digits printed on the card which are not contained on the magnetic strip. Usually printed after the CCNumber on the signature strip. Corresponds to American Express CIV, MasterCard CVC2 and VISA CVV2. Does not exist within Associations | |
Currency | Tag | A |
| 3 | The ISO 4217 currency code of the value of the transaction. e.g., USD or ZAR or GBP | |
DisplayAmount | Tag | String |
| 30 | The Amount returned in a currency aware printable format | |
ExpiryDate | Tag | N | 4 | 6 | The last month of the validity period of the card | |
MMYY | MonthYear | |||||
| MMYYYY | MonthYear | ||||
CardholderName | Tag | String |
| 50 | The name of the cardholder as embossed on the card. | |
CardholderEmail | Tag | String |
| 125 | The email address of the cardholder | |
OrderDescription | Tag | String |
| 250 | A brief description of the purchase made by the cardholder | |
AllowBudgetPeriod | Tag | Boolean |
|
| When this is true a ‘BudgetPeriod’ input field will be present on the CardDetails capture form. | |
RequestExpiryDate | Tag | N | 8 | 8 | The date after which the debit request will expire | |
YYYYMMDD | YearMonthDay | |||||
CreateTransactionUrl | Tag | Boolean |
|
| When this value is ‘true’ a ‘TransactionUrl’ will be returned to the merchant. If ‘false’ a debit request email will be sent to the ‘CardholderEmail’ | |
TransactionUrl | Tag | String |
| 225 | The transaction url that the Cardholder must be redirected to perform a transaction when the command was ‘RequestForDebit’. This will be returned to the merchant in the response if the ‘CreateTransactionUrl’ parameter is set to ‘true’ | |
MerchantName | Tag | String |
| 50 | The merchant name associated with the ApplicationID | |
MerchantAddress | Tag | String |
| 50 | The merchant address associated with the ApplicationID | |
MerchantCity | Tag | String |
| 50 | The merchant city associated with the ApplicationID | |
MerchantCountryCode | Tag | String |
| 2 | The merchant country code associated with the ApplicationID | |
MerchantCountry | Tag | String |
| 50 | The merchant country name associated with the ApplicationID | |
MerchantReference | Tag | String | 0 | 64 | A merchant generated identifier that is unique within a specified time period that identifies a transaction sequence. In the case that the transaction is an Authenticated Collection this field will contain the 14-character long Contract Reference allocated by the Merchant for this transaction. | |
OriginalMerchantReference | Tag | String | 0 | 64 | A merchant generated identifier of a previous transaction used in a Tokenized PAN transaction | |
MerchantTrace | Tag | String | 0 | 64 | Unique merchant identification for the request | |
MerchantUSN | Tag | String | 0 | 15 | The merchant USN associated with the ApplicationID | |
OriginalMerchantTrace | Tag | String |
| 64 | A reference to the original MerchantTrace previously sent to the iVeri Gateway | |
OriginalRequestID | Tag | Guid | 38 | 38 | The RequestID that was returned as part of the original transaction | |
PAN | Tag | N |
| 20 | Primary Account Number (eg Credit card number), may have been extracted from Track2. When this is an output parameter, then a section of it is dotted out, and safe to display or print | |
PANMode | Tag | String | 0 | 128 | The mechanism by which the PAN was determined from the card. The value is a comma separated list of the following:
| |
Name
| Direction | Description | ||||
Keyed | Input/Output | Card number was keyed | ||||
Tokenized | Output | PANFormat 'TransactionIndex', 'OriginalMerchantReference' or 'MSISDN' (non-registration) was specified in the request | ||||
Swiped | Input/Output | Card was swiped. This means that a Track2 must be specified in the request. | ||||
Dipped | Input/Output | Card was processed while in the card reader slot of the device. This means that a Track2 must be specified in the request. | ||||
Tapped | Input/Output | Card was processed by a contactless device. This means that a24 Track2 must be specified in the request. | ||||
ConstructedTrack2 | Output | For when a partial Track2 is received in the request usually accompanied by a PINBlock as one of the legs of a PANFormat “MSISDN” transaction. | ||||
CVV | Output | The CardSecurityCode tag had a value in the request | ||||
PIN | Output | The PINBlock tag had a value in the request | ||||
PINCapable | Input/Output | No online PIN or EMV data sent to the gateway, but the device is capable to process PIN. | ||||
EMV | Output |
| ||||
EMVFallback | Output | No EMV data specified in the request, but the service code of the request Track2 indicate a chip card. | ||||
EncryptedPAN | Output | The value of the PAN tag in the request specified encrypted data | ||||
EncryptedTrack2 | Output | The value of the Track2 tag in the request specified encrypted data | ||||
PurchaseDate | Tag |
| 4 | 4 | The date on which the purchase was made. Defaults to current Date | |
MMDD |
MonthDay | |||||
PurchaseTime | Tag |
| 4 | 4 | The time at which the purchase was made. Defaults to current Time | |
HHMM | HourMinute | |||||
ReconReference | Tag | N | 0 | 8 | Identifier that the Merchant is returned during a transaction and that also appears in the reconciliation information supplied by the Acquirer. Either assigned by the iVeri Gateway or derived from the specified MerchantReference. | |
StartDate | Tag | A |
| 6 | The date of the start of the validity period of the card number. The start date is not available on many cards, and will remain an optional parameter until the start date becomes more common
| |
MMYY | MonthYear | |||||
MMYYYY | MonthYear | |||||
Terminal | Tag | N | 0 | 8 | Identifier optionally allocated by the merchant which is intended to group transactions together for reporting purposes in reconciliation statements. | |
Track2 | Tag | String |
| 39 | Track2 after being read by the swipe device from the magnetic stripe on the card (for card present transactions). It is inclusive of the beginning and end markers being ; and ? respectively. See section 10.3 | |
TransactionIndex | Tag | Guid | 38 | 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. | |
MobileMoneyID | Tag | N | 1 | 6 | An additional transaction identifier returned for a PANFormat “MSISDN” transaction. This tag should be passed to the Gateway along with OriginalRequestID or OriginalMerchantTrace when the transaction needs to be Voided. | |
MSISDN | Tag | String |
|
| A mobile number required by PANFormat “MSISDN” transactions | |
VisaCheckoutCallID | Tag | String | 0 | 48 | Visa Checkout transaction ID associated with a payment request. | |
MasterPassTransactionID | Tag | N |
|
| This is the MasterPass system transaction reference | |
ForeignAmount | Tag | String | 0 | 11 | When doing a transaction in a foreign currency we need to specify the amount here in the foreign currency Mandatory when doing transaction in foreign currency
| |
ForeignCurrency | Tag | String | 3 | 3 | When doing a transaction in a foreign currency we need to specify the foreign currency here Mandatory when doing transaction in foreign currency
| |
ForeignExchangeID | Tag | Guid | 38 | 38 | Unique Identifier returned in the DynamicCurrencyConversion / MultiCurrencyPricing linked to the BaseAmount /BaseCurrency and the Amount and Currency in the current transaction request Mandatory when doing transaction in foreign currency
| |
PANFormat | Tag | String |
|
| An enumeration specifying how to obtain the PAN details
| |
PAN | Required tag: PAN. If PANFormat is not specified, this value is used if the PAN tag is set and the Track2 tag not set. | |||||
Track2 | Required tag: Track2. If PANFormat is not specified, this value is used if the Track2 tag is set. | |||||
VisaCheckoutCallID | Required tags: VisaCheckoutCallID The VisaCheckoutCallID is used to retireve the Payment Data from the Visa Checkout Process.
| |||||
MSISDN | Required tag: MSISDN. If in addition, AccountType, PAN (full) and ExpiryDate are provided, the transaction also serves as a registration of the MSISDN, thereby enabling future transactions with MSISDN only. | |||||
|
| |||||
CardHolderPresence | Tag | String | 0 | 128 | Specify how the cardholder is involved when a virtual transaction is performed. This tag supersedes the ElectronicCommerceIndicator tag. The value is a comma separated list of the following: | |
CardPresent | Gets set in the output when a full Track2 was specified in the request. This value may also be set in the request when the card number was keyed on a POS device. | |||||
|
|
|
|
| CardNotPresent | The physical plastic of the card was not present when the request was sent to the gateway. |
|
|
|
|
| eCommerce | Gets set in the output when one of the ElectronicCommerceIndicator values was specified in the request |
|
|
|
|
| ThreeDSecure | Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure was successful |
|
|
|
|
| ThreeDSecureAttempted | Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure was attempted unsuccessfuly |
|
|
|
|
| SecureChannel | Encryption (SSL) used between CardHolder and Merchant. ThreeDSecure not used |
|
|
|
|
| ClearChannel | No encryption used between CardHolder and Merchant |
|
|
|
|
| MOTO | Telephonic or mail order |
|
|
|
|
| Recurring | Transactions submitted by a merchant automatically |
|
|
|
|
|
|
Card Detail Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
Association | tag | string | 0 | 50 | The association to which the card number belongs e.g., VISA or Master card or American Express |
Bin | Tag | string | 1 | 9 | The Bank Identification Number into which PANs are grouped. Generally, this is the first two to eight digits |
CardType | tag | String | 0 | 50 | A description of the type of the card used e.g., Credit Card, Maestro, Electron etc |
Issuer | tag | string | 0 | 50 | If the card is local this gives a description of the institution that issued this card
|
Jurisdiction | Tag | String | 0 | 50 | Description of whether the card is a local or international card |
3DSecure Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
ElectronicCommerceIndicator | tag | A | 0 |
| More commonly known as the ECI, it describes for virtual transactions what steps were taken to secure and authenticate the transaction. Values are the following subset of CardHolderPresence values: ThreeDSecure, ThreeDSecureAttempted, SecureChannel and ClearChannel |
CardHolderAuthenticationData | tag | Base64 | 28 | 28 | For usage with Verified by Visa / MasterCard SecureCode. The CAVV or UCAF field depending on whether the card is VISA or Master card. Note: Original binary format length = 20 bytes. Mandatory when ElectronicCommerceIndicator = ThreeDSecure |
CardHolderAuthenticationID | tag | Base64 | 28 | 28 | For usage with Verified by Visa / MasterCard SecureCode. The Transaction ID. Note: Original binary format length = 20 bytes. Mandatory when ElectronicCommerceIndicator = ThreeDSecure |
ThreeDSecure_RequestID | Tag | Guid | 38 |
| The RequestID that was returned as part of the Enrollment Check that will be used to retrieve data for the Authentication Validation |
ThreeDSecure_ACS_URL | Tag | URL |
| No Limit | URL of the Access Control Server of the card-issuing bank where you need to send the ThreeDSecure_PAReq so that the customer can be authenticated. The field length can be very large. |
ThreeDSecure_PAReq | Tag | Base64 |
| No Limit | Digitally signed payer authentication request message that contains a unique transaction ID.The field length can be very large. |
ThreeDSecure_SignedPARes | Tag | Base64 |
| No Limit | Digitally signed PARes message that contains the authentication result.The field length can be very large. |
ThreeDSecure_VEResEnrolled | Tage | A | 1 | 1 | Indicator that shows whether the cardholder is participating in 3DS. |
Result Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description | |
Code | Attribute | N |
| 3 | The numeric Result Code of the completed execution. See section 10.1 | |
Description | Attribute | String |
| 1024 | A description of the results of the completed execution. Only relevant where ResultStatus is 'Unsuccessful' [-1] or 'Successful with warning' [1] | |
Source | Attribute | String |
| 138 | The source of the result | |
Previous | Attribute | Boolean |
|
| In most cases returns false, indicating that the other result values refer to the immediately completed execution. For advanced usage within a Reprint, to indicate whether the result returned refers to the current execution, or a previous execution. | |
Status | Attribute | Z |
| 2 | The status of the completed execution | |
|
|
|
|
| -1 | Unsuccessful |
0 | Successful | |||||
1 | Successful, with warning |
Masterpass Parameters
ForeignExchange Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
Currency | Subtag | A | 3 | 3 | The ISO 4217 currency code of the value of the transaction. e.g. USD or ZAR or GBP |
Amount | subTag | N | 0 | 11 | The total value of the transaction in the smallest unit of the currency specified (eg in cents) |
ForeignExchange | Tag | AN |
|
| Contains a collection of ForeignExchangeItems |
Divert Parameters
UPOP SecurePlus Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
UPOP_TransactionTime | tag | String |
|
| The time when the Merchant sends the transaction. Date and time formatted as an ISO 8601 combined date and time string using the extended format.
- Format: YYYY-MM-DDThh:mm:ssZ
- YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds
|
UPOP_RelatedTransactionType | tag | String | 2 | 2 | Related Transaction Type. One of:
- Purchase - Pre-authorization
The corresponding UnionPay protocol values are:
- 01: Purchase - 02: Pre-authorization
|
UPOP_RequestID | Tag | Guid | 38 |
| The RequestID that was returned as part of the Request Creation that will be used to retrieve data for the Authentication Validation |
UPOP_FrontUrl | Tag | URL |
| 256 | UPOP send the transaction result notification to the URL via cardholder’s browser |
UPOP_BackUrl | Tag | URL |
| 256 | UPOP send the transaction result notification to the URL via system |
UPOP_ACPReq | Tag | Base64 |
| No Limit | The Authentication Request message to be posted to the UPOP authentication server |
UPOP_Endpoint | Tag | URL |
|
| The UPOP authentication server endpoint where the Authentication Request message must be posted via cardholder’s browser |
UPOP_ACPRes | Tag | Base64 |
| No Limit | The Authentication Response message received from the UPOP authentication server |
CyberSource Parameters
Parameter | Node Type | Data Type | Required/Optional | Max Length | Description |
DeliveryMethod | subTag | 0 | O | 255 | Physical or Virtual |
DeviceFingerprintID | SubTag | AN | 0 | 88 | Session ID for the fingerprint. |
BillTo_FirstName | SubTag | AN | R | 60 | First name of cardholder |
BillTo_LastName | SubTag | AN | R | 60 | Last name of cardholder |
BillTo_Street | subTag | AN | R | 60 | Street address of cardholder |
BillTo_City | subTag | AN | R | 60 | Billing city for cardholder |
BillTo_State | subTag | AN | 0 | 2 | State or province of the cardholder. Required for U.S. and Canada. Use the two-character state, province, or territory codes.
|
BillTo_Country | subTag | AN | R | 2 | Billing country for cardholder. Use the two-character country codes. |
BillTo_PostalCode | subTag | AN | O | 10 | Postal code of the billing address. Required only if the BillTo_Country field is US or CA |
BillTo_Email | subTag | AN | R | 100 | Email address of the cardholder |
BillTo_IPAddress | subTag | AN | O | 15 | IP address of the cardholder as reported by your Web server via socket information. |
Note: If any of the fields marked in Red is unavalable all the fields in Red will be replaced with defaults specified by CyberSource |
POS Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
DeviceFirmware | Tag | String |
| 64 | The firmware (software) currently loaded on the device. This may be set as an integer |
DeviceFirmwareVersion | Tag | String |
| 64 | The version of the firmware (software) currently loaded on the device. |
DevicePINKey | Tag | Hex | 32 | 32 | Master/Session encryption specific: The device PIN Key encrypted under the device master key i.e. DMK(DPK) |
MACDevicePINKey | Tag | Hex | 8 | 8 | Master/Session encryption specific: The MAC of the device PIN Key i.e. MAC(DPK) |
AccountType | Tag | A | 0 | 32 | The type of account that this transaction relates to (known to the cardholder |
Cheque |
Not specified | ||||
Savings | Credit | ||||
AvailableBalance | Tag | N |
| 12 | The available amount in the cardholders account given in the smallest unit of currency of the cardholder (not necessarily the currency of the merchant) |
DisplayAvailableBalance | Tag | String |
| 25 | The AvailableBalance returned in a currency aware printable format |
CashAmount | Tag | N |
| 12 | The Cash (back) portion of the Amount. Subject to the constraint: 0 <= CashAmount <= Amount |
CurrentBalance | Tag | Z |
| 12 | The current balance in the cardholders account given in the smallest unit of currency of the cardholder (not necessarily the currency of the merchant) |
DisplayCurrentBalance | Tag | String |
| 25 | The CurrentBalance returned in a currency aware printable format |
DeviceMake | Tag | String |
| 64 | The manufacturer of the device (terminal). e.g. Dione / Sagem |
DeviceSerialNumber | Tag | String |
| 64 | The serial number of the device (terminal) |
DeviceCycle | Tag | String | 20 |
| the current batch id of the device (terminal) |
PINBlock | Tag | Hex | 16 | 16 | The cardholders PIN encrypted using the current device pin key |
KeySerialNumber | Tag | Hex | 20 | 20 | DUKPT encryption specific: Mandatory input parameter needed in decryption of a DUKPT PINBlock. |
Track2KeySerialNumber | Tag | Hex | 20 | 20 | DUKPT Track2 encryption specific: Mandatory input parameter needed in decryption of a DUKPT Track2. |
PANKeySerialNumber | Tag | Hex | 20 | 20 | UKPT PAN encryption specific: Mandatory input parameter needed in decryption of a DUKPT PAN. |
EMV Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
EMV_AuthorisationRequestCryptogram | Tag | Hex |
| 16 | EMV tag 9F26 |
EMV_ApplicationIdentifier | Tag | Hex |
| 32 | EMV tag 9F26 |
EMV_ApplicationInterchangeProfile | Tag | Hex |
| 4 | EMV tag 82 |
EMV_CardSequenceNumber | Tag | Hex |
| 2 | EMV tag 5F34 |
EMV_ApplicationTransactionCounter | Tag | Hex |
| 4 | EMV tag 9F36 |
EMV_ApplicationVersion | Tag | Hex |
| 4 | EMV tag 9F08 |
EMV_CardHolderVerificationMethodResult | Tag | Hex |
| 6 | EMV tag 9F34 |
EMV_CryptogramInformationData | Tag | Hex |
| 2 | EMV tag 9F27 |
EMV_IssuerApplicationData | Tag | Hex |
| 64 | EMV tag 9F10 |
EMV_TerminalCapabilities | Tag | Hex |
| 6 or 8 | EMV tag 9F33 |
EMV_TerminalType | Tag | N |
| 2 | EMV tag 9F35 |
EMV_TransactionType | Tag | N |
| 2 | EMV tag 9C |
EMV_TerminalVerificationResult | Tag | Hex |
| 10 | EMV tag 95 |
EMV_UnpredictableNumber | Tag | Hex |
| 8 | EMV tag 9F37 |
EMV_TransactionStatusInformation | Tag | Hex |
| 4 | EMV tag 9B |
EMV_IssuerAuthenticationData | Tag | Hex |
| 16 or 32 | EMV tag 91 |
EMV_IssuerScriptTemplate1 | Tag | Hex |
| 999 | EMV tag 71 |
EMV_IssuerScriptTemplate2 | Tag | Hex |
| 999 | EMV tag 72 |
EMV_ResponseCode | Tag | AN |
| 2 | EMV tag 8A |
Procurement Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
CustomerReferenceIdentifier | Tag | AN |
| 17 | Description allocated by the merchant to be printed on the Cardholders statement |
CustomerVATRegistrationNumber | Tag | AN |
| 13 | The VAT registration number of the Customer if available |
DestinationCountry | Tag | A | 2 | 2 | The ISO code for the country of residence of the Merchant. e.g., ZA, US, GB |
DestinationZIPCode | Tag | AN | 0 | 10 | The Customers Destination ZIP code |
NationalTax | Tag | N | 0 | 12 | The VAT amount of the transaction in the currency's smallest denomination. Depending on the NationalTaxIndicator this may be included or in addition to the Amount field |
NationalTaxIndicator | Tag | N | 0 | 1 | Indicates whether VAT is applicable to this transaction.
|
0 | NationalTax is NOT included | ||||
1 | NationalTax is included | ||||
OrderDate | Tag | A | 0 | 6 | The date that the order was placed. This is not necessarily the same as the PuchaseDate. Defaults to current Date |
PurchaseIdentifier | Tag | AN | 0 | 25 | Optional description allocated by the Merchant to be displayed on the Merchants statement. Defaults to MerchantReference. |
ShipFromZIPCode | Tag | AN | 0 | 10 | The ZIP code of the Merchant (Shipping source ZIP code) |
ShippingAmount | Tag | N | 0 | 12 | The amount charged to the customer for shipping charges in the currency's smallest denomination. |
ShippingTaxRate | Tag |
| 0 | 4 | The VAT rate that applies to the ShippingAmount. It is a percentage and not the actual value. The value is the rate multiplied with 10000. |
TransactionDiscount | Tag | N | 0 | 12 | Discount value for the transaction, it is the result of individual line-item percentage discounts applied to line items. In the currency’s smallest denomination |
UniqueVATInvoiceReferenceNumber | Tag | AN | 0 | 15 | The invoice number allocated by the merchant and appears on the merchant’s invoice given to the customer. This is an optional field is independent of the Merchant Reference. |
Procurement LineItems Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
Discount | subTag | N | 0 | 12 | The total discount for the line item in the currency's smallest denomination. |
ItemCommodityCode | subTag | N | 0 | 4 | The ISO commodity code for the line-item unit |
ItemDescriptor | subTag | N | 0 | 26 | A description for the line-item unit. |
ProductCode | subTag | AN | 0 | 12 | The merchant's code for the line-item unit. |
Quantity | subTag | N | 0 | 8 | The total number of line-item units. |
TaxRate | subTag | N | 0 | 4 | The VAT rate applicable to the line item. The value is the rate multiplied with 10000. |
Total | subTag | N | 0 | 12 | The total amount for the line item in the currency's smallest denomination. The value equals Quantity x UnitCost - Discount. |
UnitCost | subTag | N | 0 | 12 | The cost of a line-item unit in the currency's smallest denomination. |
UnitOfMeasure | subTag | AN | 0 | 12 | The measurement unit description. |
PassengerFirstName | subTag | AN | 0 | 60 | Passenger's first name. |
PassengerLastName | subTag | AN | 0 | 60 | Passenger's last name |
PassengerID | subTag | AN | 0 | 32 | ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number
|
PassengerStatus | subTag | AN | 0 | 32 | our company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as standard, gold, or platinum.
|
PassengerType | subTag | AN | 0 | 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 fields in Blue will only be used when doing CyberSource Advanced Fraud Screening. |
Airline Data
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
PassengerName | subTag | AN | 0 | 60 | Passenger's first name. |
PrimaryTicketNumber | subTag | AN | 0 | 60 |
|
FirstDepartureLocationCode | subTag | AN | 0 | 32 |
|
FirstArrivalLocationCode | subTag | AN | 0 | 32 |
|
OfficeIATANumber | subTag | AN | 0 | 32 |
|
OrderNumber |
|
|
|
|
|
PlaceOfIssue |
|
|
|
|
|
DepartureDate |
|
|
|
|
|
Note: The fields in Blue will only be used when doing CyberSource Advanced Fraud Screening. | |||||
CompleteRoute |
|
|
|
|
|
DepartureTime |
|
|
|
|
|
JourneyType |
|
|
AuthenticatedCollectionData Parameters
Parameter | Node Type | Data Type | Required/Optinal | Max Length | Description |
AccountNumber | subTag | AN | R | 19 | The account number that the payor is agreeing to allow the payee debit. |
DebtorIdentification | SubTag | AN | R | 35 | Some data to identify the payor e.g., ID Number |
DebtorIdentification | subTag | AN | R | 12 | The maximum amount that the payor is agreeing to in the smallest unit of the currency specified (eg in cents) |
Fleet Parameters
Parameter | Node Type | Data Type | Min Length | Max Length | Description |
CustomerReferenceIdentifier | Tag | AN |
| 8 | Contains two subfields and is in the format: “Type” + “Odometer Reading”.
|
Type | Private (P) or Business (B). Max Length = 1. Data Type = A | ||||
Odometer reading | Odometer reading. Max Length = 7. Data Type = N | ||||
Fleet LineItem Parameters | |||||
Quantity | Subtag | N | 0 | 8 | he total number of line item units |
QuantityDecimalPlaces | subtag | N | 0 | 4 | The number of implied decimals in the Quantity |
UnitCost | subtag | N | 0 | 10 | The cost of a line item unit in the currency's smallest denomination |
ProductCode | subTag | AN | 0 | 64 | The iVeri Product Code for the Fleet LineItem. The latest set of iVeri Fleet Product Codes can be obtained via the Inventory download command (Only use the ProductCodes with Type='Fleet'). The set at time of writing is provided here. |
| FLEET OIL | Oil | |||
FLEET SERVICE | Service | ||||
FLEET TYRES | Tyres | ||||
FLEET ACCIDENTS | Accidents | ||||
FLEET ACCESSORIES | Accessories | ||||
FLEET BRAKES | Brakes | ||||
| FLEET EXHAUSTS | Exhausts | |||
FLEET SHOCK ABSORBERS | Shock absorbers | ||||
FLEET BATTERIES | Batteries | ||||
FLEET GLASS | Glass | ||||
FLEET TRUCK STOP | Truck Stop | ||||
FLEET FORECOURT SHOP | Forecourt Shop | ||||
FLEET HOTEL EXPENSES | Hotel Expenses | ||||
FLEET TOLL GATE | Toll Gate | ||||
FLEET MISCELLANEOUS | Miscellaneous | ||||
FLEET PREMIUM | Premium Fuel | ||||
FLEET REGULAR | Regular Fuel | ||||
FLEET SASOL | Sasol Fuel | ||||
FLEET DIESEL | Diesel Fuel | ||||
FLEET UNLEADED SUPER | Unleaded Super Fuel | ||||
FLEET UNLEADED PREMIUM | Unleaded Premium Fuel | ||||
FLEET AVIATION | Aviation Fuel |