Preload Request

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.

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

In your server implementation, use the following Moneris Checkout URLs to post to, depending on the development stage:

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

transaction amount

txn_total

String

10-character decimal

The total dollar amount of the transaction

developmental mode

environment

String

alphabetic

qa or prod

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

testing = qa

production = prod

request type

action

String

alphabetic

preload or receipt

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

Optional Preload Request Variables

Variable Name

Type and Limits

Description

order number

order_no

String

30-character alphanumeric

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

customer ID

cust_id

String

30-character alphanumeric

Merchant-defined field that can be used as an identifier

dynamic descriptor

dynamic_descriptor

String

maximum 20-character alphanumeric

total of 24 characters including the merchant name

Merchant-defined description sent on a per-transaction basis that will appear on the credit card statement appended to the merchant’s business name

language

language

String

2-character alphabetic

Determines which language Moneris Checkout will display information in

Allowable values:

en – English

fr – French

Optional Objects for Preload Requests in Moneris Checkout

Moneris Checkout also allows you to send optional objects in the Preload request that reflect additional information entered by the customer at checkout, enable additional features, or meet transaction processing requirements.

If you have configured Moneris Checkout to handle these additional items, you do not send the corresponding object in the Preload request. Only send these optional objects if you are using your own ecommerce page to collect them separately from Moneris Checkout.

Variable Name

Type and Limits

Description

Recurring Billing

recur

Object

N/A

Contains fields related to Recurring Billing

Shopping Cart

cart

Object

N/A

The virtual shopping cart and its contents

Contact Details

contact_details

Object

N/A

Customer contact information

Shipping Details

shipping_details

Object

N/A

Customer shipping information

Billing Details

billing_details

Object

N/A

Customer billing information

Preload Request with Recurring Billing

Optional object

Include this object in Preload request to indicate the start of a series of Recurring Billing transactions that will be managed by Moneris.

Top level object field

recur

Variable Name

Type and Limits

Description

number of recurs

num_recurs

String

numeric

1-99

The number of times that the transaction must recur

period

period

String

numeric

1-999

Number of recur unit intervals that must pass between recurring billings

recurring amount

recur_amount

String

10-character decimal, minimum three digits

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

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

String

day, week, month or eom

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

String

YYMMDD format

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

String

true or false

Set to true if a charge will be made against the card immediately; otherwise set to false

Preload Request with Shopping Cart

Optional object

The shopping cart object can contain multiple items (each item is represented as its own array within the Shopping Cart object).

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