response
{"response":{
|
Top level response object |
success
"success": |
Denotes whether request was successful (i.e., approved, declined)
Unsuccessful means error or could not process
Possible values: true or false
|
request
"request":{ |
Contains information relating to the Preload request and other information that Moneris Checkout sends to the Moneris Gateway when processing the financial transaction |
transaction total amount
"txn_total": |
The total dollar amount of the transaction |
credit card total
"cc_total": |
Total amount being charged to the credit card |
ticket number
"ticket": |
The unique ticket number that identifies a particular transaction; this returned in the response to the Preload request |
customer ID
"cust_id": |
Merchant-defined field that can be used as an identifier
Searchable from the Moneris Merchant Resource Center
|
dynamic descriptor
"dynamic descriptor": |
Merchant-defined description sent on a per-transaction basis that will appear on the credit card statement appended to the merchant’s business name
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; additional characters will be truncated
NOTE: The 22-character maximum limit must take the "/" into account as one of the characters
|
order number
"order_no": |
The order number is a unique identifier appended to every financial transaction |
electronic commerce indicator
"eci": |
The e-commerce indicator or crypt type that was used to process the transaction
Possible values are:
5 - Authenticated e-commerce transaction (3-D Secure)
6 - Non-authenticated e-commerce transaction (3-D Secure)
7 - SSL-enabled merchant
|
Customer Information
"cust_info":{ |
Customer contact information
The information presented in this response object will reflect one of three scenarios:
If sent in the Preload request, this object will echo the Contact Details object
If Moneris Checkout is set to handle the customer contact information, it will reflect what the customer entered in the web form
If Moneris Checkout was set to not ask for this information, the response object will be empty
|
first name
"first_name": |
Customer first name |
last name
"last_name": |
Customer last name |
phone number
"phone": |
Customer phone number |
email
"email": |
Customer email |
Shipping
"shipping":{ |
Contains customer shipping information
The information presented in this response object will reflect one of three scenarios:
If sent in the Preload request, this object will echo the Shipping Details object
If Moneris Checkout is set to handle the customer shipping information, it will reflect what the customer entered in the web form
If Moneris Checkout was set to not ask for this information, the response object will be empty
|
shipping address line 1
"address_1": |
Customer shipping address |
shipping address line 2
"address_2": |
Customer shipping address |
shipping city
"city": |
Customer shipping address city |
shipping country
"country": |
Customer shipping address country |
shipping province
"province": |
Customer shipping address province |
shipping postal code
"postal_code": |
Customer shipping address postal code |
Billing
"billing":{ |
Contains customer billing information
The information presented in this response object will reflect one of three scenarios:
If sent in the Preload request, this object will echo the Billing Details object
If Moneris Checkout is set to handle the customer billing information, it will reflect what the customer entered in the web form
If Moneris Checkout was set to not ask for this information, the response object will be empty
|
billing address line 1
"address_1": |
Customer billing address |
billing address line 2
"address_2": |
Customer billing address |
billing city
"city": |
Customer billing address city |
billing country
"country": |
Customer billing address country |
billing province
"province": |
Customer billing address province |
billing postal code
"postal_code": |
Customer billing address postal code |
same as shipping
"same_as_shipping": |
Indicates whether the shipping address is the same as the billing address
Possible values: true or false
|
Recurring Billing
"recur":{ |
Contains fields related to Recurring Billing |
number of recurs
"number_of_recurs": |
The number of times that the transaction must recur |
period
"recur_period": |
Number of recur unit intervals that must pass between recurring billings |
recurring amount
"recur_amount": |
Dollar amount of the recurring transaction
This amount will be billed on the start date, and then billed repeatedly based on the interval defined by period and recur unit
|
recur unit
"recur_unit": |
Unit to be used as a basis for the interval
Works in conjunction with the period variable to define the billing frequency
|
start date
"start_date": |
Date of the first future recurring billing transaction; this must be a date in the future
If an additional charge will be made immediately, the start now variable must be set to true
|
bill now
"bill_now": |
Set to true if a charge will be made against the card immediately; otherwise set to false |
Shopping Cart
"cart":{ |
The virtual shopping cart and its contents
This echos the information contained in the Shopping Cart request object
|
shopping cart items
"items":[{ |
Encapsulates the entire array of items in the shopping cart |
item URL
"url": |
URL that corresponds to the image of the Moneris Checkout shopping cart item |
item description
"description": |
Describes the item in the shopping cart |
item product code
"product_code": |
The SKU for the item |
item unit cost
"unit_cost": |
Per-unit cost of the item |
item quantity
"quantity": |
Number of individual instances of the given item in the shopping cart |
subtotal
"subtotal": |
Total dollar amount of the shopping cart, before taxes |
tax
"tax":{ |
Contains information related to taxes charged on the items in the shopping cart |
tax amount
"amount": |
Dollar amount of taxes |
tax description
"description": |
Describes type of tax being applied |
tax rate
"rate": |
Percentage tax rate charged |
Credit Card (request)
"cc":{ |
Contains cardholder information |
first 6 last 4
"first6last4": |
First 6 and last 4 digits of card number |
expiry date
"expiry": |
Card expiry date |
cardholder
"cardholder": |
Cardholder name |
Gift (request)
"gift":[{ |
Object containing information about a gift card |
balance remaining
"balance_remaining": |
The remaining balance on the gift card |
gift card description
"description": |
Description of the gift card used for the transaction |
first 4 last 4
"first4last4": |
The first 4 and last 4 digits of the card |
gift card number
"pan": |
The account number of the gift card |
gift card CVD
"cvd": |
Card validation digits on the gift card |
balance used
"balance_used": |
The amount that was removed from the card's balance as part of the transaction |
Wallet
"wallet": |
Contains information from the digital wallet that was used in the transaction |
wallet type
"type": |
Type of digital wallet used in this transaction |
payment data
"paymentData":{ |
Object containing various information related to the payment sent from the digital wallet |
API version (minor)
"apiVersionMinor": |
Minor version of the API |
API version
"apiVersion": |
Version of the digital wallet's payment API |
payment method data
"paymentMethodData":{ |
Object containing information about the payment method used in the transaction |
payment method description
"description": |
User-facing message to describe the payment method that funds this transaction |
tokenization data
"tokenizationData":{ |
Object containing information related to tokenization and the digital wallet |
tokenization type
"type": |
The type of tokenization to be applied to the selected payment method
Possible values: PAYMENT_GATEWAY or DIRECT
|
token
"token": |
The generated payment method token |
payment method type
"type": |
A short identifier for the supported payment method. Possible value:
CARD
|
info
"info":{ |
Object that echoes information about the cardholder, the card and the card network from the digital wallet |
card network
"cardNetwork": |
The payment card network |
card details
"cardDetails": |
The details about the card; this value is commonly the last four digits of the selected payment account number |
card details
"cardDetails": |
The details about the card; this value is commonly the last four digits of the selected payment account number |
digital wallet billing address
"billingAddress":{ |
Object that echoes the cardholder's billing information from the digital wallet |
address 3
"address3": |
Third line of the address |
sorting code
"sortingCode": |
The sorting code |
address 2
"address2": |
Second line of the address |
country code
"countryCode": |
ISO 3166-1 alpha-2 country code |
address 1
"address1": |
First line of the address |
postal code
"postalCode": |
Address postal code or ZIP |
name
"name": |
Name of the addressee |
locality
"locality": |
City, town, neighbourhood, or suburb |
administrative area
"administrativeArea": |
A country subdivision, such as a state or province |
digital wallet shipping address
"shippingAddress":{ |
Object containing the cardholder's default shipping address information stored in the digital wallet |
address 3
"address3": |
Third line of the address |
sorting code
"sortingCode": |
The sorting code |
address 2
"address2": |
Second line of the address |
country code
"countryCode": |
ISO 3166-1 alpha-2 country code |
postal code
"postalCode": |
Address postal code or ZIP |
name
"name": |
Name of the addressee |
locality
"locality": |
City, town, neighbourhood, or suburb |
administrative area
"administrativeArea": |
A country subdivision, such as a state or province |
Receipt
"receipt":{ |
Object containing the receipt information |
result (financial transaction)
"result": |
Indicates the result of the financial transaction
Possible values are:
a = Accepted
d = Declined
|
Gift (receipt)
"gift":[{ |
Contains information related to gift card |
order number
"order_no": |
The order number is a unique identifier appended to every financial transaction |
transaction number
"transaction_no": |
Moneris Gateway-specific transaction identifier
This field is required for any future follow-on transaction requests, such as Refund, Purchase Correction and Pre-Authorization Completion transactions
|
reference number
"reference_no": |
Terminal used to process the transaction, followed by 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 should be stored by the merchant
Example: 660123450010690030
66012345: Terminal ID
001: Shift number
069: Batch number
003: Transaction number within the batch.
|
response code
"response_code": |
Transaction response code
Possible values are:
<50 – transaction approved
>=50 –transaction declined
NULL – transaction was not sent for authorization
For more details on specific response, please see the Response Codes reference topic
|
benefit amount
"benefit_amount": |
This is the benefit that was generated for the transaction; the amount that was removed from the card as part of the transaction |
benefit remaining
"benefit_remaining": |
The remaining balance on the gift card |
first 6 last 4
"first6last4": |
First 6 and last 4 digits of card number |
Credit Card (receipt)
"cc":{ |
Contains fields describing the response to the credit card transaction |
order number
"order_no": |
The order number is a unique identifier appended to every financial transaction |
customer ID
"cust_id": |
Merchant-defined field that can be used as an identifier
Searchable from the Moneris Merchant Resource Center
|
transaction number
"transaction_no": |
Used to reference the original transaction when performing a follow-on transaction (i.e., Pre-Authorization Completion, Purchase Correction or Refund)
This value is returned in the response of the original transaction
Pre-Authorization Completion: references a Pre-Authorization
Refund/Purchase Correction: references a Purchase or Pre-Authorization Completion
|
reference number
"reference_no": |
Terminal used to process the transaction, followed by 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 should be stored by the merchant
Example: 660123450010690030
66012345: Terminal ID
001: Shift number
069: Batch number
003: Transaction number within the batch.
|
transaction code
"transaction_code": |
Type of financial transaction that was performed
Possible values:
00 – Purchase
01 – Pre-Authorization
06 - Card Verification
|
transaction type
"transaction_type": |
ISO transaction code for financial transaction |
transaction date and time
"transaction_date_time": |
Processing host date and time stamp
Format: YYYY-MM-DD HH:MM:SS
|
corporate card
"corporateCard": |
Indicates whether the payment card is a corporate card |
credit card amount
"amount": |
The total dollar amount that was charged to the credit card |
response code
"response_code": |
Transaction response code
Possible values are:
<50 – transaction approved
>=50 –transaction declined
NULL – transaction was not sent for authorization
For more details on specific response, please see the Response Codes reference topic
|
ISO response code
"iso_response_code": |
ISO response code returned from issuing institution
For more details on specific ISO codes returned, see the Response Codes reference topic
|
approval code
"approval_code": |
Authorization code returned from the issuing institution |
card type
"card_type": |
Type of payment card used to process the transaction
Allowable values:
V = Visa
M = Mastercard
AX = American Express
DC = Diner's Card
NO = Novus/Discover
SE = Sears
D = INTERAC® Debit
C1 = JCB
|
wallet type
"wallet_type": |
Type of digital wallet used in this transaction |
dynamic descriptor
"dynamic_descriptor": |
Merchant-defined description sent on a per-transaction basis that will appear on the credit card statement appended to the merchant’s business name
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; additional characters will be truncated
NOTE: The 22-character maximum limit must take the "/" into account as one of the characters
|
invoice number
"invoice_number": |
Identifies an invoice number associated with the transaction |
customer code
"customer_code": |
User-defined identifier |
electronic commerce indicator
"eci": |
The e-commerce indicator or crypt type that was used to process the transaction
Possible values:
5 - Authenticated e-commerce transaction (3D-Secure)
6 - Non-authenticated e-commerce transaction (3D-Secure)
7 - SSL-enabled merchant
|
CVD result code
"cvd_result_code": |
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 Response Codes reference
|
AVS result code
"avs_result_code": |
Indicates the address verification result
For a full list of possible response codes refer to the AVS Response Codes reference
|
"first6last4":
"eci": |
First 6 and last 4 digits of card number |
expiry date
"expiry_date": |
Expiry date of the card
MMYY format
|
recur success
"recur_success": |
Indicates whether the recurring billing transaction has been successfully set up for future billing
Possible values: true or false
|
issuer ID
"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 subsequent Credential on File transactions (applies to merchant-initiated transactions only)
The issuer ID 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 issuer ID is not returned and you received a value of NULL instead, store that value and send it in the subsequent transaction
|
ECR (electronic cash register) number
"ecr_no": |
Terminal ID/ECR Number from the request |
batch number
"batch_no": |
Batch number; also presented as a component of the reference number |
sequence number
"sequence_no": |
Transaction number within the batch; also presented as a component of reference number |
result (financial transaction)
"result": |
Indicates the result of the financial transaction
Possible values are:
a = Accepted
d = Declined
|
Tokenize
"tokenize":{ |
Contains information related to the tokenization of cardholder credentials |
success (tokenize)
"success": |
Indicates whether the card was successfully tokenized
Possible values: true or false
|
first 4 last 4
"first4last4": |
The first 4 and last 4 digits of the card |
data key
"data_key": |
Unique identifier for a Vault profile, and used in future Vault financial transactions to associate a transaction with that profile |
tokenization status
"status": |
Specifies what type of failure, if any, occurred
during the tokenization request
Possible values:
001 = Successful creation of a temporary token
940 = Invalid profile id (on tokenization request)
941 = Error generating token
942 = Invalid Profile ID, or source URL
943 = Card data is invalid (not numeric, fails mod10,
we will remove spaces)
944 = Invalid expiration date (mmyy, must be current
month or in the future)
945 = Invalid CVD data (not 3-4 digits)
|
tokenization message
"message": |
Provides additional details about the success or failure of the tokenization |
Fraud
"fraud":{ |
Contains sub-objects that describe information related to fraud tool inquiries |
CVD
"cvd":{ |
Contains information related to the CVD fraud tool |
decision origin
"decision_origin": |
Possible values: Moneris or Merchant |
CVD result
"result": |
Possible values:
1 = Success
2 = Failed
3 = Not performed
4 = Card not eligible
|
condition
"condition": |
Indicates whether this fraud tool was set as a factor for Moneris to use when making an automatic decision on a transaction
Possible values are as follows:
0 = Optional
1 = Mandatory
|
status
"status": |
Indicates whether the fraud tool inquiry was performed, and if it was used for auto-decisioning purposes
Possible values:
success = Fraud tool successful
failed = Fraud tool failed (non-auto decision)
disabled = Fraud tool not performed
ineligible = Fraud tool was selected but card is not a credit card or card not eligible
failed_optional = Fraud tool failed and auto decision is optional
failed_mandatory = Fraud tool failed auto decision is mandatory
|
CVD code
"code": |
CVD result code; for a list of possible codes see the CVD Response Codes reference |
condition
"details": |
Indicates whether this fraud tool was set as a factor for Moneris to use when making an automatic decision on a transaction
Possible values are as follows:
0 = Optional
1 = Mandatory
|
AVS
"avs":{ |
Contains information related to the AVS fraud tool |
decision origin
"decision_origin": |
Possible values: Moneris or Merchant |
AVS result
"result": |
Possible values:
1 = Success
2 = Failed
3 = Not performed
4 = Card not eligible
|
condition
"condition": |
Indicates whether this fraud tool was set as a factor for Moneris to use when making an automatic decision on a transaction
Possible values are as follows:
0 = Optional
1 = Mandatory
|
status
"status": |
Indicates whether the fraud tool inquiry was performed, and if it was used for auto-decisioning purposes
Possible values:
success = Fraud tool successful
failed = Fraud tool failed (non-auto decision)
disabled = Fraud tool not performed
ineligible = Fraud tool was selected but card is not a credit card or card not eligible
failed_optional = Fraud tool failed and auto decision is optional
failed_mandatory = Fraud tool failed auto decision is mandatory
|
AVS code
"code": |
AVS result code; for a list of potential codes, see the AVS Response Codes reference |
details
"details": |
Provides detailed information about the fraud tool query
Only populated for Kount and 3-D Secure
|
3-D Secure
"3d_secure":{ |
Contains information related to the 3-D Secure fraud tool |
decision origin
"decision_origin": |
Possible values: Moneris or Merchant |
3-D Secure result
"result": |
Possible values:
1 = Success
2 = Failed
3 = Not performed
4 = Card not eligible
|
condition
"condition": |
Indicates whether this fraud tool was set as a factor for Moneris to use when making an automatic decision on a transaction
Possible values are as follows:
0 = Optional
1 = Mandatory
|
status
"status": |
Indicates whether the fraud tool inquiry was performed, and if it was used for auto-decisioning purposes
Possible values:
success = Fraud tool successful
failed = Fraud tool failed (non-auto decision)
disabled = Fraud tool not performed
ineligible = Fraud tool was selected but card is not a credit card or card not eligible
failed_optional = Fraud tool failed and auto decision is optional
failed_mandatory = Fraud tool failed auto decision is mandatory
|
3-D Secure code
"code": |
The crypt type that was used to process the transaction
Possible values are:
5 - Authenticated e-commerce transaction (3-D Secure)
6 - Non-authenticated e-commerce transaction (3-D Secure)
7 - SSL-enabled merchant |
details
"details":{ |
Provides detailed information about the fraud tool query
Only populated for Kount and 3-D Secure
|
Cardholder Authentication Value (CAVV)
"cavv": |
Value provided by the Moneris MPI or by a third-party MPI
Returned by Visa Secure, Mastercard Identity Check or American Express SafeKey transactions
|
3-D Secure message
"message": |
Describes the reasoning for the outcome of the 3-D Secure inquiry
Possible values:
"Authentication Not Available"
"Unable to Verify Enrollment"
"Successful Payer Authentication"
"Cardholder Not Participating"
"failed 3-D Secure authentication"
"Successful Merchant Attempt"
|
VERes
"VERes": |
Verification response code
Possible values:
N = The card/issuer is not enrolled
U = The card type is not participating
Y = The card is enrolled
|
PARes
"PARes": |
Payer Authentication response code. Possible values:
“true” = Fully authenticated or attempted to verify PIN.
“false” = Failed to authenticate
|
load 3-D Secure
"loadvbv": |
Only present with value "true" if page was successfully redirected from the 3-D Secure site. |
Kount
"kount":{ |
Contains information related to the Kount fraud tool |
decision origin
"decision_origin": |
Possible values: Moneris or Merchant |
Kount result
"result": |
Possible values:
001 = Success
973 = Unable to locate merchant Kount details
984 = Data error
987 = Invalid transaction
|
condition
"condition": |
Indicates whether this fraud tool was set as a factor for Moneris to use when making an automatic decision on a transaction
Possible values are as follows:
0 = Optional
1 = Mandatory
|
status
"status": |
Indicates whether the fraud tool inquiry was performed, and if it was used for auto-decisioning purposes
Possible values:
success = Fraud tool successful
failed = Fraud tool failed (non-auto decision)
disabled = Fraud tool not performed
ineligible = Fraud tool was selected but card is not a credit card or card not eligible
failed_optional = Fraud tool failed and auto decision is optional
failed_mandatory = Fraud tool failed auto decision is mandatory
|
Kount code
"code": |
Possible values:
001 = Success
973 = Unable to locate merchant Kount details
984 = Data error
987 = Invalid transaction
|
details
"details":{ |
Provides detailed information about the fraud tool query
Only populated for Kount and 3-D Secure
|
Kount response code
"responseCode": |
Final risk score returned from Kount system |
message (Kount)
"message": |
Brief description message about the Kount inquiry |
receipt ID
"receiptID": |
The order ID echoed from the original financial transaction |
Kount result
"receiptID": |
Possible values are as follows:
1 = Success
2 = Failed
3 = Not performed
4 = Card not eligible
|
Kount score
"score": |
Final risk score returned from Kount system |
Kount error
"error": |
List of errors the Kount request generated |