Payaccsys Integrated Payments API
Version 2. Source: Payaccsys Integrated Payments API V2, 2025-09-16.
Confidential. The API guide from which this reference is transcribed carries a statement of confidentiality: the recipient agrees to keep it confidential and not to place it at the disposal of any third party without Payaccsys's permission. This reference is subject to the same restriction.
Scope
From version 2, this API supports payments only. Other functions are served by separate APIs:
| For | Use |
|---|---|
| Transactional information and wallet balance updates | Wallet API |
| Account verification | AVS API |
| Debit order services | Debit Order API |
The system uses the accounting term Supplier to denote a beneficiary, vendor or payee.
What the API does
| Capability | Endpoint |
|---|---|
| Add a supplier with account details | addSuppliers |
| Update supplier details | updateSuppliers |
| List suppliers and their stored details | listSuppliers |
| Load payments for existing suppliers | loadPayments |
| Cancel payments by payment reference | cancelPayments |
| Check payment status by reference, date or batch | paymentStatus |
| Load a payment batch, with or without preloading suppliers | loadBatch |
| Cancel batches by batch reference | cancelBatches |
| List account types | listAccountTypes |
| List bank options | listBankOptions |
| List supplier types | listSupplierTypes |
| List payment types | listPaymentTypes |
Two ways to pay
There are two routes, and the choice affects what you must send with each payment.
Preload suppliers, then pay. Call addSuppliers to store banking details
once, then loadPayments with only the supplier code, amount, date and
reference. The guide describes this as providing "an added layer of security when
making payments", since the payment processes against bank account information
already on file.
Pay directly in a batch. Call loadBatch without preloading. This creates a
supplier from the data supplied and returns a supplier code.
Either route allows the Account Verification Service to be used later, though a
supplier created through loadBatch may need its AVS fields completed through
updateSuppliers.
Service types
Payments default to same-day, clearing between 20:00 and 22:00 on the day. Two alternatives may be specified per payment:
| Service | Set | Effect |
|---|---|---|
| Same day (default) | Neither flag | Clears between 20:00 and 22:00 on the payment date |
| Immediate | immediatePayment | Real-time clearance. Only to participating banks |
| One day | oneDayPayment | Pays at midnight on the payment date |
immediatePayment and oneDayPayment are mutually exclusive.
PayShap conversion is automatic and is not requested in the payload. Where a
real-time clearance instruction is directed to a
PayShap participating bank and the value does
not exceed R50 000.00, the bank converts the payment to PayShap. The service
type actually applied is returned in the product field of the loadBatch
response.
Relationship to the compliance programme
Payment activity originated through this API is subject to the controls in the Payaccsys Risk Management and Compliance Programme, including the clauses governing the payments process and the handling of merchant funds. API access is limited to vetted and approved integrations with controlled permissions and auditability.
This reference deliberately links to the RMCP without citing a clause number. The compliance library and the API reference are versioned independently, so a clause number valid in one revision of the RMCP may not exist in another.
Disclaimer and availability, as stated in the source guide
The guide records that Payaccsys makes no representations or warranties as to the completeness, accuracy, reliability, suitability or availability of the material, and that reliance on it is at the reader's own risk. It also records that while Payaccsys endeavours to provide 24/7 uptime, no warranty of availability is given; infrequent downtime is possible through emergency maintenance, security patching, system upgrades, infrastructure failure, or outages at third-party providers on which the service depends.
Version history
| Version | Date | Responsible | Description |
|---|---|---|---|
| 1.0.4 | 2022.05.21 | D Bosch | Version for distribution |
| 1.0.4 | 2024.08.23 | Y Geldenhuys | Added list of real-time participating banks |
| 1.0.4 | 2024.10.03 | Y Geldenhuys | Removal of HBZ as a real-time participating bank |
| 1.0.5 | 2024-11-14 | D Bosch | Added oneDayPayment option |
| 2 | 2025-09-16 | Y Geldenhuys | Enhanced loadBatch — option to submit batches without creating a supplier. Added list of participating PayShap banks |