Skip to main content
POST
/
v1
/
customers
Create a customer
curl --request POST \
  --url https://api.hit-pay.com/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "name": "<string>",
  "phone_number_country_code": "<string>",
  "remark": "<string>",
  "birth_date": "2023-12-25",
  "gender": "<string>",
  "address": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  }
}
'
{
  "id": "9b2ada28-be3c-47ab-883f-ba72e5d8305d",
  "name": "John Doe",
  "birth_date": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "address": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "gender": "<string>",
  "remark": "<string>",
  "phone_number_country_code": "<string>",
  "created_at": "2024-01-24T16:05:10+08:00",
  "updated_at": "2024-01-24T16:05:10+08:00"
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
email
string<email>
required

The email of the customer

​
phone_number
string
required

The phone number of the customer

​
name
string

The name of the customer

Example:

"John Doe"

​
phone_number_country_code
string

The country code of the phone number

​
remark
string

The remark of the customer

Maximum string length: 255
​
birth_date
string<date>

The birth date of the customer

​
gender
string

The gender of the customer

​
address
object

Response

201 - application/json

201

​
id
string
required
​
name
string
required
​
birth_date
string
required
​
email
string
required
​
phone_number
string
required
​
address
object
required
​
gender
string
required
​
remark
string
required
​
phone_number_country_code
string
required
​
created_at
string
required
​
updated_at
string
required