Parameter description

AcquirerCode

O

O

O

O

O

The Acquirer ISO code returned for this transaction.  Note that the success or failure of this transaction MUST be determined by the Result Code and NOT by the AcquirerCode nor the AcquirerDescription.  This is only made available as extra information and may not exist in all response.

AcquirerDescription

O

O

O

O

O

The Acquirer ISO description returned for this transaction.  Note that the success or failure of this transaction MUST be determined by the Result Code and NOT by the AcquirerCode nor the AcquirerDescription.  This is only made available as extra information and may not exist in all response.

AcquirerReference

O

O

O

The unique reference number allocated by the Acquirer to this transaction. A composite element whose format is dependent on the particular acquirer to which this transaction was routed.  The contents of this can, in some cases, be used to group transactions together to arrive at the total amount of money that should be deposited into the merchants bank account per settlement period and card type. See Appendix F - Reconciliation

Amount

M

E

M

E

M

E

The total value of the transaction in the smallest unit of the currency specified. E.g.  $10.01 meaning ten dollars and one cent would be submitted as 1001.  Note that this value includes any cashback portion that may be set so if the sale is for $10.00 and the cardholder wants cashback of $5.00 then the value set in this field would be $15.00 which without the decimal would be 1500.

ApplicationIdentifier

O

O

O

EMV Tag 9F06 (AID)

ApplicationLabel

O

O

O

EMV Tag 50

AuthorisationCode

O

O

O

The Authorisation Code issued by the Issuer to the Merchant and may be viewed by the merchant as a guarantee of funds for a limited period of time.

BudgetPeriod

O

E

O

E

The number of months over which the carholder wishes to pay off the total amount to the issuing bank.  This should be one of the following values [1|3|6|12|18|24|36].  If a value is submitted which the issuer does not support, it is likely that the Issuer will default the request to no budget period.

CardAcceptorID

O

O

O

The cardacceptorid assigned to this merchant at the acquirer.  Commonly referred to as the merchantid

CardholderName

O

O

O

The name of the Cardholder obtained from Track1 if available.

CardholderVerificationMethod

O

O

O

EMV Tag 9F34 (CVM)

CashAmount

O

E

The portion of the total value that is to be dispensed to the cardholder as cash.  This is often referred to as a cashback transaction. This is also in the smallest unit of the currency specified.

Code

M

M

M

M

M

M

M

The numeric Result Code of the completed execution.  Note that Code is contained within the Result node i.e. it is one level below the other data items described in this list.    The “Cancel” command is unique in that the only indication of success is to query the HTTP Status which will return a 200 if the “Cancel” command was successful.

Command

M

E

M

E

M

E

M

E

M

E

M

E

M

M

E

M

E

Authorisation, Debit, Credit, AuthorisationReversal, Void, GetData, Cancel, GetHMAC, GetSystemInfo

ConnectedSince

M

The date and time at which a connection from the device was established or, in the case of gateway, the date and time of the last change of status.  This can be used to determine how long the gateway has been up or down relative to the current time.  In the case of a device it can be used to determine how long the current connection has been up.

CryptogramInformationData

O

O

O

EMV Tag 9F27 (CID)

Currency

O

O

O

O

The currency that a transaction must be processed in.  This must be indicated with the Alpha currency code e.g USD or ZAR to indicate US Dollar or South African Rand.  This will be validated against the set of allowed currencies for a merchant.  Once a currency has been set, all related transactions MUST use the same currency.  If this is not set then the default currency for the mechant will be used for the transaction.

Data

O

The value as returned by the device. This parameter will be returned in response to a GetData command request.

Description

M

M

M

M

M

M

M

A description of the results of the completed execution. Only relevant where Code is not a 0 which indicates a approved transaction. Note that Description is contained within the Result node i.e. it is one level below the other data items described in this list.

DeviceSerialNumber

M

E

M

E

M

E

M

E

M

E

M

E

M

M

E

O

The serial number of the device (terminal) that is printed on the reverse of the device.  It is assumed that the mapping of the POS Till at which the customer interaction is taking place and the nearest device that will be used to perform the transaction is kept and maintained on the POS Till or Server.  This is an optional parameter to GetSystemInfo and, if set to “”, will return information on all connected devices.  If set to an actual DeviceSerialNumber it will only return information for the specific device as well as the gateway information.

DisplayAmount

O

O

O

A correctly formatted version of the Amount as far a currency symbol and number of decimal places.

DisplayCashAmount

O

O

O

