Change log

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

The format is based on Keep a Changelog.

2025-10

Added

• applePayToken to the Singe-use-tokens API request model to support Apple Pay in an App.

2025-09

Added

• PayID API
• PayID transaction details and search support for the Transactions API.
• PayID payment refund support for the Transactions API.
• payToAccount to the Transaction Response Model.
• payToBillerAccount to the Transaction Response Model.
• PayID Webhooks
• PayID column to the CSV transaction report.
• googlePayToken and displayAccountNumber to the Singe-use-tokens API request model to support Google Pay in an App.

Changed

• PayTo End to End ID column heading in the CSV transaction report to End to End ID.
• PayTo Remittance Information 1 column heading in the CSV transaction report to Remittance Information 1.
• PayTo Remittance Information 2 column heading in the CSV transaction report to Remittance Information 2.

2025-05

Changed

• For the Transactions API, entryMode is now required and usage may also be required when entryMode is STORED_CREDENTIAL. However, this will be backwards compatible for existing customers. See Stored credential data request model.

2025-01

Added

• Download CSV PayTo Agreements report.

2024-07

Added

• agreementCreationType to the PayTo Agreements API.
• agreementCreationType to the PayTo Agreement Model.

2024-05

Added

• payToAgreement to Take payment requests to support e-Commerce or Once-off PayTo payments.

2024-01

Added

• PayTo Agreements API
• PayTo transaction support for the Transactions API
• PayTo Webhooks
• supplierBusinessCode to Transaction Response Model.

2023-10

Added

• Additional column added to the Transaction CSV Export V2
  • Merchant Routing Result

2023-02

Added

• mpgsData object to Transaction Request Model.
• debtRepayment field to Transaction Request Model and Transaction Response Model.
• debtRepayment and merchantAdviceCode fields to Transaction Response Model.

2022-09

Added

• threeDS2 boolean request body property to the following resources:
  • Take payment
  • Pre-authorisation
  • Account verification
  • Register account
  • Register account without customer details
  • Generate token
• threeDS2 boolean property in ConfigObject provided to createTrustedFrame
• browserProfile object property in the Generate token request body.
• threeDS2 and threeDS2Status properties to the Generate token credit card response model
• 3D Secure Authentication
  • Use POST /v1/single-use-tokens/{singleUseTokenId}/three-ds2-authentication.
  • See the documentation.
• 3D Secure Challenge Frame to the QuickStreamAPI.creditCards module.

Changed

• Deprecated Custom Form.

2022-05

Added

• Added mpgsData to Take payment requests to support merchants using Mastercard Payment Gateway Services.

2021-11

Added

• Added customButton to Payment Request Button module in QuickStream-API.js to override the default Apple Pay and Google Pay buttons.
• Added onInitialise callback function to Payment Request Button module in QuickStream-API.js which returns a PaymentRequestInitialisedObject to indicate if Apple Pay or Google Pay is configured for your facility and available to the client.

2021-09

Added

• Added Payment Request Button module to QuickStream-API.js to enable Apple Pay and Google Pay acceptance.
• Added schemeTokenisation for Register account requests when using Scheme Tokenisation.
• Added cvn field to the Card account request model for Register account requests when using Scheme Tokenisation.

2021-08

Added

• Added Stored credential data request model for
  • Take payment,
  • Pre-authorisation,
  • Capture pre-authorisation, and
  • Account verification.

2021-04

Added

• Additional column added to the Transaction CSV Export V2
  • Payment Schedule Code

2021-03

Added

• Support for processing transactions with digital wallet accounts
  • See the documentation
• Digital wallet fields added to credit card response
  • walletProvider
  • panType
• Additional columns added to the Transaction CSV Export V2
  • Wallet Provider
  • Pan Type

2020-03

Added

• Additional column added to the Transaction CSV Export V2
  • Card Issuing Country
• Get card scheme surcharge rate helper method added to Custom Form
• Register account against business without customer details
  • See the documentation

2020-02

Added

• Added New Zealand bank account support to Accounts API, Customers API, Single Use Tokens API and Transactions API.
• List transactions by New Zealand bank account.
  • Use GET /v1/transactions/for-nz-bank-account.
  • See the documentation.
• Take payments from a New Zealand bank account.
  • Use POST /v1/transactions.
  • See New Zealand bank account request model and response model.

2020-01

Added

• Register account without customer details
  • Use POST /v1/accounts.
  • See the documentation.
  • See the tutorial.
• customerId property to the Customer Account Model.

2019-11

Added

• List returned Australian bank account transactions for a given date.
  • Use GET /v1/transactions/returns.
  • See the documentation.

2019-08

Added

• IP address validation on requests to this API.
• Secret API Key business restrictions.
• Developer? Create a QuickStream REST API test facility.
• View the REST API developer log to view requests from your system and responses from this API.

2019-04

Added

• Tutorials and troubleshooting for common scenarios.

2018-11

Added

• List open pre-authorisations.
  • Use GET /v1/transactions/open-preauths.
  • See the documentation.

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.
  • See the documentation.
• Perform an initial pre-auth transaction.
  • Use POST /transactions with a transactionType of PREAUTH.
  • See the documentation.

Changed

• Deprecated token field in data provided to callbacks in Trusted Frame and Custom Form Javascript in favour of using the single-use-token response 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.
  • Use POST /v1/payment-files to upload a payment file in one of the available formats.
  • See the documentation.
• 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.
  • See the documentation.
• Released Custom Form to seamlessly integrate bank account forms directly onto your website using QuickStream-API.js.
  • See the documentation.

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.
  • See the documentation.

2017-08

Added

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

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.
  • See the documentation.
• 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.
  • See the documentation.

v1.0

Added

• Initial release of v1.0.