Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Customers

Create Customer

This operation is used to created a new customer.

post/customers

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

firstNamestring nullable

First name.

middleNamestring nullable

Customer's middle name.

lastNamestring nullable

Last name.

companyNamestring nullable

Identifies the associated company name

phoneNumberstring nullable

Phone number.

emailstring email nullable

Contains the customer's email address.

For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

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",
  "firstName": "John",
  "middleName": "J.",
  "lastName": "Doe",
  "companyName": "SP Ltd",
  "address": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "shippingAddress": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "phoneNumber": "+18663197450",
  "email": "moneris@moneris.com"
}

Response

Customer operation result response

customerIdstring required

Unique Identification for the Customer

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

firstNamestring nullable

First name.

middleNamestring nullable

Customer's middle name.

lastNamestring nullable

Last name.

companyNamestring nullable

Identifies the associated company name

phoneNumberstring nullable

Phone number.

emailstring email nullable

Contains the customer's email address.

For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322

customDataCustomData nullable

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

Example response

{
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "createdAt": "2019-07-30T06:43:40.252Z",
  "modifiedAt": "2019-07-30T06:43:40.252Z",
  "firstName": "John",
  "middleName": "J.",
  "lastName": "Doe",
  "companyName": "SP Ltd",
  "address": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "shippingAddress": {
    "unitNumber": "123A",
    "streetNumber": "3300",
    "streetName": "Bloor Street West",
    "city": "Toronto",
    "province": "ON",
    "postalCode": "M8X 2X2",
    "country": "CA"
  },
  "phoneNumber": "+18663197450",
  "email": "moneris@moneris.com"
}