v1

latestOpenAPI 3.0.32026-07-248257161.1 KB

Customers

Create a new customer

Create a new customer for a merchant

post/customers

Query parameters

createOrUpdateboolean

Optional. If set to true, customer will be created if it does not exist otherwise updated. If omitted or set to false, an error will be returned if the customer already exist.

Request body

idstring uuid

unique uuid of the customer

namestring

customer's full name

phonestring

customer's mobile phone number.

emailstring

the email of the customer

addressstring

Full street address, which MAY include house number, street name, Post Office Box, etc

citystring

City or locality component.

postalCodestring

Zip code or postal code component.

countrystring required

ISO3166-1 alpha-2 two letter, uppercase.

localestring

User locale, language is lower case. Country in upper case

createdAtstring

The date time that record was created in our system.

updatedAtstring

The date time that record was updated in our system.

Example request

{
  "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
  "name": "John Dao",
  "email": "john.dao@example.com",
  "address": "23, avenue de la liberté",
  "city": "Dakar",
  "country": "SN",
  "locale": "fr-FR",
  "createdAt": "2022-06-20T17:17:11Z",
  "updatedAt": "2022-06-20T17:17:11Z"
}

Response

The customer is added successfully