×
Menu

Moneris Payment Gateway

 
This page details the inputs, secure inputs and outputs available for the Moneris Logic Item, how to complete each field, and an external link to the Moneris integration documentation.
 
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
storeId
No (C)
n/a
Moneris provided Store ID
apiKey
No (C)
n/a
Moneris provided API Key
orderId
Yes
50 AN
Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID
custId
No
50 AN
Customer ID
amount
Yes
10 Num
Transaction amount This must contain at least 3 digits, two of which are penny values
processingCountryCode
No
2 chars
The two-character country code of the address
tType
Yes
n/a
Transaction Type: Should be set to:
 
- preauth
- auth
- refund
- token
- purchase
- capture
avsStreetNumber
No
19 AN
Cardholder street number
avsStreetName
No
19 AN
Cardholder street name
avsPostcode
No
9 AN
Cardholder street name
avsEmail
No
10 chars
The postal code
avsShipToCountry
No
2 chars
The two-character country code of the address
avsShipMethod
No
3 chars
The three-character currency for the transaction
avsMerchProdSku
No
100 chars
The amount for the transaction
avsCustPhone
No
n/a
A person's first name
billingFirst
No
30 AN
Customer first name
billingLast
No
30 AN
Customer last name
billingCompanyName
No
50 AN
Billing Address Company Name
billingAddress
No
70 AN
Billing Address Street
billingCity
No
30 AN
Billing Address City
billingProvince
No
30 AN
Billing Address Province/State
billingPostCode
No
30 AN
Billing Address Postcode
billingCountry
No
30 AN
Billing Address Country
billingPhone
No
30 AN
Billing Address Phone Number
billingFax
No
30 AN
Billing Address Fax Number
billingTax1
No
10 AN
Federal tax amount. Amount is not used for calculating total amount
billingTax2
No
10 AN
Provincial or state tax amount. Amount is not used for calculating total amount
billingTax3
No
10 AN
County, local or specialty tax amount. Amount is not used for calculating total amount
billingShipCost
No
15 AN
Shipping cost. Amount is not used for calculating total amount
shippingFirst
No
30 AN
Customer first name
shippingLast
No
30 AN
Customer last name
shippingCompanyName
No
50 AN
Customer 's company name
shippingAddress
No
70 AN
Customer's address
shippingCity
No
30 AN
Customer's city
shippingProvince
No
30 AN
Customer's province or state
shippingPostCode
No
30 AN
Customer's postal or zip code
shippingCountry
No
30 AN
Customer's country
shippingPhone
No
30 AN
Customer's phone number
shippingFax
No
30 AN
Customer's fax number
shippingTax1
No
10 AN
Federal tax amount. Amount is not used for calculating total amount
shippingTax2
No
10 AN
Provincial or state tax amount. Amount is not used for calculating total amount
shippingTax3
No
10 AN
County, local or specialty tax amount. Amount is not used for calculating total amount
shippingShipCost
No
10 AN
Shipping cost. Amount is not used for calculating total amount
customerEmail
No
60 AN
Customer email address
customerInstructions
No
100 Char
Instructions or notes
itemDesc
No
45 AN
Item name or description
itemQuan
No
5 Num
You must send a quantity > 0 or the item will not be added to the item list (i.e. minimum 1, maximum 99999
itemProdCode
No
20 AN
Item product code or SKU
itemExtAmount
No
9 Num
Must contain at least 3 digits and 2 penny values
dynamicDescriptor
No
20 AN
Merchant defined description sent on a per-transaction basis that will appear on the credit card statement
tokenNote
No
30 AN
This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile
 
(C) - If the Logic Item Store ID and API key is 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
cardExpDate
Yes
4 chars
Secure input of the card expiry - in the format MMYY
cardCvd
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
receiptId
Payment  receipt ID
referenceNum
Moneris reference number
responseCode
Transaction response code
iSO
The URL to direct the shopper to
authCode
Authorisation code from the transaction by Moneris
transTime
Time of the transaction
transDate
Date of the transaction
transType
Transaction type of the transaction which matches what was sent in on the request
complete
Whether or not the transaction is complete or not
message
Message about the transaction
transAmount
Total amount for the transaction
cardType
The result of the individual risk checks
txnNumber
Authorisation type from the transaction
timedOut
Whether or not the transaction request timed out or not
bankTotals
-
isVisaDebit
Boolean as to whether the card used is a Visa Debit or not
cvdResultCode
CV2 AVS Response Code
avsResultCode
AVS Response Code
dataKey
-
vaultSuccess
Whether or not saving a token to the vault was successful or not
paymentType
Payment type as sent in on the transaction request
customerId
Customer ID that corresponds with the one sent in on the transaction request
phoneNumber
If provided, the phone number provided on the transaction request
emailAddress
If provided, the email address provided on the transaction request
note
If provided, the tokenNote provided on the transaction request
maskedPan
A masked copy of the PAN that corresponds with the transaction
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
 
Moneris Logic Item
The Moneris Logic Item contains the following properties:
 
 
Moneris Payment Gateway
 
1

Store ID

Unique Store ID given to the client by Moneris
2

API Key

Unique API Key given to the client by Moneris

Success Result Code

3  Each gateway has its own unique selection of status codes on a request back from the gateway - for Moneris, this is: 0
 
                This must be set in order for our internal logging processes to notice that the payment has come back with the expected response.
4

Select Endpoint

   For added security the Moneris endpoints have been hardcoded into the integration.  Test or Live needs to be selected from the Environment Type drop down list, depending on the        
transaction being conducted.
Further information can be found by viewing the integration documentation:
 
The help manual was created with Dr.Explain