EZezypay

List customers

Changed on

Retrieve a list of customers that belong to the merchant.

get/billing/customers

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/customers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Query parameters

namestring

Customer's name. Max 100 characters.

firstNamestring

Customer's first name. Max 50 characters.

lastNamestring

Customer's last name. Max 50 characters.

companyNamestring

The company name if the company is registered as a customer.

referenceCodestring

The reference code of the customer. A unique identifier from a third-party software integration.

customerNumberstring

Auto-generated unique customer number. This unique identifier is customer facing and used to uniquely identify a customer across merchants.

createdDatestring

The date the customer's record was created.

sortExpressionstring

Apply the expression to sort the customer's list based on the preferred argument. For e.g., enter lastname,ASC to sort the customer list in alphabetical order based on the lastname parameter.

limitinteger

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorinteger

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers

merchantstring required

Merchant ID

Response

200

Example response

{
  "data": [
    {
      "id": "4396988a-d8f4-4d29-a211-8be5ca2b7877",
      "number": "EZY1000374672",
      "referenceCode": "xxx",
      "firstName": "John",
      "lastName": "Doe",
      "email": "John.Doe@gmail.com",
      "companyName": "Ezypay",
      "mobilePhone": "0402141110",
      "gender": "male",
      "createdOn": "2018-08-13T06:21:19.899",
      "address": {
        "address1": "Test address 1",
        "countryCode": "AU"
      }
    }
  ]
}

Changes