Skip to main content

Change log

All notable changes to the REST API will be documented in this file.

The format is based on Keep a Changelog.

2021-09

Added

2021-08

Added

2021-04

Added

2021-03

Added

2020-03

Added

2020-02

Added

2020-01

Added

2019-11

Added

  • List returned Australian bank account transactions for a given date.

2019-08

Added

2019-04

Added

2018-11

Added

2018-10

Added

  • Fully or partially cancel a Visa/Mastercard pre-authorisation.
  • Top-up an existing Visa/Mastercard pre-authorisation.
  • Extend an original Mastercard pre-authorisation to the maximum time frame supported by the card scheme.
  • Re-authorise an original Visa pre-authorisation that has expired after the maximum time frame supported by the card scheme.

See the documentation.

2018-08

Added

  • Capture a pre-authorisation.
    • Use POST /v1/transactions with the originalReceiptNumber of a pre-authorisation transaction to capture it.
    • See the documentation.

2018-07

Added

  • Register an account by supplying a transaction receipt number.
    • Use POST /v1/customers/{customerId}/accounts with a receiptNumber to register an account using the given transaction's payment account details.
    • See the documentation.
  • Single-use-token response includes masked account details and surcharge percentage.
  • Perform an initial pre-auth transaction.

Changed

  • Deprecated token field in data provided to callbacks in Trusted Frame and Custom Form Javascript in favour of using the single-use-token reponse object.
    • The token field is still populated in quickstream-api-1.0.min.js for backwards compatibility.
    • See the documentation.

2018-04

Added

  • Upload batch payment files and poll for the processing status.
  • Retrieve the details of payment files, including transactions.
    • Use GET /v1/payment-files/{id}/payment-batches to list the payment batches in your files.
    • Use GET /v1/payment-batches/{id}/transactions?status={code} to list transactions in a payment batch.
    • See the documentation.
  • Retrieve payment file transaction reports.
    • Use these resources if your software is compatible with these report formats.
    • Use GET /v1/payment-files/{id}/flat-file for a Flat File report.
    • Use GET /v1/payment-files/{id}/csv for a CSV report.
    • Use GET /v1/payment-files/{id}/mts-rejects for a Westpac MTS Rejects report.
    • See the documentation.

2018-01

Added

  • Register an account by supplying account details directly.
    • Use POST /v1/customers/{customerId}/accounts with a creditCard, bankAccount, or nzBankAccount object to register an account using the given details.
    • See the documentation.

2017-11

Added

  • Register an account by supplying account details directly.
    • Use POST /v1/customers/{customerId}/accounts with a creditCard, bankAccount, or nzBankAccount object to register an account using the given details.
    • See the documentation.
  • Use GET /v1/businesses/{supplierBusinessCode}/list-card-surcharges to list the credit card schemes and types you accept and their surcharge rates.
  • Released Custom Form to seamlessly integrate bank account forms directly onto your website using QuickStream-API.js.

2017-10

Added

  • Take a payment by supplying account details directly.
    • Use POST/v1/transactions with a creditCard, bankAccount, or nzBankAccount object to take a payment using the given details.
    • See the documentation.

2017-09

Added

  • Include a metadata object when taking a payment with POST /v1/transactions requests to supply extra information about a transaction.

2017-08

Added

  • Use GET /v1/recurring-payments/{paymentScheduleId}/transactions to list the payment history for a Recurring Payment.

2017-07

Added

  • Released Trusted Frame to quickly and easily "drop-in" credit card or bank account forms onto your website using QuickStream-API.js.
  • Take a payment using a customer ID.
    • Use POST /v1/transactions with a customer ID to take a payment against your customer's default account.
    • Use this when your customer has one or more pre-registered accounts and you have set a default.
    • See the documentation.
  • Take a payment using an account token.
    • Use POST /v1/transactions with an account token to take a payment from a pre-registered credit card or bank account.
    • See the documentation.

2017-05

Added

  • You can list your 20 most recent transactions using GET /v1/transactions.
  • You can list transactions suspended by Fraud Guard using GET /v1/transactions/suspended.
  • List refunds for an original transaction using GET /v1/transactions/{receiptNumber}/refunds.
  • List retried payments for an original transaction using GET /v1/transactions/{receiptNumber}/retries.
  • See the Transactions API.
  • Released Custom Form to seamlessly integrate payment or tokenisation forms directly onto your website using QuickStream-API.js.

v1.0

Added

Disclaimer

The information contained in this publication is provided for learning purposes only and is subject to change. Revisions may be issued from time to time that encompass changes or additions to this module.

This is a guide only and it is not comprehensive. It does not impinge on or overrule any formal arrangement you may enter into with the Bank. The Bank and its officers shall not have any liability for any losses of any kind incurred in connection with any action, inaction or decision taken in reliance on the information herein or for any inaccuracies, errors or omissions. In this publication references to the "Bank" are to Westpac Banking Corporation ABN 33 007 457 141 and to any of its operating Divisions, including BankSA and St.George.