Generate BPAY Batch File
A simple way to save time and operational costs when making multiple invoice payments.
This API allows customers to validate a set of BPAY Payments to generate a BPAY batch file ready for upload in the format specified by their financial institution1.
This API currently generates batch files in CBA, NAB, Westpac, Macquarie, Bankwest and Bendigo Bank formats.
How this can help your business
Removing the need to manually enter BPAY Payments into online banking by generating a batch payment file for submission to your financial institution.
Batch payers can integrate this API directly into their own software to generate BPAY batch files for processing through their financial institution.
Service Providers can integrate this API into their own software to enhance functionality for Batch Payers. Examples include accounting packages and real estate management tools.
Eligibility
In order to use the BPAY Group APIs, other criteria must be met, such as providing an ACN, ABN or ARBN.
For full requirements, please see the Production Request.
For more information on how your organisation can access the APIs, check your Eligibility.
Approved Purpose
To generate a Batch File in the format specified by a Batch Payer Institution.
Integrate the API directly into your own software to enhance existing functionality or create new functionality for customers.
Endpoints
POST /generatebatchfile
Generate a BPAY Batch File for a set of BPAY Payments in a format ready for upload to the specified Financial Institution.
Branding Requirements
A BPAY logo or wordmark needs to be used where this API is consumed.
Refer to the Brand Guidelines for more information.
The Generate BPAY Batch API can be used to create the batch file which you can submit to your financial institution to make BPAY Payments. BPAY Payments cannot be made through Generate BPAY Batch API. Your use of BPAY payments is governed by separate arrangements with your financial institution.