Authentication
Organisations
Balance
Checkout
Payment Methods
Customers
Create Product
Copy
curl --request POST \
--url https://api.cashful.africa/api/canary/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currency": "<string>",
"metadata": {
"sku": "PROD-001",
"category": "electronics"
}
}
'Copy
{
"id": "product_001",
"merchantId": "merchant_456",
"name": "Airtime",
"description": "Mobile phone airtime",
"amount": 5000,
"currency": "ZAR",
"active": true,
"imageId": "file_abc123xyz",
"imageUrl": "https://my-bucket.s3.af-south-1.amazonaws.com/merchant_123/1736951234567-a1b2c3-airtime.png",
"metadata": {
"category": "telecom",
"provider": "vodacom"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Products
Create Product
Defines a product in the merchant’s catalog
POST
/
api
/
canary
/
products
Create Product
Copy
curl --request POST \
--url https://api.cashful.africa/api/canary/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currency": "<string>",
"metadata": {
"sku": "PROD-001",
"category": "electronics"
}
}
'Copy
{
"id": "product_001",
"merchantId": "merchant_456",
"name": "Airtime",
"description": "Mobile phone airtime",
"amount": 5000,
"currency": "ZAR",
"active": true,
"imageId": "file_abc123xyz",
"imageUrl": "https://my-bucket.s3.af-south-1.amazonaws.com/merchant_123/1736951234567-a1b2c3-airtime.png",
"metadata": {
"category": "telecom",
"provider": "vodacom"
},
"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
Product details
The name of the product
The three-letter ISO 4217 currency code
Optional custom metadata
Example:
{
"sku": "PROD-001",
"category": "electronics"
}The ID of the merchant whose balance is being requested. If omitted, defaults to the authenticated merchant.
A description of the product
The price of the product in the smallest currency unit
Whether the product is active
The ID of the product image file
Response
Product created successfully
Unique identifier
Example:
{ "sku": "PROD-001" }The ID of the product image file
The public URL of the product image
⌘I