Resources
Sitemap
Every page of the CentraPoint developer documentation in one list, plus the OpenAPI specification and Postman collection.
Getting started
- Introduction - What the CentraPoint API does, how it fits with hosted checkout and gateways, and where to start.
- Get started - Set up a new CentraPoint account: verify your business, connect a gateway in sandbox, set up tax, take a first test payment and invite your team.
- Quickstart - Create an API key in the CentraPoint dashboard and make your first API request.
- Authentication - Authenticate API requests with a tenant-scoped Bearer API key; plan and account requirements.
- Errors & rate limits - Error response format, error codes, validation issues, rate limits and retry guidance.
- Idempotency & metadata - Idempotency-Key retries, metadata rules, payment reference formats and how references relate to payment links.
API
- Customers - Create, upsert, search, list, retrieve and update customers, keyed by your own externalReference, and send or create customer portal links.
- Saved cards - Let customers save a card with a R1 verification or their first payment, list and manage saved cards, and charge a saved card from your own billing system.
- Products - Create, list, retrieve and update catalogue products with the Products API: SKU, name, price, currency, once-off or recurring billing and whether tax applies.
- Invoices - Create invoices with per-line VAT, send or issue them, record offline payments or allocate existing payments, and cancel them.
- Quotes - Create quotes (estimates) with per-line VAT, track acceptance, and convert accepted quotes into invoices.
- Credit notes - Issue credit notes, apply credit to invoices, and pay credit back against a payment, by payout or manually.
- Payment links - Create, list and retrieve hosted payment links, and find the payment references made through them.
- Coupons - Create discount codes for hosted checkout and customer subscriptions, and manage and validate them through the API.
- Customer subscriptions - Manage subscription packages and plans, subscribe customers to plans, and pause, resume, cancel or change their subscriptions.
- Gateway subscriptions - List, retrieve, pause, resume and cancel gateway-managed card subscriptions started by recurring payment links.
- EFT orders - Issue unique deposit references for bank transfers, upload proof of payment and track each order until your team approves it.
- Mandates - Create, list, retrieve and update Netcash debit order mandates, and issue debit order agreements for online signing.
- Transactions - List payments, and look up a payment's status and refunds with GET /api/v1/transactions/{reference}; polling as a fallback to webhooks.
- Receipts & refunds - List and retrieve receipts for completed payments and refunds, as JSON or as branded PDF documents.
- Payouts - Schedule creditor, salary and refund payments out of your Netcash account, follow their status, and cancel them.
- Reconciliation - Read Netcash statement reconciliation results per account: totals, balance view, matched lines, mismatches, payouts and payments missing from the statement.
- Entitlements - Read your organisation's plan, feature flags, limits and custom features with GET /api/v1/me and GET /api/v1/entitlements/{key}.
- API reference - Endpoint reference generated from the CentraPoint OpenAPI 3.1 specification, with code samples.
Guides
- Payment flow - The hosted checkout lifecycle: payment page, gateway, return and cancel URLs, gateway notifications, verification and statuses.
- Webhooks - Receive signed HTTPS notifications in your own systems when a payment's status changes.
- Recurring billing - Two ways to bill customers repeatedly: gateway-managed card subscriptions, or an invoice per billing cycle.
- Packages & plans - Sell subscriptions from a catalogue of packages and plans: trials, renewals, dunning and collection by gateway, debit order or invoice.
- Subscriptions for platforms - Hand customers' renewals to CentraPoint: subscriptions with add-ons, plan changes with proration, pauses, cancellations, webhooks and imports (mirror mode).
- Hosted checkout - Sell subscription packages and products on branded hosted checkout pages, and create pre-filled checkout links for known customers with checkout sessions.
- Customer portal - A branded self-service portal where your customers sign in with an emailed code to manage subscriptions, invoices, payments and their details.
- Account standing - How a subscription platform uses CentraPoint to require a card on paid plans, show grace-period banners and lock an account to billing until it is paid.
- Accepting EFT - Let customers pay by bank transfer into your own account, collect proof of payment, and approve deposits with one click.
- Gateway notification URLs - Gateway notification URLs for merchants configuring gateways, and how CentraPoint verifies every notification.
- Debit orders & reconciliation - How Netcash debit orders work in CentraPoint: mandates and online agreements, approvals, batches, action dates, unpaids, re-presentation and reconciliation.
- Tax & PDF documents - Configure sales tax such as VAT, how tax-inclusive and exclusive amounts are worked out, document branding, and invoice, receipt, refund and statement PDFs.
- Email & templates - How CentraPoint sends emails to your customers, how to use your own SMTP server, read the email log and customise every email template.
- Reports & report builder - Standard reports, the custom report builder, saved and scheduled reports, and CSV/XLSX exports in the CentraPoint dashboard.
- Migrating Netcash Pay Now - Move a Netcash Pay Now service to CentraPoint without breaking the payments your old system still creates, using legacy passthrough.
- Accounting integrations - Sync customers, invoices, payments and refunds to Sage, Xero, QuickBooks Online, Zoho Books or Invoice Ninja, or export CSV for Sage Pastel.
Administration
- Business verification - Why and how CentraPoint verifies a business (KYB) before it takes live payments: documents, statuses, sandbox-only use and the compliance_required error.
- Modules & payment gateways - How gateway modules work in the CentraPoint dashboard: adding, enabling, updating and removing modules, and configuring their payment providers.
- Roles & permissions - Built-in and custom roles in the CentraPoint dashboard, how users get a role, and the full permission catalogue.
- Two-factor authentication - Every CentraPoint dashboard user signs in with a second factor: an authenticator app or e-mailed codes, plus backup codes. Set-up, sign-in and resets.
Gateways
- Overview - Payment gateways supported by CentraPoint: countries, currencies, capabilities and configuration.
- PayFast - South African cards, Instant EFT, SnapScan, Zapper and recurring subscriptions.
- Netcash Pay Now - South African cards, Instant EFT, bank EFT and retail payments via Netcash Pay Now hosted checkout.
- Ozow - South African instant EFT (Pay by Bank) via Ozow's hosted payment page.
- Yoco - South African card, Apple Pay/Google Pay and instant EFT payments via Yoco hosted checkout.
- Peach Payments - Cards, Apple Pay/Google Pay, Capitec Pay, instant EFT, BNPL and more via Peach Payments Hosted Checkout.
- PayGate (PayWeb3) - South African cards, Masterpass, SnapScan, Zapper, SiD instant EFT and more via DPO PayGate PayWeb3.
- Netcash Debit Orders - Recurring bank debit orders (NIF batches, e-mandates) and automated account reconciliation from Netcash merchant statements.
- Paystack - Cards, bank transfer, USSD, mobile money and Apple Pay across Nigeria, Ghana, South Africa, Kenya and Cote d'Ivoire.
- Flutterwave - Pan-African cards, mobile money, bank transfer, USSD and Barter via Flutterwave hosted checkout.
- DPO Pay - DPO Pay by Network International: cards, mobile money (M-Pesa, MTN, Airtel) and PayPal across Africa.
- Pesapal - East African cards, M-Pesa, Airtel Money, MTN MoMo and bank payments via Pesapal hosted checkout.
- M-Pesa (Daraja) - Safaricom M-Pesa STK Push (Lipa Na M-Pesa Online) - payer approves on their phone. Kenya, KES.
- MTN MoMo - MTN Mobile Money Request to Pay - payer approves on their phone. Uganda, Ghana, Cameroon, Côte d'Ivoire, Zambia, Rwanda, Benin, Congo and more.
- Manual EFT (bank transfer) - Payers transfer to your bank account with a unique reference and upload proof of payment; your team approves each deposit.
Resources
Downloads
- OpenAPI specification (JSON)
- Postman collection
- centrapoint.co.za - product, pricing and the blog