Introduction
Welcome to Kwik's API documentation
Notes
- API endpoints are RESTful GET/POST HTTP requests
- Body type must be
application/json
- All API calls made must include the authorization key in the header of the call.
- Requests to the API will be limited to 100 requests per second to reduce the load on the platform.
- Dates are to be specified as 'YYYY-MM-DD'
- Timestamps are specified as 'YYYY-MM-DD HH:mm:ss' GMT+2 (South African Standard Time)
Path
Staging
https://staging.app.kwik.co.za/1.0/
Live
https://api.kwik.co.za/1.0/
Authentication
Follow the ‘Basic Authorization’ standard, below is an example:
const hexString = Buffer.from(`${api_key}:${api_secret}`).toString('base64');
const headers = {
'Authorization': `Basic ${hexString}`,
};
Staging Bank Account Numbers
These testing bank account numbers can be used in the staging
environment when creating payments.
EFT Debit Order Payments
Payment status changes can be made from the dashboard or via API payment status update API call.
Bank | Branch Code | Account Type | Account Number | Resulting Transaction Status |
---|---|---|---|---|
Standard Bank | 051001 | Current/Cheque | 00302481214 | Sent to Bank |
Standard Bank | 051001 | Current/Cheque | 10004301097 | Rejected by Bank |
Standard Bank | 051001 | Current/Cheque | 10004301100 | Paid |
Standard Bank | 051001 | Savings | 10004291601 | Unpaid |
Standard Bank | 051001 | Savings | 00302481206 | Cancelled |
Standard Bank | 051001 | Savings | 00243663005 | Disputed |
ABSA | 632005 | Current/Cheque | 04047527520 | Reversed |
ABSA | 632005 | Current/Cheque | 04047530660 | Accepted by bank |
ABSA | 632005 | Current/Cheque | 04047527350 | Rejected by Bank |
ABSA | 632005 | Savings | 09050677010 | Paid |
ABSA | 632005 | Savings | 53011389310 | Unpaid |
ABSA | 632005 | Savings | 09050717030 | Cancelled |
FNB | 250655 | Savings | 62001541061 | Disputed |
FNB | 250655 | Savings | 62001909467 | Reversed |
FNB | 250655 | Savings | 62001872440 | Paid |
If you use any other bank account number the resulting transaction status will be 'Pending'.
DebiCheck Payments
The cellphone number used on the payment will not receive a notification, this notification will only be sent on the live environment, instead a resulting payment status is simulated as shown below:
Bank | Branch Code | Account Type | Account Number | Payment Status | Resulting Transaction Status |
---|---|---|---|---|---|
Standard Bank | 051001 | Current/Cheque | 00302481214 | Pending | No transactions generated |
Standard Bank | 051001 | Current/Cheque | 10004301097 | Stopped + Rejected message | No transactions generated |
Standard Bank | 051001 | Current/Cheque | 10004301100 | Running | Paid |
Standard Bank | 051001 | Savings | 10004291601 | Running | Unpaid |
Standard Bank | 051001 | Savings | 00302481206 | Cancelled | No transactions generated |
Standard Bank | 051001 | Savings | 00243663005 | Paused | No transactions generated |
ABSA | 632005 | Current/Cheque | 04047527520 | Stopped + No reply message | No transactions generated |
ABSA | 632005 | Current/Cheque | 04047530660 | Pending | No transactions generated |
ABSA | 632005 | Current/Cheque | 04047527350 | Stopped + Rejected message | No transactions generated |
ABSA | 632005 | Savings | 09050677010 | Running | Paid |
ABSA | 632005 | Savings | 53011389310 | Running | Unpaid |
ABSA | 632005 | Savings | 09050717030 | Cancelled | No transactions generated |
FNB | 250655 | Savings | 62001541061 | Paused | No transactions generated |
FNB | 250655 | Savings | 62001909467 | Stopped + No reply message | No transactions generated |
FNB | 250655 | Savings | 62001872440 | Running | Paid |
If you use any other bank account number the resulting payment status will be 'Pending' or 'Stopped' with 'no reply from debtor' payment failed at reason. DebiCheck transactions can not be disputed UNLESS you allow payment tracking and failed transactions are re-submitted. Refer to EFT debit order payments for testing all possible transaction statuses.