Authentication
Organisations
Balance
Checkout
Payment Methods
Customers
Create Customer
Copy
curl --request POST \
--url https://api.cashful.africa/api/canary/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"orderId": "12345",
"customField": "value"
}
}
'Copy
{
"id": "customer_789",
"merchantId": "merchant_456",
"phoneNumber": "+27821234567",
"email": "john.doe@example.com",
"name": "John Doe",
"metadata": {
"source": "web",
"referralCode": "FRIEND123"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Customers
Create Customer
Creates a new customer and provisions their cash balance feature
POST
/
api
/
canary
/
customers
Create Customer
Copy
curl --request POST \
--url https://api.cashful.africa/api/canary/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"orderId": "12345",
"customField": "value"
}
}
'Copy
{
"id": "customer_789",
"merchantId": "merchant_456",
"phoneNumber": "+27821234567",
"email": "john.doe@example.com",
"name": "John Doe",
"metadata": {
"source": "web",
"referralCode": "FRIEND123"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Customer details
Optional custom metadata
Example:
{
"orderId": "12345",
"customField": "value"
}The ID of the merchant whose balance is being requested. If omitted, defaults to the authenticated merchant.
The phone number of the customer
The email address of the customer
The full name of the customer
Response
Customer created successfully
⌘I