Create a customer
Create a customer
Overview
Create a customer
Creates a customer record scoped to your organization for repeat purchases and reporting.
When to use this
Use when you have stable customer identity in your system and want card-on-file, subscriptions, or clean transaction history.
See also
List customers · Update customer
Authentication
Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.
Endpoint
POST /customers
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
No path parameters beyond the URL pattern.
Query parameters
No query parameters.
Headers
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
Lomi-Account | header | No | - | Optional lomi. Network account id (acct_...). When present, the API key acts as the Operator and the request targets the connected Member Account. |
Request body
JSON request payload.
Schema: object
| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | - |
email | No | string | - |
phone_number | No | string | - |
whatsapp_number | No | string | - |
country | No | string | - |
city | No | string | - |
address | No | string | - |
postal_code | No | string | - |
is_business | No | boolean | - |
metadata | No | object | - |
Example body:
{
"name": "Jane Doe"
}Responses
| Status | Description |
|---|---|
201 | Created successfully |
400 | Bad request, invalid or missing parameters |
401 | Invalid or missing API key |
Errors
Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.
Example
curl -sS -X POST "https://sandbox.api.lomi.africa/customers" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Jane Doe"}'OpenAPI
- operationId:
CustomersController_create - Operation:
POST /customers
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.