Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Surcharge Lookup

Surcharge Lookup

Performs surcharge lookup and determines if payment method is eligible or not and provides max rate and max amount if eligible.

post/surcharge-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."

Example request

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

Response

surcharge eligible response

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

surchargeMessagestring required

Message indicating surcharge eligibility status

maximumSurchargeRatenumber double required

Maximum surcharge rate applicable

Example response

{
  "merchantId": "0123456789101",
  "amount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "maximumSurchargeAmount": {
    "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"
  }
}