A correctly formatted version of the CashAmount as far a currency symbol and number of decimal places.

GatewayDNS

M

The currently configured gateway DNS or IP address on the Indigo server.

HMAC

O

O

The HMAC of the PAN of the card presented for payment.

LastTransactionEnd

M

The date and time at the end of the last transaction processed on a specific connection from a device.  Aside from being useful to calculate the elapsed time since a transaction was last processed on a specific device this is useful for working out how long transactions are taking.

LastTransactionStart

M

The date and time at the start of the last transaction processed on a specific connection from a device.  This, used in conjunction with the LastTransactionEnd, can be used to work out how long the user experience is taking.  Note that this includes all the time from the time a cardholder is prompted to start a transaction to the time that it is finally completed including time taken to enter the PIN, choose an account, choose a budget period etc.

Latency

M

In the case of a device, this is the time in milliseconds that it takes to obtain the date and time from the device.  This latency is updated at the start of each transaction and is not to be confused with a network ping latency.  In the case of gateway this is the time in milliseconds for the “Ping” command to obtain a response from the configured gateway. Again, this isn’t to be confused with a network ping latency.

MerchantName

O

O

O

The name fo the merchant that should appear on the cardholder’s statement.

MerchantReference

M

E

M

E

M

E

O

E

O

E

A merchant generated identifier that is unique within a specified time period that identifies a transaction.  The same MerchantReference can be used throughout the lifecycle of a transaction e.g. the same value used for Authorisation, then the Debit relating to the Authorisation and then the Credit relating to the Debit is accepted.

MerchantTrace

O

M

M

Unique merchant identification for the request generated by and returned by the Indigo Server.

OriginalMerchantTrace

O

E

O

E

O

E

The MerchantTrace returned in a previously executed transaction that the merchant wants to do a follow-up on. For a follow-up transaction the use or OriginalMerchantTrace is mandated however, for a “Void”, Indigo uses two methods to lookup a previous, related transaction.  It first tries to use OriginalMerchantTrace and if that is unsuccessful or OriginalMerchantTrace is missing, then it will attempt to lookup the data based on MerchantReference.  At least one of these two data elements MUST be present in the “Void” message in order for Indigo to find the related transaction.

PAN

M

M

M

Primary Account Number (eg Credit card number), may have been extracted from Track2. When this is an output parameter it will have been sanitized and is safe to display, store and print.

PANSequenceNumber

O

O

O

EMV Tag 5F34 (PSN)

Product

M

M

M

The name of the channel responding to this request within Indigo.

Prompts

M

The index of the Prompt to display on the device. This parameter is required when the command is GetData. The list of valid values is contained in Appendix A.  This is a JSON array of prompts in the format ["05","4D"] indicating display prompt “05” on line 1 and “4D” on line 2.

SignatureRequired

O

O

O

Determines if a signature panel must be printed on the merchant receipt for this transaction. The value returned in this field will be either “True” or “False”

SocketAddress

M

The IP address and port from which the device established the connection.

Status

M

A textual description of the state of the device/gateway at the time of the call to GetSystemInfo.  In the DeviceInfo section this will be the status of a device.  In the case of the GatewayInfo section this indicates whether communications to the gateway is up or down.

Terminal

O

E

O

E

O

E

Used to group transactions together for reporting purposes independently of the physical device (DeviceSerialNumber) at which a transaction was actually processed.

TerminalVerificationResult

O

O

O

EMV Tag 95 (TVR)

TransactionCertificate

O

O

O

EMV Tag 98 (TC)

TransactionDateTime

O

O

O

The date and time as determined by the acquirer for this transaction in “YYYY-MM-DD HH:MM: SS” formatted local time.

TransactionIndex

O

O

O

Unique identifier generated on the iVeri Gateway and allocated for a series (Authorisation, Debit and Credit) of related legs of a transaction.  This can be used as the UTI (Unique Transaction Indicator) required to be printed on receipts.

Transactions

M

The number of transactions that have been processed on the device in question since the device last connected to the Indigo server.

TransactionStatusInformation

O

O

O

EMV Tag 9B (TSI)

TransactionTypeDescription

O

O

O

A cardholder/merchant friendly version of Command + CashAmount that describes the transaction being performed e.g. Sale, Refund, Authorisaction, Sale with Cashback etc.

Version

M

M

M

M

The version of the Indigo software responding to this request in the case of a Transaction being processed.  In the case of GetSystemInfo this is the Make, Model and version of the software running on the device.