Moneris Payment Integration
About Moneris:
Moneris was established in December 2000 as a joint investment between RBC Royal Bank and BMO Bank of Montreal. The company is headquartered in Toronto, Ontario. Moneris’ U.S. operations (formerly known as Harris Bank Merchant Services/The Charge-It-System) are based in Schaumburg, Illinois.
Moneris processes more than 3 billion transactions a year for over 350,000 merchant locations, and employs more than 1,900 people across North America.
Implemented Features:
| Feature | Level of Support |
|---|
| Auth | Implemented |
| Sale (Auth+Capture) | Implemented |
| Capture | Implemented |
| Void | Implemented |
| Credit | Implemented |
| Gateway Tokenization | Implemented |
| Credentials on File | Implemented |
Authentication and Security Credentials:
Supported Parameters:
| Key Name | Format | Mandatory | Descriptions |
|---|
| apiVersion | Numerical | Required | “1.0.1” |
| apiType | Alphabetical | Required | “pxyhpci” |
| userName | Alphanumeric | Required | API Username |
| userPassKey | Alphanumeric | Required | API PassKey |
| pxyCreditCard.creditCardNumber | Numerical | Required | HostedPCI Token Representing Credit Card |
| pxy.CreditCard.cardCodeVerification | Numerical | Optional | HostedPCI Token Representing CVV Code |
| pxyCreditCard.expirationMonth | Numerical | Required | Expiration month with 2 digits for example, for December use “12” |
| pxyCreditCard.expirationYear | Numerical | Required | Expiration year with 4 digits for example, for 2025, use “2025” |
| pxyTransaction.txnCurISO | Alphabetical | Required | 3 letter ISO Currency Code for example, “USD” or “CAD” |
| pxyTransaction.txnAmount | Numerical | Required | Amount to Authorize, for example for $10.50 use 10.50 |
| pxyTransaction.merchantRefId | Numerical | Required | Merchant reference number can be order id or invoice id |
| pxyTransaction.txnPayName | Alphanumeric | Required | HostedPCI payment profile name, for example “DEF” |
| pxyTransaction.txnComment | Alphabetical | Optional | Short comment |
| pxyCustomerInfo.email | Alphanumeric | Optional | Customer’s Email Address |
| pxyCustomerInfo.customerIP | Numerical | Optional | Customer’s IP Address |
| pxyCustomerInfo.billingLocation.firstName | Alphabetical | Optional | Customer’s First Name |
| pxyCustomerInfo.billingLocation.lastName | Alphabetical | Optional | Customer’s Last Name |
| pxyCustomerInfo.billingLocation.phoneNumber | Numerical | Optional | Billing Phone Number |
| pxyCustomerInfo.billingLocation.companyName | Alphanumeric | Optional | Billing Company Name |
| pxyCustomerInfo.billingLocation.address | Alphanumeric | Optional | Customer’s Billing Address |
| pxyCustomerInfo.billingLocation.city | Alphabetical | Optional | Customer’s Billing City |
| pxyCustomerInfo.billingLocation.state | Alphabetical | Optional | Customer’s Billing State or Province |
| pxyCustomerInfo.billingLocation.zipCode | Numerical | Optional | Customer’s Billing Zip Code or Postal Code |
| pxyCustomerInfo.billingLocation.country | Alphabetical | Optional | Customer’s Billing Country |
| pxyCustomerInfo.billingLocation.tax1 | Numerical | Optional | Billing Tax 1 |
| pxyCustomerInfo.billingLocation.tax2 | Numercial | Optional | Billing Tax 2 |
| pxyCustomerInfo.billingLocation.tax3 | Numerical | Optional | Billing Tax 3 |
| pxyCustomerInfo.shippingLocation.firstName | Alphabetical | Optional | Customer’s First Name for Shipping |
| pxyCustomerInfo.shippingLocation.lastName | Alphabetical | Optional | Customer’s Last Name for Shipping |
| pxyCustomerInfo.shippingLocation.phoneNumber | Numerical | Optional | Shipping Phone Number |
| pxyCustomerInfo.shippingLocation.fax | Numerical | Optional | Shipping Fax Phone Number |
| pxyCustomerInfo.shippingLocation.companyName | Alphanumeric | Optional | Shipping Company Name |
| pxyCustomerInfo.shippingLocation.address | Alphanumeric | Optional | Customer’s Shipping Address |
| pxyCustomerInfo.shippingLocation.address2 | Alphanumeric | Optional | Secondary Shipping Address |
| pxyCustomerInfo.shippingLocation.city | Alphabetical | Optional | Customer’s Shipping City |
| pxyCustomerInfo.shippingLocation.state | Alphabetical | Optional | Customer’s Shipping State or Province |
| pxyCustomerInfo.shippingLocation.zipCode | Alphabetical | Optional | Customer’s Shipping Zip Code or Postal Code |
| pxyCustomerInfo.shippingLocation.country | Alphabetical | Optional | Customer’s Shipping Country |
| pxyCustomerInfo.shippingLocation.tax1 | Numerical | Optional | Shipping Tax 1 |
| pxyCustomerInfo.shippingLocation.tax2 | Numerical | Optional | Shipping Tax 2 |
| pxyCustomerInfo.shippingLocation.tax3 | Numerical | Optional | Shipping Tax 3 |
| pxyCustomerInfo.billingLocation.fax | Numerical | Optional | Billing Fax Phone Number |
API Endpoint URL:
https://[HPCI_API_HOSTENAME]/iSynSApp/paymentAuth.action
API Request Body:
apiVersion=1.0.1&apiType=pxyhpci&userName=[APIuserName]&userPassKey=[APIPassKey]&pxyCreditCard.creditCardNumber=[CreditCardToken]&pxyCreditCard.cardCodeVerification=[CVVToken]&pxyCreditCard.expirationMonth=[ExpiryMonth]&pxyCreditCard.expirationYear=[ExpiryYear]&pxyTransaction.txnCurISO=[Currency]&pxyTransaction.txnAmount=[Amount]&pxyTransaction.merchantRefId=[UniqueMerchantRefID]&pxyTransaction.txnPayName=[ProfileName]&pxyTransaction.txnComment=[ShortComment]&pxyCustomerInfo.billingLocation.firstName=[CustomerFirstName]&pxyCustomerInfo.billingLocation.lastName=[CustomerLastName]&pxyCustomerInfo.billingLocation.address=[BillingStreetAddress]&pxyCustomerInfo.billingLocation.city=[BillingCity]&pxyCustomerInfo.billingLocation.state=[State/Province]&pxyCustomerInfo.billingLocation.zipCode=[ZipCode/PostalCode]&pxyCustomerInfo.billingLocation.country=[Country]&pxyCustomerInfo.shippingLocation.firstName=[ShippingFirstName]&pxyCustomerInfo.shippingLocation.lastName=[ShippingLastName]&pxyCustomerInfo.shippingLocation.address=[ShippingStreetAddress]&pxyCustomerInfo.shippingLocation.city=[ShippingCity]&pxyCustomerInfo.shippingLocation.state=[ShippingState/Province]&pxyCustomerInfo.shippingLocation.zipCode=[ShippingZipCode/PostalCode]&pxyCustomerInfo.shippingLocation.country=[ShippingCountry]
Moneris Gateway Tokenization
Parameters Required for Gateway Tokenization:
| PARAMETERS | VALUE |
|---|
| pxyCreditCard.creditCardNumber | [HostedPCI Token] |
| pxyCreditCard.cardCodeVerification | [HostedPCI CVV place holder] |
| pxyCreditCard.expirationMonth | [Credit Card expire month] |
| pxyCreditCard.expirationYear | [Credit Card expire year] |
| pxyTransaction.txnPayName | [Profile Name provided by HostedPCI] |
| pxyCustomerInfo.billingLocation.firstName | [Client’s first name as it appears on the card] |
| pxyCustomerInfo.billingLocation.lastName | [Client’s last name as it appears on the card] |
Additional Parameters Required for dLocal Gateway Tokenization:
| PARAMETERS | VALUE |
|---|
| pxyTransaction.txnCurISO | [currency ISO] |
Moneris Gateway Tokenization API Call:
Request:
pxyCreditCard.creditCardNumber=4444000015201111&apiVersion=1.0.1&userPassKey=[APIPasskey]&pxyCreditCard.expirationMonth=09&pxyCreditCard.expirationYear=2022&pxyCustomerInfo.billingLocation.lastName=Customer&pxyCustomerInfo.billingLocation.firstName=Test&userName=[APIUsername]&pxyCreditCard.cardCodeVerification=200&pxyTransaction.txnPayName=DEF_MONERIS&pxyTransaction.txnCurISO=CAD&apiType=pxyhpci
Response:
status=success&operId=&tokenId=583735146&mappedCC=4444000015201111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=null&pxyResponse.processorType=monResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=O2Z5Pwl37s2Aw5xMIg1d4ijU1&pxyResponse.responseAVS1=null&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=Successfully+registered+CC+details.&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=null&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=txnResponse.complete%3Dtrue%26txnResponse.txnNumber%3Dnull%26txnResponse.referenceNum%3Dnull%26txnResponse.responseCode%3D001%26txnResponse.avsResultCode%3Dnull%26txnResponse.recurSuccess%3Dnull%26txnResponse.transType%3Dnull%26txnResponse.transDate%3D2020-11-13%26txnResponse.receiptId%3Dnull%26txnResponse.authCode%3Dnull%26txnResponse.timedOut%3Dfalse%26txnResponse.corporateCard%3Dnull%26txnResponse.message%3DSuccessfully%2Bregistered%2BCC%2Bdetails.%26txnResponse.cvdResultCode%3Dnull%26txnResponse.resSuccess%3Dtrue%26txnResponse.transTime%3D13%253A41%253A30&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_MONERIS&pxyResponse.responseStatus.code=001&pxyResponse.threeDSSRS=
Moneris Credentials on File
Required COF Parameters
| PARAMETERS | VALUES |
|---|
| pxyTransaction.cardOnFileTxnRef | [0 /1] – 1 for MIT transaction |
| pxyCustomerInfo.profileAction | [add] |
| pxyTransaction.txnRecurringFlag | [MIT] |
| pxyTransaction.cardOnFileTxnType | [C/U] – CIT or Unscheduled MIT |
| pxyTransaction.cardOnFileIssuerId | [cardOnFile Issuer ID] |
Moneris COF API Call:
Request:
pxyOrderItem.itemName=item1&pxyTransaction.cardOnFileTxnType=U&pxyCreditCard.creditCardNumber=4111110003701111&pxyCustomerInfo.billingLocation.city=Toronto&userPassKey=[APIUserPasskey]&pxyTransaction.txnAmount=22.21&pxyTransaction.cardOnFileIssuerId=659513169360936&pxyTransaction.txnPayName=DEF_MONERIS&pxyTransaction.txnRecurringFlag=MIT&apiVersion=1.0.1&pxyOrderItem.itemQuantity=1&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.billingLocation.firstName=Test&pxyCustomerInfo.billingLocation.state=ON&pxyCustomerInfo.billingLocation.country=CAN&pxyOrderItem.itemDescription=Product 1&pxyTransaction.merchantProductName=productName&pxyCreditCard.expirationMonth=09&pxyCustomerInfo.customerId=L1232112121142&userName=[APIUsername]&pxyTransaction.txnCurISO=USD&pxyCustomerInfo.billingLocation.zipCode=M7H6G5&pxyCustomerInfo.email=null@email.com&pxyCreditCard.cardType=visa&pxyTransaction.cardOnFileTxnRef=1&pxyCreditCard.expirationYear=2022&pxyCustomerInfo.billingLocation.lastName=Customer&pxyCustomerInfo.billingLocation.address=12596 West Bayaud Ave&apiType=pxyhpci&pxyTransaction.merchantRefId=1244-9879.92333009884
Response:
status=success&operId=&saleId=53626&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=420538-0_16&pxyResponse.processorType=monResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=886213234948766&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=&pxyResponse.responseAVS1=null&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=APPROVED+++++++++++*++++++++++++++++++++%3D&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=txnResponse.complete%3Dtrue%26txnResponse.txnNumber%3D420538-0_16%26txnResponse.referenceNum%3D660148420010042660%26txnResponse.responseCode%3D027%26txnResponse.avsResultCode%3Dnull%26txnResponse.iso%3D01%26txnResponse.recurSuccess%3D%26txnResponse.transType%3D00%26txnResponse.cardType%3DV%26txnResponse.transDate%3D2020-11-20%26txnResponse.receiptId%3D1244-9879.92333009884%26txnResponse.authCode%3D163387%26txnResponse.timedOut%3Dfalse%26txnResponse.ticket%3Dnull%26txnResponse.corporateCard%3Dfalse%26txnResponse.message%3DAPPROVED%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B*%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%2B%253D%26txnResponse.cvdResultCode%3D%26txnResponse.transAmount%3D22.21%26txnResponse.messageId%3D%26txnResponse.transTime%3D11%253A11%253A41&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_MONERIS&pxyResponse.responseStatus.code=027&pxyResponse.threeDSSRS=