v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB

Installments

Installment Plan Lookup

Returns list of installment plans the cardholder is eligible for.

post/installments/plans

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.

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "orderId": "1q2w3e4r5t6t78",
  "amount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  }
}

Response

List of eligible plans.

Example response

{
  "installmentPlans": [
    {
      "planId": "130d93f9-8a5d-a78c-4741-14905057ce01",
      "planIdReference": "0000000063",
      "planName": "Plan6M",
      "planType": "ISSUER_PROMOTION",
      "installmentCount": 6,
      "installmentFrequency": "MONTHLY",
      "planTermsAndConditions": [
        {
          "installmentTermsAndConditionsText": "You are selecting a 6-month installment plan.",
          "installmentTermsAndConditionsUrl": "https://developer.moneris.com/",
          "installmentTermsAndConditionsVersion": "1",
          "installmentTermsAndConditionsLanguageCode": "en"
        }
      ],
      "installmentPromotionId": "02226M1",
      "firstInstallment": {
        "installmentUpFrontFee": {
          "amount": 16000,
          "currency": "CAD"
        },
        "installmentFee": {
          "amount": 16000,
          "currency": "CAD"
        },
        "installmentAmount": {
          "amount": 16000,
          "currency": "CAD"
        }
      },
      "lastInstallment": {
        "installmentFee": {
          "amount": 16000,
          "currency": "CAD"
        },
        "installmentAmount": {
          "amount": 16000,
          "currency": "CAD"
        }
      },
      "annualPercentageRate": 90.5,
      "installmentTotalFee": {
        "amount": 16000,
        "currency": "CAD"
      },
      "totalPlanCost": {
        "amount": 16000,
        "currency": "CAD"
      }
    }
  ],
  "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"
  }
}