Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
3D Secure

Retrieve Authentication

Retrieve an authentication by its authentication Id

get/three-d-secure/authentications/{authentication-id}

Response

The authentication corresponding to the provided authentication-id

threeDSecureAuthenticationIdstring required

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

cardLookupIdstring nullable

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

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

orderIdstring nullable

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.

threeDSecureMessageType'AUTHENTICATION_RESPONSE_MESSAGE' | 'AUTHENTICATION_REQUEST_MESSAGE' | 'PREPARATION_RESPONSE_MESSAGE' | 'PREPARATION_REQUEST_MESSAGE' | 'CHALLENGE_RESPONSE_MESSAGE' | 'CHALLENGE_REQUEST_MESSAGE' | 'RESULTS_REQUEST_MESSAGE' | 'RESULTS_RESPONSE_MESSAGE' | 'ERROR_MESSAGE' | 'null' nullable

Indicates the response type in 3DS flow.

threeDSecureTransactionStatus'AUTHENTICATED' | 'AUTHENTICATION_ATTEMPTED' | 'CHALLENGE_AUTHENTICATION_REQUIRED' | 'CHALLENGE_DECOUPLED_AUTHENTICATION_CONFIRMED' | 'TECHNICAL_ISSUE' | 'NOT_AUTHENTICATED' | 'REJECTED' | 'CHALLENGE_PREFERENCE_ACKNOWLEDGED' required

Indicates the Transaction result. For more information about this field, please review https://docs.3dsecure.io/3dsv2/specification_220.html#attr-ARes-transStatus

  • AUTHENTICATED: Authentication/ Account Verification Successful.
  • AUTHENTICATION_ATTEMPTED: Attempts Processing Performed; Not Authenticated/Verified , but a proof of attempted authentication/verification is provided.
  • CHALLENGE_AUTHENTICATION_REQUIRED: Challenge Required; Additional authentication is required using the challengeUrl and challengeData.
  • CHALLENGE_DECOUPLED_AUTHENTICATION_CONFIRMED: Challenge Required; Decoupled Authentication confirmed.
  • TECHNICAL_ISSUE: Authentication/ Account Verification Could Not Be Performed; Technical or other problem.
  • NOT_AUTHENTICATED: Not Authenticated /Account Not Verified; Transaction denied.
  • REJECTED: Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.
  • CHALLENGE_PREFERENCE_ACKNOWLEDGED: Informational Only; 3DS Requestor challenge preference acknowledged.
threeDSecureTransactionStatusReasonstring nullable

Provides information on why the Transaction Status field has the specified value.

ecommerceIndicator'MAIL_TELEPHONE_ORDER_SINGLE' | 'MAIL_TELEPHONE_ORDER_RECURRING' | 'MAIL_TELEPHONE_ORDER_INSTALMENT' | 'MAIL_TELEPHONE_ORDER_UNKNOWN' | 'AUTHENTICATED_ECOMMERCE' | 'NON_AUTHENTICATED_ECOMMERCE' | 'SSL_MERCHANT' required

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 the issuer. When returned in the response, it can be different from the value sent in the request in case transaction was downgraded by the issuer.

threeDSecureChallengeUrlstring uri nullable

If the transStatus is “C” this field will be populated with the URL to POST the challengeData to create the cardholder challenge screen

threeDSecureChallengeDatastring nullable

String that must be POSTed to the Challenge URL to create challenge screen

threeDSecureAuthenticationValuestring nullable

CAVV: Cardholder Authentication Verification Value Provided during a payment request to authenticate the card user.

threeDSecureChallengeCompletionIndicator'YES' | 'NO' | 'null' nullable

Indicates if Challenge was completed. This is returned in CAVV Lookup Request.

threeDSecureServerTransactionIdstring uuid nullable

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 Request transaction.

threeDSecureDirectoryServerTransactionIdstring uuid nullable

Universally unique transaction identifier assigned by the 3DS Directory Server (DS) to identify a single transaction.

threeDSecureAccessControlServerTransactionIdstring uuid nullable

Required if sending a version 3-D Secure 2.0+ transaction. Data is obtained from a Cavv Lookup Request or MPI 3DS Authentication Request transaction

threeDSecureCardholderInformationstring nullable

Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction. The Issuer can provide information to Cardholder.

threeDSecureVersionstring required

Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1.

threeDSecureAuthenticationType'STATIC' | 'DYNAMIC' | 'OUT_OF_BAND' | 'DECOUPLED' | 'null' nullable

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 the RReq message.

threeDSecureAuthenticationTimestampstring date-time nullable

Date and time in UTC of the cardholder authentication.

Example response

{
  "threeDSecureAuthenticationId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "cardLookupId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "orderId": "1q2w3e4r5t6t78",
  "threeDSecureMessageType": "CHALLENGE_RESPONSE_MESSAGE",
  "threeDSecureTransactionStatusReason": "01 - Card authentication failed",
  "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE",
  "threeDSecureChallengeUrl": "https://developer.moneris.com/",
  "threeDSecureAuthenticationValue": "00000109260000719349",
  "threeDSecureServerTransactionId": "ad9b0eda-bf9b-4288-b188-9467993603e1",
  "threeDSecureDirectoryServerTransactionId": "ad9b0eda-bf9b-4288-b188-9467993603e1",
  "threeDSecureAccessControlServerTransactionId": "ad9b0eda-bf9b-4288-b188-9467993603e1",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantId": "0123456789101",
    "cardholderInformation": {
      "cardholderName": "John Doe",
      "companyName": "SP Ltd"
    },
    "contactDetails": {
      "phoneNumber": "+18663197450",
      "email": "moneris@moneris.com"
    },
    "billingAddress": {
      "unitNumber": "123A",
      "streetNumber": "3300",
      "streetName": "Bloor Street West",
      "city": "Toronto",
      "province": "ON",
      "postalCode": "M8X 2X2",
      "country": "CA"
    },
    "paymentMethodInformation": {
      "paymentMethodSource": "TEMPORARY_TOKEN",
      "cardInformation": {
        "bankIdentificationNumber": "123456",
        "lastFour": "1234",
        "expiryMonth": 1,
        "expiryYear": 2023,
        "cardBrand": "MASTERCARD",
        "cardType": "CREDIT",
        "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw",
        "issuer": "RBC"
      },
      "paymentAccountReference": "11112222333344445555666677778"
    },
    "createdAt": "2019-07-30T06:43:40.252Z",
    "modifiedAt": "2019-07-30T06:43:40.252Z"
  },
  "threeDSecureCardholderInformation": "Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.",
  "threeDSecureVersion": "2.2",
  "threeDSecureAuthenticationType": "DYNAMIC",
  "threeDSecureAuthenticationTimestamp": "2019-07-30T06:43:40.252Z"
}