Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Payment Methods

Create Payment Method

Create a Payment Method.

post/payment-methods

Request body

OR
OR
OR
OR
OR
OR

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "card": {
    "cardNumber": "4242424242424242",
    "expiryMonth": 1,
    "expiryYear": 2023,
    "cardSecurityCode": "123"
  },
  "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"
  }
}

Response

Payment method created successfully. Response content contains the created payment method.

paymentMethodIdstring required

Unique Identifier of the payment method.

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

createdAtstring date-time required

Time at which the object was created

modifiedAtstring date-time nullable

Time at which the object was modified

customDataCustomData nullable

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

Example response

{
  "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"
}