GuidesAPI ReferenceChangelog
Log In
API Reference
  1. Moneris API
  2. 3D Secure

Create Authentication

post
https://api.sb.moneris.io/three-d-secure/authentications

This operation is used to create an Authentication request.
The authentication request is used to start the validation process of the card.
The result of this request determines whether 3DS is supported by the card and what type of authentication is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Use the 3DS Authentication request to start the validation process of the card and cardholder identity. This request supports all 3DS authentication methods, including 3DS Requestor Initiated (3RI) and Decoupled Authentication. The fields device_channel and message_category control the type of 3DS request made. To perform a standard 3DS Authentication with a cardholder browser experience, send device_channel = 02 for BRW. The result of this request determines whether the card supports 3DS features and, if supported, whether the transaction uses a frictionless or challenge flow. To perform a 3DS Requestor Initiated Authentication without a cardholder browser experience, send device_channel = 03 for 3RI. Any fields related to the browser’s challenge prompt are no longer required, but other conditional fields for 3RI become mandatory.

string
required
length between 1 and 36

A Unique Identifier that is required for handling idempotent requests.

Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."

string | null
^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.

string | null
^[a-zA-Z0-9-_]+$

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

amount
object
required

Monetary amount.
Note: The value must be in cents. Therefore $10.59 must be sent as 1059.

string
required
length between 1 and 60

Cardholder name

string
required
length between 1 and 320

Contains the customer's email address.

For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

string
required
length between 3 and 16
^\+[1-9]\d{1,14}$

Phone number.

shippingAddress
object | null

The postal address including street, town/city, province, and postal code.
Optionally an unit number can be provided.

billingAddress
object
required

The postal address including street, town/city, province, and postal code.

paymentMethod

Payment method details

string
enum
required

Identifies the category of the message for a specific use case.

Allowed:
string
enum
required

Indicates the type of channel interface being used to initiate the transaction.

Allowed:
string | null
enum

Type of payment that triggered the verification.

  • CARDHOLDER: Cardholder initiated payment.
  • RECURRING: Recurring payment.
Allowed:
int32 | null
1 to 9999

Indicates the minimum number of days between authorisations.

date | null

Date after which no further authorisations shall be performed. This is a required field for recurring transactions, we suggest setting it at a reasonably high value if you don't have a defined expiry date.

string | null
enum

Indicates the type of 3RI request. This data element provides additional information to the ACS to determine the best approach for handing a 3RI request.

threeDSecurePriorAuthenticationInformation
object | null

Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.

string | null

URL-encoded, fully qualified callback URL that receives the response or error message.

Note: Request with URL that is not URL-encoded will be rejected for security reasons.

Example (URL-encoded): https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123

string | null
enum

Indicates whether 3DS Card Lookup was successfully completed. A successful Card Lookup increases the chances of a frictionless card authentication.

  • SUCCESS: Successfully completed.
  • FAILURE: 3DS Card Lookup attempted, but failed.
  • UNAVAILABLE: Unavailable or not attempted.
Allowed:
string | null
enum
Defaults to NO_PREFERENCE

Indicates whether a browser-based challenge is requested for this transaction. Standard is 'No Preference'

Allowed:
string | null
enum

Relates to the rendering of the challenge within the browser.

  • X_SMALL: 250 x 400
  • SMALL: 390 x 400
  • MEDIUM: 500 x 600
  • LARGE: 600 x 400
  • FULL_SCREEN: Full Screen
Allowed:
string | null
required

IP address the browser is connecting from.

string | null

Exact content of the HTTP user-agent header.
Note, when total length exceeds 2048 characters, truncate the excess portion.

boolean

Indicates whether Java is enabled in the browser

boolean

Indicates whether Javascript is enabled in the browser

int32
required
0 to 999999

Defines the pixel height of the cardholder's screen.

int32
required
0 to 999999

Defines the pixel width of the cardholder's screen.

string | null

Provides the two letter language code according the ISO 639-1 standard.

For a complete list of language codes, visit: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

Headers
string
required
Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

string

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist.
Merchants are to echo back the value with every request that is part of the call flow."

string
required
length between 13 and 13

Thirteen character identification code.

Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
*/*

Updated 3 months ago

Did this page help you?