My Profile_


Purchase

A Purchase verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.

Canada Code Sample

package Canada;
import JavaAPI.*;

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

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		//purchase.setDynamicDescriptor("2134565");

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}
                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAPurchase
{
	public static void main(String[] args)
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String amount = "5.00";
		String pan = "4242424242424242";
		String expdate = "1602";        //YYMM format
		String crypt = "7";
		String commcard_invoice = "INVC090";
		String commcard_tax_amount = "1.00";
		String processing_country_code = "US";
		boolean status_check = false;

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setCommcardInvoice(commcard_invoice);
		purchase.setCommcardTaxAmount(commcard_tax_amount);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("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("CardLevelResult = " + receipt.getCardLevelResult());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}
                

Purchase - Transaction Values

Purchase purchase = new Purchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchase);

Purchase object mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric purchase.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.
Amount String 9-character decimal purchase.setAmount(amount); Transaction amount

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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric purchase.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 String 4-character numeric
YYMM format.
purchase.setExpdate(expdate); Submit in YYMM format.
Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric purchase.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction

Purchase optional values

Value Type Limits Set method Decription
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Customer ID String 50-character alphanumeric purchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.

This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric purchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1               
Commercial card invoice String 17-character alphanumeric purchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal purchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();


purchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();


purchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();


purchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Recurring Billing Object Recur recurring_cycle = new Recur(recur_unit, start_now, start_date, num_recurs, period, recur_amount);


purchase.setRecur(recurring_cycle);
Refer below for further breakdown and definition.
Convenience Fee Object ConvFeeInfo convFeeInfo = new ConvFeeInfo();


purchase.setConvFeeInfo(convFeeInfo);
Refer below for further breakdown and definition.


Please note, if the Convenience Fee is set, then Recurring Billing is not supported.

Predecessors
  • None
Successors

Purchase With Customer Information

The Customer Information object is an optional add-on to a number of transactions. 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.

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.

The Customer Information object holds three types of information:

  • Miscellaneous customer information properties
  • Billing/Shipping information
  • Item information

Things to consider:

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

Canada Code Sample

package Canada;
                                                                          
import java.util.*;

import JavaAPI.*;

public class TestCanadaPurchaseCustInfo
{
	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 = "10.00";
		String pan = "4242424242424242";
		String expdate = "1901"; //YYMM format
		String crypt = "7";
		String processing_country_code = "CA";
		boolean status_check = false;

		/********************* Billing/Shipping Variables ****************************/

		String first_name = "Bob";
		String last_name = "Smith";
		String company_name = "ProLine Inc.";
		String address = "623 Bears Ave";
		String city = "Chicago";
		String province = "Illinois";
		String postal_code = "M1M2M1";
		String country = "Canada";
		String phone = "777-999-7777";
		String fax = "777-999-7778";
		String tax1 = "10.00";
		String tax2 = "5.78";
		String tax3 = "4.56";
		String shipping_cost = "10.00";

		/********************* Order Line Item Variables *****************************/

		String[] item_description = new String[] { "Chicago Bears Helmet", "Soldier Field Poster" };
		String[] item_quantity = new String[] { "1", "1" };
		String[] item_product_code = new String[] { "CB3450", "SF998S" };
		String[] item_extended_amount = new String[] { "150.00", "19.79" };


		/*****************************************************************************/
		/*								             */
		/*			Customer Information Option 1			     */
		/*									     */
		/*****************************************************************************/

		/********************** Customer Information Object **************************/

		CustInfo customer = new CustInfo();

		/********************** Set Customer Billing Information **********************/

		customer.setBilling(first_name, last_name, company_name, address, city,
				province, postal_code, country, phone, fax, tax1, tax2,
				tax3, shipping_cost);

		/******************** Set Customer Shipping Information ***********************/

		customer.setShipping(first_name, last_name, company_name, address, city,
				province, postal_code, country, phone, fax, tax1, tax2,
				tax3, shipping_cost);

		/***************************** Order Line Items  ******************************/

		customer.setItem(item_description[0], item_quantity[0],
				item_product_code[0], item_extended_amount[0]);

		customer.setItem(item_description[1], item_quantity[1],
				item_product_code[1], item_extended_amount[1]);


		/*****************************************************************************/
		/*								             */
		/*			Customer Information Option 2			     */
		/*									     */
		/*****************************************************************************/


		/********************** Customer Information Object **************************/

		CustInfo customer2 = new CustInfo();

		/******************************* Billing Hashtable ***************************/


		Hashtable<String, String> b = new Hashtable<String, String>();	//billing hashtable

		b.put("first_name", first_name);
		b.put("last_name", last_name);
		b.put("company_name", company_name);
		b.put("address", address);
		b.put("city", city);
		b.put("province", province);
		b.put("postal_code", postal_code);
		b.put("country", country);
		b.put("phone", phone);
		b.put("fax", fax);
		b.put("tax1", tax1);       //federal tax
		b.put("tax2", tax2);        //prov tax
		b.put("tax3", tax3);        //luxury tax
		b.put("shipping_cost", shipping_cost);   //shipping cost  

		customer2.setBilling(b);

		/****************************** Shipping Hashtable ***************************/

		Hashtable<String, String> s = new Hashtable<String, String>();	//shipping hashtable

		s.put("first_name", first_name);
		s.put("last_name", last_name);
		s.put("company_name", company_name);
		s.put("address", address);
		s.put("city", city);
		s.put("province", province);
		s.put("postal_code", postal_code);
		s.put("country", country);
		s.put("phone", phone);
		s.put("fax", fax);
		s.put("tax1", tax1);       //federal tax
		s.put("tax2", tax2);        //prov tax
		s.put("tax3", tax3);        //luxury tax
		s.put("shipping_cost", shipping_cost);   //shipping cost

		customer2.setShipping(s);

		/************************* Order Line Item1 Hashtable ************************/

		Hashtable<String, String> i1 = new Hashtable<String, String>();		//item hashtable #1

		i1.put("name", item_description[0]);
		i1.put("quantity", item_quantity[0]);
		i1.put("product_code", item_product_code[0]);
		i1.put("extended_amount", item_extended_amount[0]);

		customer2.setItem(i1);

		/************************* Order Line Item2 Hashtable **************************/

		Hashtable<String, String> i2 = new Hashtable<String, String>();		//item hashtable #2

		i2.put("name", "item2's name");
		i2.put("quantity", "7");
		i2.put("product_code", "item2's product code");
		i2.put("extended_amount", "5.01");

		customer2.setItem(i2);

		/*************** Miscellaneous Customer Information Methods *******************/

		customer.setEmail("nick@widget.com");
		customer.setInstructions("Make it fast!");

		/********************** Transactional Request Object **************************/

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setCustInfo(customer);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAPurchaseCustInfo
{
	public static void main(String[] args)
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";
		java.util.Date createDate = new java.util.Date(); 
		String order_id = "Test"+createDate.getTime();
		String amount = "5.00";
		String pan = "4005554444444403";
		String expdate = "1602";        //YYMM format
		String crypt = "7";
		String commcard_invoice = "INVC090";
		String commcard_tax_amount = "1.00";
		String cust_id = "my customer id";
		String processing_country_code = "US";
		boolean status_check = false;

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setCustId(cust_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setCommcardInvoice(commcard_invoice);
		purchase.setCommcardTaxAmount(commcard_tax_amount);

		/********************* Billing/Shipping Variables ****************************/

		String first_name = "Bob";
		String last_name = "Smith";
		String company_name = "ProLine Inc.";
		String address = "623 Bears Ave";
		String city = "Chicago";
		String province = "Illinois";
		String postal_code = "M1M2M1";
		String country = "Canada";
		String phone = "777-999-7777";
		String fax = "777-999-7778";
		String tax1 = "10.00";
		String tax2 = "5.78";
		String tax3 = "4.56";
		String shipping_cost = "10.00";

		/********************* Order Line Item Variables *****************************/

		String[] item_description = new String[] { "Chicago Bears Helmet", "Soldier Field Poster" };
		String[] item_quantity = new String[] { "1", "1" };
		String[] item_product_code = new String[] { "CB3450", "SF998S" };
		String[] item_extended_amount = new String[] { "150.00", "19.79" };

		/********************** Customer Information Object **************************/

		CustInfo customer = new CustInfo();

		/********************** Set Customer Billing Information **********************/

		customer.setBilling(first_name, last_name, company_name, address, city,
				province, postal_code, country, phone, fax, tax1, tax2,
				tax3, shipping_cost);

		/******************** Set Customer Shipping Information ***********************/

		customer.setShipping(first_name, last_name, company_name, address, city,
				province, postal_code, country, phone, fax, tax1, tax2,
				tax3, shipping_cost);

		/***************************** Order Line Items  ******************************/

		customer.setItem(item_description[0], item_quantity[0],
				item_product_code[0], item_extended_amount[0]);

		customer.setItem(item_description[1], item_quantity[1],
				item_product_code[1], item_extended_amount[1]);

		purchase.setCustInfo(customer);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("CardLevelResult = " + receipt.getCardLevelResult());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());

		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Purchase - Transaction Values

Purchase purchase = new Purchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchase);

Purchase object mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric purchase.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.
Amount String 9-character decimal purchase.setAmount(amount); Transaction amount

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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric purchase.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 String 4-character numeri

YYMM format.
purchase.setExpdate(expdate); Submit in YYMM format.

Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric purchase.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction

Purchase optional values

Value Type Limits Set method Decription
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Customer ID String 50-character alphanumeric purchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.

This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric purchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric purchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal purchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();

purchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

purchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

purchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Recurring Billing Object Recur recurring_cycle = new Recur(recur_unit, start_now, start_date, num_recurs, period, recur_amount);

purchase.setRecur(recurring_cycle);
Refer below for further breakdown and definition.
Convenience Fee Object ConvFeeInfo convFeeInfo = new ConvFeeInfo();

purchase.setConvFeeInfo(convFeeInfo);
Refer below for further breakdown and definition.

Please note, if the Convenience Fee is set, then Recurring Billing is not supported.


CustInfo object mandatory properties

Value Type Limits Set method Decription
Email Address String 60-character alphanumeric customer.setEmail("nick@widget.com"); Customer email address.
Instructions String 100-character alphanumeric customer.setInstructions("Rush!"); Instructions or notes.
Billing Information Object Option 1:

customer.setBilling(first_name, last_name, company_name, address, city, province, postal_code, country, phone, fax, tax1, tax2, tax3, shipping_cost);

Option 2:

customer.setBilling(billing_hash);
Billing information is stored as part of the CustInfo object. A maximum of 1 billing object may be set. They can be written to the object in one of two ways:
  • Using set methods
  • Using hash tables.
Refer below for further breakdown and definition.
Shipping Information Object Option 1:

customer.setShipping(first_name, last_name, company_name, address, city, province, postal_code, country, phone, fax, tax1, tax2, tax3, shipping_cost);

Option 2:

customer.setShipping(shipping_hash);
Shipping information is stored as part of the CustInfo object. A maximum of 1 shipping object may be set. They can be written to the object in one of two ways:
  • Using set methods
  • Using hash tables.
Refer below for further breakdown and definition.
Items Array Object Option 1:

customer.setItem(item_description[0], item_quantity[0], item_product_code[0], item_extended_amount[0]);

Option 2:

Customer.setItem(item_hash);
Item information is stored as part of the CustInfo object. Multiple items may be set. They can be written to the object in one of two ways:
  • Using set methods
  • Using hash tables.
Refer below for further breakdown and definition.

Setting Billing & Shipping using Set Methods

The billing information and the shipping information for a given CustInfo object are written by using the customer.setBilling() and customer.setShipping() methods respectively:

customer.setBilling(first_name, last_name, company_name, address, city, province, postal_code, country, phone, fax, tax1, tax2, tax3, shipping_cost);

customer.setShipping(first_name, last_name, company_name, address, city, province, postal_code, country, phone, fax, tax1, tax2, tax3, shipping_cost);

Both of these methods have the same set of mandatory arguments.

Setting Billing & Shipping using Hash Tables

Writing billing or shipping information using hash tables is done as follows:

  1. Instantiate a CustInfo object.
  2. Instantiate a Hashtable 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 hashtable using put methods with the hash table keys in the table below.
  4. Call the CustInfo object's setBilling()/setShipping() method to pass the hashtable 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.

Billing & Shipping mandatory values

Value Type Limits Variable/Hash Table Key Description
First Name String 30-character alphanumeric "first_name" Customer first name
Last Name String 30-character alphanumeric "last_name" Customer last name
Company Name String 50-character alphanumeric "company_name" Customer 's company name
Address String 70-character alphanumeric "address" Customer's address
City String 30-character alphanumeric "city" Customer's city
Province / State String 30-character alphanumeric "province" Customer's province or state
Postal / Zip Code String 30-character alphanumeric "postal_code" Customer's postal or zip code
Country String 30-character alphanumeric "country" Customer's country
Phone Number String 30-character alphanumeric "phone" Customer's phone number
Fax Number String 30-character alphanumeric fax" Customer's fax number
Federal Tax String 10-character alphanumeric "tax1" Federal tax amount. Amount is not used for calculating total amount.
Provincial / State Tax String 10-character alphanumeric "tax2" Provincial or state tax amount. Amount is not used for calculating total amount.
Country / Local / Specialty Tax String 10-character alphanumeric "tax3" County, local or specialty tax amount. Amount is not used for calculating total amount.
Shipping Cost String 10-character alphanumeric "shipping_cost" Shipping cost. Amount is not used for calculating total amount.

Setting Items using Set Methods

All the item information in the table below is written to the CustInfo object in one instruction for a given item. Multiples items may be set. Such as:

customer.setItem(item_description, item_quantity, item_product_code, item_extended_amount);

Setting Items using Hash Tables

Writing item information using hash tables is done as follows:

  1. Instantiate a CustInfo object.
  2. Instantiate a Hashtable 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 hashtable using put methods with the hash table keys in the table below.
  4. Call the CustInfo object's setItem() method to pass the hashtable 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.

Item mandatory values

Value Type Limits Variable/Hash Table Key Description
Item Name String 45-character alphanumeric "name" Item name or description.
Item Quantity String 5-character numeric "quantity" You must send a quantity > 0 or the item will not be added to the item list (i.e. minimum 1, maximum 99999)
Item Product Code String 20-character alphanumeric "product_code" Item product code or SKU.
Item Extended Amount String 9-character decimal "extended_amount" Must contain at least 3 digits and 2 penny values.

0.01-999999.99

Predecessors
  • None
Successors

Purchase with CVD & AVS

The Card Validation Digits (CVD) value refers to the numbers appearing on the back of the credit card rather than the numbers imprinted on the front. It is an optional fraud prevention tool that enables merchants to verify data provided by the cardholder at transaction time. This data is submitted along with the transaction to the issuing bank, which provides a response indicating whether the data is a match.

The response that is received from CVD verification is intended to provide added security and fraud prevention, but the response itself does not affect the completion of a transaction. Upon receiving a response, the choice whether to proceed with a transaction is left entirely to the merchant. The response is not a strict guideline of which transaction will approve or decline.

Address Verification Service (AVS) is an optional fraud-prevention tool offered by issuing banks whereby a cardholder's address is submitted as part of the transaction authorization. The AVS address is then compared to the address kept on file at the issuing bank. AVS checks whether the street number, street name and zip/postal code match. The issuing bank returns an AVS result code indicating whether the data was matched successfully. Regardless of the AVS result code returned, the credit card is authorized or declined by the issuing bank.

The response that is received from AVS verification is intended to provide added security and fraud prevention, but 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. The responses is not a strict guideline of whether a transaction will be approved or declined.

Things to consider:

  • CVD is only supported by Visa, MasterCard and American Express.
  • AVS is only supported by Visa, MasterCard, Discover and American Express.
  • When testing CVD or AVS, you must only use the Visa test card numbers 4242424242424242 or 4005554444444403, and the amounts described in the Simulator eFraud Response Codes Table
  • For a full list of possible AVS & CVD result codes refer to the CVD AVS Result Code table

Security:The CVD value must only be passed to the payment gateway. Under no circumstances may it be stored for subsequent uses or displayed as part of the receipt information.

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaPurchaseEfraud
{
	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 = "10.02";
		String pan = "4242424242424242";
		String expiry_date = "1901"; //YYMM format
		String crypt = "7";
		String processing_country_code = "CA";
		boolean status_check = false;

		AvsInfo avsCheck = new AvsInfo();
		avsCheck.setAvsStreetNumber("212");
		avsCheck.setAvsStreetName("Payton Street");
		avsCheck.setAvsZipCode("M1M1M1");
		avsCheck.setAvsEmail("test@host.com");
		avsCheck.setAvsHostname("hostname");
		avsCheck.setAvsBrowser("Mozilla");
		avsCheck.setAvsShiptoCountry("CAN");
		avsCheck.setAvsShipMethod("G");
		avsCheck.setAvsMerchProdSku("123456");
		avsCheck.setAvsCustIp("192.168.0.1");
		avsCheck.setAvsCustPhone("5556667777");

		CvdInfo cvdCheck = new CvdInfo();
		cvdCheck.setCvdIndicator("1");
		cvdCheck.setCvdValue("099");

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expiry_date);
		purchase.setCryptType(crypt);
		purchase.setAvsInfo(avsCheck);
		purchase.setCvdInfo(cvdCheck);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("Avs Response = " + receipt.getAvsResultCode());
			System.out.println("Cvd Response = " + receipt.getCvdResultCode());
			System.out.println("ITD Response = " + receipt.getITDResponse());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                
USA Code Sample

//NOTE: CVD/AVS mandatory in US

package USA;

import JavaAPI.*;

public class TestUSAPurchaseEfraud
{
	public static void main(String[] args)
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String amount = "5.00";
		String pan = "4242424242424242";
		String expdate = "1902";        //YYMM format
		String cust_id = "my customer id";
		String crypt = "7";
		String commcard_invoice = "INV98798";
		String commcard_tax_amount = "1.00";
		String processing_country_code = "US";
		boolean status_check = false;

		AvsInfo avsCheck = new AvsInfo();
		avsCheck.setAvsStreetNumber("212");
		avsCheck.setAvsStreetName("Payton Street");
		avsCheck.setAvsZipCode("M1M1M1");

		CvdInfo cvdCheck = new CvdInfo();
		cvdCheck.setCvdIndicator("1");
		cvdCheck.setCvdValue("099");

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setCustId(cust_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setCommcardInvoice(commcard_invoice);
		purchase.setCommcardTaxAmount(commcard_tax_amount);
		purchase.setAvsInfo(avsCheck); 
		purchase.setCvdInfo(cvdCheck);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("Avs Response = " + receipt.getAvsResultCode());
			System.out.println("Cvd Response = " + receipt.getCvdResultCode());
			System.out.println("CardLevelResult = " + receipt.getCardLevelResult());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());

		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Purchase - Transaction Values

Purchase purchase = new Purchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchase);

Purchase object mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric purchase.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.
Amount String 9-character decimal purchase.setAmount(amount); Transaction amount.
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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric purchase.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
YYMM format.
String 4-character numeric purchase.setExpdate(expdate); Submit in YYMM format.

Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric purchase.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction

Purchase optional values

Value Type Limits Set method Decription
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Customer ID String 50-character alphanumeric purchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.

This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric purchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric purchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal purchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();

purchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

purchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

purchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Recurring Billing Object Recur recurring_cycle = new Recur(recur_unit, start_now, start_date, num_recurs, period, recur_amount);

purchase.setRecur(recurring_cycle);
Refer below for further breakdown and definition.
Convenience Fee Object ConvFeeInfo convFeeInfo = new ConvFeeInfo();

purchase.setConvFeeInfo(convFeeInfo);
Refer below for further breakdown and definition.
Please note, if the Convenience Fee is set, then Recurring Billing is not supported.
CvdInfo object mandatory values
Value Type Limits Set method Description
CVD indicator String 1-character numeric cvdCheck.setCvdIndicator("1"); CVD presence indicator:
0: CVD value is deliberately bypassed or is not provided by the merchant.
1: CVD value is present.
2: CVD value is on the card, but is illegible.
9: Cardholder states that the card has no CVD imprint.
CVD Value String 4-character numeric cvdCheck.setCvdValue("099"); CVD value located on credit card. The CVD value (supplied by the cardholder) must only be passed to the payment gateway. Under no circumstances may it be stored for subsequent use or displayed as part of the receipt information.


AvsInfo object mandatory values
Value Type Limits Set method Description
AVS street number String 19-character alphanumeric1 avsCheck.setAvsStreetNumber("212"); Cardholder street number.
AVS street name String See AVS street number avsCheck.setAvsStreetName("Payton Street"); Cardholder street name.
AVS zip/postal code String 9-character alphanumeric avsCheck.setAvsZipCode("M1M1M1"); Cardholder zip/postal code

CVD & AVS Response Fields

Value Limits Get Method Description
CVD result code 2-character alphanumeric receipt.getCvdResultCode(); Indicates the CVD validation result. The first byte is the numeric CVD indicator sent in the request; the second byte is the response code. Possible response codes are shown in the CVD Result Code table.
AVS result code 1-character alphanumeric receipt.getAvsResultCode(); Indicates the address verification result. For a full list of possible response codes refer to the AVS Result Code table.

Predecessors
  • None
Successors

Purchase with Recurring Billing

Verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.

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.

In addition to instantiating a transaction object and a connection object (as you would for a normal transaction), you must instantiate a Recur object. This object has a number of mandatory properties that must be set.

Any transaction that supports Recurring Billing has a setRecur method. This is used to write the Recurring Billing information to the transaction object before writing the transaction object to the connection object.

Things to consider:

  • To avoid shifting, do not set the start_date after the 28th if the recur_unit is month. To set the billing date for the last day of the month, set recur_unit to eom.

Canada Code Sample

package Canada;
                                                                           
import java.util.*;

import JavaAPI.*;

public class TestCanadaPurchaseRecur
{
	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 = "10.00";
		String pan = "4242424242424242";
		String expiry_date = "1901"; //YYMM format
		String crypt = "7";

		/************************* Recur Variables **********************************/

		String recur_unit = "month"; //eom = end of month
		String start_now = "true";
		String start_date = "2016/07/28";
		String num_recurs = "12";
		String period = "1";
		String recur_amount = "30.00";
		String processing_country_code = "CA";
		boolean status_check = false;

		/************************* Recur Object Option1 ******************************/

		Recur recurring_cycle = new Recur(recur_unit, start_now, start_date,
				num_recurs, period, recur_amount);

		/************************* Recur Object Option2 ******************************/

		Hashtable<String, String> recur_hash = new Hashtable<String, String>();

		recur_hash.put("recur_unit", recur_unit);
		recur_hash.put("start_now", start_now);
		recur_hash.put("start_date", start_date);
		recur_hash.put("num_recurs", num_recurs);
		recur_hash.put("period", period);
		recur_hash.put("recur_amount", recur_amount);

		/************************ Transactional Object *******************************/

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expiry_date);
		purchase.setCryptType(crypt);

		/******************************* Set Recur ***********************************/

		purchase.setRecur(recurring_cycle);

		/**************************** Https Post Request ***************************/

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		/******************************* Receipt ***********************************/

		try
		{
			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("Recur Success = " + receipt.getRecurSuccess());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
} 

                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAPurchaseRecur
{
	public static void main(String[] args)
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String amount = "5.00";
		String pan = "4242424242424242";
		String expdate = "1902";        //YYMM format
		String crypt = "7";
		String commcard_invoice = "INVC090";
		String commcard_tax_amount = "1.00";
		String processing_country_code = "US";
		boolean status_check = false;

		/************************* Recur Variables **********************************/

		String recur_unit = "month";
		String start_now = "true";
		String start_date = "2016/12/01";
		String num_recurs = "12";
		String period = "1";
		String recur_amount = "30.00";
		String cust_id = "my customer id";

		Recur recurring_cycle = new Recur(recur_unit, start_now, start_date,
				num_recurs, period, recur_amount);

		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setCustId(cust_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setCommcardInvoice(commcard_invoice);
		purchase.setCommcardTaxAmount(commcard_tax_amount);            
		purchase.setRecur(recurring_cycle);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("Recur Success = " + receipt.getRecurSuccess());
			//System.out.println("CardLevelResult = " + receipt.getCardLevelResult());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());

		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Purchase - Transaction Values

Purchase purchase = new Purchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchase);

Purchase object mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric purchase.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.
Amount String 9-character decimal purchase.setAmount(amount); Transaction amount 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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric purchase.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 String 4-character numeric

YYMM format.
purchase.setExpdate(expdate); Submit in YYMM format.

Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1 - character alphanumeric purchase.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction

Purchase optional values

Value Type Limits Set method Decription
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Customer ID String 50-character alphanumeric purchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.

This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric purchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric purchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal purchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();

purchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

purchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

purchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Recurring Billing Object Recur recurring_cycle = new Recur(recur_unit, start_now, start_date, num_recurs, period, recur_amount);

purchase.setRecur(recurring_cycle);
Refer below for further breakdown and definition.
Recurring object mandatory values
Value Type Limits Argument name in example Description
Recur unit String day, week, month or eom recur_unit Unit to be used as a basis for the interval. This can be set as day, week, month or the end of the month.

Works in conjunction with the period argument (see below) to define the billing frequency.
Start Now String true/false start_now IIf 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.
Start Date String YYYY/MM/DD format start_date 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 start_now argument must be set to true.
Number of Recurs String numeric 1-99 num_recurs The number of times that the transaction must recur.
Period String numeric 1-999 period Number of recur units that must pass between recurring billings.
Recurring Amount String 9-character decimal 0.01-9999999.99. recur_amount Amount of the recurring transaction. This must contain at least three digits, two of which are penny values.

This is the amount that will be billed on the start_date, and then billed repeatedlybased on the interval defined by period and recur_unit.

Recurring Billing Response Fields

Value Limits Get Method Description
Recurring billing success true/false receipt.getRecurSuccess(); Indicates whether the recurring billing transaction has been successfully set up for future billing.

Predecessors
  • None
Successors

Purchase with Convenience Fee

The Convenience Fee program allows merchants to apply an additional charge to a customer’s bill (with their consent) for the convenience of being able to pay for goods and services using an alternative payment channel. This applies only when providing a true convenience in the form of a channel outside the merchant's customary face-to-face payment channels.

The convenience fee is a charge in addition to what the consumer is paying for the provided goods/services. This charge appears as a separate line item on the consumer’s statement.

The Convenience Fee program provides several benefits. It may allow you an opportunity to reduce or eliminate credit card processing fees and improve customer satisfaction.

In addition to instantiating a transaction object and a connection object (as you would for a normal transaction), you must instantiate a ConvFeeInfo object. This object has one mandatory value that must be set:

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaConvFeePurchase
{
	public static void main(String args[])
	{
		String store_id = "monca00392";
		String api_token = "qYdISUhHiOdfTr1CLNpN";
		String processing_country_code = "CA";

		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String amount = "10.00";
		String pan = "4242424242424242";
		String expdate = "1911";
		String crypt = "7";
		
		ConvFeeInfo convFeeInfo = new ConvFeeInfo();
		convFeeInfo.setConvenienceFee("1.00");
		
		Purchase purchase = new Purchase();
		purchase.setOrderId(order_id);
		purchase.setAmount(amount);
		purchase.setPan(pan);
		purchase.setExpdate(expdate);
		purchase.setCryptType(crypt);
		purchase.setConvFeeInfo(convFeeInfo);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.send();

		try
		{
			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("CfSuccess = " + receipt.getCfSuccess());
			System.out.println("CfStatus = " + receipt.getCfStatus());
			System.out.println("FeeAmount = " + receipt.getFeeAmount());
			System.out.println("FeeRate = " + receipt.getFeeRate());
			System.out.println("FeeType = " + receipt.getFeeType());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAConvFeePurchase
{
	public static void main(String args[])
	{
		String store_id = "monusqa138";
		String api_token = "qatoken";
		String processing_country_code = "US";

		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String amount = "10.00";
		String pan = "4242424242424242";
		String expiry_date = "1911";
		String crypt = "7";
		String commcard_invoice = "";
		String commcard_tax_amount = "";

		AvsInfo avs = new AvsInfo ("123", "Edgar Street", "M1M1M1");
		CvdInfo cvd = new CvdInfo ("1", "099");

		Purchase purchase = new Purchase (order_id, amount, pan, expiry_date, crypt, commcard_invoice, commcard_tax_amount);

		ConvFeeInfo convFeeInfo = new ConvFeeInfo();
		convFeeInfo.setConvenienceFee("5.00");
		purchase.setConvFeeInfo(convFeeInfo);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchase);
		mpgReq.send();

		try
		{
			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("CfSuccess = " + receipt.getCfSuccess());
			System.out.println("CfStatus = " + receipt.getCfStatus());
			System.out.println("FeeAmount = " + receipt.getFeeAmount());
			System.out.println("FeeRate = " + receipt.getFeeRate());
			System.out.println("FeeType = " + receipt.getFeeType());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Purchase - Transaction Values

Purchase purchase = new Purchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchase);

Purchase object mandatory values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Order ID String 50-character alphanumeric purchase.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.
Amount String 9-character decimal purchase.setAmount(amount); Transaction amount 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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric purchase.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 String 4-character numeric
YYMM format.
purchase.setExpdate(expdate); Submit in YYMM format.
Note : This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric purchase.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction
Convenience Fee Object ConvFeeInfo convFeeInfo = new ConvFeeInfo();

purchase.setConvFeeInfo(convFeeInfo);
Refer below for further breakdown and definition. Please note, if the Convenience Fee is set, then Recurring Billing is not supported.

Purchase optional values

VALUE TYPE LIMITS SET METHOD DECRIPTION
Customer ID String 50-character alphanumeric purchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.

This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric purchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric purchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal purchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();
purchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

purchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

purchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.

Convenience Fee Mandatory Values

Value Type Limits Set method Description
Convenience fee amount String 9-character decimal convFeeInfo.setConvenienceFee("5.00"); Amount customer is being charged as a convenience fee

Convenience Fee Response Fields

Value Limits Get Method Description
Convenience fee success true/false receipt.getCfSuccess(); Indicates whether the Convenience Fee transaction processed successfully.
Convenience fee status 2-character alphanumeric receipt.getCfStatus(); Indicates the status of the merchant and convenience fee transactions. The CfStatus field provides details about the transaction behavior and should be referenced when contacting Moneris Customer Support.

Possible values are:
  • 1 or 1F - Completed 1st purchase transaction
  • 2 or 2F - Completed 2nd purchase transaction
  • 3 - Completed void transaction
  • 4A or 4D - Completed refund transaction
  • 7 or 7F - Completed merchant independent refund transaction
  • 8 or 8F - Completed merchant refund transaction
  • 9 or 9F - Completed 1st void transaction
  • 10 or 10F - Completed 2nd void transaction
  • 11A or 11D - Completed refund transaction
Convenience fee amount 9-character decimal receipt.getFeeAmount(); The expected Convenience Fee amount. This field will return the amount submitted by the merchant for a successful transaction. For an unsuccessful transaction, it will return the expected convenience fee amount.
Convenience fee rate 9-character decimal receipt.getFeeRate(); The convenience fee rate that has been defined on the merchant’s profile. For example:
1.00 - a fixed amount or
10.0 - a percentage amount
Convenience fee type AMT/PCT receipt.getFeeType(); The type of convenience fee that has been defined on the merchant’s profile.
Available options are:
AMT - fixed amount
PCT - percentage

Predecessors
  • None
Successors
  • Purchase Correction ( API )
  • Refund ( API )

Purchase with INTERAC® Online

Please Note: You must be to view this content. Please or sign up.

Purchase with 3-D Secure

The Purchase with 3-D Secure transaction follows a 3-D Secure MPI authentication. After receiving confirmation from the MPI ACS transaction, this Purchase verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.

To perform the 3-D Secure authentication, the Moneris MPI or any 3rd party MPI may be used.

The Moneris MPI accepts requests for Verified by Visa (VbV), MasterCard Secure Code (MCSC) and American Express SafeKey. VBV, MCSC and SafeKey are programs based on the 3-D Secure Protocol to improve the security of online transactions. These programs involve authentication of the cardholder during an online e-commerce transaction. Authentication is based on the issuer’s selected method of authentication.

The following are examples of authentication methods:

  • Risk-based authentication
  • Dynamic passwords
  • Static passwords

Some of the benefits of these programs are reduced risk of fraudulent transactions and protection against chargebacks for certain fraudulent transactions. Enrollment is required to participate in the VbV, Secure Code and SafeKey programs. Merchants must contact the Moneris Sales/Support Helpdesk to enroll into these programs.

This transaction can also be used to process an Apple Pay or Android Pay transaction. This transaction is applicable only if choosing to integrate directly to the Apple and Google wallets (if not using the Moneris Apple Pay or Android Pay SDK). Please refer to the Apple Pay and Android Pay sections for more details on your integration options. Please refer to Apple’s and Google’s developer portal respectively for details on integrating directly to their wallets to retrieve the payload data.


NOTE:Apple Pay and Android Pay is available to Canadian integrations only.

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaCavvPurchase
{
	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 cust_id = "CUS887H67";
		String amount = "10.42";
		String pan = "4242424242424242";
		String expdate = "1901"; //YYMM
		String cavv = "AAABBJg0VhI0VniQEjRWAAAAAAA=";
		String dynamic_descriptor = "123456";
		String processing_country_code = "CA";
		boolean status_check = false;

		CavvPurchase cavvPurchase = new CavvPurchase();
		cavvPurchase.setOrderId(order_id);
		cavvPurchase.setCustId(cust_id);
		cavvPurchase.setAmount(amount);
		cavvPurchase.setPan(pan);
		cavvPurchase.setExpdate(expdate);
		cavvPurchase.setCavv(cavv);
		cavvPurchase.setDynamicDescriptor(dynamic_descriptor);

		HttpsPostRequest mpgReq = new HttpsPostRequest(); 
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(cavvPurchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("CavvResultCode = " + receipt.getCavvResultCode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSACavvPurchase
{
	public static void main(String[] args)
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String cust_id = "B_Urlac_54";
		String amount = "10.42";
		String pan = "4005554444444403";
		String expdate = "1901";        //YYMM format
		String cavv = "AAABBJg0VhI0VniQEjRWAAAAAAA";
		String commcard_invoice = "COINV982";
		String commcard_tax_amount = "1.00";
		String dynamic_descriptor = "my descriptor";
		String processing_country_code = "US";
		boolean status_check = false;

		AvsInfo avsCheck = new AvsInfo();
		avsCheck.setAvsStreetNumber("212");
		avsCheck.setAvsStreetName("Payton Street");
		avsCheck.setAvsZipCode("M1M1M1");

		CvdInfo cvdCheck = new CvdInfo();
		cvdCheck.setCvdIndicator("1");
		cvdCheck.setCvdValue("099");

		CavvPurchase cavvPurchase = new CavvPurchase();
		cavvPurchase.setOrderId(order_id);
		cavvPurchase.setCustId(cust_id);
		cavvPurchase.setAmount(amount);
		cavvPurchase.setPan(pan);
		cavvPurchase.setExpdate(expdate);
		cavvPurchase.setCavv(cavv);
		cavvPurchase.setDynamicDescriptor(dynamic_descriptor);
		cavvPurchase.setCommcardInvoice(commcard_invoice);
		cavvPurchase.setCommcardTaxAmount(commcard_tax_amount);
		cavvPurchase.setAvsInfo(avsCheck);
		cavvPurchase.setCvdInfo(cvdCheck);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(cavvPurchase);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			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("Avs Response = " + receipt.getAvsResultCode());
			System.out.println("Cvd Response = " + receipt.getCvdResultCode());
			//System.out.println("CardLevelResult = " + receipt.getCardLevelResult());
			System.out.println("CavvResultCode = " + receipt.getCavvResultCode());
			//System.out.println("StatusCode = " + receipt.getStatusCode());
			//System.out.println("StatusMessage = " + receipt.getStatusMessage());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Purchase with 3-D Secure - Transaction

CavvPurchase cavvPurchase = new CavvPurchase();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(cavvPurchase);

Purchase object mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric cavvPurchase.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.
Amount String 9-character decimal cavvPurchase.setAmount(amount); Transaction amount 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 $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric cavvPurchase.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 String 4-character numeric
YYMM format.
cavvPurchase.setExpdate(expdate); Submit in YYMM format.
Note: This is the reverse of the date displayed on the physical card, which is MMYY.
Cardholder Authentication Verification Value(CAVV) String 50-character alphanumeric cavvPurchase.setCavv(cavv); Value provided by the Moneris MPI or by a third-party MPI. It is part of a Verified by Visa (VbV), MasterCard SecureCode (MCSC) or American Express SafeKey transaction
For Apple Pay and Android Pay processing please submit the decrypted cryptogram in this field.

Purchase optional values

Value Type Limits Set method Decription
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Customer ID String 50-character alphanumeric cavvPurchase.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric cavvPurchase.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric cavvPurchase.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal cavvPurchase.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
E-Commerce Indicator String 1-character numeric cavvPurchase.setCryptType(crypt_type); Available to Canada integrations only. 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 conditional field.
If the transaction is an Apple Pay or Android Pay transaction then 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 (ex. 05 or 07) from the payload, remove the initial 0 and just send us the 2nd character.
Supported values are:
    • 5 - Authenticated e-commerce transaction (3-D secure)
    • 7 - SSL-enabled merchant
Wallet Indicator String 3-character alphanumeric cavvPurchase.setWalletIndicator(wallet_indicator); Available to Canada integrations only. 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 Apple Pay and Android Pay transactions.
Field is a case sensitive. Possible value:
    • APP = Apple Pay Wallet
    • ANP = Android Pay Wallet

Please note that if this field is included to indicate Apple Pay or Android Pay, then Convenience Fee is not supported.

Customer Information Object CustInfo customer = new CustInfo();

cavvPurchase.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

cavvPurchase.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

cavvPurchase.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Convenience Fee Object ConvFeeInfo convFeeInfo = new ConvFeeInfo();

cavvPurchase.setConvFeeInfo(convFeeInfo);
Refer below for further breakdown and definition.
Please note, if the Convenience Fee is set, then Recurring Billing is not supported.

3-D Secure Response Fields

Value Limits Get Method Description
CAVV result code 1-character alphanumeric receipt.getCavvResultCode(); Indicates the Verified by Visa CAVV result. Possible response codes are shown in the CAVV Result Code table.

Predecessors
  • For VbV, SecureCode or SafeKey transactions:
  • For Apple Pay transactions:
    • Apple Pay in-app integration – please refer to the Apple Developer Portal
    • Android Pay in-app integration - please refer to the Google Developer Portal
Successors

Purchase with Vault

This transaction 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.

The data key may be a temporary one generated using Hosted Tokenization or it may be a permanent one from the Vault.

The Vault feature allows merchants to create long term customer profiles, edit those profiles, and use them to process transactions without having to enter financial information each time.

The only difference between charging a temporary token and charging a standard Vault token is whether the expiry date is sent. With the Vault token, the expiry date is stored along with the card number as part of the Vault profile. Therefore, there is no need to send the expiry date again with each normal Vault transaction.

However, a temporary token transaction may have only stored the card number. Therefore, in this scenario the expiry date must be sent when you charge the card.

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaResPurchaseCC
{
	public static void main(String[] args)
	{
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String store_id = "store5";
		String api_token = "yesguy";
		String data_key = "ot-APGL4zwRERtVQqeTn7ZwFSGJo";
		String amount = "1.00";
		String cust_id = "customer1"; //if sent will be submitted, otherwise cust_id from profile will be used
		String crypt_type = "1";
		String descriptor = "my descriptor";
		String processing_country_code = "CA";
		String expdate = "1512"; //For Temp Token
		boolean status_check = false;

		ResPurchaseCC resPurchaseCC = new ResPurchaseCC();
		resPurchaseCC.setData(data_key);
		resPurchaseCC.setOrderId(order_id);
		resPurchaseCC.setCustId(cust_id);
		resPurchaseCC.setAmount(amount);
		resPurchaseCC.setCryptType(crypt_type);
		//resPurchaseCC.setDynamicDescriptor(descriptor);
		resPurchaseCC.setExpDate(expdate); //Temp Tokens only

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(resPurchaseCC);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ReceiptId = " + receipt.getReceiptId());
			System.out.println("ReferenceNum = " + receipt.getReferenceNum());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("AuthCode = " + receipt.getAuthCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("TransType = " + receipt.getTransType());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TransAmount = " + receipt.getTransAmount());
			System.out.println("CardType = " + receipt.getCardType());
			System.out.println("TxnNumber = " + receipt.getTxnNumber());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("Masked Pan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpdate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}
                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAResPurchaseCC
{
	public static void main(String[] args)
	{
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String store_id = "monusqa002";
		String api_token = "qatoken";
		String data_key = "1P5C4C6bNPGg5xGb4ZFfaOTt8";
		String amount = "1.00";
		String cust_id = "customer1"; //if sent will be submitted, otherwise cust_id from profile will be used
		String crypt_type = "1";
		String descriptor = "my descriptor";
		String processing_country_code = "US";
		String commcard_invoice = "123456789123456789";
		String commcard_tax_amount = "1.00";
		boolean status_check = false;

		ResPurchaseCC resPurchaseCC = new ResPurchaseCC();
		resPurchaseCC.setData(data_key);
		resPurchaseCC.setOrderId(order_id);
		resPurchaseCC.setCustId(cust_id);
		resPurchaseCC.setAmount(amount);
		resPurchaseCC.setCryptType(crypt_type);
		resPurchaseCC.setDynamicDescriptor(descriptor);
		resPurchaseCC.setCommcardInvoice(commcard_invoice);
		resPurchaseCC.setCommcardTaxAmount(commcard_tax_amount);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(resPurchaseCC);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ReceiptId = " + receipt.getReceiptId());
			System.out.println("ReferenceNum = " + receipt.getReferenceNum());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("AuthCode = " + receipt.getAuthCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("TransType = " + receipt.getTransType());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TransAmount = " + receipt.getTransAmount());
			System.out.println("CardType = " + receipt.getCardType());
			System.out.println("TxnNumber = " + receipt.getTxnNumber());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("Masked Pan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpdate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}
                

Purchase with Vault - Transaction Values

ResPurchaseCC resPurchaseCC = new ResPurchaseCC();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(resPurchaseCC);

Purchase with Vault mandatory values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Data Key String 25-character alphanumeric resPurchaseCC.setData(data_key); The data key is the token that points to a previously stored profile. Profile identifier that all future financial Vault transactions (that is, they occur after the profile was registered by a ResAddCC or ResTokenizeCC 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.
Order ID String 50-character alphanumeric resPurchaseCC.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.
Amount String 9-character decimal resPurchaseCC.setAmount(amount); Transaction amount 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 $999999.99. Transaction amounts of $0.00 are not allowed.
E-Commerce indicator String 1-character alphanumeric resPurchaseCC.setCryptType(crypt); Supported values are:
  • 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
  • 8 - Non-secure transaction (web- or email-based)
  • 9 - SET non-authenticated transaction

Purchase with Vault optional values

VALUE TYPE LIMITS SET METHOD DECRIPTION
Status Check Boolean true/false mpgReq.setStatusCheck (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.
  • 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.
Things to consider:
  • The Status Check request should only be used once and immediately (within 2 minutes) after the last transaction that had failed.
  • Do not resend the Status Check request if it has timed out. Additional investigation is required.
Expiry Date String 4-character numeric

YYMM format.
resPurchaseCC.setExpDate(expdate); The optional Expiry Date applies to Hosted Tokenization transactions. If the expiry date was not collected by Hosted Tokenization solution, then it must be set in the Vault transaction request.
Customer ID String 50-character alphanumeric resPurchaseCC.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Dynamic descriptor String 20-character alphanumeric resPurchaseCC.setDynamicDescriptor ("2134565"); 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 descriptor 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.

-Example-

Existing Business Name:  ABC Painting

Dynamic Descriptor:  Booking 12345

Cardholder Statement Displays:  ABC Painting/Booking 1

Commercial card invoice String 17-character alphanumeric resPurchaseCC.setCommcardInvoice (commcard_invoice); Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal resPurchaseCC.setCommcardTaxAmount (commcard_tax_amount); Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
Customer Information Object CustInfo customer = new CustInfo();

resPurchaseCC.setCustInfo(customer);
Refer below for further breakdown and definition.
AVS Information Object AvsInfo avsCheck = new AvsInfo();

resPurchaseCC.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.
CVD Information Object CvdInfo cvdCheck = new CvdInfo();

resPurchaseCC.setCvdInfo(cvdCheck);
Refer below for further breakdown and definition.
Recurring Billing Object Recur recurring_cycle = new Recur(recur_unit, start_now, start_date, num_recurs, period, recur_amount);

resPurchaseCC.setRecur(recurring_cycle);
Refer below for further breakdown and definition.

Vault Response Fields

Value Limits Get Method Description
Data Key 25-character alphanumeric receipt.getDataKey(); This field is created when a profile is created and a token is returned.
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false receipt.getResSuccess(); Indicates whether Vault transaction was successful.
Payment Type cc/ach receipt.getPaymentType(); Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric receipt.getResCustId(); Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric receipt.getResPhone(); Returns the phone number saved in the profile.
Email Address 30-character alphanumeric receipt.getResEmail(); Returns the email address saved in the profile.
Note 30-character alphanumeric receipt.getResNote(); Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric receipt.getResMaskedPan(); Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric receipt.getResExpdate(); Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric receipt.getResCryptType(); Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric receipt.getResAvsStreetNumber(); Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric receipt.getResAvsStreetName(); Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric receipt.getResAvsZipcode(); Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

Predecessors
Successors

Purchase with Vault and Customer Information

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.

The Vault is a complement to the recurring payment 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.

An optional add-on to a number of transactions the Customer Information object. 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.

Canada Code Sample

package Canada;
                                                                            
import java.util.*;

import JavaAPI.*;

public class TestCanadaResPurchaseCCCustInfo
{
	public static void main(String[] args)
	{
		java.util.Date createDate = new java.util.Date();
		String order_id = "Test"+createDate.getTime();
		String store_id = "store1";
		String api_token = "yesguy";
		String data_key = "eLqsADfwqHDxIpJG9vLnELx01";
		String amount = "1.00";
		String cust_id = "customer1"; //if sent will be submitted, otherwise cust_id from profile will be used
		String crypt_type = "1";
		String processing_country_code = "CA";
		boolean status_check = false;

		ResPurchaseCC resPurchaseCC = new ResPurchaseCC();
		resPurchaseCC.setData(data_key);
		resPurchaseCC.setOrderId(order_id);
		resPurchaseCC.setCustId(cust_id);
		resPurchaseCC.setAmount(amount);
		resPurchaseCC.setCryptType(crypt_type);

		//CustInfo Variables
		CustInfo custInfo = new CustInfo();
		custInfo.setEmail("nick@widget.com");
		custInfo.setInstructions("Make it fast!");

		Hashtable<String, String> b = new Hashtable<String, String>();

		b.put("first_name", "Bob");
		b.put("last_name", "Smith");
		b.put("company_name", "Widget Company Inc.");
		b.put("address", "111 Bolts Ave.");
		b.put("city", "Toronto");
		b.put("province", "Ontario");
		b.put("postal_code", "M8T 1T8");
		b.put("country", "Canada");
		b.put("phone", "416-555-5555");
		b.put("fax", "416-555-5555");
		b.put("tax1", "123.45");       //federal tax
		b.put("tax2", "12.34");        //prov tax
		b.put("tax3", "15.45");        //luxury tax
		b.put("shipping_cost", "456.23");   //shipping cost

		custInfo.setBilling(b);

		/* OR you can pass the individual args.
		   custInfo.setBilling(
		   "Bob",                  //first name
		   "Smith",                //last name
		   "Widget Company Inc.",  //company name
		   "111 Bolts Ave.",       //address
		   "Toronto",              //city
		   "Ontario",              //province
		   "M8T 1T8",              //postal code
		   "Canada",               //country
		   "416-555-5555",         //phone
		   "416-555-5555",         //fax
		   "123.45",               //federal tax
		   "12.34",                //prov tax
		   "15.45",                //luxury tax
		   "456.23"                //shipping cost
		   );
		 */