Getting started
Introduction
What the CentraPoint API does, how it fits with hosted checkout and gateways, and where to start.
CentraPoint is a payments platform for businesses in South Africa and across Africa. It gives you invoicing, hosted payment links and checkout pages, subscriptions, debit orders, a customer self-service portal, coupons, reports and reconciliation on top of the payment gateways you already use. This site documents the public REST API that your own systems use to take payments through CentraPoint, and how the hosted payment flow and gateway notifications behave.
What you can build#
- Invoice your customers: keep customers in sync from your CRM, create VAT invoices, email them with a pay link and record EFT or cash payments.
- Sell subscriptions: define packages and plans and let CentraPoint run trials, renewals, failed-payment retries and plan changes, collecting by card gateway, debit order or an invoice per cycle. Simple gateway-managed card subscriptions from recurring payment links are still available.
- Sell from hosted checkout pages: share a checkout page for a package or product, or create a pre-filled checkout session from your app, with coupon codes.
- Let customers help themselves: the customer portal shows invoices and receipts and lets customers manage their subscriptions after signing in with an emailed code.
- Collect by debit order: create Netcash mandates through the API and have customers sign your agreement online.
- Get documents and data out: branded invoice, receipt and refund PDFs, paginated lists of payments and receipts, and your plan's entitlements for your own apps.
- Create payment links from your system: an order, booking or account statement in your application becomes a CentraPoint-hosted payment page you can email, SMS or redirect to.
- Check whether a payment succeeded: find the payments for your order and look each up by its reference and fulfil the order only once it is
complete. - Offer many payment methods with one integration: cards, Instant EFT, mobile money and more through the gateways your organisation connects in the dashboard.
How it fits together#
- Your server calls
POST /api/v1/payment-linkswith an API key and your order ID asexternalReference, and receives aurl. - The payer opens the link, enters their details, chooses a payment method and is sent to the gateway.
- The gateway notifies CentraPoint server-to-server. CentraPoint verifies the notification and updates the transaction.
- CentraPoint sends a signed webhook (e.g.
payment.complete) to your endpoint. - Your server verifies the webhook and fulfils the order. As a fallback, it can find the payment references with
GET /api/v1/payment-links?externalReference=…and check them withGET /api/v1/transactions/{reference}.
The same flow works for invoices: create the customer and invoice, send the invoice's payUrl, and listen for invoice.paid. The v1 API covers customers, products, invoices, payment links, checkout sessions, coupons, packages and plans, customer and gateway subscriptions, debit order mandates, EFT orders, transactions, receipts and refunds, reconciliation and entitlements, plus outbound webhooks; see the API reference.
Base URL and versioning#
All API requests go to https://app.centrapoint.co.za over HTTPS. The current version is v1 and is part of the path (/api/v1/…). Request and response bodies are JSON.