Changelog

Release Notes

All notable changes to this project will be documented in this article.

18 Sept 2026

API Reference

• Added - New payment method guide for BPAY.
• Added - Add BPAY integration to Payment Request for resource POST /paymentrequests, and request and response example for BPAY.
• Added - Add BPAY request and response example for query transactions GET /transactions and retrieve transaction GET /transactions/{id}.

30 July 2026

API Reference

• Added - Payment Instruments resource (/paymentinstruments) with endpoints to Create, Query, Retrieve, Update, Attach, and Detach payment instruments, supporting card, wallet, token, bank account, and payment agreement instrument types.
• Changed - Updated endpoint summaries for Create, Retrieve, and Update payment instrument operations under customer (/customers/{id}/paymentinstruments).
• Added - fingerprint field to payment instrument schemas and response metadata, providing a stable identifier derived from the underlying card, bank account or PayID.
• Changed - Clarified that customer.id is optional for PMIT (Merchant Initiated Transactions) in the transaction request schema description.
• Added - PMIT purchase example without customer.id to Process a Transaction request examples.

Documentation

• Added - Customer and PMIT Workflow guide covering both the existing PMIT under customer flow and the PMIT flow, including attach-to-customer as an optional step.
• Changed - Updated Key Concepts to add a Fingerprint section explaining deduplication, linking payment activity, and instrument-level tracing use cases.

22 June 2026

API Reference

• Changed - Updated Calculate a Surcharge endpoint description to clarify that surcharging is only available for New Zealand merchants and is not available for Australian merchants.

Documentation

• Changed - Updated Surcharge and Surcharge Flow guides to state that surcharging is only available for merchants operating in New Zealand (Card Present and Card Not Present), and is no longer available for merchants operating in Australia, in accordance with the RBA mandate.

17 June 2026

API Reference

• Added - accountName to bank account models and examples for Direct Debit payment instruments.
• Changed - Updated bank account terminology from payee to payer in relevant OpenAPI bank account descriptions.
• Added - Validation response code V10133 (body_bankaccount_accountname_invalid).

Documentation

• Changed - Updated Direct Debit Flow to document accountName requirements and include accountName in AU/NZ request and response examples.
• Added - Added V10133 (body_bankaccount_accountname_invalid) to Validation Response Codes.

11 June 2026

API Reference

• Added - hostedPaymentPage object to Create a Payment Request — supports Hosted Payment Page (Paylink) flows including line items, adjustments, expiry, merchant branding, and redirect configuration.
• Added - remainingAttempts field to Payment Request responses.
• Added - LineItem, Adjustment, HostedPaymentPageRequest, and HostedPaymentPageResponse schemas.

Documentation

• Added - Payment Links guide covering how to generate a Paylink, link expiry, payment attempts, status lifecycle, and image URL constraints.

14 May 2026

API

• Added - bankName field in the metadata object of the Bank Account Instrument response. The bank name is automatically resolved from the BSB number during instrument creation.

11 February 2026

Documentation

• Added - Pay UI: Tokenisation guide to include information on how to create a payment instrument when generating a PayUI transaction.

02 February 2026

Documentation

• Added - Pay UI: New drop-in payment form that can be embedded into your website to quickly get you started to accept payments.

09 December 2025

Documentation

• Added - Omnichannel Refund process and examples.

29 August 2025

Documentation

• Changed - Updated 3D Secure Verification Flow

29 July 2025

API Reference

• Added - New resource for calulating surcharge

Documentation

• Added - Guide on Surcharge and Surcharge Flow
• Changed - Updated Secure Panel guide to include v1.1.0

3 April 2025

API Reference

• Changed - Added reports to Webhooks

18 December 2024

Documentation

• Changed - Updated Secure Panel guide to include Token and Transaction flows

12 December 2024

API Reference

• Changed - Updated reference min length to 5 characters

25 November 2024

API Reference

• Changed - Updated description max length to 140 characters for Payment Requests

18 November 2024

API Reference

• Changed - Added payment_requests to Webhooks

Documentation

• Changed - Added Payment Request to Webhooks
• Changed - Added more decline codes to Transaction Response Codes
• Changed - Added more validation codes to Validation Response Codes

31 October 2024

API Reference

• Added - Method to Update a Payment Request
• Removed - Method to Delete a Payment Request

24 October 2024

Documentation

• Added - Test scenarios for Create a Payment Request

18 September 2024

API Reference

• Added - New resource for PaymentRequestId

Documentation

• Added - Guide on PayID Overview
• Changed - Updated Payment Method Overview article to include PayID
• Changed - Updated Key Concepts article to include IDs in the API and Date Formatting

5 September 2024

Documentation

• Added - Guide on PayID Overview
• Changed - Updated Payment Method Overview article to include PayID
• Changed - Updated Key Concepts article to include IDs in the API and Date Formatting

29 July 2024

Documentation

• Added - Test scenarios for Process an In-Person Transaction and sandbox terminalId

20 June 2024

API Reference

• Added - New resource for provisioning and managing API Keys

Documentation

• Added - Guide on authentication

22 April 2024

API Reference

• Added - PayID support added to Payment Agreements

26 MAR 2024

Documentation

• Changed - Updated Webhooks article to include information on verifying webhooks using the auth header and signature.

07 Feb 2024

API Reference

• Added - Support for Direct Debit payment instruments in the customers and transactions resources.
• Changed - Re-structured the API reference to improve readability.

Documentation

• Added - Getting Started guide for testing against our Mock endpoints.
• Added - Payment Methods guides for Direct Debit Overview and Direct Debit Workflow.
• Changed - Updated Payment Methods Overview article to include Direct Debit.
• Added - Getting Started guide for testing against our Mock endpoints.
• Added - Payment Methods guides for Direct Debit Overview and Direct Debit Workflow.