Skip to main content
POST
/
v1
/
customers
Create a customer
curl --request POST \
  --url https://api.plexospay.com/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "+2389001234",
  "operator": "CVMOVEL",
  "country": "CV",
  "name": "<string>",
  "email": "<string>",
  "metadata": {}
}
'
{
  "id": "cu_abc123",
  "phone": "+2389001234",
  "operator": "CVMOVEL",
  "country": "CV",
  "name": "<string>",
  "email": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Body

application/json
phone
string
required
Example:

"+2389001234"

operator
enum<string>
required

Mobile money operator

Available options:
CVMOVEL,
UNITEL_TMAIS,
MOCK
country
enum<string>

ISO 3166-1 alpha-2 country code

Available options:
CV,
AO
name
string
email
string
metadata
object

Arbitrary key-value metadata (max 50 keys)

Response

200 - application/json

Customer created

id
string
Example:

"cu_abc123"

phone
string
Example:

"+2389001234"

operator
enum<string>

Mobile money operator

Available options:
CVMOVEL,
UNITEL_TMAIS,
MOCK
country
enum<string>

ISO 3166-1 alpha-2 country code

Available options:
CV,
AO
name
string | null
email
string | null
metadata
object

Arbitrary key-value metadata (max 50 keys)

createdAt
string<date-time>
updatedAt
string<date-time>