Resources
Changelog
Dated changes to the CentraPoint public API, the dashboard and this documentation, newest first, with API version numbers and the versioning policy.
On this page
- 24 October 2026: two-factor sign-in for every user
- 23 October 2026: Netcash Pay Now card subscriptions pause, resume and change in place
- 23 October 2026: POST /api/billing-webhook/checkout removed (1.23.0)
- 23 October 2026: custom gateway modules
- 23 October 2026: audit log filters and pre-filled checkout links
- 18 October 2026: yearly CentraPoint plans for consumers
- 18 October 2026: fuller default terms on documents
- 17 October 2026: Invoice Ninja accounting integration
- 17 October 2026: pay your CentraPoint plan yearly (1.22.0)
- 16 October 2026: recurring card payments replace card debit orders (1.21.0)
- 16 October 2026: save the card with the first payment (1.20.0)
- 8 October 2026: charge saved cards from your system (1.19.0)
- 8 October 2026: Netcash Pay Now URLs without a query, no waiting page
- 5 October 2026: saved cards and account standing (1.18.0)
- 5 October 2026: Netcash Pay Now always takes once-off payments
- 4 October 2026: Netcash statement postback
- 2 October 2026: tax setting on GET /api/v1/me
- 28 September 2026: subscription imports (mirror mode)
- 28 September 2026: recurring card payments in Netcash Pay Now
- 27 September 2026: gateway subscription fixes
- 27 September 2026: invoice-linked subscriptions and subscription invoices
- 27 September 2026: invoice payments and issuing, customer search, portal sign-in links
- 27 September 2026: subscription management for platforms
- 27 September 2026: reconciliation for every Netcash gateway
- 27 September 2026: billing periods, line details, invoice list pagination
- 27 September 2026: quotes, credit notes and payouts API
- 26 September 2026: subscriptions, portal, checkout, coupons and more
- 25 September 2026: EFT reminders and proof source
- 25 September 2026: EFT payer page and EFT at checkout
- 25 September 2026: subscription pause and resume
- 25 September 2026: eft.cancelled and fixes
- 25 September 2026: EFT orders, reconciliation API, subscription webhooks
- 25 September 2026: customers, invoices and subscriptions
- 25 September 2026: accounting integrations
- 25 September 2026: webhooks and refunds
- 25 September 2026: rate limits and references
- 25 September 2026: payment references
- 25 September 2026: launch
- Versioning policy
24 October 2026: two-factor sign-in for every user#
No change to the API: requests with API keys are not asked for a second factor. Two-factor sign-in to the dashboard is now required for every user. Users who haven't set it up are asked to at their next sign-in, before the rest of the dashboard opens. Besides an authenticator app, codes can now be e-mailed (as the chosen method, or as a fallback at sign-in for authenticator app users). Two-factor can no longer be turned off: Set up again under Settings → Security moves it to a new phone or another method and signs you out on every other device. Locked-out users are reset by CentraPoint support after an identity check; organisation admins no longer have a Reset 2FA button. For 24 hours after a password reset with an e-mailed link, authenticator app users can't use e-mailed codes (the app and backup codes still work).
23 October 2026: Netcash Pay Now card subscriptions pause, resume and change in place#
No change to requests or response shapes. Card subscriptions collected by Netcash Pay Now now support pause and resume at the gateway (Netcash's Subscription Update Service), and POST /api/v1/subscriptions/:id/update changes their amount and next charge date in place (result.mode updated) instead of e-mailing the payer a replacement checkout. Their capabilities now report pause, resume, updateAmount and updateNextDate as true; check capabilities rather than the gateway name. A next charge date that passed while a subscription was paused moves forward on the same schedule when it is resumed. Customer subscriptions billed by Netcash Pay Now can be paused and resumed, and change plan in place on the same billing frequency, the same way.
23 October 2026: POST /api/billing-webhook/checkout removed (1.23.0)#
POST /api/billing-webhook/checkout has been removed and now answers 404. Create checkout sessions with POST /api/v1/checkout-sessions instead: send planId where you sent subscriptionId; the response still carries checkoutUrl, sessionId and expiresAt (with the full session). The companyName alias inside customer / client is no longer read; send company. apiVersion is now 1.23.0.
23 October 2026: custom gateway modules#
Dashboard only, no API change. CentraPoint can now offer gateways that have no built-in module as custom gateway modules (types starting with custom_). They are added under Settings → Modules and configured under Settings → Payment providers like any other gateway, and take once-off hosted checkout payments. Payments made through them appear in transactions, webhooks and reports as usual. See Custom gateway modules.
23 October 2026: audit log filters and pre-filled checkout links#
Dashboard only, no API change. Settings → Audit log → User actions can be filtered by user (or API keys, or system actions), by action and by record; click a user, action or record in the list to filter by it, and use History on a customer's page for that customer's changes. The new Checkout link card on a customer's page gives a package or product checkout link with the customer's details filled in and the payment linked to them (details).
18 October 2026: yearly CentraPoint plans for consumers#
Dashboard only, no API change. If your account has no company registration number (Settings → Company settings or your business verification), your yearly CentraPoint plan follows section 14 of the Consumer Protection Act: we remind you between 80 and 40 business days before your year ends; the plan then continues month to month at the monthly price unless you choose "Renew for another year" under Settings → Billing; and Cancel subscription takes effect after 20 business days' notice, with a refund of the unused part of the year that is shown before you confirm.
18 October 2026: fuller default terms on documents#
No change to requests or response shapes. Invoices created with POST /api/v1/invoices without notes now get the fuller default invoice terms (when to pay, how to pay, late payment, questions, refunds and statutory rights) instead of "Payment due within 30 days.", unless you saved your own under Settings → Company settings. Send notes to set your own text per invoice. Quotes and credit notes have default terms of their own, documents can show your company registration number, and statements show the amounts owed by age. See Default terms.
17 October 2026: Invoice Ninja accounting integration#
Dashboard only, no API change. Invoice Ninja joins the accounting integrations: under Settings → Accounting, connect your own Invoice Ninja company (invoicing.co or self-hosted over https) with its address and an API token, and CentraPoint pushes customers, invoices, quotes, credit notes, payments and refunds to it.
17 October 2026: pay your CentraPoint plan yearly (1.22.0)#
API version 1.22.0. Additive: existing requests and responses are unchanged.
- Monthly or yearly. Every paid CentraPoint plan can be paid monthly or yearly. The yearly price is 12 months less a yearly discount (Starter, Growth and Business: two months free). Choose under Settings > Billing, at sign-up or on the payment page; a yearly plan renews by a Netcash Pay Now card subscription charged once a year.
- Switching. Monthly to yearly takes effect at once: you pay the yearly price and your year starts when your paid month ends. Yearly to monthly starts when your paid year ends. The old card subscription is cancelled when the new one starts, so you are never charged for both.
GET /api/v1/meaddsplan.currency,plan.priceMonthly,plan.priceYearly,plan.yearlyDiscountPercentandtenant.pendingBillingCycle(a cycle switch scheduled for the end of the paid period).
16 October 2026: recurring card payments replace card debit orders (1.21.0)#
API version 1.21.0. Requests keep working; saved-card charges and card saving are switched off.
- Subscriptions are recurring card payments. Bill a subscription with a recurring payment link (
recurring): a Netcash Pay Now card subscription that Netcash charges each period and notifies as a renewal. Once-off payments use a normal payment link. - Card debit orders are off. CentraPoint no longer saves or charges cards: the add-card page answers
409 card_setup_unavailable, saved-card charges are refused, pay pages offer no saved cards, automatic collection does nothing,saveCardon payment links is ignored, andGET /api/v1/mereportssavedCardsandchargeSavedCardsasfalse. - Account standing. A saved card is no longer a payment method: a recurring card payment or a debit order mandate is.
16 October 2026: save the card with the first payment (1.20.0)#
API version 1.20.0. Additive: existing requests, responses and webhooks keep working.
- Save the card while paying.
POST /api/v1/payment-linkstakessaveCard: true: the card the customer pays the link with is saved as their default card, so a subscription's first payment saves the card its renewals are charged to, with no separate R1.00 card verification. Needs a customer; ignored on recurring links. Payment links showsaveCard. See Save the card with the first payment. - Account standing. On a CentraPoint subscription, a paid plan needs a payment method only from its next charge (the trial end, or the end of the paid period): paying it saves the card, and before that
no_payment_methoddoes not apply. With?paidPlan=trueit still counts from the start of the paid plan.
8 October 2026: charge saved cards from your system (1.19.0)#
API version 1.19.0. Additive: existing requests, responses and webhooks keep working.
- Charge a saved card.
POST /api/v1/customers/{id}/cards/{cardId}/charges(cardIdmay bedefault) charges a customer's saved card without the customer present, for example your platform's own renewal. The charge ispendinguntil the bank confirms it;payment.complete/payment.failedcarry yourexternalReferenceandmetadata. At most one pending or successful charge perexternalReference. See Charge a saved card. - API key permissions. Charging saved cards needs a key allowed to do so (Settings → API keys); other keys get
403 permission_required.GET /api/v1/melists the key's permissions inapiKey.permissions. - Cards in
GET /api/v1/customers/{id}/cardsandGET …/cards/{cardId}havechargeable. - Account standing for platforms with their own invoices: how to apply the rules to your own invoices.
8 October 2026: Netcash Pay Now URLs without a query, no waiting page#
API version unchanged. No request, response or webhook changes.
- Netcash Pay Now URLs without a query. Gateway cards now show
/api/webhooks/netcash_paynow/notify/{providerId}/{notifySecret}and/api/webhooks/netcash_paynow/{accept|decline|redirect}/{providerId}: Netcash adds?and the payment reference to the Accept and Decline URLs and does not support URLs with a query of their own. URLs of the older?provider=form already in the Netcash portal keep working. See the Netcash Pay Now gateway page. - No waiting page for payers. A payer whose payment is not confirmed yet goes straight back to your return URL with
status=pending(orstatus=cancelledafter a decline or cancellation at the gateway) instead of waiting on a "Confirming your payment" page. Confirm the payment through the API or webhooks, as before; CentraPoint keeps checking with the gateway in the background. - While Netcash notifications to a gateway are refused (the secret in the Notify URL in the Netcash portal does not match), its card in Settings → Payment gateways says so and why.
5 October 2026: saved cards and account standing (1.18.0)#
API version 1.18.0. Additive: existing requests, responses and webhooks keep working.
- Saved cards.
POST /api/v1/customers/{id}/cards/setupstarts a hosted add-card page (a R1.00 card payment that saves the card; the R1.00 is credited to the customer's next invoice).GET /api/v1/customers/{id}/cards,GET/DELETE …/cards/{cardId}andPOST …/cards/{cardId}/defaultmanage them. Customers can pay a link issued to them with a saved card, save a new card while paying, and you can have the default card charged when an invoice falls due. Customers signed in to your customer portal can also pay with a saved card on your hosted checkout pages. The R1.00 is a normal payment (receipt,payment.complete, accounting sync) and is credited with an auto-applied credit note. See Saved cards. - Account standing.
GET /api/v1/customers/{id}/standingreturnsok,graceorlockedwith the reason, dates, outstanding invoices and links to add a card or pay. See Account standing. An invoice that automatic collection would charge but cannot yet (no card debit gateway) is markedawaitingCollectionand does not count towards a lock. - Read-only accounts: a CentraPoint account becomes read-only (
403 account_restricted) when it is limited to billing: a plan payment still unpaid 3 days after it fell due, or no card on a paid plan after the grace period (accounts that existed before this release get 14 days). Being past due no longer makes an account read-only by itself. - New webhook events:
customer.payment_method.added,customer.payment_method.removed,customer.payment_method.expiringandcustomer.standing.changed. GET /api/v1/me:capabilities.savedCards,capabilities.chargeSavedCardsandcapabilities.accountStanding.- Transactions can have
typecard_setup(the R1.00 verification) andcard_debit(a saved card charged by the bank; pending until the bank confirms).
5 October 2026: Netcash Pay Now always takes once-off payments#
API version unchanged (1.17.0). Partner API gateway listings no longer include the recurringOnly option; a recurringOnly sent when saving a gateway is ignored. Nothing else changes.
- The Use this gateway only for recurring payments option of Netcash Pay Now gateways is removed. Every Netcash Pay Now gateway takes once-off payments (payment links, invoices, products and checkout) and, while Recurring card payments is on, card subscriptions too. Gateways that had the option ticked are offered for once-off payments again. See the Netcash Pay Now gateway page.
4 October 2026: Netcash statement postback#
API version unchanged (1.17.0). One additive value; existing requests, responses and webhooks keep working.
- Statement postback for Netcash accounts. Netcash Pay Now, Debit Orders and Creditor & Salary Payments gateways have an Account reconciliation section with the Account service key. With the key set, the gateway card shows a Statement postback URL: paste it in the Netcash portal under Account profile > NetConnector (Connected services) > Account service and tick postback: when Netcash signals a new statement, CentraPoint fetches it from Netcash at once. The statement is always fetched from Netcash before anything is reconciled; a posted statement Netcash does not confirm is listed under Unverified postback - review on the Reconciliation page and changes nothing. The nightly fetch stays on as the fallback. See Netcash accounts.
- Reconciliation runs can have
trigger: "postback": a statement CentraPoint requested from Netcash to confirm one posted to the Statement postback URL (a posted statement that answers the nightly request keepscron). Unconfirmed postbacks are not reconciliation results and are not returned by the API.
2 October 2026: tax setting on GET /api/v1/me#
API version 1.17.0. One additive change; existing requests, responses and webhooks keep working.
taxonGET /api/v1/me. The response now carries your organisation's tax setting as it is charged:{ enabled, name, rate, inclusive, configured, taxNumber }.enabledis false andrateis 0 when no tax is charged;configured: falsemeans Settings → Tax was never saved, so the company VAT rate applies, added on top. A platform that mirrors or bills subscriptions through CentraPoint can check the setting before it writes anything, instead of relying on what an operator says it is. See Reading your tax setting from the API.
28 September 2026: subscription imports (mirror mode)#
API version 1.16.0. A platform that keeps billing its own customers can now import its subscriptions into CentraPoint without anyone being billed twice. All changes are additive; existing requests, responses and webhooks keep working.
collectionMethod: "external".POST /api/v1/customer-subscriptionsrecords a subscription your platform bills: CentraPoint never charges, invoices, emails, reminds, duns or expires it, and sends nosubscription.*webhooks for it. It takesstatus(active,trialing,past_due),paidThrough(the end of your current period: may be in the past forpast_due, the trial end fortrialing),currentPeriodStart,trialEndandcancelAtPeriodEnd, and may use disabled plans. See Importing subscriptions (mirror mode).POST /api/v1/customer-subscriptions/{id}/sync-periodrecords your platform's period and status after each of its renewals (external subscriptions only,409 not_externalotherwise; an older period with the same status is409 stale_period; one that keeps losing to other updates at the same time is409 concurrent_update). Actions that would make CentraPoint collect or manage their billing return409 external_subscription; cancel is silent and change-plan is recorded without proration.- Dry runs.
dryRun: trueonPOST /api/v1/customer-subscriptionsvalidates like a create and answers200 { dryRun, action: create | exists, subscription }without writing anything (no Idempotency-Key is stored). externalReferenceis unique per organisation for customer subscriptions, also for two creates at the same time: the second gets the first one's subscription. Creates now answer withcreated: true(201) orcreated: false(200). A create whoseexternalReferencebelongs to another customer, or where one side is an external subscription and the other is not, answers409 external_reference_conflict; an external subscription'sexternalReferencecannot be changed or removed.- Plan codes. Plans take an optional
code, unique per organisation (409 plan_code_taken), found with the newGET /api/v1/plans?code=; subscribe withplan: <id or code>instead ofplanId. - Customer subscription fields.
collectedByCentraPoint(false for external subscriptions: leave them out of income CentraPoint collects) andbilledBy.GET /api/v1/customer-subscriptionsfilters oncollectionMethod(comma list). sandboxon payments.GET /api/v1/transactions/{reference}, the transaction list, subscription payments andpayment.*webhooks say whether a gateway set to sandbox (test) mode processed the payment, so you can refuse to settle real invoices with test payments. It is the gateway's current CentraPoint setting; Manual EFT (no test mode) is always false, and for Netcash, DPO and PayGate with your own credentials it only repeats the setting (see Transactions).apiVersioninGET /api/v1/me(1.16.0), so integrations can stop when CentraPoint is older than they need, andcapabilities.externalSubscriptions: false for a short time while CentraPoint is being updated. Until it is true, external creates (and dry runs) answer409 external_imports_unavailableand write nothing.POST /api/v1/customer-subscriptions/{id}/canceltakessendEmail: falseto cancel without emailing the customer.
28 September 2026: recurring card payments in Netcash Pay Now#
API version 1.15.0. Netcash recurring card payments are part of the Netcash Pay Now gateway and use its URLs; the separate Netcash Recurring Card gateway type is retired.
- One gateway, one set of URLs. Each Netcash Pay Now gateway has a Recurring card payments option group: Recurring card payments (on by default) and Use this gateway only for recurring payments (off by default). Card subscriptions use the gateway's service key, notify secret and the same Notify, Accept, Decline and Redirect URLs as once-off payments; there is no second set of URLs. See Netcash Pay Now: one set of URLs and the Netcash Pay Now gateway page.
- The options apply to new payments only. They decide whether the gateway is offered for recurring payment links, products and subscription plans, and for once-off payments. Switching recurring payments off never stops a card subscription Netcash already bills: its renewals are still recorded, and it can still be cancelled with
POST /api/v1/subscriptions/{id}/cancel. netcash_recurringis retired. Gateways already set up as Netcash Recurring Card keep working unchanged, including the/api/webhooks/netcash_recurring/...URLs already in the Netcash portal, until they are converted to Netcash Pay Now gateways with recurring card payments on. From then on thegatewayvalue of their payments and subscriptions isnetcash_paynowinstead ofnetcash_recurring, also for payments made before the conversion: in transactions, subscriptions, invoice payments, outbound webhook payloads and thetypeof reconciliation account providers. Check your integration if it compares thegatewayvalue withnetcash_recurring.- Documentation: the gateway notification URLs guide, the Netcash Pay Now gateway page, reconciliation and the Pay Now migration guide describe recurring card payments as part of Netcash Pay Now; the reconciliation examples show a Pay Now gateway instead of a Recurring Card one.
27 September 2026: gateway subscription fixes#
API version 1.14.2. Fixes to gateway subscription retries and replacements, and to invoice payment origins.
- Retries and charges are the subscription's own.
POST /api/v1/subscriptions/{id}/retryno longer re-collects a failed renewal of the card subscription a replacement checkout started (for example when that checkout was no longer the current one, or the old subscription could not be cancelled at the gateway): retry that subscription instead.GET /api/v1/subscriptions/{id}/chargeslists the payments and declined attempts on the subscription's retry links and replacement checkouts, but not the renewals of the card subscription a replacement checkout started, and on a shared payment link only the payer's own payments. - One open replacement checkout, also for requests at the same time. Two replacements at once at the same amount send one link (the same
paymentLinkId/payUrl); at different amounts the later one deactivates the earlier one, as if they were sent one after the other. - A replacement checkout paid twice. When the payer completes two checkouts of one replacement link (for example in two browser tabs), only the first payment replaces the subscription. The card subscription the second one started is cancelled at the gateway (
subscription.cancelled), and the second payment is reported to your staff (a dashboard notification; for an invoice-linked subscription also thepayment.renewal_unallocatedaudit log entry) so you can refund it. If the gateway cannot cancel that card subscription, the notification says so: cancel it on the gateway's dashboard. For an invoice-linked subscription, anything it still collects is not invoiced but reported; for other subscriptions its later payments are recorded like any other and not reported again. - A replacement retires the old subscription's retry links. When a replacement checkout replaces a subscription, the old subscription's unpaid retry links are deactivated.
- No silent payments outside the invoice chain. For an invoice-linked subscription, the payments of a card subscription started by a replacement checkout that was no longer the current one are now all reported (audit log
payment.renewal_unallocatedand a notification): also those through its retry links and its own replacement checkout, and that checkout's renewals. - Invoice payment origin. In an invoice's
payments, an offline payment imported from an accounting system hasorigin: accounting(it was the integration's own name). The other values are unchanged:api,dashboardand, for transactions,gateway. - Documentation:
409 nothing_to_retryis described as implemented. It is returned when no missed charge is left to re-collect and either noamountwas sent to a subscription that missed a charge before, or the subscription is invoice-linked (with or withoutamount).
27 September 2026: invoice-linked subscriptions and subscription invoices#
API version 1.14.1. Fixes where 1.13.0 (gateway subscription management) and 1.14.0 (recurring links for an invoice) meet, so invoices always match payments.
- Invoice-linked subscriptions keep their amount.
POST /api/v1/subscriptions/{id}/updatewith a newamount, a replacement at another amount and a retry with anotheramountreturn409 invoice_linkedfor a subscription started by a recurring link for an invoice (a newnextDatestill works). Before, the change went through and later renewals could no longer be invoiced. The amount is the total of the invoice lines each new invoice copies, and replacements and retries default to it: a subscription whose amount was changed before this release can be set back to the lines total withupdateor a replacement. - Retries and replacements continue the invoice chain. A retry of a failed renewal (charged, or the retry link once paid) and the payment of a replacement checkout are each invoiced once, for the next period (the period after the latest invoice), and a replacement card's renewals carry on from there. For a subscription started by a payment link, a charged retry is recorded as a collection of that link: the transaction has
renewal: trueand sendssubscription.charged/subscription.payment_failed. - Retry once per missed charge.
POST /api/v1/subscriptions/{id}/retryre-collects the latest missed charge (a failed renewal or charged retry) that was not re-collected yet; a charged retry that is still pending counts until the gateway reports it, and a payer's declined attempt on a retry link or replacement checkout is not a missed charge. When every missed charge was re-collected it returns409 nothing_to_retryunless you sendamount(which is then collected now); a subscription that never missed a charge is collected now (its amount, oramount). Invoice-linked subscriptions always need a missed charge that was not re-collected yet: otherwise the retry returns409 nothing_to_retry, with or withoutamount. Retries of one subscription run one at a time, and a new retry link deactivates an earlier unpaid one for the same charge. In the charges list,retry: truealso marks payments and declined attempts through a retry link. - One open replacement checkout. A replacement at the same amount while the payer has not paid the previous replacement link emails that link again (same
paymentLinkId/payUrl). When a replacement checkout replaces the subscription, another unpaid one is deactivated. An invoice-linked subscription is only replaced by its current replacement checkout. - No silent unallocated payments. A payment of an invoice-linked subscription that cannot be invoiced is reported to your staff (audit log entry
payment.renewal_unallocatedand a dashboard notification) so you can allocate it withPOST /api/v1/invoices/{id}/payments{ transactionReference }, or refund it. This includes a second payment for a missed charge that was already re-collected (e.g. an earlier retry link the payer was still paying), a payment on a replacement checkout that is no longer the current one, and the renewals of a card subscription started by such a checkout. - Subscription invoices match the invoice object.
GET /api/v1/customer-subscriptions/{id}/invoicesand theinvoiceinsubscription.*webhooks now carry the invoice's stored billing period as inclusiveYYYY-MM-DDdates, likeGET /api/v1/invoices/{id}(1.13.0 sent the cycle's start and the next billing date as timestamps), lines withdetails, their own periods and the invoice tax rate for lines without one, andstatuswithpartially_paid. New fields:externalReference,taxInclusive,amountDue. - Anchored first invoices (
billingAnchorDay) with a coupon show the pro-rated discount that was charged in the line details ("Coupon CODE: -R 58,06 (pro rata for this period)"), matching the line amount.
27 September 2026: invoice payments and issuing, customer search, portal sign-in links#
API version 1.14.0. All changes are additive; existing requests, responses and webhooks keep working unchanged.
- Invoices by number.
GET /api/v1/invoices/{id}and its/pdf,/send,/payments,/canceland new/issueaccept the invoice number (e.g.INV-000042) as well as the ID. GET /api/v1/invoices gains anumberfilter (exact);externalReferenceand keyset pagination were already available. - New:
paymentson the invoice object (get, list andinvoice.*webhooks): offline payments and completed CentraPoint transactions, each withid,source,origin,method,status,amount,refundedAmount,currency,date,referenceandtransactionReference. See Payments on an invoice. - New: allocate an existing payment with
POST /api/v1/invoices/{id}/payments{ transactionReference }: links a completed transaction to the invoice without recording new money (409 already_allocatedwhen it belongs to another invoice). The offline payment body is unchanged. See Allocate an existing payment. - New: issue without emailing.
POST /api/v1/invoicesacceptsstatus: "sent"(orissue: true) to create the invoice issued with no email (unlesssend: true), and POST /api/v1/invoices/{id}/issue marks a draft sent without an email. Both sendinvoice.sent.POST /{id}/sendstill emails. - New: portal sign-in links without email. POST /api/v1/customers/{id}/portal-link with
{ "email": false }(optionalexpiresInMinutes,section) returns a single-use URL that signs the customer straight in to the portal (default 15 minutes, at most 24 hours). The default call still emails the portal link. - GET /api/v1/customers: keyset pagination (
startingAfter; the response addshasMoreandnextCursor) and aqsearch over name, company, email, billing email, account code and external reference, next to the existingexternalReferenceandemailfilters. - Recurring payment links for an invoice.
recurringwithinvoiceIdonPOST /api/v1/payment-linksis now defined: allowed when the invoice has a billing period (the first payment settles it; each renewal creates and pays a new invoice for the next period), otherwise400with the reason. See Recurring links for an invoice.
27 September 2026: subscription management for platforms#
API version 1.13.0. Additive and backwards compatible; see Managing subscriptions from your platform.
- Customer subscriptions: items (add-ons, metered usage, one-time lines),
startDate(statusscheduled),paidThrough,billingAnchorDay,couponId, collection methodmanual; change-plan takesitemsandproration(nonedefault,now,next_renewal); newpreview-change,reactivate,credit,discount,pending-change,items,invoicesandpaymentsendpoints; cancel acceptswhen. The list is keyset paginated (hasMore,nextCursor;dataunchanged) with new filterscustomerExternalReference,nextBillingFrom/nextBillingToand comma-separatedstatus. - Gateway subscriptions:
capabilitieson the object;POST /subscriptions/:id/update(amount / next date, in place or by replacement),POST /subscriptions/:id/retry,GET /subscriptions/:id/charges;/subscriptions/migrationsfor legacy Netcash subscriptions. - Webhooks: new
subscription.trial_endingandsubscription.reactivated; customer subscription events carrybillingPeriod, andinvoice/paymentwhen they concern one.
27 September 2026: reconciliation for every Netcash gateway#
API version 1.12.0. All changes are additive; existing fields keep their meaning.
- Netcash Pay Now, Recurring Card and Creditor & Salary Payments gateways take an optional Account service key. Their Netcash account statement is reconciled nightly; gateways sharing one key are one account with one statement.
- Runs gain
account,unmatched,notReceived,balance,triggerandtotals.settlements/totals.disbursements; items gainid,category,kind,code,transactionId,payoutId,payoutReferenceand the new statusnot_debited.GET /api/v1/reconciliation/runsacceptsaccountandsource. - New:
GET /api/v1/reconciliation/lines(filter by status, category, account, run and date) andGET /api/v1/reconciliation/accounts. - Creditor and salary payouts become
paidwhen their debit appears on the statement andfailedwhen the bank returns them (the credit note is released). Without a statement debit the previous rule (batch loaded and action date reached) applies after 3 days. Only the batch files of a gateway whose statement is reconciled (Account service key set, plan with reconciliation) carry each payout'sPAY-…reference (Extra 1, field 301). - Payments are confirmed from the statement by their reference. A collection line with no reference at all is compared by amount and date: it can match a completed payment, but a pending payment is only suggested (the line stays
unmatched); amount and date never complete a payment. - A return line changes a payment only when it takes money out, and a payment is returned only once: a return that may repeat one already on a statement is an
exceptionand changes nothing. reconciliation.completedaddsaccountandsummary.
27 September 2026: billing periods, line details, invoice list pagination#
API version 1.11.0. All changes are additive; existing fields keep their meaning.
- New: billing periods and line details on invoices, quotes and credit notes. Optional
periodStart/periodEnd(YYYY-MM-DD, inclusive) onPOST /api/v1/invoices,POST /api/v1/quotes,PATCH /api/v1/quotes/{id}andPOST /api/v1/credit-notes, and per line optionaldetails(up to 4000 chars) andperiodStart/periodEnd. The objects (andinvoice.*,quote.*andcredit_note.*webhook payloads) gainperiodStart/periodEnd, and each linedetails,periodStartandperiodEnd(null when not set). - Subscription invoices now carry the billing cycle as their period and a line description and details built from the package, plan and frequency. PDFs, emails and the customer portal show the billing period and line details.
- New: GET /api/v1/invoices pagination and filters. Keyset pagination (
limit,startingAfter; the response addshasMoreandnextCursornext todata),statusaccepts several comma-separated values, and newcustomerExternalReferenceandfrom/to(issue date) filters.
27 September 2026: quotes, credit notes and payouts API#
API version 1.10.0. All changes are additive; existing endpoints and webhook payloads are unchanged.
- New: Quotes API (
/api/v1/quotes): create, list, get, edit and delete drafts;send,accept,decline;convertinto an invoice; and the quote PDF. Needs Invoicing. - New: Credit notes API (
/api/v1/credit-notes): create (optionally against an invoice),issue,void,applycredit to an invoice,refundit (against a payment, by payout or recorded manually), and the credit note PDF. Needs Invoicing. - New: Payouts API (
/api/v1/payouts): schedule creditor, salary and refund payments through a Netcash Creditor & Salary Payments gateway, list, get and cancel them. Bank details are never returned. - New webhooks (finance events):
invoice.created,invoice.sent,quote.created,.updated,.sent,.accepted,.declined,.expired,.invoiced,credit_note.created,.issued,.applied,.refunded,.voided, andpayout.scheduled,.submitted,.paid,.failed,.cancelled. Theirdatais the same object the matchingGETendpoint returns. Endpoints subscribed to all events receive them automatically; handle unknown types gracefully.
26 September 2026: subscriptions, portal, checkout, coupons and more#
API version 1.9.0. All changes are additive; existing endpoints and webhook payloads are unchanged unless noted.
- New: customer subscriptions. Sell subscriptions from packages and plans with trials, setup fees, fixed terms, quantities, renewals, dunning and plan changes, collected by card gateway, debit order or an invoice per cycle. API:
/api/v1/packages,/api/v1/packages/{id}/plans,/api/v1/plans/{id}and/api/v1/customer-subscriptionswithpause,resume,cancel(now or at period end) andchange-plan(Customer subscriptions API). Needs Recurring billing. - New webhooks:
subscription.created,.renewed,.trial_ended,.past_due,.plan_changed,.updatedand.expired, pluscheckout.completedandcheckout.failed.subscription.activated,.payment_failed,.paused,.resumedand.cancelledare now also sent for customer subscriptions, withdata.object: "customer_subscription"(details). Failing endpoints now raise an in-app notification. - New: hosted checkout pages and checkout sessions. Shareable checkout pages for packages and products, and
POST /api/v1/checkout-sessionsfor a pre-filled checkout URL (24 hours), withGETto follow its outcome.POST /api/billing-webhook/checkoutis a compatibility alias for integrations built on the ASAP API. - New: coupons at checkout and on subscriptions (percentage or fixed; once, repeating or forever), with
/api/v1/couponsandPOST /api/v1/coupons/validate. Needs Coupons. - New: customer portal. Customers sign in with an emailed one-time code to see invoices and receipts, download PDFs and manage their subscriptions.
POST /api/v1/customers/{id}/portal-linkemails a sign-in link (new error codes409 portal_disabledand422 not_sent). Needs Customer portal. - New: customers.
contactType(individual/company) andbillingEmailon the customer object, create and update;GET /api/v1/customers/lookupby email, externalReference or accountCode (details). - New: Products API (
/api/v1/products). - New: tax settings and PDF documents. Settings → Tax (tax name, rate, inclusive or exclusive pricing);
taxInclusiveonPOST /api/v1/invoices(defaultfalse); branded PDFs fromGET /api/v1/invoices/{id}/pdf,GET /api/v1/receipts/{id}?format=pdfandGET /api/v1/refunds/{id}?format=pdf. - New: Receipts & refunds API and GET /api/v1/transactions to list payments, all with keyset pagination (
limit,startingAfter,hasMore,nextCursor) andfrom/todate filters. - New: Mandates API to create, list, update and pause/cancel debit order mandates and issue online agreements (
POST /api/v1/mandates/{id}/agreement). Needs Debit orders. - New: debit order settings: processing lead days with South African public holidays, weekend/holiday handling, mandate approval, required signed agreements, batch approval by staff and re-presenting unpaid debits; online agreement signing with your own template; and a debit order report.
- New: entitlements for your own apps:
GET /api/v1/meandGET /api/v1/entitlements/{key}(the latter works with any valid API key), including custom features. - New in the dashboard: standard reports and a report builder with scheduled email delivery and CSV/XLSX export (builder needs Report builder); your own SMTP server and editable email templates; Settings → Modules for adding gateway modules (plugin packages can no longer be downloaded); custom roles and permissions.
- Changed: two-factor authentication now uses an authenticator app (TOTP) with backup codes. SMS (phone) two-factor was removed: users who had it enrolled sign in with their password until they set up an authenticator app. API keys are not affected.
- Changed: invoice objects now include
taxInclusive; invoice emails and receipts for a customer go to theirbillingEmailwhen set; a validation error raised after merging aPATCH(for example on a coupon) returns400 invalid_requestwithissues; a coupon'sredemptionsis always the counts object (the list from?include=redemptionsisrecentRedemptions); subscriptions keep the coupon terms they were created with; a checkout session'smetadatais stored with the payment it creates, and a payment that completes after the session expired now completes the session.
25 September 2026: EFT reminders and proof source#
- New: EFT order
proofs[]items includesource:api,dashboardorpayer. - New: EFT payment reminders: one email about 48 hours before expiry for unpaid orders at least a day old, with the bank details and payer page link, sent to the payer's checkout email or otherwise the customer's.
- New: Settings → Webhooks can change an endpoint's events without re-creating it, so the signing secret is kept.
25 September 2026: EFT payer page and EFT at checkout#
- New: EFT orders return
payUrl, a signed public payer page with the bank details, the reference and a proof upload. No login needed; share it instead of building your own upload. - New:
POST /api/v1/eft-ordersacceptsnotifyPayerto email the customer the bank details andpayUrl(400 without a customer email). - New: hosted payment-link and invoice pages offer Bank transfer (EFT) for once-off payments. Approval pays the link or invoice, and
payment.completecarries the link'sexternalReferenceandmetadata. See EFT at hosted checkout. - Changed: once-off payment links and invoice pay links can be created when Manual EFT is the only gateway.
25 September 2026: subscription pause and resume#
- New:
POST /api/v1/subscriptions/{id}/pauseand/resumeon gateways that support it (e.g. PayFast). See the rules. - New webhooks:
subscription.pausedandsubscription.resumed, also sent for dashboard actions;datais the subscription. - Changed: pause, resume and cancel share the same rules: repeating an action that already took effect returns
200unchanged, invalid transitions return the new error409 invalid_state, and gateway refusals return502 gateway_error. Cancel is allowed fromactiveorpaused. - Changed: pausing or resuming a Netcash Pay Now subscription (which supports cancel only) now returns
409 unsupportedinstead of502 gateway_error; the dashboard no longer offers Pause for it.
25 September 2026: eft.cancelled and fixes#
- New webhook:
eft.cancelled, sent when an EFT order is cancelled through the API or the dashboard;datais the EFT order. - Changed:
POST /api/v1/invoicesacceptscustomerIdas an alternative tocustomer; send exactly one. - Fixed: payers returning from a Netcash Pay Now service-level Accept or Decline URL now land on their payment (the reference is read from
Reference/p2when there is noref). - Clarified: staff may approve an EFT order without proof, including an expired one, and
subscription.payment_failedhas no billing period because none was paid.
25 September 2026: EFT orders, reconciliation API, subscription webhooks#
- New: EFT orders API and the Accepting EFT with proof of payment guide: unique deposit references on your own bank account, multipart proof upload (PDF, PNG or JPEG, up to 10 MB), staff approval with statement matching. New Manual EFT gateway and transaction type
eft. - New: Reconciliation results API:
GET /api/v1/reconciliation/runsand/runs/{id}with totals, item statuses andnot_receivedfor Netcash statements. - New webhooks:
eft.proof_received,eft.rejected,eft.expired,reconciliation.completed, andsubscription.activated,subscription.charged,subscription.payment_failed,subscription.cancelled. - Changed:
payment.*webhooks addeftOrderId;externalReferenceandmetadatafall back to the EFT order's. - Changed:
GET /api/v1/transactions/{reference}:metadatais always an object (wasnullwithout a payment link);externalReferenceandmetadatafall back to the EFT order's; addseftOrderId;invoiceis now{ id, number, invoiceNumber, status, externalReference }, matching webhooks (invoiceNumberkept for compatibility). - Changed:
GET /api/v1/payment-links/{id}now includessubscription, like the list. - Changed: invoices reject currency codes that are not ISO 4217 (
400). - Fixed: Idempotency-Key is scoped to the HTTP method and exact path, so the same key on two different invoices (e.g.
/invoices/A/sendand/invoices/B/send) no longer replays the first response. - New guide: Migrating an existing Netcash Pay Now integration (legacy passthrough).
25 September 2026: customers, invoices and subscriptions#
- New: Customers API: create or upsert by
externalReference, list, get and update. - New: Invoices API: create with per-line VAT (idempotent on
externalReference), list (includingpartially_paid), get, send, cancel and record offline payments. Invoices includepayUrlandamountDue. - New: Subscriptions API and recurring payment links (
recurring: { frequency, amount? }) on PayFast and Netcash Pay Now. See Recurring billing. - New: payment links accept
returnUrl(allow-listed origins),metadataandcustomerId; responses addreturnUrl,metadata,recurringand (list)subscription. - New: Idempotency-Key on POST endpoints (24 hours,
Idempotent-Replayed: true,409 idempotency_conflict) and metadata on links, customers and invoices. - New webhooks:
invoice.paid,invoice.partially_paid,invoice.cancelled.payment.*data addsmetadata,customer,renewal,parentReference,subscriptionId;invoiceis now{ id, number, status, externalReference }. - New: transactions return
metadata,renewal,parentReferenceandsubscriptionId. - New error codes:
409 idempotency_conflict,409 unsupported,502 gateway_error. Invalid JSON now returns Body must be JSON; bodies over 100 000 characters return413.
25 September 2026: accounting integrations#
- New: accounting integrations (Business plan and above) for Sage Business Cloud Accounting (South Africa and international), Xero, QuickBooks Online and Zoho Books, plus a Sage Pastel / Sage 50 CSV export. Customers, invoices, completed payments and refunds sync automatically.
- New endpoint:
GET /api/v1/accounting/referral-linksreturns tracked sign-up links for partner accounting systems.
25 September 2026: webhooks and refunds#
- New: outbound webhooks. Configure up to 5 HTTPS endpoints under Settings → Webhooks to receive
payment.complete,payment.failed,payment.cancelled,payment.refundedandpayment.partially_refundedevents, signed withCentraPoint-Signature(HMAC-SHA256) and retried for about 2 days. Polling remains available as a fallback. - Changed:
POST /api/v1/payment-linksvalidatescurrencyas ISO 4217 and requires one of your enabled gateways to accept it (400 otherwise). - Changed:
expiresAtaccepts any ISO 8601 UTC offset (e.g.+02:00), and must be in the future and at most 1 year ahead. - New:
GET /api/v1/transactions/{reference}returnsrefundedAmountandrefunds[]. - The page previously titled "Webhook notification URLs & security" is now Gateway notification URLs.
25 September 2026: rate limits and references#
- Changed: rate limits are now per API key (120 requests per minute, fixed window) instead of per IP. A coarse guard of 600 requests per minute per IP applies before authentication; the client IP cannot be spoofed with
X-Forwarded-For. - New:
X-RateLimit-Limit,X-RateLimit-RemainingandX-RateLimit-Reset(Unix seconds) on every authenticated response;429responses include an exactRetry-After. - Changed: new payment references use the
CP-YYYYMMDD-XXXXXXXXformat. ExistingGSS-references stay valid and are still matched by reconciliation. Treat references as opaque strings.
25 September 2026: payment references#
- New: optional
externalReference(1–100 characters, your order ID) onPOST /api/v1/payment-links. - Changed:
POST /api/v1/payment-linksnow returns the full payment link object:id,url,title,description,amount,currency,externalReference,singleUse,active,expiresAt,paidCount,createdAt. Additive; existing fields are unchanged. - New:
GET /api/v1/payment-links(filter byexternalReference,limit1–100) andGET /api/v1/payment-links/{id}, both including thepayments(references and statuses) made through each link. This removes the earlier limitation that payment references could not be discovered via the API. - New:
GET /api/v1/transactions/{reference}returnsgateway,paymentLinkIdandexternalReference. - New error code:
500 internal_errorwith a generic message for unexpected errors.400 invalid_requestnow only carries validation messages (e.g. Product not found). - Security: the payer cancel URL is now HMAC-signed (
&sig=).
25 September 2026: launch#
Documentation launched at docs.centrapoint.co.za, covering API v1 as it stands today.
- API keys use the
cp_<8 hex>_<secret>format and are scoped to one organisation. API access requires a plan that includes the REST API. - Error responses use
{ "error": "<code>", "message": "<text>" }with the codesinvalid_request,unauthorized,plan_restricted,plan_limit,account_restricted,not_foundandrate_limited.429responses includeRetry-After. - POST /api/v1/payment-links accepts an optional
currency(default ZAR), accepts any positive amount up to 10 000 000, and returnssingleUse. - GET /api/v1/transactions/{reference} is scoped to your organisation and can return
type: "debit_order". - Gateway notification URLs use one format for every gateway:
/api/webhooks/{type}?provider={providerId}(GET and POST).
Versioning policy#
- Additive changes (new endpoints, new optional request fields, new response fields, new error codes or enum values) can ship in v1 without notice. Write clients that ignore unknown fields and handle unknown enum values.
- Breaking changes will ship under a new version path and be announced here first.