Pre-Authorization 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.

Canada: 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.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, 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

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.

Credit card number

String

20-character numeric

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.

expdate

Submit in YYMM format.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:

Issuer ID
NOTE: This variable is required for all merchant-initiated transactions following the first one; upon sending the first transaction, the Issuer ID value is received in the transaction response and then used in subsequent transaction requests (Issuer ID does not apply for Discover or Union Pay).

String

15-character alphanumeric
Variable length

Issuer_id

Unique identifier for the cardholder's stored credentials

Sent back in the response from the card brand when processing a Credential on File transaction

If the cardholder's credentials are being stored for the first time, and the issuer id was returned in the response, you must save the Issuer ID on your system to use in MIT subsequent Credential on File transactions

The IssuerID must be saved to your systems when returned from Moneris Gateway in the response data, regardless if the value was received or not. As a best practice, if the IssuerID is not returned and you received N/A instead, store it and send it in the subsequent transaction.

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:

Describes whether the transaction is the first or subsequent in the series
Possible values are:
0 - first transaction in a series (storing payment details provided by the cardholder)
2 - subsequent transactions (using previously stored payment details)

Supplementary Pre-Authorization

Supplementary Pre-Authorization is a Pre-Authorization transaction with an optional Customer ID field included.

Supplementary Pre-Authorization 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.

Canada: 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.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, 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

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.

Credit card number

String

20-character numeric

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.

expdate

Submit in YYMM format.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:

This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.

Issuer ID
NOTE: This variable is required for all merchant-initiated transactions following the first one; upon sending the first transaction, the Issuer ID value is received in the transaction response and then used in subsequent transaction requests (Issuer ID does not apply for Discover or Union Pay).

String

15-character alphanumeric
Variable length

Issuer_id

Unique identifier for the cardholder's stored credentials

Sent back in the response from the card brand when processing a Credential on File transaction

If the cardholder's credentials are being stored for the first time, and the issuer id was returned in the response, you must save the Issuer ID on your system to use in MIT subsequent Credential on File transactions

The IssuerID must be saved to your systems when returned from Moneris Gateway in the response data, regardless if the value was received or not. As a best practice, if the IssuerID is not returned and you received N/A instead, store it and send it in the subsequent transaction.

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:

Describes whether the transaction is the first or subsequent in the series
Possible values are:
0 - first transaction in a series (storing payment details provided by the cardholder)
2 - subsequent transactions (using previously stored payment details)

Pre-Authorization 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 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.

Pre-Authorization with Vault mandatory values

VALUE

TYPE

LIMITS

VARIABLE

DESCRIPTION

Data Key

String

25-character alphanumeric

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

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.

Canada: 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.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, 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

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.

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.
This field is searchable from the Moneris Merchant Resource Centre.

Issuer ID
NOTE: This variable is required for all merchant-initiated transactions following the first one; upon sending the first transaction, the Issuer ID value is received in the transaction response and then used in subsequent transaction requests (Issuer ID does not apply for Discover or Union Pay).

String

15-character alphanumeric
Variable length

Issuer_id

Unique identifier for the cardholder's stored credentials

Sent back in the response from the card brand when processing a Credential on File transaction

If the cardholder's credentials are being stored for the first time, and the issuer id was returned in the response, you must save the Issuer ID on your system to use in MIT subsequent Credential on File transactions

The IssuerID must be saved to your systems when returned from Moneris Gateway in the response data, regardless if the value was received or not. As a best practice, if the IssuerID is not returned and you received N/A instead, store it and send it in the subsequent transaction.

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:

Describes whether the transaction is the first or subsequent in the series
Possible values are:
0 - first transaction in a series (storing payment details provided by the cardholder)
2 - subsequent transactions (using previously stored payment details)

Vault Response Fields

Value

Limits

Variable

Description

Data Key

25-character alphanumeric

DataKey

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

ResSuccess

Indicates whether Vault transaction was successful.

PaymentType

cc/ach

PaymentType

Indicates the payment type associated with a Vault profile.

Customer ID

30-character alphanumeric

cust_id

Returns the customer ID saved in the profile.

Phone Number

30-character alphanumeric

phone

Returns the phone number saved in the profile.

Email Address

30-character alphanumeric

email

Returns the email address saved in the profile.

Note

30-character alphanumeric

note

Returns the note saved in the profile.

Credit Card Fields

Masked PAN

20-character numeric

masked_pan

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

Expiry Date

4-character numeric

expdate

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

E-Commerce Indicator

1-character numeric

crypt_type

Returns the e-commerce indicator saved in the profile.

AVS Street Number

19-character alphanumeric

avs_street_number

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

avs_street_name

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

avs_street_zipcode

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.