Customer

The Customer object represents the customer entry. It holds detailed information about the customer of a merchant.

You can get LIVE customer object using LIVE API key and SANDBOX customer object using SANDBOX API key.

Properties

  • Name

    id

    Type
    string (uuid)(required)
    Description
    The unique id of a customer in UUID format.
    Example

    Example:

  • Name

    firstName

    Type
    string(nullable)
    Description
    First name of the customer.
    Example

    Example:

    "John"
  • Name

    lastName

    Type
    string(nullable)
    Description
    Last name of the customer.
    Example

    Example:

    "Doe"
  • Name

    phone

    Type
    string(nullable)
    Description
    Phone number of the customer
    Pattern

    Pattern:

    ^\+(?:[0-9]){6,14}[0-9]$
    Example

    Example:

    "+12148787878"
  • Name

    email

    Type
    string(required)
    Description
    Email of the customer
    Length Constraints

    Length constraints:

    Min Length: 1
    Example

    Example:

    "j.doe@email.com"
  • Name

    dob

    Type
    string(nullable)
    Description
    Date of birth of the customer
    Example

    Example:

    "1996-05-05T00:00:00.000Z"
  • Name

    createdAt

    Type
    string(required)
    Description
    ISO Datetime of when the customer object was created
    Example

    Example:

    "2023-01-01T00:00:00.000Z"
  • Name

    updatedAt

    Type
    string(nullable)
    Description
    Last time the customer object changed in ISO Datetime format.
    Example

    Example:

    "2023-01-01T00:00:00.000Z"