Independent Refund transaction object mandatory values

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

indrefund.setAmount(amount);

Transaction amount. Used in a number of transactions. Note that this is different
from the amount used in a Completion transaction, which is an alphanumeric value.

This must contain at least 3 digits, two of which are penny values.

The minimum allowable value is $0.01, and the maximum allowable value is 9999999.99. Transaction amounts of $0.00 are not allowed.

Credit card number

String

20-character alphanumeric

indrefund.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 alphanumeric
YYMM format.

indrefund.setExpdate(expdate);

Note: This is the reverse of the date displayed on the physical card, which is MMYY.

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:

Independent Refund transaction object optional values

This can be used for policy number, membership number, student ID, invoice number
and so on.

This field is searchable from the Moneris Merchant Resource Centre.

Dynamic Descriptor

String

20-character alphanumeric

indrefund.setDynamicDescriptor("123456");

Merchant defined description sent on a per-transaction basis that will appear on the credit card statement. Dependent on the card Issuer, the statement will typically show the dynamic desciptor appended to the merchant's existing business name separated by the "/" character. Please note that the combined length of the merchant's business name, forward slash "/" character, and the dynamic descriptor may not exceed 22 characters.-Example-Existing Business Name: ABC PaintingDynamic Descriptor: Booking 12345Cardholder Statement Displays: ABC Painting/Booking 1

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.

Independent Refund with Vault Credit Card

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 an Independent Refund transaction.

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.

ResIndRefundCC transaction object definition

HttpsPostRequest object for ResIndRefundCC transaction

ResIndRefundCC transaction object mandatory values

Value

Type

Limits

Set method

Description

Data key

String

25-character alphanumeric

resIndRefundCC.setData(data_key);

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

resIndRefundCC.setOrderId(order_id); test

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

resIndRefundCC.setAmount(amount);

Transaction amount. Used in a number of transactions. Note that this is different
from the amount used in a Completion transaction, which is an alphanumeric value.

This must contain at least 3 digits, two of which are penny values.

The minimum allowable value is $0.01, and the maximum allowable value is 9999999.99. Transaction amounts of $0.00 are not allowed.

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:

This can be used for policy number, membership number, student ID, invoice number
and so on.

This field is searchable from the Moneris Merchant Resource Centre.

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.

Dynamic Descriptor

String

20-character alphanumeric

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

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

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.

Â®MONERIS and MONERIS & Design are registered trade-marks of Moneris Solutions Corporation. VISA is a registered trade-mark of Visa International. MASTERCARD and MASTERCARD SECURECODE are registered trade-marks of MasterCard International Incorporated. DISCOVER is a registered trade-mark of Discover Financial Services. AMERICAN EXPRESS and AMERICAN EXPRESS SAFEKEY are registered trade-marks of American Express Company. INTERAC is a registered trade-mark of Interac Inc. Apple, the Apple logo, Apple Pay and iPhone are trademarks of Apple Inc., registered in the U.S. and other countries.

â„¢MONERIS BE PAYMENT READY & Design is a trade-mark of Moneris Solutions Corporation. ANDROID is a trademark of Google Inc. MASTERPASS is a trade-mark of MasterCard International Inc.All other marks or registered trade-marks are the property of their respective owners.