Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Customers

Create a Customer

The Create a Customer endpoint allows you to create a new customer record within your organization. This endpoint requires a payload that includes key details about the customer, such as their email and wallet address.

📘 Note

If a customer makes a payment without being pre-registered, the system automatically creates a customer record during the checkout process.

post/v1/customers

Request body

customer_identstring

Unique identifier for a customer.

discordstring

Discord username or identifier associated with a customer, allowing for communication and linkage to Discord-based interactions.

emailstring required

Customer's email address.

namestring

Customer's name.

numberstring

Numeric identifier or contact number associated with the customer.

twitterstring

Twitter handle associated with the customer.

wallet_addressstring

Unique address associated with a customer's wallet.

Response

OK

created_atstring

The timestamp indicating when the customer record was created.

customer_identstring

The unique identifier for the customer.

emailstring

The email address associated with the customer.

guestboolean

Indicates whether the customer is a guest (true) or not (false).

idstring

The unique identifier for the customer.

is_deletedboolean

Indicates whether the customer has been deleted (true) or not (false).

last_payment_datestring

The timestamp indicating the date of the last payment made by the customer.

metadataobject

Additional metadata associated with the customer.

namestring

The name of the customer.

organisation_idstring

The identifier of the organization to which the customer belongs.

payments_countinteger

The total count of payments made by the customer.

phonestring

The phone number associated with the customer.

propertiesobject

Additional custom properties associated with the customer.

updated_atstring

The timestamp indicating when the customer record was last updated.

wallet_addressstring

The wallet address associated with the customer for cryptocurrency transactions.

Example response

{
  "created_at": "2023-03-15T08:30:00Z",
  "customer_ident": "CUST123",
  "email": "example@email.com",
  "id": "123456789",
  "last_payment_date": "2023-03-20T12:00:00Z",
  "name": "John Doe",
  "organisation_id": "ORG123",
  "payments_count": 5,
  "updated_at": "2023-03-25T10:45:00Z",
  "wallet_address": "0x4bbeEB066eD09B7AEd07bF39EEe0460DFa261520"
}