API reference
Payments
Start a payment, verify it and list payments.
Start a payment
POST/payments
Create a payment and get a checkout URL to send your customer to. They can pay by card or bank transfer.
amountintegerrequired
Amount in kobo. ₦42,000 is 4200000.
emailstringrequired
Your customer's email, for the receipt.
referencestring
Your own unique reference. We generate one if you leave it out.
callback_urlstring
Where we send the customer after they pay.
metadataobject
Anything you want back on the webhook, e.g. your order ID.
{
"amount": 4200000,
"email": "ngozi@example.com",
"reference": "order_2231",
"callback_url": "https://yourshop.ng/thanks"
}{
"status": true,
"data": {
"reference": "order_2231",
"checkout_url": "https://checkout.cswitchcba.com/c/9f2k0418",
"status": "pending",
"amount": 4200000,
"currency": "NGN"
}
}Verify a payment
GET/payments/{reference}
Confirm a payment's status and amount on your server before you release goods or services.
referencestringrequired
The payment reference.
{
"status": true,
"data": {
"reference": "order_2231",
"status": "successful",
"amount": 4200000,
"currency": "NGN",
"channel": "transfer",
"paid_at": "2026-10-21T10:42:07Z",
"customer": {
"email": "ngozi@example.com"
}
}
}List payments
GET/payments
Page through payments, newest first. Filter by status or date.
statusstring
pending, successful or failed.
fromdate
Only payments on or after this date.
per_pageinteger
Up to 100. Defaults to 20.
{
"status": true,
"data": [
{
"reference": "order_2231",
"status": "successful",
"amount": 4200000,
"channel": "transfer"
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 1
}
}