Accept BPAY payments (Australia only) - Partner software managed payment page

Introduction

This guide will demonstrate how to implement our BPAY payment offering.

API steps to implement BPAY as a payment method to your user

1. Create a payer record - POST Add a new Payer

2. Assign a CRN to the specify payer - POST a CRN to an existing Payer or via POST and assign new CRN

   1. This function POST and assign new CRN can be used to generate and assign a new BPAY CRN or iCRN. The iCRN allows for restricting a BPAY payment to a due date, amount or both.

3. This will return a billercode and CRN

4. Your application can then supply the billercode and CRN to your customer

Note - Payment via BPAY is a customer initiated transaction and payment is not processed until the customer actively initiates the payment from their online banking.

If you are interested in using the iCRN feature (Intelligent Customer Reference Number) you will need your own Biller Code. Should you need assistance, please contact your Partner Manager and they can assist you.

BPAY branding

BPAY has branding guidelines on how the BPAY and BPAY View logos and word marks need to appear in various mediums, refer to their guidelines here: BPAY Branding Guide 

 Q: How to determine the result of the transaction for a BPAY payment?

• Call our GET Search for transaction status changes around 9AM AEST daily which will pull a set of all transactions for your business that have had a change of transaction status.

• Following the above API, call our POST Acknowledge transaction status change to acknowledge the transactions and remove them from the data set when you next call the Get New Status Search above. If the transaction status changes again after you have removed it from the data set, it will be returned in the GET Search for transaction status changes to notify you of the change in status.

• BPAY transactions are typically a next day response if processed before 3PM. If the BPAY transaction is initiated after 3PM, the result will be returned the day after next.

  • e.g. BPAY querystring

    

The result of a BPAY transaction will be returned the following day if the BPAY transaction was initiated prior to 3PM AEST.