EZezypay

Update a customer

Changed on

Update an existing customer's personal details.

put/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.

Headers

merchantstring required

Merchant ID

Request body

emailstring required

A valid email address that belongs to the customer. Max of 255 characters.

firstNamestring required

Customer's first name. Max of 50 characters.

lastNamestring required

Customer's last name. Max of 50 characters.

genderstring

Customer gender. Supported values are male or female.

homePhonestring

Customer home phone number. Max of 50 characters.

mobilePhonestring

Customer mobile phone number. Max of 50 characters. Numeric only,country code without "+".

referenceCodestring

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

companyNamestring

The company name if the company is registered as a customer. Max of 100 characters.

dateOfBirthstring

Customer's date of birth. Supported format is YYYY-MM-DD.

Response

200

idstring
numberstring
referenceCodeunknown
firstNamestring
lastNamestring
emailstring
companyNameunknown
mobilePhoneunknown
homePhoneunknown
genderunknown
dateOfBirthstring
createdOnstring
addressunknown

Example response

{
  "id": "55220ffc-bc5a-4f50-adaf-fa58c061ebd1",
  "number": "EZY213000",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "Jane.Doe@gmail.com",
  "dateOfBirth": "1980-12-08",
  "createdOn": "2019-03-10T20:10:54.895",
  "metadata": {
    "foo": "bar"
  }
}

Changes