Moneris 3D Secure API
Perform 3D Secure authentications against payment methods
Moneris 3D Secure API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include 3D Secure. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 4 paths, and defines 99 schemas. It is described by OpenAPI 3.2.0, at version 2.6.1.
Requests are made against 2 base URLs: https://api.sb.moneris.io, https://api.moneris.io.
4 operations
4 paths
99 schemas
1 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Moneris 3D Secure API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-Api-Key (ApiKeyAuth).
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 14 scopes.
ApiKeyAuth— An API key is a token that a client provides when making API calls. API keys are supposed to be a secret that only the client and server know about.OAuth2— OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server. OAuth relies on authentication scenarios, that all…
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
3D Secure 4
Perform 3D Secure authentications against payment methods
POST
/three-d-secure/authentications
Create Authentication
GET
/three-d-secure/authentications/{authentication-id}
Retrieve Authentication
POST
/three-d-secure/authentications/{authentication-id}/lookup
Authentication Value Lookup
POST
/three-d-secure/card-lookups
3DS Card Lookup
Schemas 99
The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are authenticationRequest (28 properties), threeDSecureAuthentication (20 properties), paymentMethod (9 properties), cardInformation (8 properties). Each schema is shown below with its type and property counts.
expiryYear
integer
Displays the card expiration year. Accepted format: YYYY
paymentMethodCard
Credit/Debit/Gift Card payment method details.
2 required
cardholderName
string
Cardholder name
paymentMethodPermanentToken
A Permanent Token is issued by Moneris to the merchant and represents the card details. This option is used for legacy purposes.
2 required
companyName
stringnull
Identifies the associated company name
threeDSecureAuthenticationValue
stringnull
CAVV: Cardholder Authentication Verification Value Provided during a payment request to authenticate the card user.
cardLookupRequest
object
The cardlookup request verifies the applicability of 3DS on the card and returns the 3DS version supported by the card. It also returns the 3DS Method URL and…
4 properties
3 required
cardSecurityCode
string
CVD value located on credit card. The CVD value (supplied by the cardholder) must only be passed to the payment gateway. Under no circumstances may it be store…
browserJavascriptEnabled
boolean
Indicates whether Javascript is enabled in the browser
email
string
Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322
cardBrand
stringnull
Displays the card brand name associated with the card type.
authenticationRequest
object
Use the 3DS Authentication request to start the validation process of the card and cardholder identity. This request supports all 3DS authentication methods, i…
28 properties
11 required
threeDSecureChallengeRequested
stringnull
Indicates whether a browser-based challenge is requested for this transaction. Standard is 'No Preference'
threeDSecureAuthentication
object
20 properties
6 required
money
object
Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
2 properties
2 required
paymentMethod
object
Payment method response object
9 properties
4 required
card
object
Card details
4 properties
4 required
threeDSecureRecurringExpiry
stringnull
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…
threeDSecureChallengeUrl
stringnull
If the transStatus is “C” this field will be populated with the URL to POST the challengeData to create the cardholder challenge screen
resourceId
string
Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.
token
string
Created when a temporary token is created and returned. This acts as a unique profile identifier, and is a required value for temporary token transactions.
browserJavaEnabled
boolean
Indicates whether Java is enabled in the browser
paymentMethodRequest
Payment method details
1 required
cardLookup
object
8 properties
7 required
ecommerceIndicator
string
The ecommerce indicator (ECI) specifies the level of security that was used to obtain the cardholder's payment data. It is sent by the merchant and returned by…
threeDSecureRecurringFrequency
integernull
Indicates the minimum number of days between authorisations.
cardInformation
object
Information about the card being used for the transaction
8 properties
googlePayDecryptedWallet
Google Pay wallet details after decrypting the token.
1 required
walletCryptogram
string
Token cryptogram or encoded Base64 for Interac Wallets.
paymentAccountReference
stringnull
Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism.
threeDSecureChallengeCompletionIndicator
stringnull
Indicates if Challenge was completed. This is returned in CAVV Lookup Request.
parameterError
object
Request property or header related error.
4 properties
2 required
createdAt
string
Time at which the object was created
threeDSecurePriorAuthenticationData
stringnull
Data that documents and supports a specific authentication process. In the current version of the specification this data element is not defined in detail, how…
walletEcommerceIndicator
stringnull
ECI Indicator as provided by the Wallet.
error
object
Error response details.
7 properties
1 required
googlePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
paymentMethodRequestSource
string
The source of Payment Method being used. It can be: - The Id of a Payment Method already created. - Permanent Token. - Temporary Token. - Card. - E-Wallet.
streetNumber
string
Street number
threeDSecureAuthenticationTimestamp
stringnull
Date and time in UTC of the cardholder authentication.
threeDSecureCardholderInformation
stringnull
Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction. The Issuer can provide information to Cardholder.
threeDSecureNotificationUrl
string
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 secu…
paymentMethodId
string
Unique Identifier of the payment method.
postalCode
string
Postal or zip code
threeDSecureChallengeData
stringnull
String that must be POSTed to the Challenge URL to create challenge screen
paymentMethodWithId
object
Use existing unique payment method identifier.
2 properties
2 required
lookupRequest
object
The point of the 3-D Secure flow is to verify that the true cardholder is a part of the authorization. The challenge flow is used to present a way of authentic…
2 properties
2 required
threeDSecurePriorAuthenticationReference
stringnull
This data element provides additional information to the ACS to determine the best approach for handing a request.
storePaymentMethod
string
Store this payment method created through this payment for future use. - DONOTSTORE: Payment method will not be stored. - CARDHOLDERINITIATED: Payment method t…
cardNumber
string
Identifies the customer's credit or debit card number (Primary Account Number).
city
string
Identifies the city.
threeDSecureMethodUrl
string
Returns the URL for the Device Fingerprinting step.
threeDSecureChallengeResponseData
string
Provides the response data from the challenge.
threeDSecureChallengeWindowSize
stringnull
Relates to the rendering of the challenge within the browser. - XSMALL: 250 x 400 - SMALL: 390 x 400 - MEDIUM: 500 x 600 - LARGE: 600 x 400 - FULLSCREEN: Full…
streetName
string
Street name
browserUserAgent
stringnull
Exact content of the HTTP user-agent header. Note, when total length exceeds 2048 characters, truncate the excess portion.
googlePayDecryptedCardDetails
object
The payment credential itself. The format of this object is determined by the paymentMethod
6 properties
3 required
cardFingerprint
stringnull
Unique card identifier. Fingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple…
threeDSecurePriorAuthenticationMethod
stringnull
Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.
threeDSecureMethodData
string
Data that must be posted to 3DS Method URL for the Device Fingerprinting step.
threeDSecureMessageCategory
string
Identifies the category of the message for a specific use case.
cardholderInformation
objectnull
Information about the holder of the card.
2 properties
1 required
dataType
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions and is mandatory for INTERAC® e-Commerce Ap…
walletIndicator
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions.…
idempotencyKey
string
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."
paymentMethodRequestBase
object
Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API.
5 properties
1 required
threeDSecureAuthenticationType
stringnull
Indicates the type of authentication method the Issuer will use to challenge the Cardholder, whether in the ARes message or what was used by the ACS when in th…
threeDSecureDeviceChannel
string
Indicates the type of channel interface being used to initiate the transaction.
province
string
Province or state ISO 3166-2 code
country
string
Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO3…
paymentMethodTemporaryToken
A Temporary Token is issued by Moneris to the merchant and represents the card details. Please review the Hosted Tokenization feature documentation to learn ho…
2 required
apiVersion
string
The endpoint's API Version. Must be provided through headers.
expiryMonth
integer
Card expiration month. Format must be MM
threeDSecureCompletionIndicator
stringnull
Indicates whether 3DS Card Lookup was successfully completed. A successful Card Lookup increases the chances of a frictionless card authentication. - SUCCESS:…
applePayDecryptedWallet
Apple Pay wallet details after decrypting the token.
1 required
threeDSecureMessageType
stringnull
Indicates the response type in 3DS flow.
threeDSecureRequestorInitiatedIndicator
stringnull
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.
threeDSecurePriorAuthenticationTimestamp
stringnull
Date and time in UTC of the prior cardholder authentication.
currency
string
Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO4217
threeDSecureTransactionStatusReason
stringnull
Provides information on why the Transaction Status field has the specified value.
applePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
threeDSecurePriorAuthenticationInformation
objectnull
Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
4 properties
modifiedAt
stringnull
Time at which the object was modified
threeDSecureServerTransactionId
string
Indicates information required when sending a version 3-D Secure 2.0+ transaction. This data is obtained from a CAVV Lookup Request or MPI 3DS Authentication R…
customData
objectnull
Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
deviceManufacturerIdentifier
stringnull
Hex-encoded device manufacturer identifier
orderId
stringnull
Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transacti…
browserScreenWidth
integer
Defines the pixel width of the cardholder's screen.
threeDSecureAuthenticationBillingAddress
object
The postal address including street, town/city, province, and postal code.
7 properties
6 required
phoneNumber
string
Phone number.
threeDSecureVersion
string
Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1.
contactDetails
objectnull
Contact details
2 properties
cardPaymentMethodInformation
object
Details about the card used in the payment method.
5 properties
4 required
threeDSecureRequestType
stringnull
Type of payment that triggered the verification. - CARDHOLDER: Cardholder initiated payment. - RECURRING: Recurring payment.
issuer
stringnull
Card issuer.
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
browserScreenHeight
integer
Defines the pixel height of the cardholder's screen.
threeDSecureTransactionStatus
string
Indicates the Transaction result. For more information about this field, please review https://docs.3dsecure.io/3dsv2/specification220.htmlattr-ARes-transStatu…
amount
integer
Amount
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Moneris 12
Other APIs Moneris publishes across the network.
Moneris Customers API
Moneris Disputes API
Moneris Installments API
Moneris Kount API
Moneris Merchant Onboarding API
Moneris Multi-Currency Pricing Rate Lookup API
Moneris Payment Methods API
Moneris Payments API
Moneris Products API
Moneris Refunds API
Moneris Subscriptions API
Moneris Surcharge Lookup API
#3D Secure
Where this information came from
This is an independent, third-party profile of Moneris 3D Secure API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.