Standard Response Fields

To collect the applicable response details, once you send the transaction by invoking the HttpsPostRequest object's send() method you may instantiate the Receipt object, by invoking the HttpsPostRequest object's getReceipt() method. Use this object to retrieve the applicable response details.

This section outlines all of the possible response fields that may be returned. For response details custom to a particular transaction please refer to that transaction example.

Terminal used to process the transaction as well as the shift, batch and sequence number. This data is typically used to reference transactions on the host systems, and must be displayed on any receipt presented to the customer. This information is to be stored by the merchant. Example: 660123450010690030

66012345: Terminal ID

001: Shift number

069: Batch number

003: Transaction number within the batch.

Response Code

3 – character numeric Or null

receipt.getResponseCode();

Transaction Response Code < 50: Transaction approved >= 50: Transaction declined NULL: Transaction was not sent for authorization For further details on the response codes that are returned please see the Response Codes table

ISO Code

2 – character numeric

receipt.getISO();

ISO response code return from issuing institution. For further details on the response codes that are returned please see the Response Codes table

Authorization Code

8 – character alphanumeric

receipt.getAuthCode();

Authorization code returned from the issuing institution.

Transaction Time

##:##:##

receipt.getTransTime();

Processing host time stamp (24 hour clock).

Transaction Date

yyyy-mm-dd

receipt.getTransDate();

Processing host date stamp.

Transaction Type

2 – character numeric

receipt.getTransType();

Type of transaction that was performed:

00 = Purchase, Vault Credit Card Purchase

01 = Preauthorization, Vault Credit Card Pre-Authorization

02 = Pre-Authorization Completion

04 = Refund, Independent Refund, Vault Credit Card &amp

11 = Purchase Correction

Complete

true/false

receipt.getComplete();

Transaction was sent to authorization host and a response was received

Message

100 – character alphanumeric

receipt.getMessage();

Response description returned from issuing institution. This message should not be displayed on any cardholder facing materials. For receipt purposes, please refer to the Receipt Requirements

Gateway Transaction identifier. This field is required for any future follow-on transactions such as Refunds, Corrections, Completions, Reversals, etc.

Timed Out

true/false

receipt.getTimedOut();

Indicates if a transaction failed due to a process timing out.

Bank Totals

Object

receipt.getBankTotals();

Response data returned in a Batch Close and Open Totals request. Refer to Batch Close Response Fields below for further breakdown.

Ticket

receipt.getTicket();

Reserved field.

Other Response Fields

VALUE

LIMITS

GET METHOD

DESCRIPTION

Is Visa Debit

true/false

receipt.getIsVisaDebit();

(Canada only) Indicates whether the card processed is a Visa Debit.

Corporate Card

true/false

receipt.getCorporateCard();

Indicates whether the card or the card on file in the vault is a corporate card.

Batch Close / Open Totals Response Fields

VALUE

LIMITS

VARIABLE

DESCRIPTION

Processed Card Type

String Array

receipt.GetCreditCards(ecr_no);

Returns all of the processed card types in the current batch for the terminal ID/ECR Number from the request.

Terminals IDs

8 – character alphanumeric

receipt.GetTerminalIDs();

Returns the terminal ID/ECR Number from the request.

Purchase Count

4 – character numeric

receipt.GetPurchaseCount(ecr, cardType);

Indicates the # of Purchase,, Pre-Authorization Completion and Force Post transactions processed. If none were processed in the batch, then 0000 will be returned.

Purchase Amount

11 – character alphanumeric

receipt.GetPurchaseAmount(ecr, cardType);

Indicates the dollar amount processed for Purchase,, Pre-Authorization Completion or Force Post transactions. This field begins with a + and is followed by 10 numbers, the first 8 indicate the amount and the last 2 indicate the penny value. Example, +0000000000 = 0.00 and +0000041625 = 416.25

Refund Count

4 – character numeric

receipt.GetRefundCount(ecr, cardType);

Indicates the # of Refund, Independent Refund transactions processed. If none were processed in the batch, then 0000 will be returned.

Refund Amount

11 – character alphanumeric

receipt.GetRefundAmount(ecr, cardType);

Indicates the dollar amount processed for Refund, Independent Refund transactions. This field begins with a + and is followed by 10 numbers, the first 8 indicate the amount and the last 2 indicate the penny value. Example, +0000000000 = 0.00 and +0000041625 = 416.25

