(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
MiraPay Gateway (Eigen)
This page details the inputs, secure inputs and outputs available for the MiraPay Logic Item, and how to complete each field.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Input
Description
terminalId
No (C)*
n/a
Reference ID of the payment
hashKey
No (C)*
n/a
The name of the card holder
amount
Y
This is the amount of the transaction. Please note that this amount is not signed, i.e. if it’s a return, the number will be positive and the system will know it is by the Transaction Code. The amount field should be sent as cents (i.e. $10.00 should be sent as 1000 with no decimal)
transactionCode
Y
2 Num
The Transaction Code indicates the type of credit transaction that is to be performed. Please keep in mind that the transaction code used may have to be coordinated with Eigen and the processor. The values are:
- 4/04 - Refund
- 69 - Tokenise
- 11 - Auth
- 12 - Capture
invoiceNumber
Y
n/a
The Invoice Number is a field that is used by the input provider to uniquely identify a transaction, using their own numbering system. This may be a waybill number, an invoice number, a tracking number, or may, in fact, be an indication to the customer such as, city and/or location that the purchase was made. It is used by the chargeback system and will be displayed on the online reports
operatorId
Y
n/a
The Operator ID of the cashier that is responsible for the transaction. This field is for information and reporting purposes only
extOperatorId
Y
n/a
The External Operator ID of the cashier that is responsible for the transaction. This field is for information and reporting purposes only
echoData
Y
n/a
This is a general free format field that is used by the POS application when it requires data be echoed back to it. The Eigen API and switches will return this data unaltered in the response. It is typically used for linking a request back to internal primary keys, such as internal customer identifiers
accountType
Y
n/a
This field is required if Merchants are processing with US Merchant account through BCE/CT Payments. The content of this field is BE. This field should only be used for US dollar transactions. If the merchant also processes Canadian dollar transactions, this field should not be used for the Canadian dollar transactions
statementDescription
Y
Y or N
This field should be set to ‘Y’ if the Merchant wishes to send a customized message to the Financial Institutions for the cardholder Statement text.
If set, the first 20 characters of the EchoData Field (ED) will be sent as the customized message and will appear on the customer’s credit card statement. The data in the ED field must be all capitalized and contain no spaces, only slashes (/), dashes (-), or periods (.) are allowed
addressLine1
Y
n/a
This is the address of the card holder. This field is used for the Address Verification System. If this field is populated the address will be checked against the address of the card holder registered at the issuing bank
zip
Y
9 AN
This is the Zip code or Postal Code of the card holder. This field is used for Address Verification purposes. It is submitted with no spaces
transactionHandle
Y
n/a
Note that this legacy field is included here for migration purposes. It is preferable to use either the Token or Short Token fields instead
* (C) Conditional - if the Logic Item fields are not filled in, this will be required.
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
cardNumber
Yes
19 chars
Secure input of the card number
cardExpiryDate
Yes
4 chars
Secure input of the card expiry - in the format MMYY
cardSecurityCode
Yes
3 or 4 chars
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
MsgType
The message type determines the function of the message. It is a single character field that is one of the following:
Q - Request
R - Response
Id
Transaction ID
TransCounter
This counter is an internal audit counter and must be placed on the receipt
Date
This is the date and time that the transaction was processed on in the format, YYYYMMDDHHMMSS. The time section will be displayed using a 24-hour clock. This field must be placed on the receipt
ApprovalCode
The output record’s Approval Code is the approval code that Eigen received for the transaction. Upon output, the Approval Code is a number that may be referenced in the future, that identifies the response from the financial institution. Depending on the processor, the Approval Code may be padded with spaces to 8 characters
RspCode
This field is populated with a numeric value indicating the Response Code returned on the Credit Card transaction
IsoRspCode
This is a two digit international version of the response code field. It must be placed on the receipt for all debit and credit transactions
ReceiptMsg
This is the description of the account that the transaction was made against and must be placed on the receipt
OpMsg
This is the message in the response from the Eigen Financial Transaction Switches that should be displayed for the operator
DisplayMsg
This is the message that should be displayed on the POS customer’s display. It should be visible to the end consumer and unobstructed (if the customer processed the transaction through a pinpad)
Approved
This is a single character field that will normally contain either a ‘Y’ or ‘N’ indicating whether or not the transaction was approved. This field may be used internally by the POS application and does not have to be placed on the receipt
TerminalId
When the user inputs credit transactions to the Eigen Processing system, they must be attached to a specific Terminal ID. Eigen assigns the Terminal ID when the service is subscribed to and is done in coordination with the bank
EchoData
This is a general free format field that is used by the POS application when it requires data be echoed back to it. The Eigen API and switches will return this data unaltered in the response. It is typically used for linking a request back to internal primary keys, such as internal customer identifiers
ReceiptRefNumber
This is a receipt reference number utilized for the purposes of auditing and must be placed on the receipt. This field may be blank for US$ transactions
ReceiptMsgAccount
This is the description of the account that the transaction was made against and must be placed on the receip
CardType
This field indicates the card type that was used for the transaction.
InvoiceNumber
The Invoice Number is a field that is used by the input provider to uniquely identify a transaction, using their own numbering system. This may be a waybill number, an invoice number, a tracking number, or may, in fact, be an indication to the customer such as, city and/or location that the purchase was made. It is used by the chargeback system and will be displayed on the online reports
CvvRsp
This is the 1 digit alphanumeric response to the Credit Card Verification Value. Values could be:
M – Match
N – Did not match
P – CVV was passed but was not processed
U – Issuer does not participate
S - CVV should be present on the card, but merchant did not send
In rare cases, the CVV_Response can be blank
AvsCode
This is the response code from the issuing bank on the Address Verification of the card holder’s address
A – Address matches, postal code does not
B - Street address matches, but postal code not verified
C - Street address and postal code do not match
D - Street address and postal code match. Code "M" is equivalent
E – The transaction was either not eligible for address verification or an error occurred while attempting to process the message
G – Non-AVS participant outside U.S.; address not verified for international transaction (Visa Only)
M - Street address and postal code match. Code "D" is equivalent
N – Neither address nor postal code matches
R – Retry, system unable to process
S – AVS currently not supported
U – No data from issuer/Authorization system
W – For U.S. address, nine-digit postal code matches, address does not; for address outside U.S.; postal code matches, address does not
X – For U.S. addresses, all digits match, nine-digit postal code; for address outside U.S. postal code and address match
Y – All digits match, five-digit postal code
Z – Five-digit postal code matches, address does not
Blank – Address verification information was not included in the transactions
0 – Address verification information was included in the transaction, but was not verified
AvsMsg
This is the message from the issuing bank on the Address Verification of the card holder’s address
ShortToken
This is the short 19-digit token obtained from Eigen's Hosted or API solutions. When this is used, do not send the T2 (Track2) field. When processing a transaction request using the Short Token, you will also need to include the EX (Expiration Date) field
Token
This is the token obtained from Eigen's Hosted or API solutions. When TK is used, please do not use the T2 (Track2) field
errorMessage
PCI Pal Specific Error Message. If anything goes wrong in the sending of a request, our internal error handling will respond with a message on the output of the flow
MiraPay Logic Item
The MiraPay Logic Item contains the following properties:
Terminal ID
Terminal ID provided by MiraPay unique to the client.
For added security the MiraPay endpoints have been hardcoded into the integration. Test or Live needs to be selected from the Select Endpoint drop down list, depending on the transaction being conducted.
