Restrictions, Performance & Best Practice


We aim to make our API as fast and accessible for our users as possible. Due to the fact that we have no real control over how you choose to make use of the API we have put in place appropriate restrictions to prevent inefficient and redundant requests to our API. 

The following items are returned in each response’s headers:

X-Rate-Limit-Limit - The number of requests allowed in the current period

X-Rate-Limit-Remaining - The number of requests remaining in the current period

X-Rate-Limit-Reset - The number of seconds left in the current period


The below limits should be observed and are amended from time to time. 

Item Lower Limit Upper Limit*
Rate Limit 20 requests per 60 seconds 40 request per 60 seconds
Selecting Records 1,000** 1,000**
Submitting Records 1,000** 1,000**
Create Customer 5,000 per day 20,000 per day
Create BPAY CRNs 5,000 per day 20,000 per day
Create Debit Batches 5 per day 10 per day
Create Debit Instructions 5,000 per day 20,000 per day
Max Instructions per Batch 5,000 9,999


* Increases to the upper limit are made on a case by case basis.

** If you need to select or submit more than 1,000 records you should separate into multiple requests.


Recommended processing times

We recommend scheduling batch processing of information to take place between 4am to 4pm AEDST, Monday to Saturday. 

Where possible avoid scheduling batch processing of information between 8pm and 3am to avoid issues with timezone differences, interbank processing of information and interruption of service due to urgent upgrades.



To get the best performance from the API it is advisable to always:

- Use filters to narrow down search results.

- Explicitly state which fields you want returned when selecting records.

- Always create Debit Instructions in batches (up to 1,000 per request).

- Use the controller (/debit_instructions_failed) to obtain debit failures for handling in your local system.

- Acknowledge debit fails in batches (up to 1,000 per request) ie (/debit_instructions/{code},{code}/ackfail)


Have more questions? Submit a request