How this can help your business
Billers can generate CRNs, iCRNs and QR codes to include on digital, paper or email invoices.
Service Providers can integrate this API into their own software to allow their customers to generate CRNs or iCRNs. Examples include CRM systems and accounting packages.
Removes the need for Billers to build and maintain their own systems for generating CRNs or iCRNS.
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 Customer Reference Numbers (CRNs), Intelligent CRNs and QR codes.
Integrate the API directly into their own invoice generation software to validate billers, create CRNs or QR codes.
Endpoints
GET /crncheckdigitrules
This endpoint provides a list of the available rules that can be used to generate a Check Digit. Users may call this service for clarification of Check Digit naming conventions that will be required as input to the /crncheckdigitrules/{crncheckdigitrule} or /crncheckdigitrules/{crncheckdigitrule}/crns endpoints.
GET /crncheckdigitrules/{crncheckdigitrule}
This endpoint returns details of the Check Digit Rule specified by the user including any alternative names for this Rule. Users can use the output of this endpoint when generating requests for CRNs.
POST /crncheckdigitrules/{crncheckdigitrule}/crns
This endpoint returns the CRN for the specified Check Digit rule. Users are to provide the base for the Customer Reference Number. To ensure the CRN will be valid at the time of payment, CRNs generated will be in accordance with the Check Digit rules nominated against a Biller Code.
POST /crncheckdigits/biller/{billercode}
This endpoint returns CRNs/iCRNs for the nominated Biller Code and base Customer Reference Number. To ensure the CRNs/iCRNs will be valid at the time of payment, CRNs/iCRNs generated will be in accordance with the Check Digit Rules and any Validation Rules nominated against an active Biller Code.
GET /validationrules
This endpoint returns a listing of all available Validation Rules. Users can use the output of this endpoint when generating requests for CRNs.
GET /validationrules/{validationRule}
Details of specified Validation Rule.
GET /icrncheckdigitrules
This endpoint provides a list of the available rules that can be used to generate an intelligent Check Digit. Users may call this service for clarification of intelligent Check Digit naming conventions that will be required as input to the /icrncheckdigitrules/{icrncheckdigitrule} or /icrncheckdigitrules/{icrncheckdigitrule}/icrns endpoints.
GET /icrncheckdigitrules/{icrncheckdigitrule}
This endpoint returns details of the intelligent Check Digit Rule specified by the user. Users may call this service to fully understand the workings of their chosen intelligent Check Digit Rule.
POST /icrncheckdigitrules/{icrncheckdigitrule}/icrns
This endpoint returns the iCRN for the specified Check Digit rule. Users are to provide the base for the intelligent Customer Reference Number. To ensure the iCRN will be valid at the time of payment, iCRNs generated will be in accordance with the Check Digit rules nominated against a Biller Code.
POST /bills
This endpoint generates a valid BPAY CRN and BPAY bill details, including a QR Code. To ensure the CRN will be valid at the time of payment, CRNs generated will be in accordance with the Check Digit Rules and any Validation Rules nominated against a Biller Code.
Branding Requirements
A BPAY logo or wordmark needs to be used where this API is consumed.
Refer to the Brand Guidelines for more information.