Retrieve a customer

Changed on

Retrieve the personal details of a customer.

get/billing/customers/{customerId}

Request

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

Path parameters

customerIdstring required

Auto-generated identifier of the customer. This ID is case-sensitive and integrator should not use transform the details to upper case.

Headers

merchantstring required

Merchant ID

Response

200

idstring
numberstring
referenceCodeunknown
firstNamestring
lastNamestring
emailstring
companyNameunknown
mobilePhoneunknown
homePhoneunknown
genderstring
dateOfBirthstring
createdOnstring

Example response

{
  "id": "031d6fd8-f181-402a-82a3-68056639f3c0",
  "number": "EZY1000670942",
  "firstName": "John",
  "lastName": "Tester",
  "email": "John.Tester@gmail.com",
  "gender": "male",
  "dateOfBirth": "1980-06-13",
  "createdOn": "2019-06-25T02:33:07.264",
  "address": {
    "address1": "13 Testaburger Road",
    "postalCode": "90210",
    "state": "New South Wales",
    "countryCode": "AU",
    "city": "Testville"
  },
  "metadata": {
    "foo": "bar"
  }
}

Changes