My Unified API Guide PHP V1.2.5
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 480
| Download | |
| Open PDF In Browser | View PDF |
Moneris Gateway API - Integration Guide – PHP
Version: 1.2.5
Copyright © Moneris Solutions, 2019
All rights reserved. No part of this publication may be reproduced,
stored in retrieval systems, or transmitted, in any form or by any means,
electronic, mechanical, photocopying, recording, or otherwise, without
the prior written permission of Moneris Solutions Corporation.
Moneris Gateway API - Integration Guide
Security and Compliance
Your solution may be required to demonstrate compliance with the card associations’ PCI/CISP/PABP
requirements. For more information on how to make your application PCI-DSS compliant, contact the
Moneris Sales Center and visit https://developer.moneris.com to download the PCI_DSS Implementation Guide.
All Merchants and Service Providers that store, process, or transmit cardholder data must comply with
PCI DSS and the Card Association Compliance Programs. However, certification requirements vary by
business and are contingent upon your "Merchant Level" or "Service Provider Level".
The card association has some data security standards that define specific requirements for all organizations that store, process, or transmit cardholder data. As a Moneris client or partner using this
method of integration, your solution must demonstrate compliance to the Payment Card Industry Data
Security Standard (PCI DSS) and/or the Payment Application Data Security Standard (PA DSS). These
standards are designed to help the cardholders and merchants in such ways as they ensure credit card
numbers are encrypted when transmitted/stored in a database and that merchants have strong access
control measures.
Non-compliant solutions may prevent merchant boarding with Moneris. A non-compliant merchant can
also be subject to fines, fees, assessments or termination of processing services.
For further information on PCI DSS & PA DSS requirements, visit http://www.pcisecuritystandards.org.
Confidentiality
You have a responsibility to protect cardholder and merchant related confidential account information.
Under no circumstances should ANY confidential information be sent via email while attempting to diagnose integration or production issues. When sending sample files or code for analysis by Moneris staff,
all references to valid card numbers, merchant accounts and transaction tokens should be removed and
or obscured. Under no circumstances should live cardholder accounts be used in the test environment.
April 2019
Moneris Gateway API - Integration Guide
Changes in v1.2.5
Purchase transaction amended to include Customer ID variable
Previous version changes
Changes in v1.2.4
Changes limits in Amount, Transaction Amount, Completion Amount request variables to reflect 10
decimals.
Changes in v1.2.3
This version adds information about passing Offlinx™ data for the Card Match pixel tag via Unified
API transactions.
April 2019
Table of Contents
Security and Compliance
Confidentiality
2
2
Changes in v1.2.5
3
1 About This Documentation
1.1 Purpose
Getting Help
1.2 Who Is This Guide For?
1.3 Adding cURL CA Root Certificate to PHP API
10
10
10
11
11
2 Basic Transaction Set
2.1 Purchase
2.2 Pre-Authorization
2.3 Pre-Authorization Completion
2.4 Re-Authorization
2.5 Force Post
2.6 Purchase Correction
2.7 Refund
2.8 Independent Refund
2.9 Card Verification with AVS and CVD
2.10 Batch Close
2.11 Open Totals
12
13
18
23
26
28
31
33
35
37
41
43
3 Credential on File
3.1 About Credential on File
3.2 Credential on File Info Object and Variables
3.3 Credential on File Transaction Types
3.4 Initial Transactions in Credential on File
3.5 Vault Tokenize Credit Card and Credential on File
3.6 Credential on File and Converting Temporary Tokens
3.7 Card Verification and Credential on File Transactions
3.7.1 When to Use Card Verification With COF
3.7.2 Credential on File and Vault Add Token
3.7.3 Credential on File and Vault Update Credit Card
3.7.4 Credential on File and Vault Add Credit Card
3.7.5 Credential on File and Recurring Billing
45
45
45
46
46
47
47
47
47
48
48
48
49
4 Vault
4.1 About the Vault Transaction Set
4.2 Vault Transaction Types
4.2.1 Administrative Vault Transaction types
4.2.2 Financial Vault Transaction types
4.3 Vault Administrative Transactions
4.3.1 Vault Add Credit Card – ResAddCC
4.3.1.1 Vault Data Key
4.3.1.2 Vault Encrypted Add Credit Card – EncResAddCC
4.3.2 Vault Temporary Token Add – ResTempAdd
4.3.3 Vault Update Credit Card – ResUpdateCC
4.3.3.1 Vault Encrypted Update CC - EncResUpdateCC
4.3.4 Vault Delete - ResDelete
4.3.5 Vault Lookup Full - ResLookupFull
4.3.6 Vault Lookup Masked – ResLookupMasked
4.3.7 Vault Get Expiring – ResGetExpiring
50
50
50
50
52
52
52
56
56
59
61
65
68
69
71
73
4.3.8 Vault Is Corporate Card - ResIscorporateCard
4.3.9 Vault Add Token – ResAddToken
4.3.10 Vault Tokenize Credit Card – ResTokenizeCC
4.4 Vault Financial Transactions
4.4.1 Customer ID Changes
4.4.2 Purchase with Vault – ResPurchaseCC
4.4.3 Pre-Authorization with Vault – ResPreauthCC
4.4.4 Vault Independent Refund CC - ResIndRefundCC
4.4.5 Force Post with Vault - ResForcePostCC
4.4.6 Card Verification with Vault – ResCardVerificationCC
4.5 Hosted Tokenization
74
76
79
83
84
84
89
93
96
98
102
5 INTERAC® Online Payment
5.1 About INTERAC® Online Payment Transactions
5.2 Other Documents and References
5.3 Website and Certification Requirements
5.3.1 Things to provide to Moneris
5.3.2 Certification process
5.3.3 Client Requirements
5.3.4 Delays
5.4 Transaction Flow for INTERAC® Online Payment
5.5 Sending an INTERAC® Online Payment Purchase Transaction
5.5.1 Fund-Guarantee Request
5.5.2 Online Banking Response and Fund-Confirmation Request
5.6 INTERAC® Online Payment Purchase
5.7 INTERAC® Online Payment Refund
5.8 INTERAC® Online Payment Field Definitions
103
103
103
104
104
104
105
105
106
107
107
108
108
110
112
6 Mag Swipe Transaction Set
6.1 Mag Swipe Transaction Type Definitions
6.1.1 Encrypted Mag Swipe Transactions
6.2 Mag Swipe Purchase
6.2.1 Encrypted Mag Swipe Purchase
6.3 Mag Swipe Pre-Authorization
6.3.1 Encrypted Mag Swipe Pre-Authorization
6.4 Mag Swipe Completion
6.5 Mag Swipe Force Post
6.5.1 Encrypted Mag Swipe Force Post
6.6 Mag Swipe Purchase Correction
6.7 Mag Swipe Refund
6.8 Mag Swipe Independent Refund
6.8.1 Encrypted Mag Swipe Independent Refund
116
116
117
117
120
122
124
126
128
131
133
135
137
139
7 Level 2/3 Transactions
7.1 About Level 2/3 Transactions
7.2 Level 2/3 Visa Transactions
7.2.1 Level 2/3 Transaction Types for Visa
7.2.2 Level 2/3 Transaction Flow for Visa
7.2.3 VS Completion
7.2.4 VS Purchase Correction
7.2.5 VS Force Post
7.2.6 VS Refund
7.2.7 VS Independent Refund
7.2.8 VS Corpais
7.2.8.1 VS Purcha - Corporate Card Common Data
7.2.8.2 VS Purchl - Line Item Details
7.2.8.3 Sample Code for VS Corpais
143
143
143
143
146
148
152
154
159
163
168
169
174
177
7.3 Level 2/3 MasterCard Transactions
7.3.1 Level 2/3 Transaction Types for MasterCard
7.3.2 Level 2/3 Transaction Flow for MasterCard
7.3.3 MC Completion
7.3.4 MC Force Post
7.3.5 MC Purchase Correction
7.3.6 MC Refund
7.3.7 MC Independent Refund
7.3.8 MC Corpais - Corporate Card Common Data with Line Item Details
7.3.8.1 MC Corpac - Corporate Card Common Data
7.3.8.2 MC Corpal - Line Item Details
7.3.8.3 Tax Array Object - MC Corpais
7.3.8.4 Sample Code for MC Corpais
7.4 Level 2/3 American Express Transactions
7.4.1 Level 2/3 Transaction Types for Amex
7.4.2 Level 2/3 Transaction Flow for Amex
7.4.3 Level 2/3 Data Objects in Amex
7.4.3.1 About the Level 2/3 Data Objects for Amex
7.4.3.2 Defining the AxLevel23 Object
Table 1 Object
Table 1 - Setting the N1Loop Object
Table 1 - Setting the AxRef Object
216
Table 2 Object
Table 2 - Setting the AxIt1Loop Object
217
218
Table 2 - Setting the AxIt106s Object
220
Table 2 - Setting the AxTxi Object
221
Table 3 Object
Table 3 - Setting the AxTxi Object
225
226
7.4.4
7.4.5
7.4.6
7.4.7
7.4.8
8 MPI
8.1
8.2
8.3
8.4
8.5
8.6
179
179
181
183
184
187
188
190
192
194
201
204
206
209
209
211
212
212
212
213
214
AX Completion
AX Force Post
AX Purchase Correction
AX Refund
AX Independent Refund
About MPI Transactions
3-D Secure Implementations (VbV, MCSC, SafeKey)
Activating 3-D Secure Functionality
Activating Amex SafeKey
Transaction Flow for MPI
MPI Transactions
8.6.1 VbV, MCSC and SafeKey Responses
8.6.2 MpiTxn Request Transaction
8.6.2.1 TXN Response and Creating the Popup
8.6.3 Vault MPI Transaction – ResMpiTxn
8.6.4 MPI ACS Request
8.6.4.1 ACS Response and Forming a Transaction
8.6.5 Purchase with 3-D Secure – cavv_purchase
8.6.5.1 Purchase with 3-D Secure and Recurring Billing
8.6.6 Pre-Authorization with 3-D Secure – cavvPreauth
8.6.7 Cavv Result Codes for Verified by Visa
8.6.8 Vault Cavv Purchase
8.6.9 Vault Cavv Pre-Authorization
229
232
235
237
240
245
245
245
246
246
246
247
248
250
252
252
254
256
256
265
266
273
274
276
9 e-Fraud Tools
9.1 Address Verification Service
9.1.1 About Address Verification Service (AVS)
9.1.2 AVS Info Object
9.1.3 AVS Response Codes
9.1.4 AVS Sample Code
9.2 Card Validation Digits (CVD)
9.2.1 About Card Validation Digits (CVD)
9.2.2 Transactions Where CVD Is Required
9.2.3 CVD Information Object
9.2.4 CVD Result Codes
9.2.5 Sample Purchase with CVD Info Object
9.3 Transaction Risk Management Tool
9.3.1 About the Transaction Risk Management Tool
9.3.2 Introduction to Queries
9.3.3 Session Query
9.3.3.1 Session Query Transaction Flow
9.3.4 Attribute Query
9.3.4.1 Attribute Query Transaction Flow
9.3.5 Handling Response Information
9.3.5.1 TRMT Response Fields
9.3.5.2 Understanding the Risk Score
9.3.5.3 Understanding the Rule Codes, Rule Names and Rule Messages
9.3.5.4 Examples of Risk Response
Session Query
Attribute Query
9.3.6 Inserting the Profiling Tags Into Your Website
9.4 Encorporating All Available Fraud Tools
9.4.1 Implementation Options for TRMT
9.4.2 Implementation Checklist
9.4.3 Making a Decision
279
281
281
281
283
285
287
287
287
288
290
290
291
291
291
292
298
299
303
303
304
307
308
315
315
316
316
318
318
318
320
10 Apple Pay In-App and on the Web Integration
10.1 About Apple Pay In-App and on the Web Integration
10.2 About API Integration of Apple Pay
10.2.1 Transaction Types That Use Apple Pay
10.3 Apple Pay In-App Process Flows
10.4 Cavv Purchase – Apple Pay
10.5 Cavv Pre-Authorization – Apple Pay
321
321
321
321
322
323
327
11 Offlinx™
11.1 What Is a Pixel Tag?
11.2 Offlinx™ and API Transactions
332
332
332
12 Convenience Fee
12.1 About Convenience Fee
12.2 Purchase with Convenience Fee
12.3 Convenience Fee Purchase w/ Customer Information
12.4 Convenience Fee Purchase with VbV, MCSC and Amex SafeKey
333
333
333
336
340
13 Recurring Billing
13.1 About Recurring Billing
13.2 Purchase with Recurring Billing
13.3 Recurring Billing Update
13.4 Recurring Billing Response Fields and Codes
13.5 Credential on File and Recurring Billing
344
344
344
347
351
352
14 Customer Information
354
14.1 Using the Customer Information Object
14.1.1 Customer Info Object – Miscellaneous Properties
14.1.2 Customer Info Object – Billing/Shipping Information
14.1.2.1 Set Methods for Billing and Shipping Info
14.1.2.2 Using Hash Tables for Billing and Shipping Info
14.1.3 Customer Info Object – Item Information
14.1.3.1 Set Methods for Item Information
14.1.3.2 Using Hash Tables for Item Information
14.2 Customer Information Sample Code
354
355
355
356
357
358
358
358
359
15 Status Check
15.1 About Status Check
15.2 Using Status Check Response Fields
15.3 Sample Purchase with Status Check
362
362
362
363
16 Visa Checkout
16.1 About Visa Checkout
16.2 Transaction Types - Visa Checkout
16.3 Integrating Visa Checkout Lightbox
16.4 Transaction Flow for Visa Checkout
16.5 Visa Checkout Purchase
16.6 Visa Checkout Pre-Authorization
16.7 Visa Checkout Completion
16.8 Visa Checkout Purchase Correction
16.9 Visa Checkout Refund
16.10 Visa Checkout Information
364
364
364
365
366
367
368
370
372
374
376
17 Testing a Solution
17.1 About the Merchant Resource Center
17.2 Logging In to the QA Merchant Resource Center
17.3 Test Credentials for Merchant Resource Center
17.4 Getting a Unique Test Store ID and API Token
17.5 Processing a Transaction
17.5.1 Overview
17.5.2 HttpsPostRequest Object
17.5.3 Receipt Object
17.6 Testing INTERAC® Online Payment Solutions
17.7 Testing MPI Solutions
17.8 Testing Visa Checkout
17.8.1 Creating a Visa Checkout Configuration for Testing
17.9 Test Card Numbers
17.9.1 Test Card Numbers for Level 2/3
17.9.2 Test Cards for Visa Checkout
17.10 Simulator Host
379
379
379
379
381
383
383
384
386
386
387
389
389
389
390
390
390
18 Moving to Production
18.1 Activating a Production Store Account
18.2 Configuring a Store for Production
18.2.1 Configuring an INTERAC® Online Payment Store for Production
18.2.1.1 Completing the Certification Registration - Merchants
18.2.1.2 Third-Party Service/Shopping Cart Provider
18.3 Receipt Requirements
18.3.1 Certification Requirements
393
393
393
394
394
395
396
396
Appendix A Definitions of Request Fields
A.1 Definitions of Request Fields – Credential on File
A.2 Definition of Request Fields – Recurring
A.3 Definition of Request Fields for Level 2/3 - Visa
397
408
409
410
A.4 Definition of Request Fields for Level 2/3 - MasterCard
A.5 Definition of Request Fields for Level 2/3 - Amex
A.6 Definition of Request Fields – Offlinx™
419
429
439
Appendix B Definitions of Response Fields
441
Appendix C Error Messages
455
Appendix D Process Flow for Basic Pre-Auth, Re-Auth and Completion Transactions
457
Appendix E Merchant Checklists for INTERAC® Online Payment Certification Testing
458
Appendix F Third-Party Service Provider Checklists for INTERAC® Online Payment Certification Testing
462
Appendix G Merchant Checklists for INTERAC® Online Payment Certification
467
Appendix H INTERAC® Online Payment Certification Test Case Detail
H.1 Common Validations
H.2 Test Cases
H.3 Merchant front-end test case values
470
470
470
474
Copyright Notice
479
Trademarks
479
1 About This Documentation
1.1 Purpose
This document describes the transaction information for using the PHP API for sending credit card transactions. In particular, it describes the format for sending transactions and the corresponding responses
you will receive.
This document contains information about the following features:
l
l
l
l
l
l
l
l
l
l
l
Basic transactions
MPI – Verified by Visa, MasterCard Secure Code and American Express SafeKey
INTERAC® Online Payment
Vault
MSR (Magnetic Swipe Reader) and Encrypted MSR
Apple Pay and Android Pay In-App
Transaction Risk Management Tool
Convenience fee
Visa Checkout
MasterCard MasterPass
Level 2/3 Transactions
Getting Help
Moneris has help for you at every stage of the integration process.
Getting Started
Contact our Client
Integration Specialists:
clientintegrations@moneris.com
Hours: Monday – Friday, 8:30am
to 8 pm ET
During Development
Production
If you are already working
with an integration specialist and need technical
development assistance,
contact our eProducts
Technical Consultants:
If your application is already live
and you need production support,
contact Moneris Customer Service:
1-866-319-7450
Available 24/7
onlinepayments@moneris.com
1-866-319-7450
eproducts@moneris.com
Hours: 8am to 8pm ET
For additional support resources, you can also make use of our community forums at
http://community.moneris.com/product-forums/
April 2019
Page 10 of 480
Moneris Gateway API - Integration Guide
1.2 Who Is This Guide For?
The Moneris Gateway API - Integration Guide is intended for developers integrating with the Moneris
Gateway.
This guide assumes that the system you are trying to integrate meets the requirements outlined below
and that you have some familiarity with the PHP programming language.
System Requirements
l
l
l
l
PHP or above
Port 443 open for bi-directional communication
Web server with a SSL certificate
cURL - PHP interface – see Adding cURL CA Root Certificate to PHP API
1.3 Adding cURL CA Root Certificate to PHP API
cURL CA Root Certificate File:
The default installation of PHP/cURL does not include the cURL CA root certificate file. In order for the
Moneris Gateway PHP API to connect to the Moneris Gateway during transaction processing, the ‘mpgclasses.php’ file that’s included with the PHP API package needs to be modified to include a path to the
CA root certificate file.
To add the cURL CA root certificate file to the PHP API package, do the following:
1. If cURL was not installed separately from your PHP installation, libcurl is included in your PHP
installation. You need to download the ‘cacert.pem’ file from http://curl.haxx.se/docs/caextract.html and save it to the necessary directory.
2. Once downloaded, rename the file to ‘curl-ca-bundle.crt’ (e.g., 'C:\path\to\curl-ca-bundle.crt'). If
cURL was installed separately from PHP, you may need to determine the path to the cURL CA root
certificate bundle on your system (e.g., 'C:\path\to\curl-ca-bundle.crt').
3. Insert the code below into the ‘mpgclasses.php’ file as part of the cURL option setting, at approximately line 73 below the line ‘curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, TRUE);‘
curl_setopt($ch, CURLOPT_CAINFO, 'C:\path\to\curl-ca-bundle.crt');
For more information regarding the CURLOPT_SSL_VERIFYPEER option, please refer to
your PHP documentation.
Page 11 of 480
April 2019
2 Basic Transaction Set
l
l
l
l
l
l
l
l
l
l
l
2.1 Purchase
2.2 Pre-Authorization
2.3 Pre-Authorization Completion
2.4 Re-Authorization
2.5 Force Post
2.6 Purchase Correction
2.7 Refund
2.8 Independent Refund
2.9 Card Verification with AVS and CVD
2.10 Batch Close
2.11 Open Totals
April 2019
Page 12 of 480
Moneris Gateway API - Integration Guide
2.1 Purchase
Verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.
Purchase transaction object definition
$txnArray = array(‘type’=>’purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Purchase transaction values
Table 1: Purchase transaction object mandatory values
Value
Type
Limits
Set method
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
Order ID
order_id
(YYMM format)
E-commerce indicator
Page 13 of 480
String
1-character alphanumeric
'crypt_type'=>$crypt
April 2019
2 Basic Transaction Set
Table 2: Purchase transaction object optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Card Match ID
String
50-character alphanumeric
'cm_id' => $transaction_id
Customer information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Object
N/A
$mpgConvFee = new
mpgConvFeeInfo
($convFeeTemplate);
Recurring billing
Object
N/A
$mpgTxn->setRecur($mpgRecur);
Dynamic descriptor
String
20-character alpha-
'dynamic_
NOTE: Applies to Offlinx™ only; must be
unique value for each
transaction
NOTE: When storing
credentials on the initial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Convenience fee
NOTE: This variable
does not apply to Credential on File transactions.
April 2019
Page 14 of 480
Moneris Gateway API - Integration Guide
Table 2: Purchase transaction object optional values
Value
Wallet indicator1
Type
Limits
Set method
numeric
descriptor'=>$dynamic_
descriptor
String
3-character alphanumeric
'wallet_indicator'=>$wallet_
indicator
Object
N/A
NOTE: For basic
Purchase and Preauthorization, the wallet
indicator applies to
Visa Checkout and
MasterCard MasterPass only. For more,
see Appendix A Definitions of Request Fields
Credential on File Info
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
1Available to Canadian integrations only.
Page 15 of 480
April 2019
2 Basic Transaction Set
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Information
String
1-character numeric
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Purchase
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt,
'dynamic_descriptor'=>$dynamic_descriptor
//,'wallet_indicator' => '' //Refer to documentation for details
//,'mcp_amount' => $mcp_amount
//,'mcp_currency_code' => $mcp_currency_code
//,'cm_id' => '8nAK8712sGaAkls56' //set only for usage with Offlinx - Unique max 50 alphanumeric
characters transaction id generated by merchant
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("168451306048014");
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
/* Status Check Example
$mpgHttpPost =new mpgHttpsPostStatus($store_id,$api_token,$status_check,$mpgRequest);
*/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
Page 17 of 480
April 2019
2 Basic Transaction Set
Sample Purchase
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nStatusCode = " . $mpgResponse->getStatusCode());
print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
print("\nMCPAmount = " . $mpgResponse->getMCPAmount());
print("\nMCPCurrenyCode = " . $mpgResponse->getMCPCurrencyCode());
print("\nHostId = " . $mpgResponse->getHostId());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
?>
2.2 Pre-Authorization
Verifies and locks funds on the customer’s credit card. The funds are locked for a specified amount of
time based on the card issuer.
To retrieve the funds that have been locked by a Pre-Authorization transaction so that they may be
settled in the merchant’s account, a Pre-Authorization Completion transaction must be performed. A
Pre-Authorization transaction may only be "completed" once.
Things to Consider:
l
l
l
If a Pre-Authorization transaction is not followed by a Completion transaction, it must
be reversed via a Completion transaction for 0.00. See "Pre-Authorization Completion"
on page 23
A Pre-Authorization transaction may only be "completed" once . If the Completion
transaction is for less than the original amount, a Re-Authorization transaction is
required to collect the remaining funds by another Completion transaction. See ReAuthorization (page 26).
For a process flow, see "Process Flow for Basic Pre-Auth, Re-Auth and Completion Transactions" on page 457
Pre-Authorization transaction object definition
$txnArray = array(‘type’=>’preauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Pre-Authorization transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Pre-Authorization transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 18 of 480
Moneris Gateway API - Integration Guide
Table 3: Pre-Authorization object required values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 4: Pre-Authorization object optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Card Match ID
String
50-character alphanumeric
'cm_id' => $transaction_id
Customer information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
NOTE: Applies to Offlinx™ only; must be
unique value for each
transaction
NOTE: When storing
credentials on the ini-
Page 19 of 480
April 2019
2 Basic Transaction Set
Value
Type
Limits
Set method
tial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Wallet indicator1
String
3-character alphanumeric
'wallet_indicator'=>$wallet_
indicator
Object
N/A
NOTE: For basic
Purchase and Preauthorization, the wallet
indicator applies to
Visa Checkout and
MasterCard MasterPass only. For more,
see Appendix A Definitions of Request Fields
Credential on File Info
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
1Available to Canadian integrations only.
April 2019
Page 20 of 480
Moneris Gateway API - Integration Guide
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Information
String
1-character numeric
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Pre-Authorization
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt,
'dynamic_descriptor'=>$dynamic_descriptor
//,'wallet_indicator' => '' //Refer to documentation for details
//,'mcp_amount' => $mcp_amount,
//'mcp_currency_code' => $mcp_currency_code
//,'cm_id' => '8nAK8712sGaAkls56' //set only for usage with Offlinx - Unique max 50 alphanumeric
characters transaction id generated by merchant
);
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("168451306048014");
$mpgTxn->setCofInfo($cof);
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
print("\nMCPAmount = " . $mpgResponse->getMCPAmount());
print("\nMCPCurrenyCode = " . $mpgResponse->getMCPCurrencyCode());
?>
April 2019
Page 22 of 480
Moneris Gateway API - Integration Guide
2.3 Pre-Authorization Completion
Retrieves funds that have been locked (by either a Pre-Authorization or a Re-Authorization transaction),
and prepares them for settlement into the merchant’s account.
Things to Consider:
l
l
l
l
A Pre-Authorization or Re-Authorization transaction can only be completed once. Refer
to the Re-Authorization transaction for more information on how to perform multiple
Completion transactions.
To reverse the full amount of a Pre-Authorization transaction, use the Completion transaction with the amount set to 0.00.
To process this transaction, you need the order ID and transaction number from the original Pre-Authorization transaction.
For a process flow, see Appendix D Process Flow for Basic Pre-Auth, Re-Auth and Completion Transactions
Completion transaction object
$txnArray = array(‘type’=>’completion', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Completion transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Completion transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 5: Completion transaction object mandatory values
Value
Type
Limits
Set method
'order_id'=>$order_id
Order ID
String
50-character
alphanumeric
Completion Amount
String
(missing or bad snippet) 'comp_amount'=>$comp_amount
Transaction number
String
255-character
alphanumeric
'txn_number'=>$txn_number
E-Commerce indicator
String
1-character
alphanumeric
'crypt_type'=>$crypt
Page 23 of 480
April 2019
2 Basic Transaction Set
Table 6: Completion transaction optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Shipping indicator1
String
1-character alphanumeric
‘ship_indicator’=>$ship_
indicator
Sample Basic Pre-Authorization Completion
'completion',
'txn_number'=>$txnnumber,
'order_id'=>$orderid,
'comp_amount'=>$compamount,
'crypt_type'=>'7',
'cust_id'=>'customer ID',
//'mcp_amount' => $mcp_amount,
//'mcp_currency_code' => $mcp_currency_code
//'ship_indicator'=>$ship_indicator, //optional
'dynamic_descriptor'=>$dynamic_descriptor
);
## step 2) create a transaction object passing the hash created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
1Available to Canadian integrations only.
April 2019
Page 24 of 480
Moneris Gateway API - Integration Guide
Sample Basic Pre-Authorization Completion
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nMCPAmount = " . $mpgResponse->getMCPAmount());
print("\nMCPCurrenyCode = " . $mpgResponse->getMCPCurrencyCode());
?>
$compamount='0.10';
$dynamic_descriptor='123';
## step 1) create transaction array ###
$txnArray=array('type'=>'completion',
'txn_number'=>$txnnumber,
'order_id'=>$orderid,
'comp_amount'=>$compamount,
'crypt_type'=>'7',
'cust_id'=>'customer ID',
'dynamic_descriptor'=>$dynamic_descriptor
);
## step 2) create a transaction object passing the hash created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
Page 25 of 480
April 2019
2 Basic Transaction Set
Sample Basic Pre-Authorization Completion
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
2.4 Re-Authorization
If a Pre-Authorization transaction has already taken place, and not all the locked funds were released by
a Completion transaction, a Re-Authorization allows you to lock the remaining funds so that they can be
released by another Completion transaction in the future.
Re-Authorization is necessary because funds that have been locked by a Pre-Authorization transaction
can only be released by a Completion transaction one time. If the Completion amount is less than the
Pre-Authorization amount, the remaining money cannot be "completed".
For a process flow, Appendix D Process Flow for Basic Pre-Auth, Re-Auth and Completion Transactions.
Re-Authorization transaction object definition
$txnArray = array(‘type’=>’reauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Re-Authorization transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Re-Authorization transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 7: Re-Authorization transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Original order ID
String
50-character alphanumeric
'orig_order_id'=>orig_order_
id
Amount
String
(missing or bad snippet)
'amount'=>$amount
April 2019
Page 26 of 480
Moneris Gateway API - Integration Guide
Table 7: Re-Authorization transaction object mandatory values
Value
Transaction number
Type
String
Limits
255-character
Set method
'txn_number'=>$txn_number
variable character
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 1 Re-Authorization transaction optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Customer information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
NOTE: When storing
credentials on the initial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Page 27 of 480
April 2019
2 Basic Transaction Set
Sample Re-Authorization
'reauth',
'order_id'=>'ord-'.date("dmy-G:i:s"),
'cust_id'=>'my cust id',
'amount'=>'0.50',
'orig_order_id'=>'ord-110515-10:55:31', //original pre-auth order_id
'txn_number'=>'31393-0_10', //original pre-auth txn number
'crypt_type'=>'7',
'dynamic_descriptor'=>'123456'
);
/****************************** Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************************* Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/****************************** HTTPS Post Object *******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************************* Response *********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType()."
");
print("\nTransAmount = " . $mpgResponse->getTransAmount()."
");
print("\nTxnNumber = " . $mpgResponse->getTxnNumber()."
");
print("\nReceiptId = " . $mpgResponse->getReceiptId()."
");
print("\nTransType = " . $mpgResponse->getTransType()."
");
print("\nReferenceNum = " . $mpgResponse->getReferenceNum()."
");
print("\nResponseCode = " . $mpgResponse->getResponseCode()."
");
print("\nISO = " . $mpgResponse->getISO()."
");
print("\nMessage = " . $mpgResponse->getMessage()."
");
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit()."
");
print("\nAuthCode = " . $mpgResponse->getAuthCode()."
");
print("\nComplete = " . $mpgResponse->getComplete()."
");
print("\nTransDate = " . $mpgResponse->getTransDate()."
");
print("\nTransTime = " . $mpgResponse->getTransTime()."
");
print("\nTicket = " . $mpgResponse->getTicket()."
");
print("\nTimedOut = " . $mpgResponse->getTimedOut()."
");
?>
2.5 Force Post
Retrieves the locked funds and prepares them for settlement into the merchant’s account.
Used when a merchant obtains the authorization number directly from the issuer by a third-party authorization method (such as by phone).
Things to Consider:
l
April 2019
This transaction is an independent completion where the original Pre-Authorization
Page 28 of 480
Moneris Gateway API - Integration Guide
l
l
transaction was not processed via the same Moneris Gateway merchant account.
It is not required for the transaction that you are submitting to have been processed via
the Moneris Gateway. However, a credit card number, expiry date and original authorization number are required.
Force Post transactions are not supported for UnionPay
ForcePost transaction object definition
$txnArray = array(‘type’=>’forcepost', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for ForcePost transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Force Post transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 8: Force Post transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
10-character decimal
'amount'=>$amount
Up to 7 digits
(dollars) + decimal
point (.) + 2 digits
(cents) after the
decimal point
EXAMPLE: 1234567.89
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
Authorization code
String
8-character alphanumeric
'auth_code'=>$auth_code
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Page 29 of 480
April 2019
2 Basic Transaction Set
Table 9: Force Post transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Basic Force Post
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'auth_code'=>$auth_code,
'crypt_type'=>$crypt,
'dynamic_descriptor'=>$dynamic_descriptor
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
April 2019
Page 30 of 480
Moneris Gateway API - Integration Guide
Sample Basic Force Post
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
2.6 Purchase Correction
Restores the full amount of a previous Purchase, Pre-Authorization Completion or Force Post transaction
to the cardholder's card, and removes any record of it from the cardholder's statement.
This transaction can be used against a Purchase or Pre-Authorization Completion transaction that
occurred same day provided that the batch containing the original transaction remains open. When
using the automated closing feature, Batch Close occurs daily between 10 and 11 pm Eastern Time.
Things to Consider:
l
To process this transaction, you need the order ID and the transaction number from
the original Completion, Purchase or Force Post transaction.
Purchase Correction transaction object definition
$txnArray = array(‘type’=>’purchasecorrection', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Purchase Correction transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Purchase Correction transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 31 of 480
April 2019
2 Basic Transaction Set
Table 10: Purchase Correction transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character variable
character
'txn_number'=>$txn_number
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 11: Purchase Correction transaction optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Purchase Correction
'purchasecorrection',
'txn_number'=>$txnnumber,
'order_id'=>$orderid,
'crypt_type'=>'7',
'cust_id'=>'customer ID',
'dynamic_descriptor'=>$dynamic_descriptor
);
## step 2) create a transaction object passing the array created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
April 2019
Page 32 of 480
Moneris Gateway API - Integration Guide
Sample Purchase Correction
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
2.7 Refund
Restores all or part of the funds from a Purchase, Pre-Authorization Completion or Force Post transaction to the cardholder's card. Unlike a Purchase Correction, there is a record of both the initial charge
and the refund on the cardholder's statement.
To process this transaction, you need the order ID and transaction number from the original Completion, Purchase or Force Post transaction.
Refund transaction object definition
$txnArray = array(‘type’=>’refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Refund transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 33 of 480
April 2019
2 Basic Transaction Set
Table 12: Refund transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Transaction number
String
255-character
'txn_number'=>$txn_number
variable character
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 13: Refund transaction optional values
Value
Status Check
Type
Boolean
Limits
true/false
Set method
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Refund
'refund',
'txn_number'=>$txnnumber,
'order_id'=>$orderid,
'amount'=>'0.10',
'crypt_type'=>'7',
'cust_id'=> 'Customer ID',
'dynamic_descriptor'=>$dynamic_descriptor
);
## step 2) create a transaction object passing the array created in
April 2019
Page 34 of 480
Moneris Gateway API - Integration Guide
Sample Refund
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print ("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
2.8 Independent Refund
Credits a specified amount to the cardholder’s credit card. The credit card number and expiry date are
mandatory.
It is not necessary for the transaction that you are refunding to have been processed via the Moneris
Gateway.
Things to Consider:
l
Because of the potential for fraud, permission for this transaction is not granted to all
accounts by default. If it is required for your business, it must be requested via your
account manager.
Independent Refund transaction object definition
$txnArray = array(‘type’=>’ind_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Independent Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
Page 35 of 480
April 2019
2 Basic Transaction Set
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Independent Refund transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 14: Independent Refund transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 15: Independent Refund transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Independent Refund
'ind_refund',
'order_id'=>$orderid,
'cust_id'=>'my cust id',
'amount'=>'1.00',
'pan'=>'4242424242424242',
'expdate'=>'1103',
'crypt_type'=>'7',
'dynamic_descriptor'=>$dynamic_descriptor
);
## step 2) create a transaction object passing the array created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
2.9 Card Verification with AVS and CVD
Verifies the validity of the credit card, expiry date and any additional details (such as the Card Verification
Digits or Address Verification details). It does not verify the available amount or lock any funds on the
credit card.
Page 37 of 480
April 2019
2 Basic Transaction Set
Things to Consider:
l
l
l
l
l
l
The Card Verification transaction is only supported by Visa, MasterCard and Discover
For some Credential on File transactions, Card Verification with AVS and CVD is used as
a prior step to get the Issuer ID used in the subsequent transaction
For Card Verification, CVD is supported by Visa, MasterCard and Discover.
For Card Verification, AVS is supported by Visa, MasterCard and Discover.
When testing Card Verification, please use the Visa and MasterCard test card numbers
provided in the MasterCard Card Verification and Visa Card Verification tables available
in CVD & AVS (E-Fraud) Simulator.
For a full list of possible AVS & CVD result codes refer to the CVD and AVS Result Code
tables.
Card Verification object definition
$txnArray = array(‘type’=>’card_verification', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Card Verification transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Card Verification transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 16: Card Verification transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
April 2019
Page 38 of 480
Moneris Gateway API - Integration Guide
Table 16: Card Verification transaction object mandatory values
Value
Type
Limits
Set method
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
AVS
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
NOTE: When storing
credentials on the initial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Table 17: Basic Card Verification transaction object optional values
Value
Type
Credential on File Info
Object
Limits
N/A
Set Method
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Page 39 of 480
April 2019
2 Basic Transaction Set
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Information
String
1-character numeric
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Card Verification
'card_verification',
'order_id'=>'ord-'.date("dmy-G:i:s"),
'cust_id'=>'my cust id',
'pan'=>'4242424242424242',
'expdate'=>'1512',
'crypt_type'=>'7'
);
$mpgTxn = new mpgTransaction($txnArray);
/************************** AVS Variables *****************************/
April 2019
Page 40 of 480
Moneris Gateway API - Integration Guide
Sample Card Verification
$avs_street_number = '201';
$avs_street_name = 'Michigan Ave';
$avs_zipcode = 'M1M1M1';
/************************** CVD Variables *****************************/
$cvd_indicator = '1';
$cvd_value = '198';
/********************** AVS Associative Array *************************/
$avsTemplate = array(
'avs_street_number'=>$avs_street_number,
'avs_street_name' =>$avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/********************** CVD Associative Array *************************/
$cvdTemplate = array(
'cvd_indicator' => $cvd_indicator,
'cvd_value' => $cvd_value
);
/************************** AVS Object ********************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/************************** CVD Object ********************************/
$mpgCvdInfo = new mpgCvdInfo ($cvdTemplate);
/*********************** Credential on File ************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("12345678901234");
$mpgTxn->setAvsInfo($mpgAvsInfo);
$mpgTxn->setCvdInfo($mpgCvdInfo);
$mpgTxn->setCofInfo($cof);
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
?>
2.10 Batch Close
Takes the funds from all Purchase, Completion, Refund and Force Post transactions so that they will be
deposited or debited the following business day.
For funds to be deposited the following business day, the batch must close before 11 pm Eastern Time.
Page 41 of 480
April 2019
2 Basic Transaction Set
Batch Close transaction object definition
$txnArray = array(‘type’=>’batchclose', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Batch Close transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Batch Close transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 18: Batch Close transaction object mandatory values
Value
ECR (electronic cash
register) number
Type
Limits
String
No limit (value
provided by Moneris)
Set method
ecr_number=>$ecr_number
Sample Batch Close
'batchclose',
'ecr_number'=>$ecr_number
);
$mpgTxn = new mpgTransaction($txnArray);
## step 2) create mpgRequest object ###
$mpgReq=new mpgRequest($mpgTxn);
$mpgReq->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgReq->setTestMode(true); //false or comment out this line for production transactions
## step 3) create mpgHttpsPost object which does an https post ##
$mpgHttpPost=new mpgHttpsPost($store_id,$api_token,$mpgReq);
## step 4) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
##step 5) get array of all credit cards
$creditCards = $mpgResponse->getCreditCards($ecr_number);
## step 6) loop through the array of credit cards and get information
for($i=0; $i < count($creditCards); $i++)
{
print "\nCard Type = $creditCards[$i]";
April 2019
Page 42 of 480
Moneris Gateway API - Integration Guide
Sample Batch Close
print "\nPurchase Count = "
. $mpgResponse->getPurchaseCount($ecr_number,$creditCards[$i]);
print "\nPurchase Amount = "
. $mpgResponse->getPurchaseAmount($ecr_number,$creditCards[$i]);
print "\nRefund Count = "
. $mpgResponse->getRefundCount($ecr_number,$creditCards[$i]);
print "\nRefund Amount = "
. $mpgResponse->getRefundAmount($ecr_number,$creditCards[$i]);
print "\nCorrection Count = "
. $mpgResponse->getCorrectionCount($ecr_number,$creditCards[$i]);
print "\nCorrection Amount = "
. $mpgResponse->getCorrectionAmount($ecr_number,$creditCards[$i]);
}
?>
2.11 Open Totals
Returns the details about the currently open batch.
Similar to the Batch Close; the difference is that it does not close the batch for settlement.
Open Totals transaction object definition
$txnArray = array(‘type’=>’opentotals', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Open Totals transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Open Totals transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 19: Open Totals transaction object mandatory values
Value
ECR (electronic cash
register) number
Type
Limits
String
No limit (value
provided by Moneris)
Set method
ecr_number=>$ecr_number
Sample Open Totals
'opentotals',
'ecr_number'=>$ecr_number
);
$mpgTxn = new mpgTransaction($txnArray);
## step 2) create mpgRequest object ###
$mpgReq= new mpgRequest($mpgTxn);
$mpgReq->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgReq->setTestMode(true); //false or comment out this line for production transactions
## step 3) create mpgHttpsPost object which does an https post ##
$mpgHttpPost=new mpgHttpsPost($store_id,$api_token,$mpgReq);
## step 4) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
##step 5) get array of all credit cards
$creditCards = $mpgResponse->getCreditCards($ecr_number);
## step 6) loop through the array of credit cards and get information
for($i=0; $i < count($creditCards); $i++)
{
print "\nCard Type = $creditCards[$i]";
print "\nPurchase Count = "
. $mpgResponse->getPurchaseCount($ecr_number,$creditCards[$i]);
print "\nPurchase Amount = "
. $mpgResponse->getPurchaseAmount($ecr_number,$creditCards[$i]);
print "\nRefund Count = "
. $mpgResponse->getRefundCount($ecr_number,$creditCards[$i]);
print "\nRefund Amount = "
. $mpgResponse->getRefundAmount($ecr_number,$creditCards[$i]);
print "\nCorrection Count = "
. $mpgResponse->getCorrectionCount($ecr_number,$creditCards[$i]);
print "\nCorrection Amount = "
. $mpgResponse->getCorrectionAmount($ecr_number,$creditCards[$i]);
}
?>
April 2019
Page 44 of 480
3 Credential on File
l
l
l
l
l
l
l
3.1
3.2
3.3
3.4
3.6
3.5
3.7
About Credential on File
Credential on File Info Object and Variables
Credential on File Transaction Types
Initial Transactions in Credential on File
Credential on File and Converting Temporary Tokens
Vault Tokenize Credit Card and Credential on File
Card Verification and Credential on File Transactions
3.1 About Credential on File
When storing customers' credit card credentials for use in future authorizations, or when using these credentials in subsequent transactions, card brands now require merchants to indicate this in the transaction request.
In the Moneris API, this is handled by the Moneris Gateway via the inclusion of the Credential on File info
object and its variables in the transaction request.
While the requirements for handling Credential on File transactions relate to Visa, Mastercard and Discover only, in order to avoid confusion and prevent error, please implement these changes for all card
types and the Moneris system will then correctly flow the relevant card data values as appropriate.
While in the testing phase, we recommend that you test with Visa cards because implementation for the
other card brands is still in process.
NOTE: If either the first transaction or a Card Verification authorization is declined when
attempting to store cardholder credentials, those credentials cannot be stored —therefore
the merchant must not use the credential for any subsequent transactions.
3.2 Credential on File Info Object and Variables
The Credential on File Info object is nested within the request for the applicable transaction types.
Object:
cof
Variables in the cof object:
Payment Indicator
Payment Information
Issuer ID
For more information, see Definitions of Request Fields – Credential on File.
For more information, see 1 Definition of Request Fields – Credential on File
April 2019
Page 45 of 480
Moneris Gateway API - Integration Guide
3.3 Credential on File Transaction Types
The Credential on File Info object applies to the following transaction types:
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Purchase
Pre-Authorization
Purchase with 3-D Secure – cavv_purchase
Purchase with 3-D Secure and Recurring Billing
Pre-Authorization with 3-D Secure – cavvPreauth
Purchase with Vault – ResPurchaseCC
Pre-Authorization with Vault – ResPreauthCC
Card Verification with AVS and CVD
Card Verification with Vault – ResCardVerificationCC
Vault Add Credit Card – ResAddCC
Vault Update Credit Card – ResUpdateCC
Vault Add Token – ResAddToken
Vault Tokenize Credit Card – ResTokenizeCC
Recurring Billing
Purchase
Pre-Authorization
Purchase with 3-D Secure – cavv_purchase
Pre-Authorization with 3-D Secure – cavv_preauth
Purchase with Vault
Pre-Authorization with Vault
Card Verification
Card Verification with Vault
Vault Add Credit Card
Vault Update Credit Card
Recurring Billing transactions
3.4 Initial Transactions in Credential on File
When sending an initial transaction with the Credential on File Info object, i.e., a transaction request
where the cardholder's credentials are being stored for the first time, it is important to understand the
following:
l
l
l
l
You must send the cardholder's Card Verification Digits (CVD)
Issuer ID will be sent without a value on the initial transaction, because it is received in the
response to that initial transaction; for all subsequent merchant-intiated transactions and all
administrative transactions you send this Issuer ID
The payment information field should always be set to a value of 0 on the first transaction
The payment indicator field should be set to the value that is appropriate for the transaction
Page 46 of 480
April 2019
3 Credential on File
3.5 Vault Tokenize Credit Card and Credential on File
When you want to store cardholder credentials from previous transactions into the Vault, you use the
Vault Tokenize Credit Card transaction request. Credential on File rules require that only previous transactions with the Credential on File Info object can be tokenized to the Vault.
For more information about this transaction, see 4.3.10 Vault Tokenize Credit Card – ResTokenizeCC.
3.6 Credential on File and Converting Temporary Tokens
In the event you decide to convert a temporary token representing cardholder credentials into a permanent token, these credentials become stored credentials, and therefore necessary to send Credential
on File information.
For Vault Temporary Token Add transactions where you subsequently decide to convert the temporary
token into a permanent token (stored credentials):
1. Send a transaction request that includes the Credential on File Info object to get the Issuer ID; this
can be a Card Verification, Purchase or Pre-Authorization request
2. After completing the transaction, send the Vault Add Token request with the Credential on File
object (Issuer ID only) in order to convert the temporary token to a permanent one.
For more information about Vault Temporary Token Add transaction, see 1 Vault Temporary Token Add.
3.7 Card Verification and Credential on File Transactions
In the absence of a Purchase or Pre-Authorization, a Card Verification transaction is used to get the
unique Issuer ID value (issuerId) that is used in subsequent Credential on File transactions. Issuer ID is a
variable included in the nested Credential on File Info object.
For all first-time transactions, including Card Verification transactions, you must also request the cardholder's Card Verification Details (CVD). For more on CVD, see 9.2 Card Validation Digits (CVD).
For a complete list of these variables, see each transaction type or Definitions of Request Fields – Credential on File
The Card Verification request, including the Credential on File Info object, must be sent immediately prior
to storing cardholder credentials.
For information about Card Verification, see 2.9 Card Verification with AVS and CVD. see 1 Card Verification.
3.7.1 When to Use Card Verification With COF
If you are not sending a Purchase or Pre-Authorization transaction (i.e., you are not charging the customer immediately), you must use Card Verification (or in the case of Vault Add Token, Card Verification
with Vault) first before running the transaction in order to get the Issuer ID.
Transactions this applies to:
April 2019
Page 47 of 480
Moneris Gateway API - Integration Guide
Vault Add Credit Card – ResAddCC
Vault Update Credit Card – ResUpdateCC
Vault Add Token – ResAddToken
Vault Add Credit Card – res_add_cc
Vault Update Credit Card – res_update_cc
Recurring Billing transactions, if:
l the first transaction is set to start on a future date
3.7.2 Credential on File and Vault Add Token
For Vault Add Token transactions:
1. Send Card Verification with Vault transaction request including the Credential on File object to get
the Issuer ID
2. Send the Vault Add Token request including the Credential on File object (with Issuer ID only;
other fields are not applicable)
For more on this transaction type, see 4.3.9 Vault Add Token – ResAddToken.
3.7.3 Credential on File and Vault Update Credit Card
For Vault Update Credit Card transactions where you are updating the credit card number:
1. Send Card Verification transaction request including the Credential on File object to get the
Issuer ID
2. Send the Vault Update Credit Card request including the Credential on File Info object (Issuer ID
only).
For more on this transaction type, see 4.3.3 Vault Update Credit Card – ResUpdateCC.
3.7.4 Credential on File and Vault Add Credit Card
For Vault Add Credit Card transactions:
1. Send Card Verification transaction request including the Credential on File object to get the
Issuer ID
2. Send the Vault Add Credit Card request including the Credential on File Info object (Issuer ID only)
For more on this transaction type, see 4.3.1 Vault Add Credit Card – ResAddCC.
Page 48 of 480
April 2019
3 Credential on File
3.7.5 Credential on File and Recurring Billing
NOTE: The value of the payment indicator field must be R when sending Recurring Billing
transactions.
For Recurring Billing transactions which are set to start immediately:
1. Send a Purchase transaction request with both the Recurring Billing and Credential on File info
objects (with Recurring Billing object field start now = true)
For Recurring Billing transactions which are set to start on a future date:
1. Send Card Verification transaction request including the Credential on File info object to get the
Issuer ID
2. Send Purchase transaction request with the Recur and Credential on File info objects included
For updating a Recurring Billing series where you are updating the card number (does not apply if you are
only modifying the schedule or amount in a recurring series):
1. Send Card Verification request including the Credential on File info object to get the Issuer ID
2. Send a Recurring Billing Update transaction
For more information about the Recurring Billing object, see Definition of Request Fields – Recurring.
April 2019
Page 49 of 480
4 Vault
l
l
l
l
l
4.1
4.2
4.3
4.4
4.5
About the Vault Transaction Set
Vault Transaction Types
Vault Administrative Transactions
Vault Financial Transactions
Hosted Tokenization
4.1 About the Vault Transaction Set
The Vault feature allows merchants to create customer profiles, edit those profiles, and use them to process transactions without having to enter financial information each time. Customer profiles store customer data essential to processing transactions, including credit and signature debit.
The Vault is a complement to the Recurring Billing module. It securely stores customer account information on Moneris secure servers. This allows merchants to bill customers for routine products or services
when an invoice is due.
4.2 Vault Transaction Types
The Vault API supports both administrative and financial transactions.
4.2.1 Administrative Vault Transaction types
ResAddCC
Creates a new credit card profile, and generates a unique data key which can be obtained
from the Receipt object.
This data key is the profile identifier that all future financial Vault transactions will use to associate with the saved information.
EncResAddCC
Creates a new credit card profile, but requires the card data to be either swiped or manually
keyed in via a Moneris-provided encrypted mag swipe reader.
ResTempAdd
Creates a new temporary token credit card profile. This transaction requires a duration to be
set to indicate how long the temporary token is to be stored for.
During the lifetime of this temporary token, it may be used for any other vault transaction
before it is permanently deleted from the system.
ResUpdateCC
Updates a Vault profile (based on the data key) to contain credit card information.
All information contained within a credit card profile is updated as indicated by the submitted
fields.
EncResUpdateCC
Updates a profile (based on the data key) to contain credit card information. The encrypted
version of this transaction requires the card data to either be swiped or manually keyed in via
a Moneris-provided encrypted mag swipe reader.
April 2019
Page 50 of 480
Moneris Gateway API - Integration Guide
ResDelete
Deletes an existing Vault profile of any type using the unique data key that was assigned when
the profile was added.
It is important to note that after a profile is deleted, the information which was saved within
can no longer be retrieved.
ResLookupFull
Verifies what is currently saved under the Vault profile associated with the given data key. The
response to this transaction returns the latest active data for that profile.
Unlike ResLookupMasked (which returns the masked credit card number), this transaction
returns both the masked and the unmasked credit card numbers.
ResLookupMasked
Verifies what is currently saved under the Vault profile associated with the given data key. The
response to this transaction returns the latest active data for that profile.
Unlike ResLookupFull (which only returns both the masked and the unmasked credit card
numbers), this transaction only returns the masked credit card number.
ResGetExpiring
Verifies which profiles have credit cards that are expiring during the current and next calendar
month. For example, if you are processing this transaction on September 30, then it will
return all cards that expire(d) in September and October of this year.
When generating a list of profiles with expiring credit cards, only the masked credit card numbers are returned.
This transaction can be performed no more than 2 times on any given calendar day, and it
only applies to credit card profiles.
ResIscorporatecard
Determines whether a profile has a corporate card registered within it.
After sending the transaction, the response field to the Receipt object's getCorporateCard
method is either true or false depending on whether the associated card is a corporate
card.
ResAddToken
Converts a Hosted Tokenization temporary token to a permanent Vault token.
A temporary token is valid for 15 minutes after it is created.
ResTokenizeCC
Creates a new credit card profile using the credit card number, expiry date and e-commerce
indicator that were submitted in a previous financial transaction. A transaction that was previously done in Moneris Gateway is taken, and the card data from that transaction is stored
in the Moneris Vault.
As with ResAddCC, a unique data key is generated and returned to the merchant via the
Receipt object. This is the profile identifier that all future financial Vault transactions will use to
associate with the saved information.
Page 51 of 480
April 2019
4 Vault
4.2.2 Financial Vault Transaction types
ResPurchaseCC
Uses the data key to identify a previously registered credit card profile. The details saved
within the profile are then submitted to perform a Purchase transaction.
ResPreauthCC
Uses the data key to identify a previously registered credit card profile. The details within the
profile are submitted to perform a Pre-Authorization transaction.
ResIndRefundCC
Uses the unique data key to identify a previously registered credit card profile, and credits a
specified amount to that credit card.
ResMpiTxn
Uses the data key (as opposed to a credit card number) in a VBV/SecureCode Txn MPI transaction. The merchant uses the data key with ResMpiTxn request, and then reads the
response fields to verify whether the card is enrolled in Verified by Visa or MasterCard
SecureCode. Retrieves the vault transaction value to pass on to Visa or MasterCard.
After it has been validated that the data key is is enrolled in 3-D Secure, a window appears in
which the customer can enter the 3-D Secure password. The merchant may initiate the forming of the validation form getMpiInLineForm().
For more information on integrating with MonerisMPI, refer to 8 MPI
4.3 Vault Administrative Transactions
Administrative transactions allow you to perform such tasks as creating new Vault profiles, deleting existing Vault profiles and updating profile information.
Some Vault Administrative Transactions require the Credential on File object to be sent with the issuer ID
field only.
4.3.1 Vault Add Credit Card – ResAddCC
Creates a new credit card profile, and generates a unique data key which can be obtained from the
Receipt object.
This data key is the profile identifier that all future financial Vault transactions will use to associate with
the saved information.
ResAddCC transaction object definition
$txnArray = array(‘type’=>’res_add_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for ResAddCC transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
April 2019
Page 52 of 480
Moneris Gateway API - Integration Guide
ResAddCC transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 20: Vault Add Credit Card transaction object mandatory values
Value
Type
Limits
Set method
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
E-commerce indicator
String
1-character alphanumeric
Credential on File Info
Object
N/A
'crypt_type'=>$crypt
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Table 21: Vault Add Credit Card transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Email address
String
30-character alphanumeric
'email'=>$email
Page 53 of 480
April 2019
4 Vault
Table 21: Vault Add Credit Card transaction optional values
Value
Type
Limits
Set method
Phone number
String
30-character alphanumeric
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
Data key format
String
2-character alphanumeric
'data_key_format'=>$data_key_
format
Credential on File Transaction Object Request Fields
Value
Issuer ID
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Type
String
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Vault Add Credit Card
$type,
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
'note'=>$note,
'pan'=>$pan,
'expdate'=>$expiry_date,
//'data_key_format'=>$data_key_format, //optional
'crypt_type'=>$crypt_type
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setIssuerId("139X3130ASCXAS9");
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Page 55 of 480
April 2019
4 Vault
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.1.1 Vault Data Key
The ResAddCC sample code includes the following instruction from the Receipt object:
print("\nDataKey = " . $mpgResponse->getDataKey());
The data key response field is populated when you send a Vault Add Credit Card – ResAddCC (page 52),
Vault Encrypted Add Credit Card – EncResAddCC (page 56), Vault Tokenize Credit Card – ResTokenizeCC
(page 79), Vault Temporary Token Add – ResTempAdd (page 59) or Vault Add Token – ResAddToken
(page 76) transaction. It is the profile identifier that all future financial Vault transactions will use to associate with the saved information.
The data key is a maximum 28-character alphanumeric string.
4.3.1.2 Vault Encrypted Add Credit Card – EncResAddCC
Vault Encrypted Add Credit Card transaction object definition
$txnArray = array(‘type’=>’enc_res_add_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Encrypted Add Credit Card transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Encrypted Add Credit Card transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 22: Vault Encrypted Add Credit Card transaction object mandatory values
Value
Type
Limits
Encrypted Track2 data
String
40-character numeric
'enc_track2'=>$enc_track2
Device type
String
30-character alphanumeric
'device_type'=>$device_type
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
April 2019
Set method
Page 56 of 480
Moneris Gateway API - Integration Guide
Table 23: Vault Encrypted Add Credit Card transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
AVS information
Object
Not applicable. Click
hereSee 9.1 (page
281).
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Email address
String
30-character alphanumeric
'email'=>$email
Phone number
String
30-character alphanumeric
enc_res_add_cc
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
Data key format1
String
2-character alphanumeric
'data_key_format'=>$data_key_
format
Sample Vault Encrypted Add Credit Card
$type,
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
1Available to Canadian integrations only.
Page 57 of 480
April 2019
4 Vault
Sample Vault Encrypted Add Credit Card
'note'=>$note,
'enc_track2'=>$enc_track2,
'device_type'=>$device_type,
//'data_key_format'=>$data_key_format, //optional
'crypt_type'=>$crypt_type
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
April 2019
Page 58 of 480
Moneris Gateway API - Integration Guide
4.3.2 Vault Temporary Token Add – ResTempAdd
Creates a new temporary token credit card profile. This transaction requires a duration to be set to indicate how long the temporary token is to be stored for.
During the lifetime of this temporary token, it may be used for any other Vault transaction before it is permanently deleted from the system.
Things to Consider:
l
The duration, or lifetime, of the temporary token can be set to be a maximum of 15
minutes.
Vault Temporary Token Add transaction object definition
$txnArray = array(‘type’=>’res_temp_add', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Temporary Token Add transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Temporary Token Add transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 24: Vault Temporary Token Add transaction object mandatory values
Value
Type
Limits
Set method
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
Duration
String
3-character numeric
'duration'=>$duration
maximum 15 minutes
E-commerce indicator
Page 59 of 480
String
1-character alphanumeric
'crypt_type'=>$crypt
April 2019
4 Vault
Table 25: Vault Temporary Token Add transaction optional values
Value
Data key format1
Type
String
Limits
2-character alphanumeric
Set method
'data_key_format'=>$data_key_
format
Sample Vault Temporary Token Add
$type,
'pan'=>$pan,
'expdate'=>$expiry_date,
'duration'=>$duration,
//'data_key_format'=>$data_key_format, //optional
'crypt_type'=>$crypt_type
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\Masked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
?>
'crypt_type'=>$crypt_type
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
1Available to Canadian integrations only.
April 2019
Page 60 of 480
Moneris Gateway API - Integration Guide
Sample Vault Temporary Token Add
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\Masked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.3 Vault Update Credit Card – ResUpdateCC
Updates a Vault profile (based on the data key) to contain credit card information. All information contained within a credit card profile is updated as indicated by the submitted fields.
Things to Consider:
l
l
This will update a profile to contain Credit Card information by referencing the profile’s
unique data key. If the profile which is being updated was already a Credit Card profile,
all information contained within it will simply be updated as indicated by the submitted
fields. This means that all fields are optional, and only those fields that are submitted
will be updated.
To update a specific field on the profile, only set that specific element using the corresponding set method.
Vault Update Credit Card transaction object definition
$txnArray = array(‘type’=>’res_update_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Update Credit Card transaction
$mpgRequest = new mpgRequest($mpgTxn);
Page 61 of 480
April 2019
4 Vault
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Update Credit Card transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 26: Vault Update Credit Card transaction object mandatory values
Value
Type
Data key
String
Limits
25-character alphanumeric
Set method
'data_key'=>$data_key
Optional values that are submitted to the ResUpdateCC object are updated. Unsubmitted optional values (with one exception) remain unchanged. This allows you to change only the fields you want.
If a profile contains AVS information, but a Vault Update Credit Card transaction is submitted without an
AVS Info object, the existing AVS Info details are deactivated and the new credit card information is
registered without AVS.
Table 27: Vault Update Credit Card transaction optional values
Value
Type
Limits
Set method
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
AVS information
Object
n/a
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Email address
String
30-character alphanumeric
'email'=>$email
April 2019
Page 62 of 480
Moneris Gateway API - Integration Guide
Value
Type
Limits
Set method
Phone number
String
30-character alphanumeric
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
Credential on File Info
Object
N/A
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Credential on File Transaction Object Request Fields
Value
Issuer ID
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Type
String
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Vault Update Credit Card
$type,
'data_key'=>$data_key,
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
'note'=>$note,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt_type
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setIssuerId("168451306048014");
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
April 2019
Page 64 of 480
Moneris Gateway API - Integration Guide
Sample Vault Update Credit Card
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.3.1 Vault Encrypted Update CC - EncResUpdateCC
Vault Encrypted Update CC transaction object definition
$txnArray = array(‘type’=>’enc_res_update_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Encrypted Update CC transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Encrypted Update CC transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 28: Vault Encrypted Update CC transaction object mandatory values
Value
Type
Limits
Set method
Data key
String
25-character alphanumeric
'data_key'=>$data_key
Encrypted Track2 data
String
Variable length
'enc_track2'=>$enc_track2
Device type
String
30-character alphanumeric
'device_type'=>$device_type
Page 65 of 480
April 2019
4 Vault
Optional values that are submitted to the ResUpdateCC object are updated, while unsubmitted optional
values (with one exception) remain unchanged. This allows you to change only the fields you want.
The exception is that if you are making changes to the payment type, all of the variables in the optional
values table below must be submitted.
If you update a profile to a different payment type, it is automatically deactivated and a new credit card
profile is created and assigned to the data key. The only values from the prior profile that will remain
unchanged are the customer ID, phone number, email address, and note.
EXAMPLE: If a profile contains AVS information, but a ResUpdateCC transaction is submitted without an AVSInfo object, the existing AVSInfo details are deactivated and the new
credit card information is registered without AVS.
Table 29: Vault Encrypted Update CC transaction optional values
Value
Type
Limits
Set method
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
AVS information
Object
Not applicable. Click
hereSee 9.1 (page
281).
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Email address
String
30-character alphanumeric
'email'=>$email
Phone number
String
30-character alphanumeric
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
Sample Vault Encrypted Update CC - CA
$type,
'data_key'=>$data_key,
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
'note'=>$note,
'enc_track2'=>$enc_track2,
'device_type'=>$device_type,
'crypt_type'=>$crypt_type
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Page 67 of 480
April 2019
4 Vault
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.4 Vault Delete - ResDelete
NOTE: After a profile has been deleted, the details can no longer be retrieved.
Vault Delete transaction object definition
$txnArray = array(‘type’=>’res_delete', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Delete transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Delete transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 30: Vault Delete transaction object mandatory values
Value
Data key
Type
String
Limits
25-character alphanumeric
Set method
'data_key'=>$data_key
Sample Vault Delete
$type,
'data_key'=>$data_key
);
April 2019
Page 68 of 480
Moneris Gateway API - Integration Guide
Sample Vault Delete
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.5 Vault Lookup Full - ResLookupFull
Vault Lookup Full transaction object definition
$txnArray = array(‘type’=>’res_lookup_full', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Lookup Full transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Page 69 of 480
April 2019
4 Vault
Vault Lookup Full transaction values
Table 31: Vault Lookup Full transaction object mandatory values
Value
Data key
April 2019
Type
String
Limits
25-character alphanumeric
Set method
'data_key'=>$data_key
Page 70 of 480
Moneris Gateway API - Integration Guide
Sample Vault Lookup Full
$type,
'data_key'=>$data_key
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nPan = " . $mpgResponse->getResDataPan());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.6 Vault Lookup Masked – ResLookupMasked
Vault Lookup Masked transaction object definition
$txnArray = array(‘type’=>’res_lookup_masked', …);
Page 71 of 480
April 2019
4 Vault
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Lookup Masked transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Lookup Masked transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 32: Vault Lookup Masked transaction object mandatory values
Value
Data key
Type
String
Limits
25-character alphanumeric
Set method
'data_key'=>$data_key
Sample Vault Lookup Masked
$type,
'data_key'=>$data_key
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
April 2019
Page 72 of 480
Moneris Gateway API - Integration Guide
Sample Vault Lookup Masked
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.7 Vault Get Expiring – ResGetExpiring
Vault Get Expiring transaction object definition
$txnArray = array(‘type’=>’res_get_expiring', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Get Expiring transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Get Expiring transaction values
ResGetExpiring transaction object mandatory values: None.
Sample Vault Get Expiring
$type );
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
Page 73 of 480
April 2019
4 Vault
Sample Vault Get Expiring
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------$DataKeys = $mpgResponse->getDataKeys();
for($i=0; $i < count($DataKeys); $i++)
{
$mpgResponse->setResolveData($DataKeys[$i]);
print("\n\nData Key = " . $DataKeys[$i]);
print("\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
}
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.8 Vault Is Corporate Card - ResIscorporateCard
Vault Is Corporate Card transaction object definition
$txnArray = array(‘type’=>’res_iscorporatecard', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Is Corporate Card transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
April 2019
Page 74 of 480
Moneris Gateway API - Integration Guide
Vault Is Corporate Card transaction values
Table 33: Vault Is Corporate Card transaction object mandatory values
Value
Data key
Type
String
Limits
25-character alphanumeric
Set method
'data_key'=>$data_key
Sample Vault Is Corporate Card
$type,
'data_key'=>$data_key
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nCorporateCard = " . $mpgResponse->getCorporateCard());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
Page 75 of 480
April 2019
4 Vault
4.3.9 Vault Add Token – ResAddToken
This transaction is used to convert a temporary token into a permanent token for storage in the Moneris
Vault
Things to Consider:
l
l
l
If you intend to store the token for use in future transactions (i.e., Credential on File
transactions), first you must send either a Vault financial transaction (Purchase
with Vault or Pre-Authorization with Vault) or a Card Verification with Vault in order to
get the Issuer ID
The Vault Add Token request uses the Issuer ID to indicate that it is referencing stored
credentials
Vault Add Token transaction object definition
$txnArray = array(‘type’=>’res_add_token', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Add Token transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Add Token transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 34: Vault Add Token transaction object mandatory values
Value
Type
Limits
Set method
Data key
String
28-character alphanumeric
'data_key'=>$data_key
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Credential on File Info
Object
N/A
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
April 2019
Page 76 of 480
Moneris Gateway API - Integration Guide
Value
Type
Limits
Set method
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Table 35: Vault Add Token transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Email address
String
30-character alphanumeric
'email'=>$email
Phone number
String
30-character alphanumeric
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
Data key format1
String
2-character alphanumeric
'data_key_format'=>$data_key_
format
1Available to Canadian integrations only.
Page 77 of 480
April 2019
4 Vault
Credential on File Transaction Object Request Fields
Value
Issuer ID
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Type
Limits
String
15-character numeric
variable length
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Vault Add Token
$type,
'data_key'=>$temp_data_key,
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
'note'=>$note,
'expdate'=>$expiry_date,
//'data_key_format'=>$data_key_format, //optional
'crypt_type'=>$crypt_type
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
April 2019
Page 78 of 480
Moneris Gateway API - Integration Guide
Sample Vault Add Token
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setIssuerId("168451306048014");
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.3.10 Vault Tokenize Credit Card – ResTokenizeCC
Creates a new credit card profile using the credit card number, expiry date and e-commerce indicator
that were submitted in a previous financial transaction. Previous transactions to be tokenized must have
included the Credential on File Info object.
The Issuer ID received in the previous transaction response is sent in the Vault Tokenize Credit Card
request to reference that this is a stored credential.
Basic transactions that can be tokenized are:
Page 79 of 480
April 2019
4 Vault
l
l
l
Purchase
Pre-Authorization
Card Verification
The tokenization process is outlined below :
Figure 1: Tokenize process diagram
Vault Tokenize Credit Card transaction object definition
$txnArray = array(‘type’=>’res_tokenize_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Tokenize Credit Card transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Tokenize Credit Card transaction values
These mandatory values reference a previously processed credit card financial transaction. The credit
card number, expiry date, and e-commerce indicator from the original transaction are registered in the
Vault for future financial Vault transactions.
Table 36: Vault Tokenize Credit Card transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
April 2019
Page 80 of 480
Moneris Gateway API - Integration Guide
Table 37: Vault Tokenize Credit Card transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Email address
String
30-character alphanumeric
'email'=>$email
Phone number
String
30-character alphanumeric
'phone'=>$phone
Note
String
30-character alphanumeric
'note'=>$note
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Data key format1
String
2-character alphanumeric
'data_key_format'=>$data_key_
format
Credential on File Info
Object
N/A
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
1Available to Canadian integrations only.
Page 81 of 480
April 2019
4 Vault
Credential on File Transaction Object Request Fields
Value
Issuer ID
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Type
String
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Any field that is not set in the tokenize request is not stored with the transaction. That is, Moneris Gateway does not automatically take the optional information that was part of the original transaction.
The ResolveData that is returned in the response fields indicates what values were registered for this profile.
Sample Vault Tokenize Credit Card
$type,
'order_id'=>$order_id,
'txn_number'=>$txn_number,
//'data_key_format'=>$data_key_format, //optional
'cust_id'=>$cust_id,
'phone'=>$phone,
'email'=>$email,
'note'=>$note
);
/********************** AVS Associative Array *********************************/
$avsTemplate = array(
April 2019
Page 82 of 480
Moneris Gateway API - Integration Guide
Sample Vault Tokenize Credit Card
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
/************************** AVS Object ***************************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setIssuerId("168451306048014");
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setAvsInfo($mpgAvsInfo);
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.4 Vault Financial Transactions
After a financial transaction is complete, the response fields indicate all the values that are currently
saved under the profile that was used.
Page 83 of 480
April 2019
4 Vault
4.4.1 Customer ID Changes
Some financial transactions take the customer ID as an optional value. The customer ID may or may not
already be in the Vault profile when the transaction is sent. Therefore, it is possible to change the value of
the customer ID by performing a financial transaction
The table below shows what the customer ID will be in the response field after a financial transaction is
performed.
Table 38: Customer ID use in response fields
Already in profile?
Passed in?
Version used in response
No
No
Customer ID not used in transaction
No
Yes
Passed in
Yes
No
Profile
Yes
Yes
Passed in
4.4.2 Purchase with Vault – ResPurchaseCC
Purchase with Vault transaction object definition
$txnArray = array(‘type’=>’res_purchase_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Purchase with Vault transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Purchase with Vault transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 39: Purchase with Vault transaction object mandatory values
Value
Type
Limits
Set method
Data key
String
25-character alphanumeric
'data_key'=>$data_key
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snip-
'amount'=>$amount
April 2019
Page 84 of 480
Moneris Gateway API - Integration Guide
Value
Type
Limits
Set method
pet)
E-commerce indicator
String
1-character alphanumeric
Credential on File Info
Object
N/A
'crypt_type'=>$crypt
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Table 40: Purchase with Vault transaction optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
YYMM format.
(Note that this is
reversed from the
date displayed on the
card, which is MMYY)
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Customer information
Object
N/A
$mpgTxn->setCustInfo
Page 85 of 480
April 2019
4 Vault
Value
Type
Limits
Set method
($mpgCustInfo);
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD information
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Object
N/A
$mpgTxn->setRecur($mpgRecur);
NOTE: When storing
credentials on the initial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Recurring billing
April 2019
Page 86 of 480
Moneris Gateway API - Integration Guide
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Information
String
1-character numeric
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Purchase with Vault
'res_purchase_cc',
'data_key'=>$data_key,
'order_id'=>$orderid,
'cust_id'=>$custid,
'amount'=>$amount,
'crypt_type'=>$crypt_type,
//'expdate'=>$expdate,
'dynamic_descriptor'=>'12484'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("12345678901234");
$mpgTxn->setCofInfo($cof);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nAVSResponse = " . $mpgResponse->getAvsResultCode());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
April 2019
Page 88 of 480
Moneris Gateway API - Integration Guide
Sample Purchase with Vault
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.4.3 Pre-Authorization with Vault – ResPreauthCC
Pre-Authorization with Vault transaction object definition
$txnArray = array(‘type’=>’res_preauth_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Pre-Authorization with Vault transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Pre-Authorization with Vault transaction values
Table 41: Pre-Authorization with Vault transaction object mandatory values
Value
Type
Limits
Set method
Data key
String
25- character alphanumeric
'data_key'=>$data_key
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
10-character decimal
'amount'=>$amount
Up to 7 digits
(dollars) + decimal
point (.) + 2 digits
(cents) after the
decimal point
EXAMPLE: 1234567.89
E-commerce indicator
Page 89 of 480
String
1-character alpha-
'crypt_type'=>$crypt
April 2019
4 Vault
Table 41: Pre-Authorization with Vault transaction object mandatory values (continued)
Value
Type
Limits
Set method
numeric
Credential on File Info
Object
N/A
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Table 42: Pre-Authorization with Vault transaction optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
Customer ID
April 2019
String
50-character alphanumeric
'cust_id'=>$cust_id
Page 90 of 480
Moneris Gateway API - Integration Guide
Value
Type
Limits
Set method
Customer information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD information
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
NOTE: When storing
credentials on the initial transaction, the
CVD object must be
sent; for subsequent
transactions using
stored credentials, CVD
can be sent with cardholder-initiated transactions only—
merchants must not
store CVD information.
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Inform-
Page 91 of 480
String
1-character numeric
April 2019
4 Vault
Value
ation
Type
Limits
Set Method
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Pre-Authorization with Vault
'res_preauth_cc',
'data_key'=>$data_key,
'order_id'=>$orderid,
'cust_id'=>$custid,
'amount'=>$amount,
'crypt_type'=>$crypt_type,
//'expdate=>$expdate,
'dynamic_descriptor'=>'12424'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("12345678901234");
$mpgTxn->setCofInfo($cof);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
April 2019
Page 92 of 480
Moneris Gateway API - Integration Guide
Sample Pre-Authorization with Vault
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nAVSResponse = " . $mpgResponse->getAvsResultCode());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.4.4 Vault Independent Refund CC - ResIndRefundCC
Vault Independent Refund transaction object definition
$txnArray = array(‘type’=>’res_ind_refund_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Vault Independent Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Vault Independent Refund transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 93 of 480
April 2019
4 Vault
Table 43: Vault Independent Refund transaction object mandatory values
Value
Type
Limits
Set method
Data key
String
25-character alphanumeric
'data_key'=>$data_key
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
10-character decimal
'amount'=>$amount
Up to 7 digits
(dollars) + decimal
point (.) + 2 digits
(cents) after the
decimal point
EXAMPLE: 1234567.89
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 44: Vault Independent Refund transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
April 2019
Page 94 of 480
Moneris Gateway API - Integration Guide
Sample Vault Independent Refund
'res_ind_refund_cc',
'data_key'=>$data_key,
'order_id'=>$orderid,
'cust_id'=>$custid,
'amount'=>$amount,
'crypt_type'=>$crypt_type,
'dynamic_descriptor'=>'12346'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
Page 95 of 480
April 2019
4 Vault
Sample Vault Independent Refund
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
Vault response fields
For a list and explanation of (Receipt object) response fields that are available after sending this Vault
transaction, see Definitions of Response Fields (page 441).
4.4.5 Force Post with Vault - ResForcePostCC
Force Post with Vault transaction object definition
$txnArray = array(‘type’=>’res_forcepost_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Force Post with Vault transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Force Post with Vault transaction object values
Table 1 Force Post with Vault transaction object mandatory values
Value
Type
Limits
Set Method
Amount
String
(missing or bad snippet)
'amount'=>$amount
Data key
String
25-character alphanumeric
'data_key'=>$data_key
Authorization code
String
8-character alphanumeric
'auth_code'=>$auth_code
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
April 2019
Page 96 of 480
Moneris Gateway API - Integration Guide
Table 2 Force Post with Vault transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic Descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Force Post with Vault
'res_forcepost_cc',
'order_id'=>$orderid,
'cust_id'=>$custid,
'amount'=>$amount,
'data_key'=>$data_key,
'crypt_type'=>$crypt_type,
'auth_code'=>$auth_code,
'dynamic_descriptor'=>$dynamic_descriptor
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
Page 97 of 480
April 2019
4 Vault
Sample Force Post with Vault
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nAVSResponse = " . $mpgResponse->getAvsResultCode());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
4.4.6 Card Verification with Vault – ResCardVerificationCC
Things to Consider:
l
l
l
This transaction type only applies to Visa, Mastercard and Discover transactions
The card number and expiry date for this transaction are passed using a token, as represented by the data key value
When using a temporary token (e.g., such as with Hosted Tokenization) and you intend
to store the cardholder credentials, this transaction must be run prior to running the
Vault Add Token transaction
Card Verification with Vault object definition
$txnArray = array(‘type’=>’res_card_verification_cc', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Card Verification with Vault transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Card Verification with Vault transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 98 of 480
Moneris Gateway API - Integration Guide
Table 45: Card Verification with Vault transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Data key
String
25-character alphanumeric
'data_key'=>$data_key
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
AVS
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Credential on File Info
Object
N/A
$mpgTxn->setCofInfo($cof);
cof
NOTE: This is a nested
object within the transaction, and required
when storing or using
the customer's stored
credentials. The Credential on File Info
object has its own
request variables, listed in blue in the table
below, "Credential on
File Object Request
Variables".
Page 99 of 480
April 2019
4 Vault
Credential on File Transaction Object Request Fields
Value
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
15-character alphanumeric
Set Method
$cof->setIssuerId("VALUE_FOR_
ISSUER_ID");
variable length
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
String
1-character alphabetic
$cof->setPaymentIndicator
("PAYMENT_INDICATOR_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Payment Information
String
1-character numeric
$cof->setPaymentInformation
("PAYMENT_INFO_VALUE");
NOTE: For a list and explanation of the possible values to send for this variable, see
Definitions of Request Fields – Credential
on File
Sample Card Verification with Vault
'res_card_verification_cc',
'data_key'=>$data_key,
'order_id'=>$orderid,
'crypt_type'=>$crypt_type,
'expdate'=>$expdate
);
/************************** CVD Variables *****************************/
$cvd_indicator = '1';
$cvd_value = '198';
/********************** CVD Associative Array *************************/
$cvdTemplate = array(
'cvd_indicator' => $cvd_indicator,
'cvd_value' => $cvd_value
);
$mpgCvdInfo = new mpgCvdInfo ($cvdTemplate);
/************************** AVS Variables *****************************/
//The AVS portion is optional if AVS details are already stored in this profile
//If AVS details are resent in Purchase transaction, they will replace stored details
$avs_street_number = '';
$avs_street_name = 'bloor st';
$avs_zipcode = '111111';
/********************** AVS Associative Array *************************/
$avsTemplate = array(
'avs_street_number' => $avs_street_number,
'avs_street_name' => $avs_street_name,
'avs_zipcode' => $avs_zipcode
);
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setCvdInfo($mpgCvdInfo);
$mpgTxn->setAvsInfo($mpgAvsInfo);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("12345678901234");
$mpgTxn->setCofInfo($cof);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nDataKey = " . $mpgResponse->getDataKey());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nMessage = " . $mpgResponse->getMessage());
Page 101 of 480
April 2019
4 Vault
Sample Card Verification with Vault
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCVDResponse = " . $mpgResponse->getCvdResultCode());
print("\nAVSResponse = " . $mpgResponse->getAvsResultCode());
print("\nResSuccess = " . $mpgResponse->getResSuccess());
print("\nPaymentType = " . $mpgResponse->getPaymentType());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
//----------------- ResolveData -----------------------------print("\n\nCust ID = " . $mpgResponse->getResDataCustId());
print("\nPhone = " . $mpgResponse->getResDataPhone());
print("\nEmail = " . $mpgResponse->getResDataEmail());
print("\nNote = " . $mpgResponse->getResDataNote());
print("\nMasked Pan = " . $mpgResponse->getResDataMaskedPan());
print("\nExp Date = " . $mpgResponse->getResDataExpDate());
print("\nCrypt Type = " . $mpgResponse->getResDataCryptType());
print("\nAvs Street Number = " . $mpgResponse->getResDataAvsStreetNumber());
print("\nAvs Street Name = " . $mpgResponse->getResDataAvsStreetName());
print("\nAvs Zipcode = " . $mpgResponse->getResDataAvsZipcode());
?>
4.5 Hosted Tokenization
Moneris Hosted Tokenization is a solution for online e-commerce merchants who do not want to handle
credit card numbers directly on their websites, yet want the ability to fully customize their check-out web
page appearance.
When an hosted tokenization transaction is initiated, the Moneris Gateway displays (on the merchant’s
behalf) a single text box on the merchant’s checkout page. The cardholder can then securely enter the
credit card information into the text box. Upon submission of the payment information on the checkout
page, Moneris Gateway returns a temporary token representing the credit card number to the merchant. This is then used in an API call to process a financial transaction directly with Moneris to charge
the card. After receiving a response to the financial transaction, the merchant generates a receipt and
allows the cardholder to continue with online shopping.
For more details on how to implement the Moneris Hosted Tokenization feature, see the Hosted Solutions Integration Guide. The guide can be downloaded from the Moneris Developer Portal
(https://developer.moneris.com).
April 2019
Page 102 of 480
5 INTERAC® Online Payment
l
l
l
l
l
l
l
l
5.1
5.2
5.3
5.4
5.5
5.6
5.7
5.8
About INTERAC® Online Payment Transactions
Other Documents and References
Website and Certification Requirements
Transaction Flow for INTERAC® Online Payment
Sending an INTERAC® Online Payment Purchase Transaction
INTERAC® Online Payment Purchase
INTERAC® Online Payment Refund
INTERAC® Online Payment Field Definitions
5.1 About INTERAC® Online Payment Transactions
The INTERAC® Online Payment method offers cardholders the ability to pay using online banking. This
payment method can be combined with the Moneris Gateway API solution to allow online payments
using credit and debit cards.
INTERAC® Online Payment transactions via the API require two steps:
1. The cardholder guarantees the funds for the purchase amount using their online banking process.
2. The merchant confirms the payment by sending an INTERAC® Online Payment purchase request
to Moneris using the API.
Any of the transaction objects that are defined in this section can be passed to the HttpsPostRequest
connection object defined in Section 17.5 Processing a Transaction.
INTERAC® Online Payment transactions are available to Canadian integrations only.
5.2 Other Documents and References
INTERAC® Online Payment is offered by Acxsys Corporation, which is also a licensed user of the Interac
logo. Refer to the following documentation and websites for additional details.
INTERAC® Online PaymentMerchant Guideline
Visit the Moneris Developer Portal (https://developer.moneris.com) to access the latest documentation
and downloads.
This details the requirements for each page consumers visit on a typical INTERAC® Online Payment merchant website. It also details the requirements that can be displayed on any page (that is, requirements
that are not page-specific).
Logos
Visit the Moneris Developer Portal (https://developer.moneris.com) to access the logos and downloads.
April 2019
Canada Only
Page 103 of 480
Moneris Gateway API - Integration Guide
5.3 Website and Certification Requirements
5.3.1 Things to provide to Moneris
Refer to the Merchant Guidelines referenced in Section 5.2 for instructions on proper use of logos and
the term "INTERAC® Online Payment". You need to provide Moneris with the following registration
information:
l
l
l
l
l
Merchant logo to be displayed on the INTERAC® Online Payment Gateway page
l In both French and English
l 120 × 30 pixels
l Only PNG format is supported.
Merchant business name
l In both English and French
l Maximum 30 characters.
List of all referrer URLs. That is, URLs from which the customer may be redirected to the INTERAC®
Online Payment gateway.
List of all URLs that may appear in the IDEBIT_FUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
List of all URLs that may appear in the IDEBIT_NOTFUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
Note that if your test and production environments are different, provide the above information for
both environments.
5.3.2 Certification process
Test cases
All independent merchants and third-party service/shopping cart providers must pass the certification
process by conducting all the test cases outlined in Appendix E (page 458) and "Third-Party Service Provider Checklists for INTERAC® Online Payment Certification Testing" on page 462 respectively. This is
required after you have completed all of your testing.
Any major changes to your website after certification (with respect to the INTERAC® Online Payment functionality) require the site to be re-certified by completing the test cases again.
Appendix H (page 470) is the Certification Test Case Detail showing all the information and requirements
for each test case.
Page 104 of 480
Canada Only
April 2019
5 INTERAC® Online Payment
Screenshots
You must provide Moneris with screenshots of your check-out process showing examples of approved
and declined transactions using the INTERAC® Online Payment service.
Checklists
To consistently portray the INTERAC Online service as a secure payment option, you must complete the
respective Merchant Requirement checklist inAppendix E (page 458) or Appendix F (page 462)accordingly.
The detailed descriptions of the requirements in these checklists can be found in the INTERAC® Online
Payment Merchant Guidelines document referred to in 5.2 (page 103). If any item does not apply, mark it
as "N/A".
After completion, fax or email the results to the Moneris Integration Support help desk for review before
implementing the change into the production environment.
5.3.3 Client Requirements
Checklists
As a merchant using an INTERAC® Online Payment-certified third-party solution, your clients must complete the Merchant Checklists for INTERAC® Online Payment Certification form (Appendix G, page 467).
They will not be required to complete any of the test cases.
Your clients must also complete the Merchant Requirement checklist (Appendix G, page 467). Ensure that
your product documentation properly instructs your clients to fax or email the results to the Moneris
Integration Support helpdesk for registration purposes.
Screenshots
Your clients must provide Moneris with screenshots of their check-out process that show examples of
approved and declined transactions using INTERAC® Online Payment.
5.3.4 Delays
Note that merchants that fall under the following category codes listed in Table 46 may experience delays
in the certification or registration process of up to 7 days.
Table 46: Category codes that might introduce certification/registration delays
Category code
Merchant type/name
4812
Telecommunication equipment including telephone sales
4829
Money transfer—merchant
5045
Computers, computer peripheral equipment, software
5732
Electronic sales
6012
Financial institution—merchandise and services
6051
Quasi cash—merchant
April 2019
Canada Only
Page 105 of 480
Moneris Gateway API - Integration Guide
Category code
Merchant type/name
6530
Remote stored value load—merchant
6531
Payment service provider—money transfer for a purchase
6533
Payment service provider—merchant—payment transaction
5.4 Transaction Flow for INTERAC® Online Payment
Figure 2: INTERAC® Online Payment transaction flow diagram
1. Customer selects the INTERAC® Online Payment option on the merchant's web store.
2. Merchant redirects the customer to the IOP gateway to select a financial institution (issuer) of
choice. This step involves form-posting the following required variables over the HTTPS protocol:
l
l
l
l
l
l
l
l
l
IDEBIT_MERCHNUM
IDEBIT_AMOUNT1
IDEBIT_CURRENCY
IDEBIT_FUNDEDURL
IDEBIT_NOTFUNDEDURL
IDEBIT_MERCHLANG
IDEBIT_VERSIONIDEBIT_TERMID - optional
IDEBIT_INVOICE - optional
IDEBIT_MERCHDATA - optional
3. Customer selects an issuer, and is directed to the online banking site. Customer completes the
online banking process and guarantees the funds for the purchase.
1This value is expressed in cents. Therefore, $1 is input as 100
Page 106 of 480
Canada Only
April 2019
5 INTERAC® Online Payment
4. Depending on the results of step 5.4, the issuer re-directs the customer through the IOP Gateway to either the merchant's non-funded URL (4a) or funded URL (4b). Both URLs can appear on
the same page. The funded/non-funded URLs must validate the variables posted back according
to 5.8 (page 112) before continuing.
5.4 shows the variables that are posted back in the re-direction.
If the customer is directed to the non-funded URL, return to step 5.4 and ask for another means
of payment.
If the customer is directed to the funded URL, continue to the next step.
5. Merchant sends an INTERAC® Online Payment purchase request to Moneris Gateway while displaying the "Please wait...." message to the customer. This should be done within 30 minutes of
receiving the response in step 5.4.
6. Moneris' processing host sends a request for payment confirmation to the issuer.
7. The issuer sends a response (either approved or declined) to Moneris host.
8. Moneris Gateway relays the response back to the merchant. If the payment was approved, the
merchant fulfills the order.
Table 47: Funded and non-funded URL variables
To funded URL only
To funded and non-funded URL
IDEBIT_TRACK2
IDEBIT_VERSION
IDEBIT_ISSCONF
IDEBIT_ISSLANG
IDEBIT_ISSNAME
IDEBIT_TERMID (optional)
IDEBIT_INVOICE (optional)
IDEBIT_MERCHDATA (optional)
5.5 Sending an INTERAC® Online Payment Purchase Transaction
5.5.1 Fund-Guarantee Request
After choosing to pay by INTERAC® Online Payment, the customer is redirected using an HTML form post
to the INTERAC® Online PaymentGateway page. Below is a sample code that is used to post the request
to the Gateway.
April 2019
Canada Only
Page 107 of 480
Moneris Gateway API - Integration Guide
5.5.2 Online Banking Response and Fund-Confirmation Request
The response variables are posted back in an HTML form to either the funded or non-funded URL that
was provided to INTERAC®.
The following variables must be validated (5.8, page 112):
l
l
l
l
l
l
IDEBIT_TRACK2
IDEBIT_ISSCONF
IDEBIT_ISSNAME
IDEBIT_VERSION
IDEBIT_ISSLANG
IDEBIT_INVOICE
Note that IDEBIT_ISSCONF and IDEBIT_ISSNAME must be displayed on the client’s receipt that is generated by the merchant.
After validation, IDEBIT_TRACK2 is used to form an IDebitPurchase transaction that is sent to Moneris
Gateway to confirm the fund.
If the validation fails, redirect the client to the main page and ask for a different means of payment.
If the validation passes, an IDebitPurchase transaction can be sent to Moneris Gateway.
5.6 INTERAC® Online Payment Purchase
INTERAC® Online Payment Purchase transaction object definition
$txnArray = array(‘type’=>’idebit_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for INTERAC® Online Payment Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
INTERAC® Online Payment Purchase transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 108 of 480
Canada Only
April 2019
5 INTERAC® Online Payment
Table 48: INTERAC® Online Payment transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Track2 data
String
40-character alphanumeric
'idebit_track2'=>$idebit_
track2
Table 49: INTERAC® Online Payment Purchase transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic
descriptor
String
20-character alphanumeric
'dynamic_descriptor'=>$dynamic_
descriptor
Customer
information
Object
Not applicable. Click hereSee $mpgTxn->setCustInfo
($mpgCustInfo);
Section 14 (page 354).
Sample INTERAC® Online Payment Purchase
'idebit_purchase',
'order_id'=>$orderid,
'cust_id'=>'my cust id',
'amount'=>'50.00',
'idebit_track2'=>'3728024906540591206=0609AAAAAAAAAAAAA'
);
## step 2) create a transaction object passing the hash created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
April 2019
Canada Only
Page 109 of 480
Moneris Gateway API - Integration Guide
Sample INTERAC® Online Payment Purchase
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
5.7 INTERAC® Online Payment Refund
To process this transaction, you need the order ID and transaction number from the original INTERAC®
Online Payment Purchase transaction.
INTERAC® Online Payment Refund transaction object definition
$txnArray = array(‘type’=>’idebit_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for INTERAC® Online Payment Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
INTERAC® Online Payment Refund transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 50: INTERAC® Online Payment Refund transaction object mandatory variables
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Page 110 of 480
Canada Only
April 2019
5 INTERAC® Online Payment
Table 51: INTERAC® Online Payment Refund transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
April 2019
Canada Only
Page 111 of 480
Moneris Gateway API - Integration Guide
Sample code
Sample INTERAC® Online Payment Refund
'idebit_refund',
'order_id'=>$orderid,
'amount'=>'50.00',
'txn_number'=>$txn_number
);
## step 2) create a transaction object passing the hash created in
## step 1.
$mpgTxn = new mpgTransaction($txnArray);
## step 3) create a mpgRequest object passing the transaction object created
## in step 2
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
## step 4) create mpgHttpsPost object which does an https post ##
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
## step 5) get an mpgResponse object ##
$mpgResponse=$mpgHttpPost->getMpgResponse();
## step 6) retrieve data using get methods
print ("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
5.8 INTERAC® Online Payment Field Definitions
Table 52: Field Definitions
Characters
Limits
Value
Description
IDEBIT_
MERCHNUM
Page 112 of 480
5-14
Numbers and uppercase letters
This field is provided by Moneris. For example, 0003MONMPGXXXX.
Canada Only
April 2019
5 INTERAC® Online Payment
Table 52: Field Definitions (continued)
Characters
Limits
Value
Description
IDEBIT_TERMID 8
Numbers and uppercase letters
Optional field
IDEBIT_
AMOUNT
1-12
IDEBIT_
CURRENCY
3
Numbers
Amount expressed in cents (for example, 1245 for $12.45) to charge to the card.
"CAD" or "USD"
National currency of the transaction.
IDEBIT_INVOICE 1-20
ISO-8859-1 encoded characters restricted to:
l
l
l
l
l
Uppercase and lowercase
Numbers
ÀÁÂÄÈÉÊËÎ Ï Ô ÙÛÜÇàáâäèéêëîïôù û ü ÿ ç
Spaces
#$. , -/ =?@'
Optional field
Can be the Order ID when used with Moneris Gateway fund confirmation transactions.
IDEBIT_
MERCHDATA
1024
ISO-8859-1 restricted to single-byte codes, hex 20 to 7E (consistent with
US-ASCII and ISO-8859-1 Latin-1).
Note that the following character combinations may not be accepted in
the IDEBIT_MERCHDATA field:
l
"/..", "/%2E.", "/.%2E", "/%2E%2E", "\\%2E%2E", "\\%2E.",
"\\.%2E", "\\%2E%2E", "&#", "<", "%3C", ">", "%3E"
Free form data provided by the merchant that will be passed back unchanged to the
merchant once the payment has been guaranteed in online banking.
This may be used to identify the customer, session or both.
April 2019
Canada Only
Page 113 of 480
Moneris Gateway API - Integration Guide
Table 52: Field Definitions (continued)
Characters
Limits
Value
Description
IDEBIT_
FUNDEDURL
1024
ISO-8859-1 restricted to single-byte codes, restricted to:
l
l
l
Uppercase and lowercase letters
Numbers
;/ ?:@&=+$, -_. !~*‘ ()%
Https address to which the issuer will redirect cardholders after guaranteeing the
fund through online banking.
IDEBIT_
1024
NOTFUNDEDURL
ISO-8859-1, restricted to single-byte codes, restricted to:
l
l
l
Uppercase and lowercase letters
Numbers
;/ ?:@&=+$, -_. !~*‘ ()%
Https address to which the issuer redirects cardholders after failing or canceling the
online banking process.
IDEBIT_
MERCHLANG
2
“en” or “fr”
Customer's current language at merchant.
IDEBIT_VERSION 3
Numbers
Initially, the value is 1.
IDEBIT_ISSLANG 2
“en” or “fr”
Customer’s current language at issuer.
IDEBIT_TRACK2
37
ISO-8859-1 (restricted to single-byte codes), hex 20 to 7E (consistent with
US-ASCII and ISO-8859-1 Latin-1)
Value returned by the issuer. It includes the PAN, expiry date, and transaction ID.
IDEBIT_ISSCONF 15
ISO-8859-1 encoded characters restricted to:
l
l
l
l
l
Uppercase and lowercase letters
Numbers
ÀÁÂÄÈÉÊËÎ Ï Ô ÙÛÜÇàáâäèéêëîïôù û ü ÿ ç
Spaces
#$. , -/ =?@'
Confirmation number returned from the issuer to be displayed on the merchant’s
confirmation page and on the receipt.
Page 114 of 480
Canada Only
April 2019
5 INTERAC® Online Payment
Table 52: Field Definitions (continued)
Characters
Limits
Value
Description
IDEBIT_
ISSNAME
30
ISO-8859-1 encoded characters restricted to:
l
l
l
l
l
Uppercase and lowercase letters
Numbers
ÀÁÂÄÈÉÊËÎ Ï Ô ÙÛÜÇàáâäèéêëîïôù û ü ÿ ç
Spaces
#$. , -/ =?@•'
Issuer name to be displayed on the merchant’s confirmation page and on the
receipt.
April 2019
Canada Only
Page 115 of 480
6 Mag Swipe Transaction Set
l
l
l
l
l
l
l
l
6.1 Mag Swipe Transaction Type Definitions
6.2 Mag Swipe Purchase
l 6.2.1 Encrypted Mag Swipe Purchase
6.3 Mag Swipe Pre-Authorization
l 6.3.1 Encrypted Mag Swipe Pre-Authorization
6.4 Mag Swipe Completion
6.5 Mag Swipe Force Post
l 6.5.1 Encrypted Mag Swipe Force Post
6.6 Mag Swipe Purchase Correction
6.7 Mag Swipe Refund
6.8 Mag Swipe Independent Refund
l 6.8.1 Encrypted Mag Swipe Independent Refund
Mag Swipe transactions allow customers to swipe a credit card and submit the Track2 details.
These transactions support the submission of Track2 as well as a manual entry of the credit card number
and expiry date. If all three fields are submitted, the Track2 details are used to process the transaction.
6.1 Mag Swipe Transaction Type Definitions
Purchase
Verifies funds on the customer’s card, removes the funds and prepares them for deposit into
the merchant’s account.
Pre-Authorization
Verifies and locks funds on the customer’s credit card. The funds are locked for a specified
amount of time based on the card issuer.
To retrieve the funds that have been locked by a Pre-Authorization transaction so that they
may be settled in the merchant’s account, a Completion transaction must be performed. A
Pre-Authorization may only be "completed" once.
Completion
Retrieves funds that have been locked (by a Mag Swipe Pre-Authorization transaction), and
prepares them for settlement into the merchant’s account.
Force Post
Retrieves the locked funds and prepares them for settlement into the merchant’s account.
This is used when a merchant obtains the authorization number directly from the issuer by a
third-party authorization method (such as by phone).
Purchase Correction
Restores the full amount of a previous Mag Swipe Purchase or Mag Swipe Completion transaction to the cardholder's card, and removes any record of it from the cardholder's statement. The order ID and transaction number from the original transaction are required, but
the credit card does not need to be re-swiped.
This transaction can be used against a Purchase or Completion transaction that occurred
same day provided that the batch containing the original transaction remains open. When
using the automated closing feature, Batch Close occurs daily between 10 and 11 pm Eastern
Time.
April 2019
Page 116 of 480
Moneris Gateway API - Integration Guide
This transaction is sometimes referred to as "void".
Refund
Restores all or part of the funds from a Mag Swipe Purchase or Mag Swipe Completion transaction to the cardholder's card. Unlike a Purchase Correction, there is a record of the refund.
Independent Refund
Credits a specified amount to the cardholder’s credit card.
This does not require a previous transaction (such as Mag Swipe Purchase) to be logged in the
Moneris Gateway. However, a credit card must be swiped to provide the Track2 data.
6.1.1 Encrypted Mag Swipe Transactions
Encrypted Mag Swipe transactions allow the customer to swipe or key in a credit card using a Monerisprovided encrypted mag swipe reader, and submit the encrypted Track2 details.
The encrypted mag swipe reader can be used for processing:
l
l
l
Swiped card-present transactions
Manually keyed card-present transactions
Manually keyed card-not-present transactions.
Encrypted Mag Swipe transactions are identical to the regular Mag Swipe transactions from the customer's perspective. However, the card data must be swiped or keyed in via a Moneris-provided encrypted mag swipe reader. Contact Moneris for more details.
Only Mag Swipe Purchase and Mag Swipe Pre-Authorization have encrypted versions. Their explanations
appear in this document as subsections of the regular (unencrypted) Mag Swipe Purchase and Mag
Swipe Pre-Authorization transactions respectively.
6.2 Mag Swipe Purchase
Mag Swipe Purchase transaction object definition
$txnArray = array(‘type’=>’track2_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Purchase transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 117 of 480
April 2019
6 Mag Swipe Transaction Set
Table 53: Mag Swipe Purchase transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
OR
OR
OR
Track2 data
40-character numeric
track2=>$track
4-character alphanumeric
'expdate'=>$expiry_date
Expiry date
String
(YYMM format)
POS code
String
2-character numeric
'pos_code'=>$pos_code
Table 54: Mag Swipe Purchase transaction optional values
Value
Type
Limits
Set method
AVS information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
CVD information
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Mag Swipe Purchase
'track2_purchase',
order_id=>$orderid,
cust_id=>$custid,
amount=>$amount,
track2=>$track,
pan=>'',
expdate=>'',
pos_code=>'00',
dynamic_descriptor=>'nqa'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
Page 119 of 480
April 2019
6 Mag Swipe Transaction Set
Sample Mag Swipe Purchase
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCardLevelResult = " . $mpgResponse->getCardLevelResult());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.2.1 Encrypted Mag Swipe Purchase
Encrypted Mag Swipe Purchase transaction object definition
$txnArray = array(‘type’=>’enc_track2_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Encrypted Mag Swipe Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Encrypted Mag Swipe Purchase transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 55: Encrypted Mag Swipe Purchase transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Encrypted Track2 data
String
n/a
'enc_track2'=>$enc_track2
POS code
String
2-character numeric
'pos_code'=>$pos_code
Device type
String
30-character alphanumeric
'device_type'=>$device_type
April 2019
Page 120 of 480
Moneris Gateway API - Integration Guide
Table 56: Encrypted Mag Swipe Purchase transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
AVS information
Object
n/a
$mpgTxn->setAvsInfo
($mpgAvsInfo);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Encrypted Mag Swipe Purchase
'enc_track2_purchase',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
enc_track2=>$enc_track2,
pos_code=>$pos_code,
device_type=>$device_type
);
/********************** AVS Associative Array *************************/
$avsTemplate = array(
avs_street_number=>"123",
avs_street_name =>"bloor st w",
avs_zipcode => "90210"
);
/************************** AVS Object ********************************/
$mpgAvsInfo = new mpgAvsInfo ($avsTemplate);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Set AVS and CVD *****************************/
$mpgTxn->setAvsInfo($mpgAvsInfo);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
Page 121 of 480
April 2019
6 Mag Swipe Transaction Set
Sample Encrypted Mag Swipe Purchase
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nMaskedPan = " . $mpgResponse->getMaskedPan());
?>
6.3 Mag Swipe Pre-Authorization
Mag Swipe Pre-Authorization transaction object definition
$txnArray = array(‘type’=>’track2preauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Pre-Authorization transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Pre-Authorization transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 57: Mag Swipe Pre-Authorization transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
OR
OR
OR
track2=>$track
April 2019
Page 122 of 480
Moneris Gateway API - Integration Guide
Table 57: Mag Swipe Pre-Authorization transaction object mandatory values (continued)
Value
Type
Track2 data
Limits
Set method
40-character numeric
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
POS code
String
2-character numeric
'pos_code'=>$pos_code
Table 58: Mag Swipe Pre-Authorization transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Mag Swipe Pre-Authorization
'track2_preauth',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
track2=>$track,
pan=>$pan,
expdate=>$expdate,
pos_code=>'00',
dynamic_descriptor=>'nqa'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCardLevelResult = " . $mpgResponse->getCardLevelResult());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.3.1 Encrypted Mag Swipe Pre-Authorization
Encrypted Mag Swipe Pre-Authorization transaction object definition
$txnArray = array(‘type’=>’enc_track2_preauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Encrypted Mag Swipe Pre-Authorization transaction
$mpgRequest = new mpgRequest($mpgTxn);
April 2019
Page 124 of 480
Moneris Gateway API - Integration Guide
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Encrypted Mag Swipe Pre-Authorization transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 59: Encrypted Mag Swipe Pre-Authorization transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
OR
OR
OR
Encrypted Track2
n/a
'enc_track2'=>$enc_track2
POS code
String
2-character numeric
'pos_code'=>$pos_code
Device type
String
30-character alphanumeric
'device_type'=>$device_type
Table 60: Encrypted Mag Swipe Pre-Authorization transaction optional values
Value
Type
Limits
Customer ID
String
50-character alphanumeric
Status Check
Boolean
true/false
Set method
'cust_id'=>$cust_id
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Encrypted Mag Swipe Pre-Authorization
'enc_track2_preauth',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
enc_track2=>$enc_track2,
pos_code=>$pos_code,
device_type=>$device_type,
dynamic_descriptor=>'12345'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nMaskedPan = " . $mpgResponse->getMaskedPan());
?>
6.4 Mag Swipe Completion
Mag Swipe Completion transaction object definition
$txnArray = array(‘type’=>’track2_completion', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Completion transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Completion transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 126 of 480
Moneris Gateway API - Integration Guide
Table 61: Mag Swipe Completion transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character
'txn_number'=>$txn_number
variable character
Completion Amount
String
(missing or bad snippet)
'comp_amount'=>$comp_amount
POS code
String
2-character numeric
track2completion
'pos_code'=>$pos_code
Table 62: Mag Swipe Completion transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Mag Swipe Completion
'track2_completion',
order_id=>$orderid,
comp_amount=>$compamount,
txn_number=>$txnnumber,
pos_code=>'00',
Page 127 of 480
April 2019
6 Mag Swipe Transaction Set
Sample Mag Swipe Completion
dynamic_descriptor=>$dynamic_descriptor
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.5 Mag Swipe Force Post
Mag Swipe Force Post transaction object definition
$txnArray = array(‘type’=>’track2_forcepost', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Force Post transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Force Post transaction mandatory arguments
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 128 of 480
Moneris Gateway API - Integration Guide
Table 63: Mag Swipe Force Post transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
OR
OR
OR
Track2 data
40-character numeric
track2=>$track
4-character alphanumeric
'expdate'=>$expiry_date
Expiry date
String
(YYMM format)
POS code
String
2-character numeric
'pos_code'=>$pos_code
Authorization code
String
8-character alphanumeric
'auth_code'=>$auth_code
Table 64: Mag Swipe Force Post transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
track2forcePost
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Mag Swipe Force Post
'track2_forcepost',
order_id=>$orderid,
cust_id=>$custid,
amount=>$amount,
track2=>$track,
pan=>'',
expdate=>'',
pos_code=>'00',
auth_code=>$authcode,
dynamic_descriptor=>'nqa'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
April 2019
Page 130 of 480
Moneris Gateway API - Integration Guide
Sample Mag Swipe Force Post
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.5.1 Encrypted Mag Swipe Force Post
The Encrypted Mag Swipe Force Post is used when a merchant obtains the authorization number directly
from the issuer using a phone or any third-party authorization method. This transaction does not
require that an existing order be logged in the Moneris Gateway. However, the credit card must be
swiped or keyed in using a Moneris-provided encrypted mag swipe reader, and the encrypted Track2
details must be submitted. There are also optional fields that may be submitted such as cust_id and
dynamic_descriptor.
To complete the transaction, the authorization number obtained from the issuer must be entered.
Encrypted Mag Swipe Force Post transaction object definition
$txnArray=array(type=>'enc_track2_forcepost', ...);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Encrypted Mag Swipe Force Post transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Encrypted Mag Swipe Force Post transaction object values
Table 1 Encrypted Mag Swipe Force Post transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Encrypted Track2 data
String
n/a
'enc_track2'=>$enc_track2
Page 131 of 480
April 2019
6 Mag Swipe Transaction Set
Value
Type
Limits
Set Method
POS Code
String
2-character numeric
'pos_code'=>$pos_code
Device type
String
30-character alphanumeric
'device_type'=>$device_type
Authorization Code
String
8-character alphanumeric
'auth_code'=>$auth_code
Table 2 Encrypted Mag Swipe Force Post transaction object optional values
Value
Type
Limits
Set Method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Encrypted Mag Swipe Force Post
'enc_track2_forcepost',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
enc_track2=>$enc_track2,
pos_code=>$pos_code,
device_type=>$device_type,
auth_code=>$auth_code,
dynamic_descriptor=>'12345'
);
April 2019
Page 132 of 480
Moneris Gateway API - Integration Guide
Sample Encrypted Mag Swipe Force Post
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nMaskedPan = " . $mpgResponse->getMaskedPan());
?>
6.6 Mag Swipe Purchase Correction
Mag Swipe Purchase Correction transaction object definition
$txnArray = array(‘type’=>’track2_purchasecorrection', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Purchase Correction transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Purchase Correction transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Page 133 of 480
April 2019
6 Mag Swipe Transaction Set
Table 65: Mag Swipe Purchase Correction transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Table 66: Mag Swipe Purchase Correction transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Mag Swipe Purchase Correction
'track2_purchasecorrection',
order_id=>$orderid,
txn_number=>$txnnumber,
dynamic_descriptor=>$dynamic_descriptor
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
April 2019
Page 134 of 480
Moneris Gateway API - Integration Guide
Sample Mag Swipe Purchase Correction
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.7 Mag Swipe Refund
Mag Swipe Refund transaction object definition
$txnArray = array(‘type’=>’track2_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Refund transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 67: Mag Swipe Refund transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Page 135 of 480
April 2019
6 Mag Swipe Transaction Set
Table 68: Mag Swipe Refund transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample Mag Swipe Refund
'track2_refund',
order_id=>$orderid,
amount=>$amount,
txn_number=>$txnnumber,
dynamic_descriptor=>$dynamic_descriptor
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
April 2019
Page 136 of 480
Moneris Gateway API - Integration Guide
Sample Mag Swipe Refund
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.8 Mag Swipe Independent Refund
NOTE: If you receive a TRANSACTION NOT ALLOWED error, it may mean the Mag
Swipe Independent Refund transaction is not supported on your account. Contact Moneris
to have it temporarily (re-)enabled.
Mag Swipe Independent Refund transaction object definition
$txnArray = array(‘type’=>’track2_ind_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Mag Swipe Independent Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Mag Swipe Independent Refund transaction values
Table 69: Mag Swipe Independent Refund transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Page 137 of 480
April 2019
6 Mag Swipe Transaction Set
Table 69: Mag Swipe Independent Refund transaction object mandatory values
Value
Type
Limits
Set method
Track2 data
String
40-character numeric
track2=>$track
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
(YYMM format)
POS code
String
2-character numeric
'pos_code'=>$pos_code
Table 70: Mag Swipe Independent Refund transaction optional values
Value
Type
Limits
Set method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample Mag Swipe Independent Refund
'track2_ind_refund',
order_id=>$orderid,
cust_id=>$custid,
amount=>$amount,
track2=>$track,
pan=>'',
expdate=>'',
pos_code=>'00',
dynamic_descriptor=>'nqa'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
6.8.1 Encrypted Mag Swipe Independent Refund
The Encrypted Mag Swipe Independent Refund credits a specified amount to the cardholder’s credit
card. The Encrypted Mag Swipe Independent Refund does not require an existing order to be logged in
the Moneris Gateway. However, the credit card must be swiped using the Moneris-provided encrypted
mag swipe reader to provide the encrypted track2 details.
There are also optional fields that may be submitted such as cust_id and dynamic_descriptor. The
transaction format is almost identical to Encrypted Mag Swipe Purchase and Encrypted Mag Swipe
PreAuth.
Page 139 of 480
April 2019
6 Mag Swipe Transaction Set
NOTE:
The Encrypted Mag Swipe Independent Refund transaction may not be supported on
your account. This may yield a TRANSACTION NOT ALLOWED error when attempting the
transaction.
To temporarily enable (or re-enable) the Independent Refund transaction type, contact
Moneris
Encrypted Mag Swipe Independent Refund transaction object definition
$txnArray = array(‘type’=>’enc_track2_ind_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Encrypted Mag Swipe Independent Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Encrypted Mag Swipe Independent Refund transaction object values
Table 1 Encrypted Mag Swipe Independent Refund transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Encrypted Track 2 data
String
n/a
'enc_track2'=>$enc_track2
Device Type
String
30-character alphanumeric
'device_type'=>$device_type
POS Code
String
2-character numeric
'pos_code'=>$pos_code
April 2019
Page 140 of 480
Moneris Gateway API - Integration Guide
Table 2 Encrypted Mag Swipe Independent Refund transaction object optional values
Value
Type
Limits
Set Method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Page 141 of 480
April 2019
6 Mag Swipe Transaction Set
Sample Encrypted Mag Swipe Independent Refund
'enc_track2_ind_refund',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
enc_track2=>$enc_track2,
pos_code=>$pos_code,
device_type=>$device_type,
dynamic_descriptor=>'12345'
);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nMaskedPan = " . $mpgResponse->getMaskedPan());
?>
April 2019
Page 142 of 480
7 Level 2/3 Transactions
l
l
l
l
7.1
7.2
7.3
7.4
About Level 2/3 Transactions
Level 2/3 Visa Transactions
Level 2/3 MasterCard Transactions
Level 2/3 American Express Transactions
7.1 About Level 2/3 Transactions
The Moneris Gateway API supports passing Level 2/3 purchasing card transaction data for
Visa, MasterCard and American Express corporate cards.
All Level 2/3 transactions use the same Pre-Authorization transaction as described in the topic PreAuthorization (page 18).
7.2 Level 2/3 Visa Transactions
l
l
l
l
l
l
l
l
7.2.1
7.2.2
7.2.3
7.2.5
7.2.4
7.2.6
7.2.7
7.2.8
Level 2/3 Transaction Types for Visa
Level 2/3 Transaction Flow for Visa
VS Completion
VS Force Post
VS Purchase Correction
VS Refund
VS Independent Refund
VS Corpais
7.2.1 Level 2/3 Transaction Types for Visa
This transaction set includes a suite of corporate card financial transactions as well as a transaction that
allows for the passing of Level 2/3 data. Please ensure that Visa Level 2/3 support is enabled on your merchant account. Batch Close, Open Totals and Pre-authorization are identical to the transactions outlined
in the section Basic Transaction Set (page 12).
l
l
When the Pre-authorization response contains CorporateCard equal to true then you can submit
the Visa transactions.
If CorporateCard is false then the card does not support Level 2/3 data and non Level 2/3 transaction are to be used. If the card is not a corporate card, please refer to the section 2 Basic Transaction Set for the appropriate non-corporate card transactions.
NOTE: This transaction set is intended for transactions where Corporate Card is true and
Level 2/3 data will be submitted. If the credit card is found to be a corporate card but you do
April 2019
Page 143 of 480
Moneris Gateway API - Integration Guide
not wish to send any Level 2/3 data then you may submit Visa transactions using the basic
transaction set outlined in 2 Basic Transaction Set.
Pre-authorization– (authorization/pre-authorization)
Pre-authorization verifies and locks funds on the customer’s credit card. The funds are locked
for a specified amount of time, based on the card issuer. To retrieve the funds from a preauth
so that they may be settled in the merchant account a capture must be performed. CorporateCard will return as true if the card supports Level 2/3.
VS Completion – (Capture/Pre-authorization Completion)
Once a Pre-authorization is obtained the funds that are locked need to be retrieved from the
customer’s credit card. The capture retrieves the locked funds and readies them for settlement into the merchant account. Prior to performing a VS Completion, a Pre-authorization
must be performed. Once the transaction is completed, VS Corpais must be used to process
the Level 2/3 data.
VS Force Post – (Force Capture/Pre-authorization Completion)
This transaction is an alternative to VS Completion to obtain the funds locked on Pre-auth
obtained from IVR or equivalent terminal. The VS Force Post retrieves the locked funds and
readies them for settlement in to the merchant account. Once the transaction is completed,
VS Corpais must be used to process the Level 2/3 data.
VS Purchase Correction (Void, Correction)
VS Completion and VS Force Post can be voided the same day* that they occur. A
VS Purchase Correction must be for the full amount of the transaction and will remove any
record of it from the cardholder statement.
VS Refund – (Credit)
A VS Refund can be performed against a VS Completion to refund any part or all of the transaction. Once the transaction is completed, VS Corpais must be used to process the Level 2/3
data.
VS Independent Refund – (Credit)
A VS Independent Refund can be performed against a purchase or a capture to refund any
part, or all of the transaction. Independent refund is used when the originating transaction
was not performed through Moneris Gateway. Once the transaction is completed, VS Corpais
must be used to process the Level 2/3 data.
NOTE: the Independent Refund transaction may or may not be supported on your
account. If you receive a transaction not allowed error when attempting an independent refund, it may mean the transaction is not supported on your account. If you
wish to have the Independent Refund transaction type temporarily enabled (or reenabled), please contact the Service Centre at 1-866-319-7450.
VS Corpais – (Level 2/3 Data)
VS Corpais will contain all the required and optional data fields for Level 2/3 Business to Business data. VS Corpais data can be sent when the card has been identified in the Pre-authorization transaction request as being a corporate card.
Page 144 of 480
April 2019
7 Level 2/3 Transactions
* A VS Purchase Correction can be performed against a transaction as long as the batch that contains the
original transaction remains open. When using the automated closing feature, the batch close occurs
daily between 10 – 11 pm EST.
April 2019
Page 145 of 480
Moneris Gateway API - Integration Guide
7.2.2 Level 2/3 Transaction Flow for Visa
Pre-authorization/Completion Transaction Flow
Page 146 of 480
April 2019
7 Level 2/3 Transactions
Purchase Correction Transaction Flow
April 2019
Page 147 of 480
Moneris Gateway API - Integration Guide
7.2.3 VS Completion
Once a Pre-authorization is obtained, the funds that are locked need to be retrieved from the customer’s
credit card. This VS Completion transaction is used to secure the funds locked by a pre-authorization
transaction and readies them for settlement into the merchant account.
NOTE: Once you have completed this transaction successfully, to submit the complete supplemental level 2/3 data, please proceed to VS Corpais.
VS Completion transaction object definition
$txnArray = array(‘type’=>’vscompletion', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Completion transaction object
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VS Completion transaction object values
Table 1 VS Completion transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Completion amount
String
(missing or bad snippet)
'comp_amount'=>$comp_amount
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
E-Commerce Indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 Visa - Corporate Card Common Data - Level 2 Request Fields
Req*
Y
Value
National Tax
Limits
Set Method
12-character decimal
'national_
tax'=>$national_
tax
Page 148 of 480
Description
Must reflect
the amount of
National Tax
(GST or HST)
appearing on
the invoice.
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
Minimum 0.01 Maximum
- 999999.99.
Must have 2
decimal places.
Y
Merchant
VAT Registration/Single
Business Reference
20-character alphanumeric
'merchant_vat_
no'=>$merchant_
vat_no
Merchant’s Tax
Registration
Number
must be
provided if tax
is included on
the invoice
NOTE: Must
not be all
spaces or all
zeroes
C
Local Tax
12-character decimal
'local_
tax'=>$local_tax
Must reflect
the amount of
Local Tax (PST
or QST) appearing on the
invoice
If Local Tax
included then
must not be all
spaces or all zeroes; Must be
provided if
Local Tax (PST
or QST) applies
Minimum =
0.01
Maximum =
999999.99
Must have 2
decimal places
C
Local Tax (PST or QST)
April 2019
15-character alpha-
'local_tax_
no'=>$local_tax_no
Merchant's
Page 149 of 480
Moneris Gateway API - Integration Guide
Req*
Value
Registration Number
Limits
Set Method
numeric
Description
Local Tax
(PST/QST)
Registration
Number
Must be
provided if tax
is included on
the invoice; If
Local Tax
included then
must not be all
spaces or all zeroes
Must be
provided if
Local Tax (PST
or QST) applies
C
Customer
VAT Registration Number
13-character alphanumeric
'customer_vat_
no'=>$customer_
vat_no
If the Customer’s Tax
Registration
Number
appears on the
invoice to support tax
exempt transactions it must
be provided
here
C
Customer Code/Customer Reference Identifier (CRI)
16-character alphanumeric
'cri'=>$cri
Value which
the customer
may choose to
provide to the
supplier at the
point of sale –
must be
provided if
given by the
customer
N
Customer Code
17-character alphanumeric
'customer_
code'=>$customer_
code
Optional customer code
field that will
not be passed
Page 150 of 480
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
along to Visa,
but will be
included on
Moneris reporting
N
Invoice Number
17-character alphanumeric
'invoice_
number'=>$invoice_
number
Optional
invoice number
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
*Y = Required, N = Optional, C = Conditional
Sample VS Completion
$type,
'order_id'=>$order_id,
'comp_amount'=>$comp_amount,
'txn_number'=>$txn_number,
'crypt_type'=>$crypt,
'national_tax'=>$national_tax,
'merchant_vat_no'=>$merchant_vat_no,
'local_tax'=>$local_tax,
'customer_vat_no'=>$customer_vat_no,
'cri'=>$cri,
'local_tax_no'=>$local_tax_no
);
/**************************** Transaction Object *****************************/
April 2019
Page 151 of 480
Moneris Gateway API - Integration Guide
Sample VS Completion
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
7.2.4 VS Purchase Correction
The VS Purchase Correction (also known as a "void") transaction is used to cancel a transaction that was
performed in the current batch. No amount is required because a void is always for 100% of the original
transaction. The only transaction that can be voided using VS Purchase Correction is a VS Completion or
VS Force Post. To send a void the order_id and txn_number from the VS Completion/VS Force Post are
required.
VS Purchase Correction transaction object definition
$txnArray = array(‘type’=>’vspurchasecorrection', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Purchase Correction transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Page 152 of 480
April 2019
7 Level 2/3 Transactions
VS Purchase Correction transaction object values
Table 1 VS Purchase Correction transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
E-Commerce Indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Sample VS Purchase Correction
$type,
'order_id'=>$order_id,
'amount'=>$amount,
'txn_number'=>$txn_number,
'crypt_type'=>$crypt
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
April 2019
Page 153 of 480
Moneris Gateway API - Integration Guide
Sample VS Purchase Correction
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
7.2.5 VS Force Post
The VS Force Post transaction is used to secure the funds locked by a pre-authorization transaction performed over IVR or equivalent terminal. When sending a force post request, you will need Order ID,
Amount, Credit Card Number, Expiry Date, E-commerce Indicator and the Authorization Code received in
the pre-authorization response.
NOTE: Once you have completed this transaction successfully, to submit the complete supplemental level 2/3 data, please proceed to VS Corpais.
VS Force Post transaction object definition
$txnArray = array(‘type’=>’vsforcepost', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Force Post transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VS Force Post transaction object values
Table 1 VS Force Post transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Page 154 of 480
April 2019
7 Level 2/3 Transactions
Value
Type
Expiry Date
String
Limits
4-character numeric
Set Method
'expdate'=>$expiry_date
YYMM format
Authorization code
String
8-character alphanumeric
'auth_code'=>$auth_code
E-commerce Indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 VS Force Post transaction object optional values
Value
Type
Customer ID
String
Limits
50-character alphanumeric
Set Method
'cust_id'=>$cust_id
Table 3 Visa - Corporate Card Common Data - Level 2 Request Fields
Req*
Y
Value
National Tax
Limits
12-character decimal
Set Method
'national_
tax'=>$national_
tax
Description
Must reflect
the amount of
National Tax
(GST or HST)
appearing on
the invoice.
Minimum 0.01 Maximum
- 999999.99.
Must have 2
decimal places.
Y
Merchant
VAT Registration/Single
Business Reference
20-character alphanumeric
'merchant_vat_
no'=>$merchant_
vat_no
Merchant’s Tax
Registration
Number
must be
provided if tax
is included on
the invoice
NOTE: Must
not be all
spaces or all
April 2019
Page 155 of 480
Moneris Gateway API - Integration Guide
Req*
Value
Limits
Set Method
Description
zeroes
C
Local Tax
12-character decimal
'local_
tax'=>$local_tax
Must reflect
the amount of
Local Tax (PST
or QST) appearing on the
invoice
If Local Tax
included then
must not be all
spaces or all zeroes; Must be
provided if
Local Tax (PST
or QST) applies
Minimum =
0.01
Maximum =
999999.99
Must have 2
decimal places
C
Local Tax (PST or QST)
Registration Number
15-character alphanumeric
'local_tax_
no'=>$local_tax_no
Merchant's
Local Tax
(PST/QST)
Registration
Number
Must be
provided if tax
is included on
the invoice; If
Local Tax
included then
must not be all
spaces or all zeroes
Must be
provided if
Local Tax (PST
Page 156 of 480
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
or QST) applies
C
Customer
VAT Registration Number
13-character alphanumeric
'customer_vat_
no'=>$customer_
vat_no
If the Customer’s Tax
Registration
Number
appears on the
invoice to support tax
exempt transactions it must
be provided
here
C
Customer Code/Customer Reference Identifier (CRI)
16-character alphanumeric
'cri'=>$cri
Value which
the customer
may choose to
provide to the
supplier at the
point of sale –
must be
provided if
given by the
customer
N
Customer Code
17-character alphanumeric
'customer_
code'=>$customer_
code
Optional customer code
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
N
Invoice Number
17-character alphanumeric
'invoice_
number'=>$invoice_
number
Optional
invoice number
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
*Y = Required, N = Optional, C = Conditional
April 2019
Page 157 of 480
Moneris Gateway API - Integration Guide
Sample VS Force Post
$type,
'order_id'=>$order_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'auth_code'=>$auth_code,
'crypt_type'=>$crypt,
'national_tax'=>$national_tax,
'merchant_vat_no'=>$merchant_vat_no,
'local_tax'=>$local_tax,
'customer_vat_no'=>$customer_vat_no,
'cri'=>$cri,
'local_tax_no'=>$local_tax_no
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
Page 158 of 480
April 2019
7 Level 2/3 Transactions
Sample VS Force Post
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
7.2.6 VS Refund
VS Refund will credit a specified amount to the cardholder’s credit card. A refund can be sent up to the
full value of the original VS Completion or VS Force Post. To send a VS Refund you will require the Order
ID and Transaction Number from the original VS Completion or VS Force Post.
NOTE: Once you have completed this transaction successfully, to submit the complete supplemental level 2/3 data, please proceed to VS Corpais.
VS Refund transaction object definition
$txnArray = array(‘type’=>’vsrefund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VS Refund transaction object values
Table 1 VS Refund transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Amount
String
(missing or bad snippet)
'amount'=>$amount
E-Commerce Indicator
String
1-character alpha-
'crypt_type'=>$crypt
April 2019
Page 159 of 480
Moneris Gateway API - Integration Guide
Value
Type
Limits
Set Method
numeric
Table 2 Visa - Corporate Card Common Data - Level 2 Request Fields
Req*
Y
Value
National Tax
Limits
12-character decimal
Set Method
'national_
tax'=>$national_
tax
Description
Must reflect
the amount of
National Tax
(GST or HST)
appearing on
the invoice.
Minimum 0.01 Maximum
- 999999.99.
Must have 2
decimal places.
Y
Merchant
VAT Registration/Single
Business Reference
20-character alphanumeric
'merchant_vat_
no'=>$merchant_
vat_no
Merchant’s Tax
Registration
Number
must be
provided if tax
is included on
the invoice
NOTE: Must
not be all
spaces or all
zeroes
C
Local Tax
12-character decimal
'local_
tax'=>$local_tax
Must reflect
the amount of
Local Tax (PST
or QST) appearing on the
invoice
If Local Tax
included then
must not be all
Page 160 of 480
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
spaces or all zeroes; Must be
provided if
Local Tax (PST
or QST) applies
Minimum =
0.01
Maximum =
999999.99
Must have 2
decimal places
C
Local Tax (PST or QST)
Registration Number
15-character alphanumeric
'local_tax_
no'=>$local_tax_no
Merchant's
Local Tax
(PST/QST)
Registration
Number
Must be
provided if tax
is included on
the invoice; If
Local Tax
included then
must not be all
spaces or all zeroes
Must be
provided if
Local Tax (PST
or QST) applies
C
Customer
VAT Registration Number
April 2019
13-character alphanumeric
'customer_vat_
no'=>$customer_
vat_no
If the Customer’s Tax
Registration
Number
appears on the
invoice to support tax
exempt transactions it must
be provided
here
Page 161 of 480
Moneris Gateway API - Integration Guide
Req*
Value
Limits
Set Method
Description
C
Customer Code/Customer Reference Identifier (CRI)
16-character alphanumeric
'cri'=>$cri
Value which
the customer
may choose to
provide to the
supplier at the
point of sale –
must be
provided if
given by the
customer
N
Customer Code
17-character alphanumeric
'customer_
code'=>$customer_
code
Optional customer code
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
N
Invoice Number
17-character alphanumeric
'invoice_
number'=>$invoice_
number
Optional
invoice number
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
*Y = Required, N = Optional, C = Conditional
Sample VS Refund
$type,
'order_id'=>$order_id,
'amount'=>$amount,
'txn_number'=>$txn_number,
'crypt_type'=>$crypt,
'national_tax'=>$national_tax,
'merchant_vat_no'=>$merchant_vat_no,
'local_tax'=>$local_tax,
'customer_vat_no'=>$customer_vat_no,
'cri'=>$cri,
'local_tax_no'=>$local_tax_no
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
7.2.7 VS Independent Refund
VS Independent Refund will credit a specified amount to the cardholder’s credit card. The independent
refund does not require an existing order to be logged in the Moneris Gateway; however, the credit card
number and expiry date will need to be passed. The transaction format is almost identical to a pre-authorization.
April 2019
Page 163 of 480
Moneris Gateway API - Integration Guide
NOTE: Once you have completed this transaction successfully, to submit the complete supplemental level 2/3 data, please proceed to VS Corpais.
VS Independent Refund transaction object definition
$txnArray = array(‘type’=>’vsind_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Independent Refund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VS Independent Refund transaction object values
Table 1 VS Independent Refund transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
YYMM format
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 VS Independent Refund transaction object optional values
Value
Type
Customer ID
String
Limits
50-character alphanumeric
Set Method
'cust_id'=>$cust_id
Table 3 Visa - Corporate Card Common Data - Level 2 Request Fields
Req*
Y
Value
National Tax
Page 164 of 480
Limits
12-character decimal
Set Method
'national_
tax'=>$national_
Description
Must reflect
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
tax
Description
the amount of
National Tax
(GST or HST)
appearing on
the invoice.
Minimum 0.01 Maximum
- 999999.99.
Must have 2
decimal places.
Y
Merchant
VAT Registration/Single
Business Reference
20-character alphanumeric
'merchant_vat_
no'=>$merchant_
vat_no
Merchant’s Tax
Registration
Number
must be
provided if tax
is included on
the invoice
NOTE: Must
not be all
spaces or all
zeroes
C
Local Tax
12-character decimal
'local_
tax'=>$local_tax
Must reflect
the amount of
Local Tax (PST
or QST) appearing on the
invoice
If Local Tax
included then
must not be all
spaces or all zeroes; Must be
provided if
Local Tax (PST
or QST) applies
Minimum =
0.01
Maximum =
999999.99
April 2019
Page 165 of 480
Moneris Gateway API - Integration Guide
Req*
Value
Limits
Set Method
Description
Must have 2
decimal places
C
Local Tax (PST or QST)
Registration Number
15-character alphanumeric
'local_tax_
no'=>$local_tax_no
Merchant's
Local Tax
(PST/QST)
Registration
Number
Must be
provided if tax
is included on
the invoice; If
Local Tax
included then
must not be all
spaces or all zeroes
Must be
provided if
Local Tax (PST
or QST) applies
C
Customer
VAT Registration Number
13-character alphanumeric
'customer_vat_
no'=>$customer_
vat_no
If the Customer’s Tax
Registration
Number
appears on the
invoice to support tax
exempt transactions it must
be provided
here
C
Customer Code/Customer Reference Identifier (CRI)
16-character alphanumeric
'cri'=>$cri
Value which
the customer
may choose to
provide to the
supplier at the
point of sale –
must be
provided if
given by the
customer
Page 166 of 480
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
N
Customer Code
17-character alphanumeric
'customer_
code'=>$customer_
code
Optional customer code
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
N
Invoice Number
17-character alphanumeric
'invoice_
number'=>$invoice_
number
Optional
invoice number
field that will
not be passed
along to Visa,
but will be
included on
Moneris reporting
*Y = Required, N = Optional, C = Conditional
Sample VS Independent Refund
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
April 2019
Page 167 of 480
Moneris Gateway API - Integration Guide
Sample VS Independent Refund
'crypt_type'=>$crypt,
'national_tax'=>$national_tax,
'merchant_vat_no'=>$merchant_vat_no,
'local_tax'=>$local_tax,
'customer_vat_no'=>$customer_vat_no,
'cri'=>$cri,
'local_tax_no'=>$local_tax_no
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
7.2.8 VS Corpais
VS Corpais will contain all the required and optional data fields for Level 2/3 Purchasing Card Addendum
data. VS Corpais data can be sent when the card has been identified in the Pre-authorization transaction
request as being a corporate card.
In addition to the Order ID and Transaction number, this transaction also contains two objects:
l
l
VS Purcha – Corporate Card Common Data
VS Purchl – Line Item Details
VS Corpais request must be preceded by a financial transaction (VS Completion, VS Force Post, VS
Refund, VS Independent Refund) and the Corporate Card flag must be set to “true” in the Pre-authorization response.
Page 168 of 480
April 2019
7 Level 2/3 Transactions
VS Corpais transaction object definition
$txnArray = array(‘type’=>’vscorpais', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VS Corpais transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VS Corpais transaction object values
Table 1 VS Corpais transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
vsPurcha
Object
n/a
$vsPurcha = new vsPurcha();
$mpgVsLevel23 = new
mpgVsLevel23();
For a list of the variables that appear in
this object, see the
table below
vsPurchl
$mpgVsLevel23->setVsPurch
($vsPurcha, $vsPurchl);
Object
$vsPurchl = new vsPurchl();
n/a
$mpgVsLevel23 = new
mpgVsLevel23();
For a list of the variables that appear in
this object, see the
table below
$mpgVsLevel23->setVsPurch
($vsPurcha, $vsPurchl);
*Y = Required, N = Optional, C = Conditional
7.2.8.1 VS Purcha - Corporate Card Common Data
VS Corpais transactions use the VS Purcha object to contain Level 2 data.
Table 1 Corporate Card Common Data - Level 2 Request Fields - VSPurcha
Req*
C
Value
Buyer Name
April 2019
Limits
30-character
alphanumeric
Set Method
$vsPurcha->setBuyerName
($buyer_name);
Description
Buyer/Recipient
Name
Page 169 of 480
Moneris Gateway API - Integration Guide
Req*
Value
Limits
Set Method
Description
NOTE: Name
required by CRA on
transactions >$150
C
Local Tax Rate
4-character
decimal
$vsPurcha>setLocalTaxRate
($local_tax_rate);
Indicates the
detailed tax rate
applied in relationship to a local
tax amount
EXAMPLE: 8% PST
should be 8.0
Minimum = 0.01
Maximum = 99.99
NOTE: Must be
provided if Local
Tax (PST or QST)
applies.
N
Duty Amount
9-character
decimal
$vsPurcha>setDutyAmount($duty_
amount);
Duty on total purchase amount
A minus sign
means 'amount is a
credit', plus sign or
no sign means
'amount is a debit'
maximum without
sign is 999999.99
N
Invoice Discount
Treatment
1-character
numeric
$vsPurcha>setDiscountTreatment
($discount_treatment);
Indicates how the
merchant is managing discounts
Must be one of the
following values:
0 - if no invoice level
discounts apply for this
invoice
1 - if Tax was calculated on Post-Discount totals
Page 170 of 480
April 2019
7 Level 2/3 Transactions
Req*
Value
Limits
Set Method
Description
2 - if Tax was calculated on Pre-Discount
totals
N
Invoice Level Discount Amount
9-character
decimal
$vsPurcha>setDiscountAmt
($discount_amt);
Amount of discount (if provided
at the invoice level
according to the
Invoice Discount
Treatment)
Must be non-zero
if Invoice Discount
Treatment is 1 or 2
Minimum amount
is 0.00 and maximum is 999999.99
C
Ship To Postal
Code / Zip Code
10-character
alphanumeric
$vsPurcha>setShipToPostalCode
($ship_to_pos_code);
The postal code or
zip code for the
destination where
goods will be
delivered
NOTE: Required if
shipment is
involved
Full alpha postal
code - Valid
ANA
April 2019
Canada Only
Page 317 of 480
9.4 Encorporating All Available Fraud Tools
l
l
l
9.4.1 Implementation Options for TRMT
9.4.2 Implementation Checklist
9.4.3 Making a Decision
To minimize fraudulent activity in online transactions, Moneris recommends that you implement all of
the fraud tools available through the Moneris Gateway. These are explained below:
Address Verification Service (AVS)
Verifies the cardholder's billing address information.
Verified by Visa, MasterCard Secure Code and Amex SafeKey (VbV/MCSC/SafeKey)
Authenticates the cardholder at the time of an online transaction.
Card Validation Digit (CVD)
Validates that cardholder is in possession of a genuine credit card during the transaction.
Note that all responses that are returned from these verification methods are intended to provide added
security and fraud prevention. The response itself does not affect the completion of a transaction. Upon
receiving a response, the choice to proceed with a transaction is left entirely to the merchant.
9.4.1 Implementation Options for TRMT
Option A
Process a Transaction Risk Management Tool query and obtain the response. You can then decide
whether to continue with the transaction, abort the transaction, or use additional efraud features.
If you want to use additional efraud features, perform one or both of the following to help make your
decision about whether to continue with the transaction or abort it:
l
l
Process a VbV/MCSC/SafeKey transaction and obtain the response. The merchant then makes the
decision whether to continue with the transaction or to abort it.
Process a financial transaction including AVS/CVD details and obtain the response. The merchant
then makes a decision whether to continue with the transaction or to abort it.
Option B
1.
2.
3.
4.
Process a Transaction Risk Management Tool query and obtain the response.
Process a VbV/MCSC/SafeKey transaction and obtain the response.
Process a financial transaction including AVS/CVD details and obtain the response.
Merchant then makes a one-time decision based on the responses received from the eFraud
tools.
9.4.2 Implementation Checklist
The following checklists provide high-level tasks that are required as part of your implementation of the
Transaction Risk Management Tool. Because each organization has certain project requirements for
implementing system and process changes, this list is only a guideline, and does not cover all aspects of
your project.
April 2019
Page 318 of 480
Moneris Gateway API - Integration Guide
Download and review all of the applicable APIs and Integration Guides
Please review the sections outlined within this document that refers to the following feature
Table 94: API documentation
Document/API
Use the document if you are….
Transaction Risk Management Tool Integration
Guide (Section #)
Implementing or updating your integration for the
Transaction Risk Management Tool
Moneris MPI – Verified by Visa/MasterCard
SecureCode/American Express SafeKey – Java API
Integration Guide
Implementing or updating Verified by Visa, MasterCard SecureCode or American Express SafeKey
Basic transaction with VS and CVD (Section#)
Implementing or updating transaction processing,
AVS or CVD
Design your transaction flow and business processes
When designing your transaction flow, think about which scenarios you would like to have automated,
and which scenarios you would like to have handled manually by your employees.
The “Understand Transaction Risk Management Transaction Flow” and Handling Response Information
(page 303) sections can help you work through the design of your transaction and process flows.
Things to consider when designing your process flows:
l
l
l
Processes for notifying people within your organization when there is scheduled maintenance for
Moneris Gateway.
Handling refunds, canceled orders and so on.
Communicating with customers when you will not be shipping the goods because of suspected
fraud, back-ordered goods and so on.
Complete your development and testing
l
The Moneris Gateway API - Integration Guide provides the technical details required for the development and testing. Ensure that you follow the testing instructions and data provided.
If you are an integrator
l
l
l
Ensure that your solution meets the requirements for PCI-DSS/PA-DSS as applicable.
Send an email to eproducts@moneris.com with the subject line “Certification Request”.
Develop material to set up your customers as quickly as possible with your solution and a Moneris
account. Include information such as:
l Steps they must take to enter their store ID or API token information into your solution.
Page 319 of 480
April 2019
l
Any optional services that you support via Moneris Gateway (such as TRMT, AVS, CVD,
VBV/MCSC/SafeKey and so on) so that customers can request these features.
9.4.3 Making a Decision
Depending on your business policies and processes, the information obtained from the fraud tools (such
as AVS, CVD, VbV/MCSC/SafeKey and TRMT) can help you make an informed decision about whether to
accept a transaction or deny it because it is potentially fraudulent.
If you do not want to continue with a likely fraudulent transaction, you must inform the customer that
you are not proceeding with their transaction.
If you are attempting to do further authentication by using the available fraud tools, but you have
received an approval response instead, cancel the financial transaction by doing one of the following:
l
l
If the original transaction is a Purchase, use a Purchase Correction or Refund transaction. You will
need the original order ID and transaction number.
If the original transaction is a Pre-Authorization, use a Completion transaction for $0.00.
April 2019
Page 320 of 480
10 Apple Pay In-App and on the Web Integration
l
l
l
l
l
10.1 About Apple Pay In-App and on the Web Integration10.1 About Apple Pay In-App and on the
Web Integration
10.2 About API Integration of Apple Pay
10.3 Apple Pay In-App Process Flows10.3 Apple Pay In-App Process Flows
10.4 Cavv Purchase – Apple Pay 10.4 Cavv Purchase – Apple Pay
10.5 Cavv Pre-Authorization – Apple Pay
10.1 About Apple Pay In-App and on the Web Integration
The Moneris Gateway enables merchants to process in-app or on the web payment methods in mobile
applications and the Safari web browser on Apple devices via Apple Pay.
Moneris Solutions offers two processing and integration methods for Apple Pay. Merchants can choose
to use one of two methods:
l
l
Software Development Kit (SDK), or
API
While both methods provide the same basic payment features, there are differences in their implementations.
This guide only deals with the API method; for detailed information about the SDK method of integration, see the Moneris Developer Portal at https://developer.moneris.com.
10.2 About API Integration of Apple Pay
An API integration works to provide a communication link between the merchants’ server and Moneris’
server. APIs are required to complete any transaction, and therefore the APIs for Apple Pay are also
included within an SDK integration.
If the merchant chooses to use only an API integration, the merchant must decrypt payload information
themselves before sending the decrypted information to the Moneris Gateway to be processed. Because
this process is complicated, Apple recommend only businesses with expertise and a previously integrated payment processing system use APIs instead of SDKs.
10.2.1 Transaction Types That Use Apple Pay
In the Moneris Gateway API, there are two transaction types that allow you to process decrypted transaction payload information with Apple Pay:
l
l
10.4 Cavv Purchase – Apple Pay 10.4 Cavv Purchase – Apple Pay
10.5 Cavv Pre-Authorization – Apple Pay
April 2019
Page 321 of 480
Moneris Gateway API - Integration Guide
NOTE: INTERAC® e-Commerce functionality is currently available using the Cavv
Purchase transaction type only.
Once you have processed the initial transaction using Cavv Purchase or Cavv Pre-Authorization, if
required you can then process any of the following transactions:
l
l
l
Refund (page 33)
Pre-Authorization Completion (page 23)
Purchase Correction (page 31)
10.3 Apple Pay In-App Process Flows
For both API and SDK methods of mobile in-app integration, the merchant’s iOS app uses Apple’s PassKit
Framework to request and receive encrypted payment details from Apple. When payment details are
returned in their encrypted form, they can be decrypted and processed by the Moneris Gateway in one
of two ways: SDK or API.
Steps in the Apple Pay In-App and on the Web payment process
API
1. Merchant’s mobile application or web page requests and receives the encrypted payload.
2. Encrypted payload is sent to the merchant’s server, where it is decrypted.
Page 322 of 480
April 2019
10 Apple Pay In-App and on the Web Integration
3. Moneris Gateway receives the decrypted payload from the merchant’s server, and processes the
Cavv Purchase – Apple Pay (page 323)Cavv Purchase – Apple Pay (page 323) or Cavv Pre-Authorization – Apple Pay (page 327)Cavv Pre-Authorization – Apple Pay (page 327) transaction.
a. Please ensure the wallet indicator is properly populated with the correct value (APP for
Apple Pay In-App or APW for Apple Pay on the Web).
SDK
1. Merchant's mobile application or web page requests and receives the encrypted payload.
2. Encrypted payload is sent from the merchant’s server to the Moneris Gateway, and the payload is
decrypted and processed.
This guide only deals with the API method; for detailed information about the SDK method of integration, see the Moneris Developer Portal at https://developer.moneris.com.
10.4 Cavv Purchase – Apple Pay
The Cavv Purchase for Apple Pay transaction follows a 3-D Secure model but it does not require an MPI.
Once the Apple Pay payload has been decrypted, this Purchase verifies funds on the customer’s card,
removes the funds and prepares them for deposit into the merchant’s account.
For Apple Pay processing, this transaction is only applicable if choosing to integrate directly to the Apple
Wallet (if not using the Moneris Apple Pay SDK). Please refer to 10 Apple Pay In-App and on the Web
Integration for more details on your integration options.
Refer to Apple's Developer Portal for details on integrating directly to Apple Wallet to retrieve the payload data.
CavvPurchase transaction object definition
$txnArray = array(‘type’=>’cavv_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Cavv Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Cavv Purchase transaction values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 323 of 480
Moneris Gateway API - Integration Guide
Table 95: Cavv Purchase transaction object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character alphanumeric
'pan'=>$pan
Expiry date
String
4-character alphanumeric
'expdate'=>$expiry_date
YYMM format
CAVV
String
100-character alphanumeric
cavv=>$cavv
String
1-character alphanumeric
'crypt_type'=>$crypt
NOTE: For Apple Pay
Cavv Purchase and Cavv
Pre-Authorization transactions, CAVV field contains the decrypted
cryptogram. For more,
see Appendix A Definitions of Request
Fields.
E-commerce indicator
NOTE: For Apple Pay
Cavv Purchase and Cavv
Pre-Authorization transactions, the E-commerce indicator is a
mandatory field containing the value
received from the
decrypted payload or a
default value of 5. If
you get a 2-character
value (e.g.,. 05 or 07)
from the payload,
remove the initial 0
and just send us the
2nd character. For
more, see Appendix A
Definitions of Request
Fields.
Page 324 of 480
April 2019
10 Apple Pay In-App and on the Web Integration
Table 1 CavvPurchase transaction object optional values
Value
Type
Limits
Set Method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Card Match ID
String
50-character alphanumeric
'cm_id' => $transaction_id
Customer information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
Network
String
alphabetical
String
3-character alphanumeric
NOTE: Applies to Offlinx™ only; must be
unique value for each
transaction
NOTE: This request variable is mandatory for
INTERAC® e-Commerce
transactions conducted
via Apple Pay, and is
not for use with credit
card transactions.
Data Type
NOTE: This request variable is mandatory for
INTERAC® e-Commerce
transactions conducted
via Apple Pay, and is
not for use with credit
card transactions.
April 2019
Page 325 of 480
Moneris Gateway API - Integration Guide
Sample Cavv Purchase for Apple Pay
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'cavv'=>$cavv,
'crypt_type'=>$crypt_type, //mandatory for AMEX only
//'wallet_indicator'=>$wallet_indicator, //set only for wallet transactions. e.g. APPLE PAY
//'network'=> "Interac", //set only for Interac e-commerce
//'data_type'=> "3DSecure", //set only for Interac e-commerce
'dynamic_descriptor'=>$dynamic_descriptor
//,'cm_id' => '8nAK8712sGaAkls56' //set only for usage with Offlinx - Unique max 50 alphanumeric
characters transaction id generated by merchant
);
/****************************** Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("168451306048014");
$mpgTxn->setCofInfo($cof);
/******************************* Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/****************************** HTTPS Post Object *******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************************* Response *********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
Page 326 of 480
April 2019
10 Apple Pay In-App and on the Web Integration
Sample Cavv Purchase for Apple Pay
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCavvResultCode = " . $mpgResponse->getCavvResultCode());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
?>
10.5 Cavv Pre-Authorization – Apple Pay
The Cavv Pre-Authorization for Apple Pay transaction follows a 3-D Secure model but it does not require
an MPI. Once the Apple Pay payload has been decrypted, this Pre-Authorization verifies funds on the customer’s card, and holds the funds. To prepare the funds for deposit into the merchant’s account please
process a Pre-Authorization Completion transaction.
For Apple Pay processing, this transaction is only applicable if choosing to integrate directly to the Apple
Wallet (if not using the Moneris Apple Pay SDK). Please refer to 10 Apple Pay In-App and on the Web
Integration for more details on your integration options.
Refer to Apple's Developer Portal for details on integrating directly to Apple Wallet to retrieve the payload data.
NOTE: INTERAC® e-Commerce functionality is currently available using the Cavv
Purchase transaction type only.
Cavv Pre-Authorization transaction object definition
$txnArray = array(‘type’=>’cavv_preauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Cavv Pre-Authorization transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
April 2019
Page 327 of 480
Moneris Gateway API - Integration Guide
Cavv Pre-Authorization transaction values
Table 96: Cavv Pre-Authorization object mandatory values
Value
Type
Limits
Set method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Cardholder Authentication Verification Value
(CAVV)
String
50-character alphanumeric
cavv=>$cavv
Expiry date
String
4-character numeric
'expdate'=>$expiry_date
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
NOTE: For Apple Pay
Cavv Purchase and Cavv
Pre-Authorization transactions, CAVV field contains the decrypted
cryptogram. For more,
see Appendix A Definitions of Request
Fields.
NOTE: For Apple Pay
Cavv Purchase and Cavv
Pre-Authorization transactions, the E-commerce indicator is a
mandatory field containing the value
received from the
decrypted payload or a
default value of 5. If
you get a 2-character
value (e.g.,. 05 or 07)
from the payload,
remove the initial 0
and just send us the
2nd character. For
more, see Appendix A
Definitions of Request
Fields.
Page 328 of 480
April 2019
10 Apple Pay In-App and on the Web Integration
Table 1 Cavv Pre-Authorization object optional values
Value
Type
Limits
Set method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Card Match ID
String
50-character alphanumeric
'cm_id' => $transaction_id
String
alphabetical
String
3-character alphanumeric
NOTE: Applies to Offlinx™ only; must be
unique value for each
transaction
Network
NOTE: This request variable is mandatory for
INTERAC® e-Commerce
transactions conducted
via Apple Pay, and is
not for use with credit
card transactions.
Data Type
NOTE: This request variable is mandatory for
INTERAC® e-Commerce
transactions conducted
via Apple Pay, and is
not for use with credit
card transactions.
Sample Cavv Pre-Authorization for Apple Pay
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'cavv'=>$cavv,
'crypt_type'=>$crypt_type, //mandatory for AMEX only
//'wallet_indicator'=>$wallet_indicator, //set only for wallet transactions. e.g. APPLE PAY
'dynamic_descriptor'=>$dynamic_descriptor
//,'cm_id' => '8nAK8712sGaAkls56' //set only for usage with Offlinx - Unique max 50 alphanumeric
characters transaction id generated by merchant
);
/****************************** Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("U");
$cof->setPaymentInformation("2");
$cof->setIssuerId("168451306048014");
$mpgTxn->setCofInfo($cof);
/******************************* Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/****************************** HTTPS Post Object *******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/************************************ Response **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
Page 330 of 480
April 2019
10 Apple Pay In-App and on the Web Integration
Sample Cavv Pre-Authorization for Apple Pay
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCavvResultCode = " . $mpgResponse->getCavvResultCode());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
?>
April 2019
Page 331 of 480
Moneris Gateway API - Integration Guide
11 Offlinx™
l
l
What Is a Pixel Tag?
Offlinx™ and API Transactions
11.1 What Is a Pixel Tag?
A pixel tag is a piece of code that goes on a web page and requests an image file (a tiny transparent image
or pixel) when loaded, which, while not visible to the user, allows Offlinx™ to gather relevant information
about the user.
The data collected by our pixel tag is:
l
l
l
Anonymous (not personally identifiable) and compliant with privacy standards
Secure — utilizes SSL communication to transmit the data securely
Not shared with anyone
11.2 Offlinx™ and API Transactions
The Offlinx™ Card Match pixel tag feature can be implemented via the Unified API with the Card Match
ID variable, which corresponds to the Transaction ID in Offlinx™. The Card Match ID must be a unique
value for each transaction.
For more information about the Offlinx™ solution, consult the Offlinx™ Pixel Tag Setup Guide available
from your account/service manager.
API transactions where this applies:
l
l
l
l
l
l
Purchase
Pre-Authorization
Purchase with 3-D Secure – cavv_purchase
Pre-Authorization with 3-D Secure – cavvPreauth
Cavv Purchase – Apple Pay
Cavv Pre-Authorization – Apple Pay
Page 332 of 480
April 2019
12 Convenience Fee
l
l
l
l
12.1
12.2
12.3
12.4
About Convenience Fee
Purchase with Convenience Fee
Convenience Fee Purchase w/ Customer Information
Convenience Fee Purchase with VbV, MCSC and Amex SafeKey
12.1 About Convenience Fee
The Convenience Fee program was designed to allow merchants to offer the convenience of an alternative payment channel to the cardholder at a charge. This applies only when providing a true "convenience" in the form of an alternative payment channel outside the merchant's customary face-to-face
payment channels. The convenience fee will be a separate charge on top of what the consumer is paying
for the goods and/or services they were given, and this charge will appear as a separate line item on the
consumer’s statement.
NOTE: The Convenience Fee program is only offered to certain supported Merchant Category Codes (MCCs). Please speak to your account manager for further details.
12.2 Purchase with Convenience Fee
NOTE: Convenience Fee Purchase with Customer Information is also supported.
Convenience Fee Purchase transaction object definition
$txnArray = array(‘type’=>’purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Convenience Fee Purchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Convenience Fee Purchase transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
April 2019
Page 333 of 480
Moneris Gateway API - Integration Guide
Table 1 Convenience Fee Purchase transaction object mandatory values
Value
Type
Limits
Set Method
Convenience Fee
Object
n/a
$mpgConvFee = new
mpgConvFeeInfo
($convFeeTemplate);
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
YYMM format
'expdate'=>$expiry_date
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Convenience fee
amount
String
9-character decimal
$convFeeTemplate = array
(convenience_fee=>$convfee_
amount);
Table 2 Convenience Fee Purchase transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
AVS information
Object
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD information
Object
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Sample Purchase with Convenience Fee
'purchase',
order_id=>$orderid,
cust_id=>'cust',
amount=>$amount,
pan=>$pan,
expdate=>$expiry_date,
crypt_type=>'7',
dynamic_descriptor=>$dynamic_descriptor
);
/********************** ConvFee Associative Array *************************/
$convFeeTemplate = array(
convenience_fee=>'1.00'
);
/************************** ConvFee Object ********************************/
$mpgConvFee = new mpgConvFeeInfo($convFeeTemplate);
/************************ Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Set ConvFee *****************************/
$mpgTxn->setConvFeeInfo($mpgConvFee);
/************************ Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"CA" for sending transaction to Canadian environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ mpgHttpsPost Object ******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************ Response Object **********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nISO = " . $mpgResponse->getISO());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCardLevelResult = " . $mpgResponse->getCardLevelResult());
print("\nCfSuccess = " . $mpgResponse->getCfSuccess());
print("\nCfStatus = " . $mpgResponse->getCfStatus());
April 2019
Page 335 of 480
Moneris Gateway API - Integration Guide
Sample Purchase with Convenience Fee
print("\nFeeAmount = " . $mpgResponse->getFeeAmount());
print("\nFeeRate = " . $mpgResponse->getFeeRate());
print("\nFeeType = " . $mpgResponse->getFeeType());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
12.3 Convenience Fee Purchase w/ Customer Information
Convenience Fee Purchase with Customer information transaction object definition
$txnArray = array(‘type’=>’purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Convenience Fee Purchase with Customer Info transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Convenience Fee Purchase with Customer information transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 1 Convenience Fee Purchase w/ Customer Info transaction object mandatory values
Value
Type
Limits
Set Method
Convenience Fee
Object
n/a
$mpgConvFee = new
mpgConvFeeInfo
($convFeeTemplate);
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Page 336 of 480
April 2019
12 Convenience Fee
Table 1 Convenience Fee Purchase w/ Customer Info transaction object mandatory values (continued)
Value
Type
Limits
Set Method
Expiry date
String
4-character numeric
YYMM format
'expdate'=>$expiry_date
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Convenience fee
amount
String
9-character decimal
$mpgConvFee = new
mpgConvFeeInfo
($convFeeTemplate);
Table 2 Convenience Fee Purchase w/ Customer Info transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Customer information
Object
n/a
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS information
Object
n/a
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD information
Object
n/a
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Sample Convenience Fee Purchase with Customer Information
$first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setBilling($billing);
$shipping = array(
'first_name' => $first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
Page 338 of 480
April 2019
12 Convenience Fee
Sample Convenience Fee Purchase with Customer Information
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setShipping($shipping);
$mpgCustInfo->setEmail($email);
$mpgCustInfo->setInstructions($instructions);
/*********************** Set Line Item Information *********************/
$item[0] = array(
'name'=>$item_name[0],
'quantity'=>$item_quantity[0],
'product_code'=>$item_product_code[0],
'extended_amount'=>$item_extended_amount[0]
);
$item[1] = array(
'name'=>$item_name[1],
'quantity'=>$item_quantity[1],
'product_code'=>$item_product_code[1],
'extended_amount'=>$item_extended_amount[1]
);
$mpgCustInfo->setItems($item[0]);
$mpgCustInfo->setItems($item[1]);
/********************** ConvFee Associative Array *************************/
$convFeeTemplate = array(
'convenience_fee'=>'2.00'
);
/************************** ConvFee Object ********************************/
$mpgConvFee = new mpgConvFeeInfo($convFeeTemplate);
/***************** Transactional Associative Array ********************/
$txnArray=array(
'type'=>$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt
);
/********************** Transaction Object ****************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************** Set Customer Information ************************/
$mpgTxn->setCustInfo($mpgCustInfo);
/************************ Set ConvFee *****************************/
$mpgTxn->setConvFeeInfo($mpgConvFee);
/************************* Request Object *****************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ HTTPS Post Object ***************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/****************8********** Response *********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
April 2019
Page 339 of 480
Moneris Gateway API - Integration Guide
Sample Convenience Fee Purchase with Customer Information
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
12.4 Convenience Fee Purchase with VbV, MCSC and Amex SafeKey
Convenience Fee Purchase with VbV/MCSC/SafeKey transaction object definition
$txnArray = array(‘type’=>’cavv_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for Convenience Fee Purchase w/ VbV/MCSC/SafeKey transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Convenience Fee Purchase with VbV/MCSC/SafeKey transaction object values
For a full description of mandatory and optional values, see Appendix A Definitions of Request Fields
Table 1 Convenience Fee Purchase with VbV, MCSC, SafeKey - Required Fields
Value
Type
Limits
Set Method
Convenience Fee
Object
N/A
$mpgConvFee = new
mpgConvFeeInfo
($convFeeTemplate);
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Credit card number
String
20-character numeric
'pan'=>$pan
Expiry date
String
4-character numeric
YYMM format
'expdate'=>$expiry_date
Page 340 of 480
April 2019
12 Convenience Fee
Value
Type
Limits
Set Method
E-Commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Cardholder Authentication Verification Value
(CAVV)
String
50-character alphanumeric
cavv=>$cavv
Convenience fee
amount
String
9-character decimal
$convFeeTemplate = array
(convenience_fee=>$convfee_
amount);
Table 2 Convenience Fee Purchase with VbV, MCSC, SafeKey - Optional Values
Value
Type
Limits
Set Method
Status Check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
E-commerce indicator
String
1-character numeric
'crypt_type'=>$crypt
Customer Information
Object
N/A
$mpgTxn->setCustInfo
($mpgCustInfo);
AVS Information
Object
N/A
$mpgTxn->setAvsInfo
($mpgAvsInfo);
CVD Information
Object
N/A
$mpgTxn->setCvdInfo
($mpgCvdInfo);
Sample Purchase with VbV/MCSC/SafeKey
$type,
order_id=>$order_id,
cust_id=>$cust_id,
amount=>$amount,
pan=>$pan,
expdate=>$expiry_date,
cavv=>$cavv,
commcard_invoice=>$commcard_invoice,
commcard_tax_amount=>$commcard_tax_amount,
crypt_type=>$crypt_type, //mandatory for AMEX only
dynamic_descriptor=>'test'
);
/********************** ConvFee Associative Array *************************/
$convFeeTemplate = array(
convenience_fee=>'1.00'
);
/************************** ConvFee Object ********************************/
$mpgConvFee = new mpgConvFeeInfo($convFeeTemplate);
/****************************** Transaction Object *******************************/
$mpgTxn = new mpgTransaction($txnArray);
/************************ Set ConvFee *****************************/
$mpgTxn->setConvFeeInfo($mpgConvFee);
/******************************* Request Object **********************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"CA" for sending transaction to Canadian environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/****************************** HTTPS Post Object *******************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
//Status check example
//$mpgHttpPost = new mpgHttpsPostStatus($store_id,$api_token,$status,$mpgRequest);
/************************************* Response *********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
Page 342 of 480
April 2019
12 Convenience Fee
Sample Purchase with VbV/MCSC/SafeKey
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nCardLevelResult = " . $mpgResponse->getCardLevelResult());
print("\nCavvResultCode = " . $mpgResponse->getCavvResultCode());
print("\nCfSuccess = " . $mpgResponse->getCfSuccess());
print("\nCfStatus = " . $mpgResponse->getCfStatus());
print("\nFeeAmount = " . $mpgResponse->getFeeAmount());
print("\nFeeRate = " . $mpgResponse->getFeeRate());
print("\nFeeType = " . $mpgResponse->getFeeType());
//print("\nStatusCode = " . $mpgResponse->getStatusCode());
//print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
April 2019
Page 343 of 480
13 Recurring Billing
l
l
l
l
l
l
l
13.1 About Recurring Billing
13.2 Purchase with Recurring Billing
1 Purchase with Recurring Billing
13.3 Recurring Billing Update
1 Recurring Billing Update
13.4 Recurring Billing Response Fields and Codes
13.5 Credential on File and Recurring Billing
13.1 About Recurring Billing
Recurring Billing allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.
Recurring Billing series are created by sending the Recurring Billing object in these transactions:
l
l
l
Purchase
Purchase with Vault
Purchase with 3-D Secure (cavvPurchase)
You can modify a Recurring Billing series after it has been created by sending the Recurring Billing Update
administrative transaction.
NOTE: Alternatively, if you prefer to manage recurring series on your own merchant system, you can send the periodic payments as basic Purchase transactions with the e-commerce indicator (crypt_type) value = 2 and with the Credential on File info object
included.
13.2 Purchase with Recurring Billing
Recurring Billing Info Object Definition
$recurArray = array(
'recur_unit'=>$recurUnit, // (day | week | month)
'start_date'=>$startDate, //yyyy/mm/dd
'num_recurs'=>$numRecurs,
'start_now'=>$startNow,
'period' => $recurInterval,
'recur_amount'=> $recurAmount
);
$mpgRecur = new mpgRecur($recurArray);
April 2019
Page 344 of 480
Moneris Gateway API - Integration Guide
Transaction object set method
$mpgTxn->setRecur($mpgRecur);
Recurring Billing Info Object Request Fields
Variable and Field Name
Type and Limits
Number of Recurs
String
num_recurs
numeric, 1-99
Period
String
period
numeric, 1-999
Start Date
String
start_date
YYYY/MM/DD
Description
The number of times that the
transaction must recur
Number of recur units that
must pass between recurring
billings
Date of the first future recurring
billing transaction
This value must be a date in the
future
If an additional charge is to be
made immediately, the value of
Start Now must be set to true
Start Now
String
start_now
true/false
If a single charge is to be made
against the card immediately,
set this value to true; the
amount to be billed immediately may differ from the
amount billed on a regular
basis thereafter
If the billing is to start in the
future, set this value to false
When set to false, use Card Verification prior to sending the
Purchase with Recur and Credential on File objects
Recurring Amount
String
recur_amount
10-character decimal, minimum
three digits
Up to 7 digits (dollars) + decimal
point (.) + 2 digits (cents) after
the decimal point
Page 345 of 480
Amount of the recurring transaction
This is the amount that will be
billed on the Start Date and
then billed repeatedly based on
the interval defined by Period
and Recur Unit
April 2019
13 Recurring Billing
Variable and Field Name
Type and Limits
Description
EXAMPLE: 1234567.89
Recur Unit
String
recur_unit
day, week, month or eom
Unit to be used as a basis for
the interval
Works in conjunction with
Period to define the billing frequency
Possible values are:
day
week
month
eom (end of month)
Sample Purchase with Recurring Billing
$recurUnit, // (day | week | month)
'start_date'=>$startDate, //yyyy/mm/dd
'num_recurs'=>$numRecurs,
'start_now'=>$startNow,
'period' => $recurInterval,
'recur_amount'=> $recurAmount
);
$mpgRecur = new mpgRecur($recurArray);
/*********************** Transactional Associative Array **********************/
$txnArray=array('type'=>'purchase',
April 2019
Page 346 of 480
Moneris Gateway API - Integration Guide
Sample Purchase with Recurring Billing
'order_id'=>$orderId,
'cust_id'=>$custId,
'amount'=>$nowAmount,
'pan'=>$creditCard,
'expdate'=>$expiryDate,
'crypt_type'=>$cryptType
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Recur Object *********************************/
$mpgTxn->setRecur($mpgRecur);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setPaymentIndicator("R");
$cof->setPaymentInformation("2");
$cof->setIssuerId("168451306048014");
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print ("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nRecurSuccess = " . $mpgResponse->getRecurSuccess());
print("\nIssuerId = " . $mpgResponse->getIssuerId());
?>
13.3 Recurring Billing Update
After you have set up a Recurring Billing transaction series, you can change some of the details of the
series as long as it has not yet completed the preset recurring duration (i.e., it hasn’t terminated yet).
Before sending a Recurring Billing Update transaction that updates the credit card number, you must
send a Card Verification request. This requirement does not apply if you are only updating the schedule
or amount.
Page 347 of 480
April 2019
13 Recurring Billing
Things to Consider:
l
When completing the update recurring billing portion please keep in mind that the
recur bill dates cannot be changed to have an end date greater than 10 years from
today and cannot be changed to have an end date end today or earlier.
Recurring Billing Update transaction object definition
$txnArray=array('type'=>'recur_update',... );
HttpsPostRequest object for Recurring Billing Update transaction
$mpgTxn = new mpgTransaction($txnArray);
$mpgRequest = new mpgRequest($mpgTxn);
Recurring Billing Update transaction values
Table 1 Recurring Billing Update – Basic Required Fields
Variable and Field Name
Type and Limits
Order ID
String
order_id
50-character alphanumeric
Set Method
'cust_id'=>$cust_id
Table 2 Recurring Billing Update – Basic Optional Fields
Variable and Field Name
Type and Limits
Customer ID
String
cust_id
50-character alphanumeric
Credit card number
String
pan
20-character alphanumeric
Expiry date
String
expdate
YYMM
April 2019
Set Method
'cust_id'=>$cust_id
'pan'=>$pan
'expdate'=>$expiry_date
Page 348 of 480
Moneris Gateway API - Integration Guide
Table 3 Recurring Billing Update – Recurring Billing Required Fields
Variable and Field
Name
Type and Limits
Recurring amount
String
recur_amount
10-character decimal;
Up to 7 digits
(dollars) + decimal
point + 2 digits (cents)
after the decimal point
Set Method
Description
'recur_
amount'=>$recur_
amount
Changes the amount that is
billed recurrently
'add_num_recurs'
=> $add_num
Adds to the given number
of recurring transactions to
the current (remaining)
number
The change takes effect on
the next charge
EXAMPLE:
1234567.89
Add number of recurs
String
add_num
numeric, 1-999
This can be used if a customer decides to extend a
membership or subscription
Cannot be used to decrease
the current number of recurring transactions; use
Change number of recurs
instead
numeric, 1-999
'total_num_
recurs' =>
$total_num
Replaces the current
(remaining) number of
recurring transactions
Hold recurring billing
String
'hold' => $hold
Temporarily pauses recurring billing
hold
true/false
Terminate recurring
transaction
String
Change number of
recurs
String
total_num
terminate
Page 349 of 480
true/false
While a transaction is on
hold, it is not billed for the
recurring amount; however,
the number of remaining
recurs continues to be
decremented during that
time
'terminate' =>
$terminate
Terminates recurring billing
NOTE: After it has
April 2019
13 Recurring Billing
Variable and Field
Name
Type and Limits
Set Method
Description
been terminated, a
recurring transaction
cannot be reactivated;
a new purchase transaction with recurring
billing must be submitted.
Sample Recurring Billing Update
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'recur_amount'=>$recur_amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'add_num_recurs' => $add_num,
'total_num_recurs' => $total_num,
'hold' => $hold,
'terminate' => $terminate
);
/******************* Credential on File **********************************/
$cof = new CofInfo();
$cof->setIssuerId("168451306048014");
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
$mpgTxn->setCofInfo($cof);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
April 2019
Page 350 of 480
Moneris Gateway API - Integration Guide
Sample Recurring Billing Update
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nRecurUpdateSuccess = " . $mpgResponse->getRecurUpdateSuccess());
print("\nNextRecurDate = " . $mpgResponse->getNextRecurDate());
print("\nRecurEndDate = " . $mpgResponse->getRecurEndDate());
?>
13.4 Recurring Billing Response Fields and Codes
Table 97 outlines the response fields that are part of recurring billing. Some are available when you set up
recurring billing (such as with a Purchase transaction), and some are available when you update an existing transaction with the Recurring Billing transaction.
Receipt object definition
$mpgResponse=$mpgHttpPost->getMpgResponse();
Table 97: Recurring Billing response fields
Value
Type
Limits
Get method
Description
Transaction object with Recurring Billing response fields
Response code String 3-character numeric
$mpgResponse->getResponseCode()
See Table 98: for a description of possible response codes.
Recur success
$mpgResponse->getRecurSuccess()
String TBD
Indicates whether the transaction successfully registered
Recur update object response fields
Recur update
success
String true/false
$mpgResponse->getRecurUpdateSuccess
()
Indicates whether the transaction successfully updated.
Next recur
date
String yyyy-mm-dd format
$mpgResponse->getNextRecurDate()
Indicates when the transaction will be billed again.
Recur end date String yyyy-mm-dd format
$mpgResponse->getRecurEndDate()
Indicates when the Recurring Billing Transaction will end.
Page 351 of 480
April 2019
13 Recurring Billing
The Recur Update response is a 3-digit numeric value. The following is a list of all possible responses after
a Recur Update transaction has been sent.
Table 98: Recur update response codes
Request Value
Definition
001
Recurring transaction successfully updated (optional: terminated)
983
Cannot find the previous transaction
984
Data error: (optional: field name)
985
Invalid number of recurs
986
Incomplete: timed out
null
Error: Malformed XML
13.5 Credential on File and Recurring Billing
NOTE: The value of the payment indicator field must be R when sending Recurring Billing
transactions.
For Recurring Billing transactions which are set to start immediately:
1. Send a Purchase transaction request with both the Recurring Billing and Credential on File info
objects (with Recurring Billing object field start now = true)
For Recurring Billing transactions which are set to start on a future date:
1. Send Card Verification transaction request including the Credential on File info object to get the
Issuer ID
2. Send Purchase transaction request with the Recur and Credential on File info objects included
For updating a Recurring Billing series where you are updating the card number (does not apply if you are
only modifying the schedule or amount in a recurring series):
1. Send Card Verification request including the Credential on File info object to get the Issuer ID
2. Send a Recurring Billing Update transaction
For more information about the Recurring Billing object, see Definition of Request Fields – Recurring.
April 2019
Page 352 of 480
14 Customer Information
l
l
14.1 Using the Customer Information Object
14.2 Customer Information Sample Code
The Customer Information object offers a number of fields to be submitted as part of the financial transaction, and stored by Moneris. These details may be viewed in the future in the Merchant Resource
Center.
The following transactions support the Customer Information object :
l
l
l
Purchase (Basic, Interac Debit and Vault)
Pre-Authorization (Basic and Vault)
Re-Authorization (Basic)
The Customer Information object holds three types of information:
l
l
l
Billing/Shipping information
Miscellaneous customer information properties
Item information
Things to Consider:
l
l
l
l
If you send characters that are not included in the allowed list, these extra transaction
details may not be stored.
All fields are alphanumeric and allow the following characters: a-z A-Z 0-9 _ - : . @ $ = /
All French accents should be encoded as HTML entities, such as é.
The data sent in Billing and Shipping Address fields will not be used for any address verification.
14.1 Using the Customer Information Object
l
l
l
14.1.1 Customer Info Object – Miscellaneous Properties
14.1.2 Customer Info Object – Billing/Shipping Information
14.1.3 Customer Info Object – Item Information
In addition to instantiating a transaction object and a connection object (as you would for a normal transaction), you must instantiate a CustInfo object.
Any transaction that supports CustInfo has a setCustInfo method. This is used to write the customer
information to the transaction object before writing the transaction object to the connection object.
CustInfo object definition
$mpgCustInfo = new mpgCustInfo();
April 2019
Page 354 of 480
Moneris Gateway API - Integration Guide
Transaction object set method
$mpgTxn->setCustInfo($mpgCustInfo);
14.1.1 Customer Info Object – Miscellaneous Properties
While most of the Customer Information data is organized into objects, there are some values that are
properties of the CustInfo object itself. They are explained in the table below.
Table 99: CustInfo object miscellaneous properties
Value
Type
Limits
Set method
Email
Address
String
60-character alphanumeric
$mpgCustInfo->setEmail($email);
Instructions
String
100-character alphanumeric
$mpgCustInfo->setInstructions
($note);
14.1.2 Customer Info Object – Billing/Shipping Information
Billing and shipping information is stored as part of the Customer Information object. They can be written to the object in one of two ways:
l
l
Using set methods
Using hash tables
Whichever method you use, you will be writing the information found in the table below for both the
billing information and the shipping information.
All values are alphanumeric strings. Their maximum lengths are given in the Limit column.
Table 100: Billing and shipping information values
Value
Limit
Hash table key
First name
30
"first_name"
Last name
30
"last_name"
Company name
50
"company_name"
Address
70
"address"
Page 355 of 480
April 2019
14 Customer Information
Table 100: Billing and shipping information values (continued)
Value
Limit
Hash table key
City
30
"city"
Province/State
30
"province"
Postal/Zip code
30
"postal_code"
Country
30
"country"
Phone number (voice)
30
"phone"
Fax number
30
"fax"
Federal tax
10
"tax1"
Provincial/State tax
10
"tax2"
County/Local/Specialty tax
10
"tax3"
Shipping cost
10
"shipping_cost"
14.1.2.1 Set Methods for Billing and Shipping Info
The billing information and the shipping information for a given CustInfo object are written by using the
$mpgCustInfo->setBilling($billing); and $mpgCustInfo->setShipping($shipping);
methods respectively:
$billing = array(
'first_name' => $first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
April 2019
Page 356 of 480
Moneris Gateway API - Integration Guide
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setBilling($billing);
$shipping = array(
'first_name' => $first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setShipping($shipping);
Both of these methods have the same set of mandatory arguments. They are described in the Billing and
shipping information values table in 14.1.2.1 Set Methods for Billing and Shipping Info.
For sample code, see 14.2 Customer Information Sample Code.
14.1.2.2 Using Hash Tables for Billing and Shipping Info
Writing billing or shipping information using hash tables is done as follows:
1. Instantiate a CustInfo object.
2. Instantiate a hash table object. (The sample code uses a different hash table for billing and shipping for clarity purposes. However, the skillful developer can re-use the same one.)
3. Build the hash table using put methods with the hash table keys found in the Billing and shipping
information values table in 14.1.2 Customer Info Object – Billing/Shipping Information.
Page 357 of 480
April 2019
14 Customer Information
4. Call the CustInfo object's setBilling/setShipping method to pass the hash table information to
the CustInfo object
5. Call the transaction object's setCustInfo method to write the CustInfo object (with the billing/shipping information to the transaction object.
For sample code, see 14.2 Customer Information Sample Code.
14.1.3 Customer Info Object – Item Information
The Customer Information object can hold information about multiple items. For each item, the values
in the table below can be written.
All values are strings, but note the guidelines in the Limits column.
Table 101: Item information values
Value
Limits
Hash table key
Item name
45-character alphanumeric
"name"
Item quantity
5-character numeric
"quantity"
Item product code
20-character alphanumeric
"product_code"
Item extended amount
9-character decimal with at
least 3 digits and 2 penny values.
"extended_amount"
0.01-999999.99
One way of representing multiple items is with four arrays. This is the method used in the sample code.
However, there are two ways to write the item information to the CustInfo object:
l
l
Set methods
Hash tables
14.1.3.1 Set Methods for Item Information
All the item information found in the Item information values table in 14.1.3 Customer Info Object – Item
Information is written to the CustInfo object in one instruction for a given item. Such as:
customer.setItem(item_description, item_quantity, item_product_code, item_
extended_amount);
For sample code (showing how to use arrays to write information about two items), see 14.2 Customer
Information Sample Code.
14.1.3.2 Using Hash Tables for Item Information
Writing item information using hash tables is done as follows:
April 2019
Page 358 of 480
Moneris Gateway API - Integration Guide
1. Instantiate a CustInfo object.
2. Instantiate a hash table object. (The sample code uses a different hash table for each item for clarity purposes. However, the skillful developer can re-use the same one.)
3. Build the hash table using put methods with the hash table keys in the Item information values
table in 14.1.3 Customer Info Object – Item Information.
4. Call the CustInfo object's setItem method to pass the hash table information to the CustInfo
object
5. Call the transaction object's setCustInfo method to write the CustInfo object (with the item
information to the transaction object.
For sample code that shows how to use arrays to write information about two items, see 14.2 Customer
Information Sample Code.
14.2 Customer Information Sample Code
Below is an example of a Basic Purchase with Customer Information transaction.
Note that the two items ordered are represented by four arrays, and the billing and shipping details are
the same.
Sample Purchase with Customer Information
## Example php -q TestPurchase-CustInfo.php
require "../../mpgClasses.php";
/************************ Request Variables ***************************/
$store_id='store5';
$api_token='yesguy';
/********************* Transactional Variables ************************/
$type='purchase';
$order_id='ord-'.date("dmy-G:i:s");
$cust_id='my cust id';
$amount='1.00';
$pan='4242424242424242';
$expiry_date='0812'; //December 2008
$crypt='7';
/******************* Customer Information Variables ********************/
$first_name = 'Cedric';
$last_name = 'Benson';
$company_name = 'Chicago Bears';
$address = '334 Michigan Ave';
$city = 'Chicago';
$province = 'Illinois';
$postal_code = 'M1M1M1';
$country = 'United States';
$phone_number = '453-989-9876';
$fax = '453-989-9877';
$tax1 = '1.01';
$tax2 = '1.02';
$tax3 = '1.03';
$shipping_cost = '9.95';
$email ='Joe@widgets.com';
$instructions ="Make it fast";
Page 359 of 480
April 2019
14 Customer Information
Sample Purchase with Customer Information
/*********************** Line Item Variables **************************/
$item_name[0] = 'Guy Lafleur Retro Jersey';
$item_quantity[0] = '1';
$item_product_code[0] = 'JRSCDA344';
$item_extended_amount[0] = '129.99';
$item_name[1] = 'Patrick Roy Signed Koho Stick';
$item_quantity[1] = '1';
$item_product_code[1] = 'JPREEA344';
$item_extended_amount[1] = '59.99';
/******************** Customer Information Object *********************/
$mpgCustInfo = new mpgCustInfo();
/********************** Set Customer Information **********************/
$billing = array(
'first_name' => $first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setBilling($billing);
$shipping = array(
'first_name' => $first_name,
'last_name' => $last_name,
'company_name' => $company_name,
'address' => $address,
'city' => $city,
'province' => $province,
'postal_code' => $postal_code,
'country' => $country,
'phone_number' => $phone_number,
'fax' => $fax,
'tax1' => $tax1,
'tax2' => $tax2,
'tax3' => $tax3,
'shipping_cost' => $shipping_cost
);
$mpgCustInfo->setShipping($shipping);
$mpgCustInfo->setEmail($email);
$mpgCustInfo->setInstructions($instructions);
/*********************** Set Line Item Information *********************/
$item[0] = array(
'name'=>$item_name[0],
'quantity'=>$item_quantity[0],
'product_code'=>$item_product_code[0],
'extended_amount'=>$item_extended_amount[0]
);
$item[1] = array(
'name'=>$item_name[1],
'quantity'=>$item_quantity[1],
'product_code'=>$item_product_code[1],
April 2019
Page 360 of 480
Moneris Gateway API - Integration Guide
Sample Purchase with Customer Information
'extended_amount'=>$item_extended_amount[1]
);
$mpgCustInfo->setItems($item[0]);
$mpgCustInfo->setItems($item[1]);
/***************** Transactional Associative Array ********************/
$txnArray=array(
'type'=>$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt
);
/********************** Transaction Object ****************************/
$mpgTxn = new mpgTransaction($txnArray);
/******************** Set Customer Information ************************/
$mpgTxn->setCustInfo($mpgCustInfo);
/************************* Request Object *****************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/************************ HTTPS Post Object ***************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/*************************** Response *********************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
Page 361 of 480
April 2019
15 Status Check
l
l
l
15.1 About Status Check
15.2 Using Status Check Response Fields
15.3 Sample Purchase with Status Check
15.1 About Status Check
Status Check is a connection object value that allows merchants to verify whether a previously sent transaction was processed successfully.
To submit a Status Check request, resend the original transaction with all the same parameter values,
but set the status check value to either true or false.
Once set to “true”, the gateway will check the status of a transaction that has an order_id that matches
the one passed.
l
l
If the transaction is found, the gateway will respond with the specifics of that transaction.
If the transaction is not found, the gateway will respond with a not found message.
Once it is set to “false”, the transaction will process as a new transaction.
For example, if you send a Purchase transaction with Status Check, include the same values as the original Purchase such as the order ID and the amount.
The feature must be enabled in your merchant profile. To have it enabled, contact Moneris.
Things to Consider:
l
l
l
The Status Check request should only be used once and immediately (within 2 minutes)
after the last transaction that had failed.
The Status Check request should not be used to check openTotals & batchClose
requests.
Do not resend the Status Check request if it has timed out. Additional investigation is
required.
15.2 Using Status Check Response Fields
After you have used the connection object to send a Status Check request, you can use the Receipt
object to obtain the information you want regarding the success of the original transaction.
The status response fields related to the status check are Status Code and Status Message.
Possible Status Code response values:
l
l
0-49: successful transaction
50-999: unsuccessful transaction.
April 2019
Page 362 of 480
Moneris Gateway API - Integration Guide
Possible Status Message response values:
l
l
Found: Status code is 0-49
Not found or Null: Status code is 50-999)
If the Status Message is Found, all other response fields are the same as those from the original transaction.
If the Status Message is Not found, all other response fields will be Null.
15.3 Sample Purchase with Status Check
Sample Purchase transaction with Status Check
'purchase',
'order_id'=>'order',
'cust_id'=>'cust',
'amount'=>'1.00',
'pan'=>'4242424242424242',
'expdate'=>'2202',
'crypt_type'=>'1',
'dynamic_descriptor'=>''
);
$mpgTxn = new mpgTransaction($txnArray);
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA");
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
$mpgHttpPost =new mpgHttpsPostStatus($store_id,$api_token,$status_check,$mpgRequest);
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nStatusCode = " . $mpgResponse->getStatusCode());
print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
Page 363 of 480
April 2019
16 Visa Checkout
l
l
l
l
l
l
l
l
l
l
16.1 About Visa Checkout
16.2 Transaction Types - Visa Checkout
16.3 Integrating Visa Checkout Lightbox
16.4 Transaction Flow for Visa Checkout
16.5 Visa Checkout Purchase
16.6 Visa Checkout Pre-Authorization
16.7 Visa Checkout Completion
16.8 Visa Checkout Purchase Correction
16.9 Visa Checkout Refund
16.10 Visa Checkout Information
16.1 About Visa Checkout
Visa Checkout is a digital wallet service offered to customers using credit cards. Visa Checkout functionality can be integrated into the Moneris Gateway via the API.
16.2 Transaction Types - Visa Checkout
Below is a list of transactions supported by the Visa Checkout API, other terms used for the transaction
type are indicated in brackets.
VdotMePurchase (sale)
Call to Moneris to obtain funds on the Visa Checkout callId and ready them for deposit
into the merchant’s account. It also updates the customer’s Visa Checkout transaction history.
VdotMePreAuth (authorisation / pre-authorization)
Call to Moneris to verify funds on the Visa Checkout callid and reserve those funds for
your merchant account. The funds are locked for a specified amount of time, based on the
card issuer. To retrieve the funds from this call so that they may be settled in the merchant’s
account, a VdotMeCompletion must be performed. It also updates the customer’s Visa
Checkout transaction history.
VdotMeCompletion (Completion / Capture)
Call to Moneris to obtain funds reserved by VdotMePreAuth call. This transaction call
retrieves the locked funds and readies them for settlement into the merchant’s account. This
call must be made typically within 72 hours of performing VdotMePreAuth. It also updates
the customer’s Visa Checkout transaction history.
VdotMePurchaseCorrection (Void / Purchase Correction)
Call to Moneris to void the VdotMePurchases and VdotMeCompletions the same day* that
they occurred on. It also updates the customer’s Visa Checkout transaction history.
VdotMeRefund (Credit)
Call to Moneris to refund against a VdotMePurchase or VdotMeCompletion to refund
any part, or all of the transaction. It also updates the customer’s Visa Checkout transaction
history.
April 2019
Page 364 of 480
Moneris Gateway API - Integration Guide
VdotMeInfo (Credit)
Call to Moneris to obtain cardholder details such as, name on card, partial card number,
expiry date, shipping and billing information.
16.3 Integrating Visa Checkout Lightbox
1. Using the API Key you obtained when you configured your Visa Checkout store, create Visa Checkout Lightbox integration with JavaScript by following the Visa documentation, which is available
on Visa Developer portal:
Visa Checkout General Information (JavaScript SDK download)
https://developer.visa.com/products/visa_checkout
Getting Started With Visa checkout
https://developer.visa.com/products/visa_checkout/guides#getting_started
Adding Visa Checkout to Your Web Page
https://developer.visa.com/products/visa_checkout/guides#adding_to_page
Submitting the Consumer Payment Request
https://developer.visa.com/products/visa_checkout/guides#submitting_csr
2. If you get a payment success event from the resulting Visa Lightbox JavaScript, you will have to
parse and obtain the callid from their JSON response. The additional information is obtained
using VdotMeInfo.
Once you have obtained the callid from Visa Lightbox, you can make appropriate Visa Checkout VdotMe
transaction call to Moneris to process your transaction and obtain your funds.
NOTE: During Visa Checkout testing in our QA test environment, please use the API key
that you generated in the Visa Checkout configuration for the V.Init call in your
JavaScript.
Page 365 of 480
April 2019
16 Visa Checkout
16.4 Transaction Flow for Visa Checkout
April 2019
Page 366 of 480
Moneris Gateway API - Integration Guide
16.5 Visa Checkout Purchase
VdotMePurchase transaction object definition
$txnArray = array(‘type’=>’vdotme_purchase', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest for VdotMePurchase transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VdotMePurchase transaction object values
Table 1 VdotMePurchase transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Call ID
String
20-character numeric
'callid'=>$callid
Amount
String
(missing or bad snippet)
'amount'=>$amount
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 VdotMePurchase transaction object optional values
Value
Type
Limits
Set Method
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample VdotMePurchase
$type,
'order_id'=>$order_id,
'amount'=>$amount,
'callid'=>$callid,
'crypt_type'=>$crypt,
'cust_id'=>$cust_id,
'dynamic_descriptor'=>$dynamic_descriptor
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
16.6 Visa Checkout Pre-Authorization
VdotMePreAuth is virtually identical to the VdotMePurchase with the exception of the transaction
type name.
If the order could not be completed for some reason, such as an order is cancelled, made in error or not
fulfillable, the VdotMePreAuth transaction must be reversed within 72 hours.
To reverse an authorization, perform a VdotMeCompletion transaction for $0.00 (zero dollars).
April 2019
Page 368 of 480
Moneris Gateway API - Integration Guide
VdotMePreAuth transaction object definition
$txnArray = array(‘type’=>’vdotme_preauth', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VdotMePreAuth transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VdotMePreAuth transaction object values
Table 1 VdotMePreAuth transaction object mandatory values
Value
Type
Limits
Set Method
Amount
String
(missing or bad snippet)
'amount'=>$amount
Call ID
String
20-character numeric
'callid'=>$callid
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 VdotMePreAuth transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample VdotMePreAuth
$type,
'order_id'=>$order_id,
'amount'=>$amount,
'callid'=>$callid,
'crypt_type'=>$crypt,
'cust_id'=>$cust_id,
'dynamic_descriptor'=>$dynamic_descriptor
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
16.7 Visa Checkout Completion
The VdotMeCompletion transaction is used to secure the funds locked by a VdotMePreAuth transaction.
You may also perform this transaction at $0.00 (zero dollars) to reverse a VdotMePreauth transaction
that you are unable to fulfill.
VdotMeCompletion transaction object definition
$txnArray = array(‘type’=>’vdotme_completion', …);
$mpgTxn = new mpgTransaction($txnArray);
April 2019
Page 370 of 480
Moneris Gateway API - Integration Guide
HttpsPostRequest object for VdotMeCompletion transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VdotMeCompletion transaction object values
Table 1 VdotMeCompletion transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Completion amount
String
(missing or bad snippet)
'comp_amount'=>$comp_amount
E-commerce indicator
String
1-character alphanumeric
'crypt_type'=>$crypt
Table 2 VdotMeCompletion transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Sample VdotMeCompletion
$type,
'order_id'=>$order_id,
'comp_amount'=>$comp_amount,
'txn_number'=>$txn_number,
'crypt_type'=>$crypt,
'cust_id'=>$cust_id,
'dynamic_descriptor'=>$dynamic_descriptor
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
16.8 Visa Checkout Purchase Correction
VdotMePurchaseCorrection is used to cancel a VdotMeCompletion or VdotMePurchase trans-
action that was performed in the current batch. No other transaction types can be corrected using this
method.
No amount is required because it is always for 100% of the original transaction.
VdotMePurchaseCorrection transaction object definition
$txnArray = array(‘type’=>’vdotme_purchasecorrection', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VdotMePurchaseCorrection transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
April 2019
Page 372 of 480
Moneris Gateway API - Integration Guide
VdotMePurchaseCorrection transaction object values
Table 1 VdotMePurchaseCorrection transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
Table 2 VdotMePurchaseCorrection transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Status check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample VdotMePurchaseCorrection
$type,
'order_id'=>$order_id,
'txn_number'=>$txn_number,
'crypt_type'=>$crypt,
'cust_id'=>$cust_id,
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
Page 373 of 480
April 2019
16 Visa Checkout
Sample VdotMePurchaseCorrection
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
16.9 Visa Checkout Refund
VdotMeRefund will credit a specified amount to the cardholder’s credit card and update their Visa Checkout transaction history. A refund can be sent up to the full value of the original VdotMeCompletion or
VdotMePurchase.
VdotMeRefund transaction object definition
$txnArray = array(‘type’=>’vdotme_refund', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VdotMeRefund transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VdotMeRefund transaction object values
Table 1 VdotMeRefund transaction object mandatory values
Value
Type
Limits
Set Method
Order ID
String
50-character alphanumeric
'order_id'=>$order_id
Amount
String
(missing or bad snippet)
'amount'=>$amount
Transaction number
String
255-character alphanumeric
'txn_number'=>$txn_number
April 2019
Page 374 of 480
Moneris Gateway API - Integration Guide
Value
Type
E-commerce indicator
String
Limits
1-character alphanumeric
Set Method
'crypt_type'=>$crypt
Table 2 VdotMeRefund transaction object optional values
Value
Type
Limits
Set Method
Customer ID
String
50-character alphanumeric
'cust_id'=>$cust_id
Dynamic descriptor
String
20-character alphanumeric
'dynamic_
descriptor'=>$dynamic_
descriptor
Status check
Boolean
true/false
$mpgHttpPost =new
mpgHttpsPostStatus($store_
id,$api_
token,$status,$mpgRequest);
Sample VdotMeRefund
$type,
'order_id'=>$order_id,
'txn_number'=>$txn_number,
'amount'=>$amount,
'crypt_type'=>$crypt,
'cust_id'=>$cust_id,
'dynamic_descriptor'=>$dynamic_descriptor
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
Page 375 of 480
April 2019
16 Visa Checkout
Sample VdotMeRefund
/***************************** HTTPS Post Object *****************************/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
?>
16.10 Visa Checkout Information
VdotMeInfo will get customer information from their Visa Checkout wallet. The details returned are
dependent on what the customer has stored in Visa Checkout.
VdotMeInfo transaction object definition
$txnArray = array(‘type’=>’vdotme_getpaymentinfo', …);
$mpgTxn = new mpgTransaction($txnArray);
HttpsPostRequest object for VdotMeInfo transaction
$mpgRequest = new mpgRequest($mpgTxn);
$mpgHttpPost = new mpgHttpsPost($store_id,$api_token,$mpgRequest);
VdotMeInfo transaction object values
Table 1 VdotMeInfo transaction object mandatory values
Value
Call ID
Type
Limits
String
20-character numeric
Set Method
'callid'=>$callid
Sample VdotMeInfo
'vdotme_getpaymentinfo',
'callid'=>$callid
);
/**************************** Transaction Object *****************************/
$mpgTxn = new mpgTransaction($txnArray);
/****************************** Request Object *******************************/
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to US environment
$mpgRequest->setTestMode(true); //false or comment out this line for production transactions
/***************************** HTTPS Post Object *****************************/
/* Status Check Example
$mpgHttpPost =new mpgHttpsPostStatus($store_id,$api_token,$status_check,$mpgRequest);
*/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
/******************************* Response ************************************/
$vdotmeinfo=$mpgHttpPost->getMpgResponse();
print("\nResponse Code: " . $vdotmeinfo->getResponseCode());
print("\nResponse Message: " . $vdotmeinfo->getMessage());
print("\nCurrency Code: " . $vdotmeinfo->getCurrencyCode());
print("\nPayment Totals: " . $vdotmeinfo->getPaymentTotal());
print("\nUser First Name: " . $vdotmeinfo->getUserFirstName());
print("\nUser Last Name: " . $vdotmeinfo->getUserLastName());
print("\nUsername: " . $vdotmeinfo->getUserName());
print("\nUser Email: " . $vdotmeinfo->getUserEmail());
print("\nEncrypted User ID: " . $vdotmeinfo->getEncUserId());
print("\nCreation Time Stamp: " . $vdotmeinfo->getCreationTimeStamp());
print("\nName on Card: " . $vdotmeinfo->getNameOnCard());
print("\nExpiration Month: " . $vdotmeinfo->getExpirationDateMonth());
print("\nExpiration Year: " . $vdotmeinfo->getExpirationDateYear());
print("\nLast 4 Digits: " . $vdotmeinfo->getLastFourDigits());
print("\nBin Number (6 Digits): " . $vdotmeinfo->getBinSixDigits());
print("\nCard Brand: " . $vdotmeinfo->getCardBrand());
print("\nCard Type: " . $vdotmeinfo->getVDotMeCardType());
print("\nBilling Person Name: " . $vdotmeinfo->getBillingPersonName());
print("\nBilling Address Line 1: " . $vdotmeinfo->getBillingAddressLine1());
print("\nBilling City: " . $vdotmeinfo->getBillingCity());
print("\nBilling State/Province Code: " . $vdotmeinfo->getBillingStateProvinceCode());
print("\nBilling Postal Code: " . $vdotmeinfo->getBillingPostalCode());
print("\nBilling Country Code: " . $vdotmeinfo->getBillingCountryCode());
print("\nBilling Phone: " . $vdotmeinfo->getBillingPhone());
print("\nBilling ID: " . $vdotmeinfo->getBillingId());
print("\nBilling Verification Status: " . $vdotmeinfo->getBillingVerificationStatus());
print("\nPartial Shipping Country Code: " . $vdotmeinfo->getPartialShippingCountryCode());
print("\nPartial Shipping Postal Code: " . $vdotmeinfo->getPartialShippingPostalCode());
print("\nShipping Person Name: " . $vdotmeinfo->getShippingPersonName());
print("\nShipping Address Line 1: " . $vdotmeinfo->getShippingAddressLine1());
print("\nShipping City: " . $vdotmeinfo->getShippingCity());
print("\nShipping State/Province Code: " . $vdotmeinfo->getShippingStateProvinceCode());
print("\nShipping Postal Code: " . $vdotmeinfo->getShippingPostalCode());
print("\nShipping Country Code: " . $vdotmeinfo->getShippingCountryCode());
print("\nShipping Phone: " . $vdotmeinfo->getShippingPhone());
Page 377 of 480
April 2019
16 Visa Checkout
Sample VdotMeInfo
print("\nShipping Default: " . $vdotmeinfo->getShippingDefault());
print("\nShipping ID: " . $vdotmeinfo->getShippingId());
print("\nShipping Verification Status: " . $vdotmeinfo->getShippingVerificationStatus());
print("\nisExpired: " . $vdotmeinfo->getIsExpired());
print("\nBase Image File Name: " . $vdotmeinfo->getBaseImageFileName());
print("\nHeight: " . $vdotmeinfo->getHeight());
print("\nWidth: " . $vdotmeinfo->getWidth());
print("\nIssuer Bid: " . $vdotmeinfo->getIssuerBid());
print("\nRisk Advice: " . $vdotmeinfo->getRiskAdvice());
print("\nRisk Score: " . $vdotmeinfo->getRiskScore());
print("\nAVS Response Code: " . $vdotmeinfo->getAvsResponseCode());
print("\nCVV Response Code: " . $vdotmeinfo->getCvvResponseCode());
?>
April 2019
Page 378 of 480
17 Testing a Solution
l
l
l
l
l
l
l
l
l
l
17.1 About the Merchant Resource Center
17.2 Logging In to the QA Merchant Resource Center
17.3 Test Credentials for Merchant Resource Center
17.4 Getting a Unique Test Store ID and API Token
17.5 Processing a Transaction
17.6 Testing INTERAC® Online Payment Solutions
17.7 Testing MPI Solutions
17.8 Testing Visa Checkout
1 Test Cards
17.10 Simulator Host
17.1 About the Merchant Resource Center
The Merchant Resource Center is the user interface for Moneris Gateway services. There is also a
QA version of the Merchant Resource Center site specifically allocated for you and other developers to
use to test your API integrations with the gateway.
You can access the Merchant Resource Center in the test environment at:
https://esqa.moneris.com/mpg (Canada)
The test environment is generally available 24/7, but 100% availability is not guaranteed. Also, please be
aware that other merchants are using the test environment in the Merchant Resource Center. Therefore,
you may see transactions and user IDs that you did not create. As a courtesy to others who are testing,
we ask that you use only the transactions/users that you created. This applies to processing Refund
transactions, changing passwords or trying other functions.
17.2 Logging In to the QA Merchant Resource Center
To log in to the QA Merchant Resource Center for testing purposes:
1. Go to the Merchant Resource Center QA website at https://esqa.moneris.com/mpg
2. Enter your username and password, which are the same email address and password you use to
log in to the Developer Portal
3. Enter your Store ID, which you obtained from the Developer Portal's My Testing Credentials as
described in Test Credentials for Merchant Resource Center (page 379)
17.3 Test Credentials for Merchant Resource Center
For testing purposes, you can either use the pre-existing test stores in the Merchant Resource Center, or
you can create your own unique test store where you will only see your own transactions. If you want to
use the pre-existing stores, use the test credentials provided in the following tables with the corresponding lines of code, as in the examples below.
April 2019
Page 379 of 480
Moneris Gateway API - Integration Guide
Example of Corresponding Code For Canada:
$store_id='monca00392';
$api_token='qYdISUhHiOdfTr1CLNpN';
$mpgRequest->setProcCountryCode("CA");
$mpgRequest->setTestMode(true);
Table 102: Test Server Credentials - Canada
store_id
api_token
Username
Password
Other Information
store1
yesguy
demouser
password
store2
yesguy
demouser
password
store3
yesguy
demouser
password
store4
yesguy
demouser
password
store5
yesguy
demouser
password
monca00392
yesguy
demouser
password
Use this store to
test Convenience
Fee transactions
moncaqagt1
mgtokenguy1
demouser
password
Use this store to
test Token Sharing
moncaqagt2
mgtokenguy2
demouser
password
Use this store to
test Token Sharing
moncaqagt3
mgtokenguy3
demouser
password
Use this store to
test Token Sharing
monca01428
mcmpguy
demouser
password
Use this store to
test MasterCard
MasterPass
Alternatively, you can create and use a unique test store where you will only see your own
transactions. For more on this, see Getting a Unique Test Store ID and API Token (page 381)
Page 380 of 480
April 2019
17 Testing a Solution
17.4 Getting a Unique Test Store ID and API Token
Transactions requests via the API will require you to have a Store ID and a corresponding API token.For
testing purposes, you can either use the pre-existing test stores in the Merchant Resource Center, or you
can create your own unique test store where you will only see your own transactions.
To get your unique Store ID and API token:
1. Log in to the Developer Portal at https://developer.moneris.com
2.
3.
4.
5.
In the My Profile dialog, click the Full Profile
button
Under My Testing Credentials, select Request Testing Credentials
Enter your Developer Portal password and select your country
Record the Store ID and API token that are given, as you will need them for logging in to the Merchant Resource Center (Store ID) and for API requests (API token).
Alternatively, you can use the pre-existing test stores already set up in the Merchant Resource Center as
described in Test Credentials for Merchant Resource Center (page 379).
April 2019
Page 381 of 480
17.5 Processing a Transaction
l
l
l
1.1 Overview
1.2 HttpsPostRequest Object
1.3 Receipt Object
17.5.1 Overview
There are some common steps for every transaction that is processed.
1. Instantiate the transaction object (e.g., Purchase), and update it with object definitions that
refer to the individual transaction.
2. Instantiate the HttpsPostRequest connection object and update it with connection information,
host information and the transaction object that you created in step 17.5
Section 17.5 (page 383) provides the HttpsPostRequest connection object definition. This object
and its variables apply to every transaction request.
3. Invoke the HttpsPostRequest object's send() method.
4. Instantiate the Receipt object, by invoking the HttpsPostRequest object's get Receipt method.
Use this object to retrieve the applicable response details.
Some transactions may require steps in addition to the ones listed here. Below is a sample Purchase
transaction with each major step outlined. For extensive code samples of other transaction types, refer
to the PHP API ZIP file.
NOTE: For illustrative purposes, the order in which lines of code appear below may differ
slightly from the same sample code presented elsewhere in this document.
$type,
'order_id'=>$order_id,
'cust_id'=>$cust_id,
'amount'=>$amount,
'pan'=>$pan,
'expdate'=>$expiry_date,
'crypt_type'=>$crypt,
'dynamic_descriptor'=>$dynamic_descriptor
);
Instantiate the transaction object and
assign values to properties.
$mpgTxn = new mpgTransaction($txnArray);
$mpgRequest = new mpgRequest($mpgTxn);
$mpgRequest->setProcCountryCode("CA"); //"US" for sending transaction to
US environment
$mpgRequest->setTestMode(true); //false or comment out this line for
production transactions
/* Status Check Example
$mpgHttpPost =new mpgHttpsPostStatus($store_id,$api_token,$status_
check,$mpgRequest);
*/
$mpgHttpPost =new mpgHttpsPost($store_id,$api_token,$mpgRequest);
$mpgResponse=$mpgHttpPost->getMpgResponse();
print("\nCardType = " . $mpgResponse->getCardType());
print("\nTransAmount = " . $mpgResponse->getTransAmount());
print("\nTxnNumber = " . $mpgResponse->getTxnNumber());
print("\nReceiptId = " . $mpgResponse->getReceiptId());
print("\nTransType = " . $mpgResponse->getTransType());
print("\nReferenceNum = " . $mpgResponse->getReferenceNum());
print("\nResponseCode = " . $mpgResponse->getResponseCode());
print("\nISO = " . $mpgResponse->getISO());
print("\nMessage = " . $mpgResponse->getMessage());
print("\nIsVisaDebit = " . $mpgResponse->getIsVisaDebit());
print("\nAuthCode = " . $mpgResponse->getAuthCode());
print("\nComplete = " . $mpgResponse->getComplete());
print("\nTransDate = " . $mpgResponse->getTransDate());
print("\nTransTime = " . $mpgResponse->getTransTime());
print("\nTicket = " . $mpgResponse->getTicket());
print("\nTimedOut = " . $mpgResponse->getTimedOut());
print("\nStatusCode = " . $mpgResponse->getStatusCode());
print("\nStatusMessage = " . $mpgResponse->getStatusMessage());
?>
Instantiate connection
object and assign values to properties,
including the transaction object you just
created.
Instantiate the Receipt
object and use its get
methods to retrieve
the desired response
data.
17.5.2 HttpsPostRequest Object
The transaction object that you instantiate becomes a property of this object when you call its set transaction method.
HttpsPostRequest Object Definition
HttpsPostRequest mpgReq = new HttpsPostRequest();
After instantiating the HttpsPostRequest object, update its mandatory and optional values as outlined in
the following values tables.
Page 384 of 480
April 2019
Table 103: HttpsPostRequest object mandatory values
Type
Set method
Limits
Value
Description
Processing
String
2-character alphabetic
country code
CA for Canada, US for USA.
$mpgRequest->setProcCountryCode
("CA");
Test mode
$mpgRequest->setTestMode(true);
Boolean
true/false
Set to true when in test mode. Set to false (or comment out entire line) when in production mode.
Store ID
String
10-character alphanumeric
$mpgHttpPost = new
mpgHttpsPostStatus($store_
id,$api_token,$status_
check,$mpgRequest);
Unique identifier provided by Moneris upon merchant account set up.
See 17.1 About the Merchant Resource Center for test environment details.
API Token
String
20-character alphanumeric
$mpgHttpPost = new
mpgHttpsPostStatus($store_
id,$api_token,$status_
check,$mpgRequest);
Unique alphanumeric string assigned upon merchant account activation. To locate your
production API token, refer to the Merchant Resource Center Admin Store Settings.
See 17.3 Test Credentials for Merchant Resource Center for test environment details.
Transaction
Object
$mpgRequest = new mpgRequest
($mpgTxn);
Not applicable
This argument is one of the numerous transaction types discussed in the rest of this
manual. (Such as Purchase, Refund and so on.) This object is instantiated in step 1
above.
Table 1 HttpsPostRequest object optional values
Type
Value
Set method
Limits
Description
Status
Check
Boolean true/false $mpgHttpPost = new mpgHttpsPostStatus($store_
id,$api_token,$status_check,$mpgRequest);
See Appendix A Definitions of Request Fields.
NOTE: while this value belongs to the HttpsPostRequest object, it is only supported by some transactions.
Check the individual transaction definition to find out whether Status Check can be used.
April 2019
Page 385 of 480
Moneris Gateway API - Integration Guide
17.5.3 Receipt Object
After you send a transaction using the HttpsPostRequest object's send method, you can instantiate a
receipt object.
Receipt Object Definition
$mpgResponse=$mpgHttpPost->getMpgResponse();
For an in-depth explanation of Receipt object methods and properties, see Appendix B Definitions of
Response Fields.
17.6 Testing INTERAC® Online Payment Solutions
Acxsys has two websites where merchants can post transactions for testing the fund guarantee porting
of INTERAC® Online Payment transactions. The test IDEBIT_MERCHNUM value is provided by Moneris
after registering in the test environment.
After registering, the following two links become accessible:
l
l
Merchant Test Tool
Certification Test Tool
Merchant Test Tool
https://merchant-test.interacidebit.ca/gateway/merchant_test_processor.do
This URL is used to simulate the transaction response process, to validate response variables, and to
properly integrate your checkout process.
When testing INTERAC® Online Payment transactions, you are forwarded to the INTERAC® Online Payment Merchant Testing Tool. A screen appears where certain fields need to be completed.
For an approved response, do not alter any of the fields except for the ones listed here.
IDEBIT_TRACK2
To form a track2 when testing with the Moneris Gateway, use one of these three numbers:
3728024906540591206=01121122334455000
5268051119993326=01121122334455000000
453781122255=011211223344550000000000
IDEBIT_ISSNAME
RBC
IDEBIT_ISSCONF
123456
For a declined response, provide any other value as the IDEBIT_TRACK2. Click Post to Merchant.
Whether the transaction is approved or declined, do not click Validate Data. This will return validation
errors.
Page 386 of 480
April 2019
Certification Test Tool
https://merchant-test.interacidebit.ca/gateway/merchant_certification_processor.do
This URL is used to complete the required INTERAC® Online Payment Merchant Front-End Certification
test cases, which are outlined in Appendix E (page 458) and Appendix F (page 462).
To confirm the fund that was guaranteed above, an INTERAC® Online Payment Purchase must be sent to
the Moneris Gateway QAusing the following test store information:
Host: esqa.moneris.com
Store ID: store3
API Token: yesguy
You can always log into the Merchant Resource Center to check the results using the following information:
URL: https://esqa.moneris.com/mpg
Store ID: store3
Note that all response variables that are posted back from the IOP gateway in step 5.4 of 5.4 must be validated for length of field, permitted characters and invalid characters.
17.7 Testing MPI Solutions
When testing your implementation of the Moneris MPI, you can use the Visa/MasterCard/Amex PIT (production integration testing) environment. The testing process is slightly different than a production environment in that when the inline window is generated, it does not contain any input boxes. Instead, it
contains a window of data and a Submit button. Clicking Submit loads the response in the testing window. The response will not be displayed in production.
NOTE: MasterCard SecureCode and Amex SafeKey may not be directly tested within our
current test environment. However, the process and behavior tested with the Visa test
cards will be the same for MCSC and SafeKey.
When testing you may use the following test card numbers with any future expiry date. Use the appropriate test card information from the tables below: Visa and MasterCard use the same test card information, while Amex uses unique information.
April 2019
Page 387 of 480
Moneris Gateway API - Integration Guide
Table 104: MPI test card numbers (Visa and MasterCard only)
Card Number
VERes
4012001037141112 Y
PARes
Action
true
TXN – Call function to create inLine window.
ACS – Send CAVV to Moneris Gateway using either the Cavv
Purchase or the Cavv Pre-Authorization transaction.
4012001038488884 U
NA
Send transaction to Moneris Gateway using either the basic
Purchase or the basic Pre-Authorization transaction. Set crypt_
type = 7.
4012001038443335 N
NA
Send transaction to Moneris Gateway using either the basic
Purchase or the basic Pre-Authorization transaction.
4242424242424242
Set crypt_type = 6.
4012001037461114 Y
false
Card failed to authenticate. Merchant may chose to send transaction or decline transaction. If transaction is sent, use crypt
type = 7.
Table 105: MPI test card numbers (Amex only)
Card Number
Password
VERes Required? PARes
Action
375987000000062 U
Not
required
N/A
TXN – Call function to create inLine window.
ACS – Send CAVV to Moneris Gateway using either the
Cavv Purchase or the Cavv Pre-Authorization transaction.Set crypt_type = 7.
375987000000021 Y
Yes:
false
test13fail
Card failed to authenticate. Merchant may chose to
send transaction or decline transaction. If transaction
is sent, use crypt type = 7.
375987000000013 N
Not
required
N/A
Send transaction to Moneris Gateway using either the
basic Purchase or the basic Pre-Authorization transaction. Set crypt_type = 6.
374500261001009 Y
Yes:
test09
true
Card failed to authenticate. Merchant may choose to
send transaction or decline transaction. Set crypt_
type = 5.
VERes
The result U, Y or N is obtained by using getMessage().
PARes
The result “true” or “false” is obtained by using getSuccess().
To access the Merchant Resource Center in the test environment go to https://esqa.moneris.com/mpg.
Page 388 of 480
April 2019
Transactions in the test environment should not exceed $11.00.
17.8 Testing Visa Checkout
In order to test Visa Checkout you need to:
1. Create a Visa Checkout configuration profile in the Merchant Resource Center QA environment at
https://esqa.moneris.com/mpg. To learn more about this, see "Creating a Visa Checkout Configuration for Testing" below.
2. Obtain a Lightbox API key to be used for Lightbox integration. To learn more about this, see "Integrating Visa Checkout Lightbox" on page 365.
3. For test card numbers specifically for use when testing Visa Checkout, see "Test Cards for Visa
Checkout" on the next page
17.8.1 Creating a Visa Checkout Configuration for Testing
Once you have a test store created, you need to activate Visa Checkout in the QA environment.
To activate Visa Checkout in QA:
1.
2.
3.
4.
Log in to the the QA environment at https://esqa.moneris.com/mpg
In the Admin menu, select Visa Checkout
Complete the applicable fields
Click Save.
17.9 Test Card Numbers
Because of security and compliance reasons, the use of live credit and debit card numbers for testing is
strictly prohibited. Only test credit and debit card numbers are to be used.
To test general transactions, use the following test card numbers:
Table 106: General test card numbers
Card Number
Card Plan
Mastercard
5454545454545454
Visa
4242424242424242
Amex
373599005095005
JCB
3566007770015365
April 2019
Page 389 of 480
Moneris Gateway API - Integration Guide
Card Number
Card Plan
Diners
36462462742008
Track2
5258968987035454=06061015454001060101?
Discover
6510000000000182
UnionPay
6250944000000771
17.9.1 Test Card Numbers for Level 2/3
When testing Level 2/3 transactions, use the card numbers below.
Card Brand
Test Card Number
Mastercard
5454545442424242
Visa
4242424254545454
Amex
373269005095005
17.9.2 Test Cards for Visa Checkout
Table 1 Test Cards Numbers – Visa Checkout
Card Plan
Card Number
Visa
4005520201264821 (without card art)
Visa
4242424242424242 (with card art)
MasterCard
5500005555555559
American Express
340353278080900
Discover
6011003179988686
17.10 Simulator Host
The test environment has been designed to replicate the production environment as closely as possible.
One major difference is that Moneris is unable to send test transactions onto the production authorization network. Therefore, issuer responses are simulated. Additionally, the requirement to emulate
Page 390 of 480
April 2019
approval, decline and error situations dictates that certain transaction variables initiate various response
and error situations.
The test environment approves and declines transactions based on the penny value of the amount sent.
For example, a transaction made for the amount of $9.00 or $1.00 is approved because of the .00 penny
value.
Transactions in the test environment must not exceed $11.00.
For a list of all current test environment responses for various penny values, please see the Test Environment Penny Response Table available at https://developer.moneris.com.
NOTE: These responses may change without notice. Check the Moneris Developer Portal
(https://developer.moneris.com) regularly to access the latest documentation and downloads.
April 2019
Page 391 of 480
18 Moving to Production
l
l
l
l
18.1 Activating a Production Store Account
18.2 Configuring a Store for Production
18.3 Receipt Requirements
1 Getting Help
18.1 Activating a Production Store Account
The steps below outline how to activate your production account so that you can process production
transactions.
1.
2.
3.
4.
Obtain your activation letter/fax from Moneris.
Go to https://www.moneris.com/activate.
Input your store ID and merchant ID from the letter/fax and click Activate.
Follow the on-screen instructions to create an administrator account. This account will grant you
access to the Merchant Resource Center.
5. Log into the Merchant Resource Center at https://www3.moneris.com/mpg using the user credentials created in step 18.1.
6. Proceed to ADMIN and then STORE SETTINGS.
7. Locate the API token at the top of the page. You will use this API token along with the store ID
that you received in your letter/fax and to send any production transactions through the API.
When your production store is activated, you need to configure your store so that it points to the production host. To learn how do to this, see Configuring a Store for Production (page 393)
NOTE: For more information about how to use the Merchant Resource Center, see the Moneris Gateway Merchant Resource Center User’s Guide, which is available at
https://developer.moneris.com.
18.2 Configuring a Store for Production
After you have completed your testing and have activated your production store, you are ready to point
your store to the production host.
To configure a store for production:
1. Change the test mode set method from true to false.
2. Change the Store ID to reflect the production store ID that you received when you activated your
production store. To review the steps for activating a production store, see Activating a Production Store Account (page 393).
3. Change the API token to the production token that you received during activation.
4. If you haven't done so already, change the code to reflect the correct processing country (Canada
for most merchants). For more on this, see
The table below illustrates the steps above using the relevant code (and where X is an alphanumeric character).
April 2019
Page 393 of 480
Moneris Gateway API - Integration Guide
Step
1
Code in Testing
No string changes for this item, only set
method is altered:
Changes for Production
Set method for production:
$mpgRequest->setTestMode(false);
$mpgRequest->setTestMode(true);
2
String:
String for Production:
$store_id='store5';
$store_id='monXXXXXXXX';
Associated Set Method:
'store_id'=>$store_id
3
String:
String for Production:
$api_token='yesguy';
$api_token='XXXX';
Associated Set Method:
'api_token'=>$api_token
18.2.1 Configuring an INTERAC® Online Payment Store for Production
Before you can process INTERAC® Online Payment transactions through your web site, you need to complete the certification registration process with Moneris, as described below. The production IDEBIT_
MERCHNUM value is provided by Moneris after you have successfully completed the certification.
Acxsys’ production INTERAC® Online PaymentGateway URL is https://gateway.interaconline.com/merchant_processor.do.
To access the Moneris Moneris Gateway production gateway URL, use the following:
Store ID: Provided by Moneris
API Token: Generated during your store activation process.
Processing country code: CA
The production Merchant Resource Center URL is https://www3.moneris.com/mpg/
18.2.1.1 Completing the Certification Registration - Merchants
To complete the certification registration, fax or email the information below to our Integration Support
helpdesk:
Page 394 of 480
April 2019
18 Moving to Production
l
l
l
l
l
Merchant logo to be displayed on the INTERAC® Online Payment Gateway page
l In both French and English
l 120 × 30 pixels
l Only PNG format is supported.
Merchant business name
l In both English and French
l Maximum 30 characters.
List of all referrer URLs. That is, URLs from which the customer may be redirected to the INTERAC®
Online Payment gateway.
List of all URLs that may appear in the IDEBIT_FUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
List of all URLs that may appear in the IDEBIT_NOTFUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
18.2.1.2 Third-Party Service/Shopping Cart Provider
In your product documentation, instruct your clients to provide the information below to the Moneris
Gateway Integration Support helpdesk for certification registration:
l
l
l
l
l
Merchant logo to be displayed on the INTERAC® Online Payment Gateway page
l In both French and English
l 120 × 30 pixels
l Only PNG format is supported.
Merchant business name
l In both English and French
l Maximum 30 characters.
List of all referrer URLs. That is, URLs from which the customer may be redirected to the INTERAC®
Online Payment gateway.
List of all URLs that may appear in the IDEBIT_FUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
List of all URLs that may appear in the IDEBIT_NOTFUNDEDURL field of the https form POST to the
INTERAC® Online Payment Gateway.
See 5.3.3, page 105 for additional client requirements.
April 2019
Page 395 of 480
Moneris Gateway API - Integration Guide
18.3 Receipt Requirements
Visa and MasterCard expect certain details to be provided to the cardholder and on the receipt when a
transaction is approved.
Receipts must comply with the standards outlined within the Integration Receipts Requirements. For all
the receipt requirements covering all transaction scenarios, visit the Moneris Developer Portal at
https://developer.moneris.com.
Production of the receipt must begin when the appropriate response to the transaction request is
received by the application. The transaction may be any of the following:
l
l
l
l
l
l
Sale (Purchase)
Authorization (PreAuth, Pre-Authorization)
Authorization Completion (Completion, Capture)
Offline Sale (Force Post)
Sale Void (Purchase Correction, Void)
Refund.
The boldface terms listed above are the names for transactions as they are to be displayed on receipts.
Other terms used for the transaction are indicated in brackets.
18.3.1 Certification Requirements
Card-present transaction receipts are required to complete certification.
Card-not-present integration
Certification is optional but highly recommended.
Card-present integration
After you have completed the development and testing, your application must undergo a certification process where all the applicable transaction types must be demonstrated, and the
corresponding receipts properly generated.
Contact a Client Integration Specialist for the Certification Test checklist that must be completed and returned for verification. (See "Getting Help" on page 1 for contact details.) Be sure
to include the application version of your product. Any further changes to the product after
certification requires re-certification.
After the certification requirements are met, Moneris will provide you with an official certification letter.
Page 396 of 480
April 2019
Appendix A Definitions of Request Fields
This appendix deals with values that belong to transaction objects. For information on values that
belong to the (HttpsPostRequest) connection object, see "Processing a Transaction" on page 383.
NOTE:
Alphanumeric fields allow the following characters: a-z A-Z 0-9 _ - : . @ spaces
All other request fields allow the following characters: a-z A-Z 0-9 _ - : . @ $ = /
Note that the values listed in Appendix A are not mandatory for every transaction. Check the transaction
definition. If it says that a value is mandatory, a further description is found here.
Table 107: Request fields
Type
Limits
Sample code variable definition
Value
Description
General transaction values
Order ID
String
50-character
alphanumeric
order_id
Merchant-defined transaction identifier that must be unique for every Purchase,
PreAuth and Independent Refund transaction. No two transactions of these
types may have the same order ID.
For Refund, Completion and Purchase Correction transactions, the order ID must
be the same as that of the original transaction.
The last 10 characters of the order ID are displayed in the “Invoice Number” field
on the Merchant Direct Reports. However only letters, numbers and spaces are
sent to Merchant Direct.
A minimum of 3 and a maximum of 10 valid characters are sent to Merchant
Direct. Only the last characters beginning after any invalid characters are sent. For
example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.
If the order ID has fewer than 3 characters, it may display a blank or 0000000000
in the Invoice Number field.
April 2019
Page 397 of 480
Moneris Gateway API - Integration Guide
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
Amount
String
10-character decimal
amount
Up to 7 digits
(dollars) + decimal
point (.) + 2 digits
(cents) after the
decimal point
EXAMPLE: 1234567.89
Transaction amount. Used in a number of transactions. Note that this is different
from the amount used in a Completion transaction, which is an alphanumeric
value.
This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is
9999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String
20-character numeric pan
(no spaces or dashes)
Most credit card numbers today are 16 digits, but some 13-digit numbers are still
accepted by some issuers. This field has been intentionally expanded to 20 digits
in consideration for future expansion and potential support of private label card
ranges.
Expiry date
String
4-character numeric
expdate
(YYMM format)
Note: This is the reverse of the date displayed on the physical card, which is
MMYY.
Page 398 of 480
April 2019
Appendix A Definitions of Request Fields
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
E-Commerce
indicator
String
1-character alphanumeric
crypt_type
1: Mail Order / Telephone Order—Single
2: Mail Order / Telephone Order—Recurring
3: Mail Order / Telephone Order—Instalment
4: Mail Order / Telephone Order—Unknown classification
5: Authenticated e-commerce transaction (VbV/MCSC/SafeKey)
6: Non-authenticated e-commerce transaction (VbV/MCSC/SafeKey)
7: SSL-enabled merchant
8: Non-secure transaction (web- or email-based)
9: SET non-authenticated transaction
NOTE:
When processing a Cavv Purchase or Pre-Authorization for
Apple Pay or Android Pay transactions whereby the merchant is
using their own API to decrypt the payload, this field is
mandatory.
For Apple Pay or Android Pay, send the value returned in the
eciIndicator or 3dsEciIndicator respectively. If the value is not
present, please send the value as 5. If you get a 2-character
value (e.g.,. 05 or 07) from the payload, remove the initial 0 and
just send us the 2nd character.
Supported values for Apple Pay and Android Pay are:
5: Authenticated e-commerce transaction
7: SSL-enabled merchant
April 2019
Page 399 of 480
Moneris Gateway API - Integration Guide
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
Completion
Amount
String
10-character decimal
comp_amount
Up to 7 digits
(dollars) + decimal
point (.) + 2 digits
(cents) after the
decimal point
EXAMPLE: 1234567.89
Amount of a Completion transaction. This may not be equal to the amount value
(described on page 397), which appeared in the original Pre-Authorization
transaction.
Shipping Indicator1 String
1-character alphanumeric
ship_indicator
Used to identify completion transactions that require multiple shipments, also
referred to as multiple completions. By default, if the shipping indicator is not
passed, all completions are listed as final completions. To indicate that the
completion is to be left open by the issuer as supplemental shipments or
completions are pending, a value of P is submitted.
Possible values:
P = Partial
F = Final
1Available to Canadian integrations only.
Page 400 of 480
April 2019
Appendix A Definitions of Request Fields
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
Transaction number
String
255-character
alphanumeric
txn_number
Used when performing follow-on transactions. (That is, Completion, Purchase Correction or Refund.) This must be the value that was returned as the transaction
number in the response of the original transaction.
When performing a Completion, this value must reference the Pre-Authorization.
When performing a Refund or a Purchase Correction, this value must reference
the Completion or the Purchase.
Authorization code String
8-character alphanumeric
auth_code
Authorization code provided in the transaction response from the issuing bank.
This is required for Force Post transactions.
ECR number
String
8-character alphanumeric
ecr_number
Electronic cash register number, also referred to as TID or Terminal ID.
MPI transaction values
XID
String
20-character alphanumeric
xid
Can also be used as your order ID when using Moneris Gateway. Fixed length —
must be exactly 20 characters.
MD (Merchant
Data)
String
1024-character alpha- MD
numeric
Information to be echoed back in the response.
Merchant URL
String
Variable length
merchantUrl
URL to which the MPI response is to be sent.
Accept
String
Variable length
accept
MIME types that the browser accepts
User Agent
String
Variable length
userAgent
Browser details
PARes
String
Variable length
(Not shown)
Value passed back to the API during the TXN, and returned to the MPI when an
ACS request is made.
April 2019
Page 401 of 480
Moneris Gateway API - Integration Guide
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
cavv
Cardholder
String
50-character alphaAuthentication Verinumeric
fication Value
Value provided by the Moneris MPI or by a third-party MPI. It is part of a Verified
(CAVV)
by Visa/MasterCard SecureCode/American Express SafeKey transaction.
NOTE: For Apple Pay and Android Pay Cavv Purchase and Cavv Pre-Authorization transactions,
CAVV field contains the decrypted cryptogram.
Vault transaction values
Data key
String
28-character alphanumeric
data_key
Profile identifier that all future financial Vault transactions (that is, they occur after
the profile was registered by a Vault Add Credit Card- ResAddCC, Vault Encrypted
Add Credit Card - EncResAddCC, Vault Tokenize Credit Card - ResTokenizeCC,
Vault Add Temporary Token - ResTempAdd or Vault Add Token - ResAddToken
transaction) will use to associate with the saved information.
The data key is generated by Moneris, and is returned to the merchant (via the
Receipt object) when the profile is first registered.
Duration
String
3-character numeric
duration
Amount of time the temporary token should be available, up to 900 seconds.
Page 402 of 480
April 2019
Appendix A Definitions of Request Fields
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
Data key format1
String
2-character alphanumeric
data_key_format;
This field will specify the data key format being returned. If left blank, Data Key
format will default to 25-character alphanumeric.
Valid values:
no value sent or 0 = 25-character alpha-numeric Data Key
By using the following values, a unique token is generated specifically for the PAN
that is presented for tokenization. Any subsequent tokenization requests for the
same PAN will result in the same token
0U = 25-character alpha-numeric Data Key, Unique
Mag Swipe transaction values
POS code
String
20-character numeric
pos_code
Under normal presentment situations, the value is 00.
If a Pre-Authorization transaction was card-present and keyed-in, then the
POS code for the corresponding Completion transaction is 71.
In an unmanned kiosk environment where the card is present, the value is 27.
If the solution is not “merchant and cardholder present”, contact Moneris for the
proper POS code.
Track2 data
String
40-character
alphanumeric
track2
Retrieved from the mag stripe of a credit card by swiping it through a card reader,
or the "fund guarantee" value returned by the INTERAC® Online Payment system.
Encrypted track2
data
String
Variable length
enc_track2
String that is retrieved by swiping or keying in a credit card number through a
Moneris-provided encrypted mag swipe card reader. It is part of an encrypted
keyed or swiped transaction only. This string must be retrieved by a specific
device. (See below for the list of current available devices.)
1Available to Canadian integrations only.
April 2019
Page 403 of 480
Moneris Gateway API - Integration Guide
Table 107: Request fields (continued)
Type
Limits
Sample code variable definition
Value
Description
Device type
String
30-character alphanumeric
device_type
Type of encrypted mag swipe reader that was read the credit card. This must be a
Moneris-provided device so that the values are properly encrypted and
decrypted.
This field is case-sensitive. Available values are:
"idtech_bdk"
Page 404 of 480
April 2019
Appendix A Definitions of Request Fields
Note that the values listed in Appendix A are not supported by every transaction. Check the transaction
definition. If it says that a value is optional, a further description is found here.
Table 108: Optional transaction values
Type
Limits
Sample code variable definition
Value
Description
General transaction values
Customer ID
String
30-character alphanumeric
cust_id
This can be used for policy number, membership number, student ID, invoice number and so on.
This field is searchable from the Moneris Merchant Resource Center.
Status Check
String
true/false
status_check
20-character alphanumeric
dynamic_descriptor
See .
Dynamic
descriptor
String
Combined with merchant's business name cannot exceed 25 characters.
Merchant-defined description sent on a per-transaction basis that will appear on the
credit card statement appended to the merchant’s business name.
April 2019
Page 405 of 480
Moneris Gateway API - Integration Guide
Table 108: Optional transaction values (continued)
Type
Limits
Sample code variable definition
Value
Description
Wallet
indicator1
String
3-character alphanumeric
wallet_indicator
Optional value to indicate when the credit card details were collected from a wallet
such as Apple Pay, Android Pay, Visa Checkout, MasterCard MasterPass.
This field is applicable to Apple Pay and Android Pay transactions whereby the merchant is using their own API to decrypt the payload. This is a mandatory field for
these types of Apple Pay and Android Pay transactions.
l
l
Apple Pay and Android Pay wallet indicator is applicable to Cavv Purchase –
Apple Pay and Cavv Pre-Authorization – Apple Pay
Visa Checkout and MasterCard MasterPass wallet indicator is applicable to
basic Purchase and Pre-Authorization
Possible values are:
l
l
l
l
l
APP = Apple Pay In-App
APW = Apple Pay on the Web
ANP = Android Pay In-App
VCO = Visa Checkout
MMP = MasterCard MasterPass
NOTE: Please note that if this field is included to indicate Apple Pay or Android Pay, then Convenience Fee is not supported.
Vault transaction values
Phone number
String
30-character alphanumeric
phone
Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Email address
String
30-character alphanumeric
email
Email address of the customer. Can be sent in when creating or updating a Vault profile.
Additional
notes
String
30-character alphanumeric
note
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.
For information about Customer Information request fields see 14 Customer Information
1Available to Canadian integrations only.
Page 406 of 480
April 2019
Appendix A Definitions of Request Fields
For information about Address Verification Service (AVS) request fields see 9.1 Address Verification Service
For information about Card Validation Digits (CVD) request fields see
For information about Recurring Billing request fields see Appendix A Recurring Billing.
For information about Convenience Fee request fields see Appendix A Convenience Fee.
For information about Level 2/3 Visa, Level 2/3 MasterCard and Level 2/3 American Express, see A.3 Definition of Request Fields for Level 2/3 - Visa, A.5 Definition of Request Fields for Level 2/3 - Amex
April 2019
Page 407 of 480
Moneris Gateway API - Integration Guide
A.1 Definitions of Request Fields – Credential on File
Variable Name
Issuer ID
Type
String
NOTE: This variable is
required for all merchant-intiated transactions following the
first one; upon sending
the first transaction,
the Issuer ID value is
received in the transaction response and
then used in subsequent transaction
requests.
Payment Indicator
Limits
Description
15-character alphanumeric
Unique identifier for the cardholder's
stored credentials
Variable length
Sent back in the response from the
card brand when processing a Credential on File transaction
If the cardholder's credentials are
being stored for the first time, you
must save the Issuer ID on your system to use in subsequent Credential
on File transactions (applies to merchant-initiated transactions only)
String
1-character alphabetic
Indicates the intended or current use
of the credentials
Possible values for first transactions:
C - unscheduled credential on file (first transaction only)
R - recurring
Possible values for subsequent transactions:
R - recurring
U - unscheduled merchant-initiated transaction
Z - unscheduled cardholder-initiated transaction
Payment Information
String
1-character numeric
Describes whether the transaction is
the first or subsequent in the series
Possible values are:
0 - first transaction in a series (storing payment details provided by the cardholder)
2 - subsequent transactions (using previously
stored payment details)
Page 408 of 480
April 2019
Appendix A Definitions of Request Fields
A.2 Definition of Request Fields – Recurring
Recurring Billing Info Object Request Fields
Variable and Field Name
Type and Limits
Number of Recurs
String
num_recurs
numeric, 1-99
Period
String
period
numeric, 1-999
Start Date
String
start_date
YYYY/MM/DD
Description
The number of times that the
transaction must recur
Number of recur units that
must pass between recurring
billings
Date of the first future recurring
billing transaction
This value must be a date in the
future
If an additional charge is to be
made immediately, the value of
Start Now must be set to true
Start Now
String
start_now
true/false
If a single charge is to be made
against the card immediately,
set this value to true; the
amount to be billed immediately may differ from the
amount billed on a regular
basis thereafter
If the billing is to start in the
future, set this value to false
When set to false, use Card Verification prior to sending the
Purchase with Recur and Credential on File objects
Recurring Amount
String
recur_amount
10-character decimal, minimum
three digits
Up to 7 digits (dollars) + decimal
point (.) + 2 digits (cents) after
the decimal point
April 2019
Amount of the recurring transaction
This is the amount that will be
billed on the Start Date and
then billed repeatedly based on
the interval defined by Period
and Recur Unit
Page 409 of 480
Moneris Gateway API - Integration Guide
Variable and Field Name
Type and Limits
Description
EXAMPLE: 1234567.89
Recur Unit
String
recur_unit
day, week, month or eom
Unit to be used as a basis for
the interval
Works in conjunction with
Period to define the billing frequency
Possible values are:
day
week
month
eom (end of month)
A.3 Definition of Request Fields for Level 2/3 - Visa
Table 1 Visa - Corporate Card Common Data - Level 2 Request Fields
Req*
Y
Field Name
National Tax
Limits
12-character decimal
Set Method
'national_
tax'=>$national_
tax
Description
Must reflect the
amount of
National Tax
(GST or HST)
appearing on
the invoice.
Minimum - 0.01
Maximum 999999.99.
Must have 2
decimal places.
Y
Merchant
VAT Registration/Single
Business Reference
Number
Page 410 of 480
20-character alphanumeric
'merchant_vat_
no'=>$merchant_
vat_no
Merchant’s Tax
Registration
Number
must be
provided if tax is
included on the
invoice
April 2019
Appendix A Definitions of Request Fields
Req*
Field Name
Limits
Set Method
Description
NOTE: Must
not be all
spaces or all
zeroes
C
Local Tax
12-character decimal
'local_
tax'=>$local_tax
Must reflect the
amount of Local
Tax (PST or QST)
appearing on
the invoice
If Local Tax
included then
must not be all
spaces or all zeroes; Must be
provided if Local
Tax (PST or QST)
applies
Minimum = 0.01
Maximum =
999999.99
Must have 2
decimal places
C
Local Tax (PST or QST)
Registration Number
15-character alphanumeric
'local_tax_
no'=>$local_tax_no
Merchant's
Local Tax
(PST/QST) Registration Number
Must be
provided if tax is
included on the
invoice; If Local
Tax included
then must not
be all spaces or
all zeroes
Must be
provided if Local
Tax (PST or QST)
applies
April 2019
Page 411 of 480
Moneris Gateway API - Integration Guide
Req*
Field Name
Limits
Set Method
Description
C
Customer
VAT Registration Number
13-character alphanumeric
'customer_vat_
no'=>$customer_
vat_no
If the Customer’s Tax
Registration
Number
appears on the
invoice to support tax exempt
transactions it
must be
provided here
C
Customer Code/Customer Reference Identifier (CRI)
16-character alphanumeric
'cri'=>$cri
Value which the
customer may
choose to
provide to the
supplier at the
point of sale –
must be
provided if
given by the customer
N
Customer Code
17-character alphanumeric
'customer_
code'=>$customer_
code
Optional customer code field
that will not be
passed along to
Visa, but will be
included on
Moneris reporting
N
Invoice Number
17-character alphanumeric
'invoice_
number'=>$invoice_
number
Optional invoice
number field
that will not be
passed along to
Visa, but will be
included on
Moneris reporting
*Y = Required, N = Optional, C = Conditional
Table 2 Visa - Corporate Card Common Data- Level 2 Request Fields (VSPurcha)
Req
C*
Variable Name
Buyer Name
Page 412 of 480
Field Name
buyer_name
Size/Type
30-character alphanumeric
Description
Buyer/Receipient
Name
April 2019
Appendix A Definitions of Request Fields
Req
Variable Name
Field Name
Size/Type
Description
*only required by
CRA if transaction is
>$150
C*
Local tax rate
local_tax_rate
4-character decimal
Indicates the
detailed tax rate
applied in relationship to a local
tax amount
EXAMPLE: 8% PST
should be 8.0.
maximum 99.99
*Must be provided
if Local Tax (PST or
QST) applies.
N
Duty Amount
duty_amount
9-character decimal
Duty on total purchase amount
A minus sign
means 'amount is a
credit', plus sign or
no sign means
'amount is a debit'
maximum without
sign is 999999.99
N
Invoice Discount
Treatment
discount_treatment
1-character numeric
Indicates how the
merchant is managing discounts
Must be one of the
following values:
0 - if no invoice level
discounts apply for this
invoice
1 - if Tax was calculated on Post-Discount totals
2 - if Tax was calculated on Pre-Discount
totals
April 2019
Page 413 of 480
Moneris Gateway API - Integration Guide
Req
Variable Name
N
Invoice Level Discount Amount
Field Name
discount_amt
Size/Type
9-character decimal
Description
Amount of discount (if provided
at the invoice level
according to the
Invoice Discount
Treatment)
Must be non-zero if
Invoice Discount
Treatment is 1 or 2
Minimum amount
is 0.00 and maximum is 999999.99
C*
Ship To Postal
Code / Zip Code
ship_to_pos_code
10-character alphanumeric
The postal code or
zip code for the destination where
goods will be
delivered
*Required if shipment is involved
Full alpha postal
code - Valid
ANASource Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.4 Linearized : No Page Count : 480 Page Mode : UseOutlines Page Layout : SinglePage Language : en-us Producer : madbuild Create Date : 2019:04:08 13:37:36-04:00 Modify Date : 2019:04:08 13:37:36-04:00 Title : My Document Author : michael.pukin Subject :EXIF Metadata provided by EXIF.tools