Customer Object

A customer object represent the merchant / your business customers which stored in Harsya System for multiple purpose activity. e.g. recurring payments, store payment method of each customers, etc.

Customer Object Example

{
    "uuid": "234f-873g-551A-lgtm",
    "firstName":"John",
    "lastName":"Doe",
    "email": "[e-mail]",
    "phoneNumber":"081234567890",
    "merchantId": "7822-9dfu-2156-lgtm",
    "address": {
        "addressLine1": "addressLine1",
        "addressLine2": "addressLine2",
        "city": "Jakarta Utara",
        "state" : "DKI Jakarta",
        "postalCode": "123456", 
        "country": "ID"   
    },
    "metadata": {
        "foo": "bar"
    }
}

Customer Object Schema

Schema Path	Specs and Validation	Description
uuid	String	Object Unique Identifier
firstName	String Required	First Name of the customer
lastName	String Required Alphanumeric	Last Name of the customer
email	String Required	Email Address of the customer
phoneNumber	String Required Unique	Phone Number of the customer
merchantId	String Required	Merchant Id where the customer first registered
address	Object Optional	Address of residence of the customer
address.addressLine1	String Optional	Address of the customers i.e. Street Name and Number
address.addressLine2	String Optional	Additional address information of the customers. i.e. Building Name, Room Number
address.city	String Optional	City of the customer address
address.state	String Optional	State / Province of the customer address
address.postalCode	String Optional	Postal code of the customer address
address.country	String Optional	Two letter digits country code based on ISO 3166-1 alpha-2 of the customer address
metadata	Object Optional	Contains key-value pairs to store additional information of the customer