v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB

3D Secure

3DS Card Lookup

post/three-d-secure/card-lookups

Request body

idempotencyKeystring required

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."

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.

threeDSecureNotificationUrlstring required

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

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "orderId": "1q2w3e4r5t6t78",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "threeDSecureNotificationUrl": "https%3A%2F%2Fdeveloper.moneris.com%2F"
}

Response

3D-Secure Card Lookup created successfully

cardLookupIdstring required

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.

threeDSecureServerTransactionIdstring uuid required

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.

threeDSecureVersionstring required

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

threeDSecureMethodUrlstring uri required

Returns the URL for the Device Fingerprinting step.

threeDSecureMethodDatastring required

Data that must be posted to 3DS Method URL for the Device Fingerprinting step.

Example response

{
  "cardLookupId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "orderId": "1q2w3e4r5t6t78",
  "threeDSecureServerTransactionId": "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"
  },
  "threeDSecureVersion": "2.2",
  "threeDSecureMethodUrl": "https://developer.moneris.com/"
}