Commonwealth Bank/BPoint Merchant Setup

Commonwealth Bank/BPoint Merchant Setup

Commonwealth Bank/BPoint Merchant Setup

Overview

CommBank BPoint is a PCI-DSS compliant payment gateway by the Commonwealth Bank of Australia. The Transvirtual integration enables secure invoice payments via:
  • Online payments in the Transvirtual portal using saved (tokenised) cards
  • Email payment links that redirect customers to BPoint's Hosted Payment Page (HPP)
  • Automated and manual payments for Prepaid accounts
  • Invoice Payment widget (portal/web) flows
Key capabilities:
  • Card tokenisation: card data is never stored in Transvirtual, only tokens
  • Invoice email payment links: customers can pay without logging in
  • Auto-debit for due invoices with prior saved tokens
  • Prepaid top-ups and auto top-up support
Known limitations:
  • HPP email payments do not save card details (one-time payments)
  • AUD only
  • No SMS payment links
  • Refunds are processed outside Transvirtual
  • Failed payments from HPP cannot be fully logged in Transvirtual; failures are logged when payments are initiated in Transvirtual

Before You Begin

Ensure you have:
  • A CommBank BPoint merchant account, with:
    • Merchant Number
    • Biller Code
    • API Username
    • API Password
  • Transvirtual admin access to configure Merchant (Payment Provider) settings
Note: credential validation may occur during transaction attempts rather than at form save. Ensure values are correct to avoid failed payments.

Part A: Enable BPoint as a Payment Provider

Add BPoint in Global Setup
  1. In Transvirtual, go to Settings > General > Global Setup > Merchant/Payment Setup.
  2. Select "CommBank BPoint" from the list of supported merchants and add the following details:
    1. Merchant Number
    2. Biller Code
    3. API Username
    4. API Password
  3. Save the configuration.
Note: once validated, the API Password will not be displayed back in the UI.

Part B: Tokenised Cards and Portal Payments

Allow customers to add a card (tokenisation)
Customers can store a tokenised card in Transvirtual to speed up invoice payments and enable auto-debit.
  1. From the customer portal or admin: Configuration > Credit Cards > Add Credit Card.
  2. The customer completes card entry on the HPP; BPoint sends a webhook including tokenised card details.
  3. Transvirtual saves the token; the card appears as available for future payments and auto-debit.
Pay an invoice in Transvirtual with a saved card
  1. Open an Approved & Locked invoice. Go to the Credit Card tab.
  2. Select an existing saved card token (Transvirtual displays masked digits only).
  3. On success, Transvirtual marks the invoice paid and stores the receipt/transaction details. On failure, an error is shown and logged.
Best practice: default to the card last used by the customer to minimise selection friction; always reconfirm before charging.
BPoint supports secure invoice payment via a link embedded in invoice emails. Customers can pay without logging in; cards used via the HPP link are not saved.
Generate and send invoice payment links via Email Export
  1. Go to Import/Export > Invoices > New Rule.
  2. Name the rule and select Export Framework = Email.
    1. Trigger Period = Every 2 mins (default)
    2. Enable Export = Yes
    3. Data Filter = InvoiceState = 'ApprovedLocked'
  3. Click Settings next to the Email framework and choose recipients (e.g. invoice contact).
  4. In the Email Body, insert the placeholder @Model.InvoicePaymentLink. This is populated by Transvirtual using BPoint's HPP configuration API.
  5. Save the Email Settings and update the export rule.
Customer experience
  • The customer receives the invoice email and clicks the payment link.
  • They are redirected to BPoint HPP to enter card details and pay.
  • On completion, BPoint sends a webhook to Transvirtual; Transvirtual updates the payment status and displays a static success/failure page.
Important: card details entered via the email link HPP are not saved. If an invoice is revised and re-issued, generate and send a new link; previous links are not updated.

Part D: Auto-Debit and Prepaid

Enable auto-debit for invoices
  1. Ensure the customer has an active tokenised card saved (see Part B).
  2. Enable auto-debit on due date within the customer's finance settings.
  3. Transvirtual processes payments on the due date using stored tokens.
Note: consent capture for auto-debit is out of scope. Configure notification emails to advise customers of successful auto-debits.
Prepaid accounts and auto top-up
  1. In the customer's Finance tab, enable Prepaid.
  2. Attach a tokenised card to the account.
  3. Optionally enable Auto Prepaid Top-up: set a threshold and top-up amount.
  4. Use the manual transaction tool to top up on demand; print statements as required.

Part E: Widgets (Invoice Payments)

  1. Go to Settings > General > Global Setup > Website Widgets > View/Test Website Widget Configuration.
  2. Open "Invoice Credit Card Payment" (or the Bootstrap variant) to test.
  3. Enter an invoice number and follow the payment flow (supports BPoint when configured as the merchant).