Along with credit cards and PayPal, BPAY is a widely accepted form of payment online.  By following the steps below, Customer Self Service can be configured to accept BPAY payments from customers.

BPAY logo and sample payment info

Step-by-step guide

To enable BPAY at the System level:

  1. As Administrator, in the CMS, navigate to Settings → Settings → Credit Cards (on your site: /zSettings.aspx).
  2. Click the Orders tab.
  3. Click the Credit Cards tab.
  4. Tick the flag 'Allow BPay Payment'.
  5. Tick the flag 'Hold BPay & EFT Payments', if required.
    • Holding BPay payments ensures a Cash Receipt is not created until the payment is released in the 'Release Payments' screen (see How to release EFT and BPAY Payments for instructions).
  6. Enter your 'BPay Biller Code' (obtained directly from BPAY).
  7. Tick the flag 'Auto Integrate BPAY EFT Order Payments', if required.
    • Automatically integrating BPay payments means the sales order will not be held until the payment is released via 'Release Payments'. 
  8. Click the 'Update' button to save changes.

Once the functionality is enabled, every BPAY transaction will require a Biller Code and a Reference:

  • The Biller Code is your organisation's unique ID, obtained directly from BPAY.
  • The Reference can be sourced in one of two ways: 
    1. Receipt Number = the web order number + a system-defined check digit. This will produce a unique reference for every order payment. This method is the default.
    2. Customer Defined = a value from the BPayReferenceNumber field, which is stored against the customer record online. This field can be maintained via 'Customer Maintenance' or integrated from PRONTO. The reference number will always be the same based on the customer. 

Customer Defined BPAY Reference numbers can be enabled at the Role level. For example, your organisation may decide that wholesale B2B customers each have their own BPAY Reference, whilst Public B2C customers use the system-generated reference.  (The system will default to the Receipt Number method if the role flag is not set.)

Step-by-step guide

To Set the BPAY Reference Source at Role Level:

  1. Login as an Administrator.
  2. Navigate to Accounts → Role Management (on your site: /zRoles.aspx).
  3. Select the required role via radio button.
  4. Click the Functions tab.
  5. Click Modify.
  6. Update the setting BPAY Reference Source by selecting from the drop-down list:
    1. Receipt Number
    2. Customer Defined
  7. Click OK to save. 
    Role Management - BPAY Reference Source 


The above BPAY Reference sources apply to order payments only. For invoice/account payment, the BPAY Reference will be a system-generated receipt number, taken from the Customer Payments table.

If Customer Defined References are to be used, they will need to be maintained at the Customer level.

To Set the BPAY Reference Number for a Customer: 

  1. Login as an Administrator. 
  2. Navigate to 'Accounts' --> 'Customer Maintenance' (/CustomerMaintenance.aspx?mode=admin)
  3. Search for the required customer.
  4. Click the 'Customer Details' tab.
  5. Click 'Modify'.
  6. Enter the customer's reference in the field 'BPAY Reference Number'
  7. Click 'OK' to save. 
    Customer Maintenance - BPAY Reference Number 

Related help