Please see our documentation hub which contains copyable snippets with additional code snippets.
Payouts can be used in two ways
1. Manual upload of CSV information
2. API requests to submit batch payouts
With both methods, you would need to either maintain some funds (float) that we debit on each batch request, or make a transfer for the total amount that needs to be paid out.
How to use PayOuts?
To process a PayOuts batch a few steps are required, which are described below. To get access to the PayOuts portal and your API credentials, please send an email to email@example.com.
1. Upload a PayOuts batch
You can upload a batch with recipients to be paid out via API or via a CSV upload
- for the API documentation and Process overview here
- for the CSV file upload – you can upload a batch file to peachpay.co.za for the PayOuts. You can find a sample . CSV here
You can specify one of the two Service Types in your upload:
- SDV means that the batch is processed the same day
- 1Day means that the batch will be processed in 1 day (if uploaded Monday the batch will be paid out on Tuesdays)
After a batch is uploaded a Check Digit Verification (CDV) will be performed to check on account validity of every payout. Passing this test does not necessarily mean that the bank account is valid and open. However, failing it does mean there is no such an account (click here for more info about the CDV)
It is recommended to use the list of universal bank branch codes to avoid errors like incorrect branch codes, non-existent branch codes, etc. You can find the list here; List Of Universal Branch Codes - SA.
It is strongly recommended to do a Bank Account Verification on the first PayOut to an account. This to avoid the risk of paying out the incorrect bank account, as executed PayOuts can not be reversed (click here for more info about the Bank Account Verification).
Other Frequently asked questions about uploading a batch
2. Transfer the funds to be distributed
Transfer the sum of your PayOuts batch to our Nedbank Payout Account (this needs to be in our bank account before the platform can release the funds, so please factor in some time for interbank clearing).
You can do this in two ways:
- Transfer the exact amount per batch
- Use a float to pay out from (Click here for more information)
3. Handle the Unpaids
Unpaids are the payments returned by banks for reasons such as Account Frozen / No Account exists etc.
- If you submit via API – you will receive callback via API for unpaids
- You can also view the unpaids in our console
We will refund the funds to you on a weekly basis (every Friday currently).
The banks say that unpaids will arrive within five working days. For payments, they are usually all in by the end of day two but there are some fringe cases where this can take longer (eg. payment made to a closed account).
Other Frequently asked questions about handling Unpaids
- Is there a retry mechanism for Unpaids callbacks?
- Whitelisting IP address for PayOuts callback notifications
- How can we test unpaid notifications on our callback URL?
4. Funds reflecting in the beneficiaries account
- Batches are processed throughout the day until cut-off at 4:00 PM
- 8 PM onwards your beneficiaries will see funds in their accounts (keep in mind inter-bank delays)
Note that we can't release payment batches when the funds reflect in our account.
5. Processing over Weekends and Public HolidaysNote that there are no processing on non-business days, (weekends and Public Holidays).
* Please ensure that batches are uploaded in time for processing before weekends and Public Holidays.
* Regular processing will resume the next business working day.
A system error message will advise you to choose a different date, should the chosen date be invalid and fall on a non-processing day.