Preload Request

post

https://gatewayt.moneris.com/chktv2/request/request.php

The Preload request is the means by which a Moneris Checkout instance is securely generated at transaction time. It involves a server-to-server post using the JSON format documented below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The response to the Preload request returns a ticket number which uniquely identifies the instance and must be passed in the JavaScript request in order to display the Moneris Checkout page in the browser.

Body Params

store_id

string

required

Unique identifier provided by Moneris upon merchant account set up.

api_token

string

required

Unique alphanumeric string assigned upon merchant account activation.

checkout_id

string

required

Identifies your Moneris Checkout configuration; this is given to you when you configure your page in the Merchant Resource Center.

txn_total

string

required

The total dollar amount of the transaction.

environment

string

enum

required

Indicates the stage of development you are sending the request for:

testing = qa

production = prod

Allowed:

action

string

enum

required

Defaults to preload

Type of request being made to Moneris Checkout server; is either preload or receipt request.

Allowed:

order_no

string

The order number is a unique identifier appended to every financial transaction.

50-character alphanumeric with some special characters are not allowed:
< > $ % = ? ^ " { } [ ] \

cust_id

string

Merchant-defined field that can be used as an identifier. Searchable from the Moneris Merchant Resource Center.

50-character alphanumeric with some special characters are not allowed:
< > $ % = ? ^ " { } [ ] \

data_key_format

string

enum

2-character alphanumeric string that specifies the data key format being returned. If left blank, data key format will default to 25-character alphanumeric.

NOTE: If the request uses a format with uniqueness, indicated by suffix [U], any attempt to tokenize a card that is already stored under this merchant account will return the existing token instead of a new token.

Possible values:

0 = 25 character alphanumeric data key.
0U = 0 = unique 25 character alphanumeric data key.
1 = first 6, last 4 from card number.
with random characters between. Preserves card length.
1U = first 6, last 4 from card number with random characters between. Preserves card length. Unique.
2 = first 6, last 4 from card number with random characters between. Does not preserve card length.
2U = first 6, last 4 from card number with random characters between. Does not preserve card length. Unique.
4U = first 6, last 4 from card number. 7th character is random alpha, others between are random. Forces 16 character length. Unique.

Allowed:

dynamic_descriptor

string

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.

20-character alphanumeric total of 22 characters including your merchant name and separator.

NOTE: Some special characters are not allowed:
< > $ % = ? ^ " { } [ ] \

language

string

enum

Determines which language Moneris
Checkout will display information in.

Allowed:

data_key

string

25-character alphanumeric unique identifier for a Vault profile, and used in future Vault financial transactions to associate a transaction with that profile Data key is generated by Moneris and returned to you in the Receipt object when the profile is first registered.

NOTE: Only send this field with Vault Card Update, or else the Preload request will be rejected; this feature is only available when the Preload transaction type sent is a Card Verification.

ask_cvv

string

enum

When set to Y, Moneris Checkout will prompt the cardholder to enter their CVV when they select a payment card that has been stored as a token.

NOTE: This field is only applicable when sending the Token object.

Allowed:

recur

object

Contains fields related to Recurring Billing.

cart

object

The virtual shopping cart and its contents.

contact_details

object

Customer contact information. This object is returned in the Response to Receipt Request as the Customer Information response object (cust_info).

shipping_details

object

Customer shipping information.

billing_details

object

Customer billing information.

token

array of objects

Array object containing between 1 to 3 pairs of a unique data key and an associated issuer ID, each pair representing an instance of a payment card stored in the Moneris Vault; used for Pay By Token transactions.

token

kount_udf

object

Object containing between 1 and 14 pairs of key/values representing Kount User Defined Fields (UDFs). Only available to merchants using Kount Enterprise.

These UDFs are custom attribute key/value pairs passed to Moneris Checkout during the preload. Moneris Checkout will forward UDFs to Kount as part of risk inquiry. If you are intending to pass this additional UDF data to Kount, you must also create appropriate "label" entries in your Kount Agent Web Console (AWC) before passing any values in preload requests. Only pre-configured fields will appear in the portal and be available for review.

Responses

200Successful request processing

400Bad Request