My Profile_

Visa Checkout Refund

A Visa Checkout Refund is a Call to Moneris to refund against a Visa Checkout Purchase or Visa Checkout Completion to refund any part, or all of the transaction. It also updates the customer’s Visa Checkout transaction history. If the transaction is still in an open batch please refer to Visa Checkout Purchase Correction. Unlike a Visa Checkout Purchase Correction, after a Visa Checkout Refund there is a record of both the initial charge and the refund on the cardholder's statement.

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaVdotMeRefund
{
	public static void main(String[] args)
	{
		String store_id = "moneris";
		String api_token = "hurgle";
		String order_id = "Test1432134710264";
		String txn_number = "724380-1_10";
		String amount = "1.00";
		String crypt_type = "7";
		String dynamic_descriptor = "inv 123";
		String cust_id = "my customer id";
		String processing_country_code = "CA";
		boolean status_check = false;

		VdotMeRefund vDotMeRefundRequest = new VdotMeRefund();
		vDotMeRefundRequest.setOrderId(order_id);
		vDotMeRefundRequest.setAmount(amount);
		vDotMeRefundRequest.setCustId(cust_id);
		vDotMeRefundRequest.setTxnNumber(txn_number);
		vDotMeRefundRequest.setCryptType(crypt_type);
		vDotMeRefundRequest.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(vDotMeRefundRequest);
		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("StatusCode = " + receipt.getStatusCode());
			System.out.println("StatusMessage = " + receipt.getStatusMessage());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

Visa Checkout Refund transaction values

VdotMeRefund vDotMeRefundRequest = new VdotMeRefund();

HttpsPostRequest mpgReq = new HttpsPostRequest();

Visa Checkout Refund mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric vDotMeRefundRequest.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 10-character decimal vDotMeRefundRequest.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 $9999999.99. Transaction amounts of $0.00 are not allowed.
Transaction Number String 20-character alphanumeric vDotMeRefundRequest.setTxnNumber(txn_number);
 Used when performing follow-on transactions. (That is, Completion, Purchase Correction or Refund.) This must be the value that was returned as the transaction number in the response of the original transaction.

When performing a Completion, this value must reference the Pre-Authorization. When performing a Refund or a Purchase Correction, this value must reference the Completion or the Purchase.
E-commerce Indicator String 1-character alphanumeric vDotMeRefundRequest.setCryptType(crypt_type);

Describes the category of e-commerce transaction being processed. Allowable 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

In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows:


if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6
if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7
if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7
if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7

Visa Checkout Refund optional values

Value Type Limits Set method Description
Customer ID String 50-character alphanumeric vDotMeRefundRequest.setCustId(custid); 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 vDotMeRefundRequest.setDynamicDescriptor ("2134565"); Merchant defined description sent on a per-transaction basis that will appear on the credit card statement appended to the merchant’s business name.
The combined length of the merchant’s business name and dynamic_descriptor may not exceed 25 characters.
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.