Customers
Create a customer
Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Customers
Create a customer
This endpoint allows you to create a customer. The customer will be created with the provided details and will be returned in the response.
POST
/
v1
/
customers
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/customers \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"name": "John Doe",
"email": "jsmith@example.com",
"phone_number": "<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
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Body
application/json
Response
201 - application/json
201
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/customers \
--header 'Content-Type: application/json' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--data '{
"name": "John Doe",
"email": "jsmith@example.com",
"phone_number": "<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"
}