Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Validations

Create Card Validation

Initiate a new Card Validation request.

post/validations

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.

customerIdstring nullable

Unique Identification for the Customer

customerReferencestring nullable

Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.

dynamicDescriptorstring nullable

Merchant defined description sent on a per-transaction basis that will appear on the credit card statement.

Dependent on the card Issuer, the statement will typically show the dynamic descriptor appended to the merchant's existing business name separated by the '/' character.

Note: The combined length of the merchant's business name, forward slash '/' character, and the dynamic descriptor may not exceed 22 characters.

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

Describes the category of e-commerce transaction being processed.

customDataCustomData nullable

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "orderId": "1q2w3e4r5t6t78",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "credentialOnFileInformation": {
      "paymentIndicator": "CUSTOMER_INITIATED",
      "paymentInformation": "FIRST",
      "issuerId": "123asd"
    }
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "dynamicDescriptor": "moneris",
  "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE"
}

Response

Validation request created successfully.

validationIdstring required

The unique identifier of the Validation

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.

createdAtstring date-time required

Time at which the object was created

modifiedAtstring date-time nullable

Time at which the object was modified

validationStatus'DECLINED' | 'DECLINED_RETRY' | 'PROCESSING' | 'SUCCEEDED' required

Validation Status description.

customerIdstring nullable

Unique Identification for the Customer

customerReferencestring nullable

Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.

customDataCustomData nullable

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Example response

{
  "validationId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "orderId": "1q2w3e4r5t6t78",
  "createdAt": "2019-07-30T06:43:40.252Z",
  "modifiedAt": "2019-07-30T06:43:40.252Z",
  "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"
  },
  "validationStatus": "SUCCEEDED",
  "transactionDetails": {
    "isoResponseCode": "00",
    "responseCode": "001",
    "authorizationCode": "11223344",
    "message": "SUCCESS",
    "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE"
  },
  "verificationDetails": {
    "addressVerificationServiceResultCode": "FULL_MATCH",
    "cardSecurityCodeResultCode": "MATCH"
  },
  "credentialOnFileResponse": {
    "originalAmount": {
      "amount": 15000,
      "currency": "CAD"
    },
    "issuerId": "A"
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212"
}