My Profile_

MCP 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.

This transaction request is the multi-currency pricing (MCP) enabled version of the equivalent financial transaction.

MCP Pre-Authorization transaction object definition

MCPPreAuth mcpPreauth = new MCPPreAuth();

HttpsPostRequest object for MCP Pre-Authorization transaction

HttpsPostRequest mpgReq = new HttpsPostRequest();


Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaMCPPreauth
	public static void main(String[] args)
		String store_id = "store5";
		String api_token = "yesguy";
		java.util.Date createDate = new java.util.Date(); 
		String order_id = "Test"+createDate.getTime();
		String amount = "5.00";
		String pan = "4242424242424242";
		String expdate = "1902";
		String crypt = "7";
		String processing_country_code = "CA";
		boolean status_check = false;

		MCPPreAuth mcpPreauth = new MCPPreAuth();
		//mcpPreauth.setWalletIndicator(""); //Refer documentation for possible values

		//optional - Credential on File details
		CofInfo cof = new CofInfo();
		//MCP Fields
		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setTestMode(true); //false or comment out this line for production transactions

			Receipt receipt = mpgReq.getReceipt();

			System.out.println("CardType = " + receipt.getCardType());
			System.out.println("TransAmount = " + receipt.getTransAmount());
			System.out.println("TxnNumber = " + receipt.getTxnNumber());
			System.out.println("ReceiptId = " + receipt.getReceiptId());
			System.out.println("TransType = " + receipt.getTransType());
			System.out.println("ReferenceNum = " + receipt.getReferenceNum());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("ISO = " + receipt.getISO());
			System.out.println("BankTotals = " + receipt.getBankTotals());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("AuthCode = " + receipt.getAuthCode());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Ticket = " + receipt.getTicket());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());
			System.out.println("IssuerId = " + receipt.getIssuerId());
			System.out.println("MerchantSettlementAmount = " + receipt.getMerchantSettlementAmount());
			System.out.println("CardholderAmount = " + receipt.getCardholderAmount());
			System.out.println("CardholderCurrencyCode = " + receipt.getCardholderCurrencyCode());
			System.out.println("MCPRate = " + receipt.getMCPRate());
			System.out.println("MCPErrorStatusCode = " + receipt.getMCPErrorStatusCode());
			System.out.println("MCPErrorMessage = " + receipt.getMCPErrorMessage());
			System.out.println("HostId = " + receipt.getHostId());		
		catch (Exception e)

Core connection object fields (all API transactions)

Variable Name Type and Limits Set Method Description
store ID



mpgReq.setStoreId(store_id); Unique identifier provided by Moneris upon merchant account set up.
API token




Unique alphanumeric string assigned upon merchant account activation

To find your API token, refer to your test or production store’s Admin settings in the Merchant Resource Center, at the following URLs:

MCP Pre-Authorization transaction request fields – Required

Variable Name Type and Limits Set Method Description
order ID


50-character alphanumeric a-Z A-Z 0-9 _ - : . @ spaces

mcpPreauth.setOrderId(order_id); Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

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.
credit card number


max 20-character alphanumeric

mcpPreauth.setPan(pan); 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


4-character alphanumeric YYMM

mcpPreauth.setExpDate(expiry_date); Note: This is the reverse of the date displayed on the physical card, which is MMYY.
electronic commerce indicator


1-character alphanumeric

mcpPreauth.setCryptType(crypt); 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)
6: Non-authenticated e-commerce transaction (VBV)
7: SSL-enabled merchant

MCP-specific request fields – Required

Variable Name Type and Limits Set Method Description
MCP version number


current version is 1.0

mcpPreauth.setMCPVersion("MCP_VERSION_NUM"); Release version number for MCP
cardholder amount


12-character numeric

smallest discrete unit of foreign currency

mcpPreauth.setCardholderAmount("CARDHOLDER_AMOUNT"); Amount, in units of foreign currency, the cardholder will be charged on the transaction
cardholder currency code


3-character numeric

mcpPreauth.setCardholderCurrencyCode("CARDHOLDER_CURRENCY_CODE"); ISO code representing the foreign currency of the cardholder

MCP Pre-Authorization transaction request fields – Optional

Variable Name Type and Limits Set Method Description
customer ID


30-character alphanumeric


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 Centre

dynamic descriptor


max 20-character alphanumeric

total of 22 characters including your merchant name and separator


Merchant defined description sent on a per-transaction basis that will appear on the credit card statement. Dependent on the card Issuer, the statement will typically show the dynamic desciptor appended to the merchant's existing business name separated by the "/" character. Please note that the combined length of the merchant's business name, forward slash "/" character, and the dynamic descriptor may not exceed 22 characters.


Existing Business Name: ABC Painting

Dynamic Descriptor: Booking 12345

Cardholder Statement Displays: ABC Painting/Booking 1

wallet indicator


3-character alphanumeric

mcpPreauth.setWalletIndicator(wallet_indicator); Available to Canada integrations only. This field is applicable to Visa Checkout and MasterCard MasterPass transactions whereby the merchant has integrated directly to the Visa/MC wallet to retrieve the card data and is now submitting it for processing. This is a mandatory field for these Visa Checkout and MasterCard MasterPass transactions.
Field is a case sensitive. Possible value:
  • APP = Apple Pay In-app
  • APW = Apple Pay On the Web
  • ANP = Android Pay Wallet
  • MMP = MasterCard MasterPass
  • VCO = Visa Checkout
Credential on File Info cof

NOTE: This is a nested object within the transaction, and required when storing or using the customer's stored credentials. For information about fields in the Credential on FIle Info object, see Credential on File Info Object and Variables.



mcpPreauth.setCofInfo(cof); If you are doing a vault transaction (using a permanent token) the COF Info object is mandatory.
For Definitions of Request Fields of Credential on File please refer back to Purchase / Preauth with Credential on File section.
AVS Information



mcpPreauth.setAvsInfo(avsCheck); Contains fields applying to the Address Verification Service (AVS) e-fraud tool
CVD Information



mcpPreauth.setCvdInfo(cvdCheck); Contains fields related to the Card Validation Digits e-fraud tool

MCP-specific request fields – Optional

Variable Name Type and Limits Set Method Description
MCP rate token



mcpPreauth.setMCPRateToken("MCP_RATE_TOKEN"); Token representing a temporarily locked-in foreign exchange rate, obtained in the response of the MCP Get Rate transaction and used in subsequent MCP financial transaction requests in order to redeem that rate