Correction Count

4 – character numeric

receipt.GetCorrectionCount(ecr, cardType);

Indicates the # of Purchase Correction transactions processed. If none were processed in the batch, then 0000 will be returned.

Correction Amount

11 – character alphanumeric

receipt.GetCorrectionAmount(ecr, cardType);

Indicates the dollar amount processed for Purchase Correction transactions. This field begins with a + and is followed by 10 numbers, the first 8 indicate the amount and the last 2 indicate the penny value. Example, +0000000000 = 0.00 and +0000041625 = 416.25

CVD and 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.

Status Check Response Fields

Value

Limits

Get Method

Description

Status Code

3-character alphanumeric

receipt.getStatusCode();

The StatusCode is populated when status_check is set to “true” in the request.

<50: Transaction found

>=50: Transaction not found

Status Message

found/not found

receipt.getStatusMessage();

The StatusMsg is populated when status_check is set to “true” in the request.

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

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.

PAN

20-character numeric

receipt.getResPan();

Returns the full 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.

Get Expiring Fields

Expiring card's payment type

cc

receipt.getExpPaymentType();

Indicates the payment type associated with a Vault profile.

Expiring card's Customer ID

30-character alphanumeric

receipt.getExpCustId();

Returns the customer ID saved in the profile.

Expiring card's Phone Number

30-character alphanumeric

receipt.getExpPhone();

Returns the phone number saved in the profile.

Expiring card's Email Address

30-character alphanumeric

receipt.getExpEmail();

Returns the email address saved in the profile.

Expiring card's Note

30-character alphanumeric

receipt.getExpNote();

Returns the note saved in the profile.

Get Expiring Credit Card Fields

Expiring card's Masked PAN

20-character numeric

receipt.getExpMaskedPan();

Returns the first 4 last 4 of the card number saved in the profile.

Expiring card's Expiry Date

4-character numeric

receipt.getExpExpdate();

Returns the expiry date of the card number saved in the profile. YYMM format.

Expiring card's E-Commerce Indicator

1-character numeric

receipt.getExpCryptType();

Returns the e-commerce indicator saved in the profile.

Expiring card's AVS Street Number

19-character alphanumeric

receipt.getExpAvsStreetNumber();

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.

Expiring card's AVS Street Name

19-character alphanumeric

receipt.getExpAvsStreetName();

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.

Expiring card's AVS Zip/Postal Code

9-character alphanumeric

receipt.getExpAvsZipcode();

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.

MCP Response Fields

Variable Name

Type and Limits

Get Method

Description

cardholder amount

12-character numeric

variable length

receipt.getCardholderAmount();

Amount, in
units of foreign
currency, the
cardholder will
pay on the
transaction

cardholder currency code

3-character
numeric

receipt.getCardholderCurrencyCode();

ISO code for
the foreign currency
the cardholder
is using
to pay

host ID

15-character
alphanumeric

receipt.getHostId();

Unique identifier
used
across the
Moneris platform

MCP error message

250-character alphanumeric

variable length

receipt.getMCPErrorMessage();

Message corresponding
with an
MCP error code

MCP error status code

4-character numeric

variable length

receipt.getMCPErrorStatusCode();

A number representing a MCP error code response

MCP rate

9-character
decimal
variable
length

receipt.getMCPRate();

The foreign
exchange rate
(foreign currency
to CAD)
that will beused for the
transaction

If a MCP rate token
was used, it will
reflect the rate
secured by the
MCP Get Rate
transaction; if
no token was
used, the rate
is the current
exchange rate
retrieved by
the Moneris
Gateway

merchant settlement amount

10-character
decimal

Up to 7 digits
(dollars) +
decimal point
(.) + 2 digits
(cents) after
the decimal
point

EXAMPLE:
1234567.89

receipt.getMerchantSettlementAmount();

Amount that
will be paid to
the merchant,
in Canadian
dollars

merchant settlement currency

3-character
numeric

receipt.getMerchantSettlementCurrency();

Currency that
the merchant
is settling in

Response fields specific to MCP Get Rate

MCP rate token

17-character
alphanumeric

receipt.getMCPRateToken();

Time-limited
token representing
a
temporarily
locked in foreign
exchange
rate for use in
financial transactions

Â®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.