Payment Management (PMTMGT)

Payment Management is a sub-domain of Obligation Management (OBLMGT). This page contains information and artefacts for Digital Service Providers (DSPs) who have or are interested in developing web services that enable a business or their intermediary to manage their payments to the ATO. The services described below are only deployed on the SBR ebMS3 platform.

For ease of use, services have been organised into the following business processes:

  • Set or cancel a direct debit – Allows users to request for the ATO to initiate a single direct debit (DD) of a client's nominated bank account where a Direct Debit Authority is already be in place or to cancel a single DD without cancelling the Direct Debit Authority.
  • Evaluate a payment plan – Allows users to view accounts eligible for payment plans, view an active plan, calculate a plan for a specified account and submit a payment plan.
  • Generate payment reference number – Allows users to proactively manage their debt by providing the ability to generate PRN details for available accounts and roles.

The ATO provides a number of common artefacts and reference documents to support DSPs (such as the ATO Service Registry and the ATO Service Support Versioning Strategy). These can be found here.

Set or cancel a direct debit

Direct Debit (2018)

Service Version 0003.2018
Service Actions Add – Allows authorised parties to request the ATO to initiate a single direct debit of the client’s nominated bank account for selected accounts/role, where a Direct Debit Authority is already recorded. This service will not add a direct debit authority.

Cancel – Allows authorised parties to cancel a previously requested single Direct Debit. This service does not cancel the Direct Debit Authority.
Name Version number Status Size Published date
ATO DD.0003 2018 Package v1.0 Contents.docx 1.0 Final 226KB 30 August 2018
ATO DD.0003 2018 Package v1.0.zip 1.0 Final 2.33MB 30 August 2018

Direct Debit (2016)

Service Version 0002.2016
Service Actions Add – Enables authorised parties to request the ATO to initiate a single direct debit of the client’s nominated bank account and also the ability to cancel a previously requested single direct debit.

Cancel – Allows for a cancellation of a previously requested single Direct Debit and does not cancel the Direct Debit Authority.
Name Version number Status Size Published date
ATO DD.0002 2016 Package v1.3 Contents.docx 1.3 Final 232KB 20 September 2018
ATO DD.0002 2016 Package v1.3.zip 1.3 Final 572KB 20 September 2018

Back to top

Evaluate a payment plan

Service Suite:  Payment Plan (PMTPLN) 2017

Service Name:  Payment Plan Eligibility (PMTPLNELG)

Service Version 0002.2017
Service Actions

List – Allows a request for a client or a specified account the:

  • eligibility to create a new payment plan, including available payment plan options; and
  • payment plan identifier for existing active payment plans.

Service Name:  Payment Plan (PMTPLN)

Service Version 0002.2017
Service Actions

Get – Allows a request to view a payment plan for a specified payment plan ID (e.g. instalment amounts (including GIC), due dates, Payment plan ID, total estimated GIC for payment plan).

Calculate – Allows a request to calculate a payment plan schedule, including the GIC payable under the payment plan, for a specified account. Requesting the calculation multiple times with different input parameters (e.g. instalment amounts, frequency) allows the impact on the GIC amount payable for a payment plan to be determined.

Submit – Allows a request to create a payment plan for a specified eligible account. The payment plan details include the payment plan amount, start date, end date, payment frequency, instalment amounts, and payment method.  The Payment reference number and Payment plan ID are also returned.

Name Version number Status Size Published date
ATO PMTPLN Business Implementation Guide.docx 2.0 Final 268KB 15 February 2018
ATO PMTPLN 2017 Package v0.2.1 Contents.docx 0.2.1 Draft 239KB 23 August 2018
ATO PMTPLN 2017 Package v0.2.zip 0.2 Draft 5.17MB 07 December 2017

Back to top

Generate payment reference numbers

Service Name:  Payment Reference Number (PRN)

Service Version 0001.2016
Service Action Get – Allows retrieval of a payment reference number (PRN) for selected accounts/roles.
Name Version number Status Size Published date
ATO PRN 2016 Business Implementation Guide.docx 1.0 Final 224KB 16 November 2017
ATO PRN.0001 2016 Package v1.3 Contents.docx 1.3 Final 221KB 15 November 2018
ATO PRN.0001 2016 Package v1.3.zip 1.3 Final 448KB 15 November 2018

Back to top


SBR ebMS3 webservices artefacts

The Australian Taxation Office has developed an ebMS/AS4 implementation extending on the SBR initiative to simplify Business to Government reporting obligations and aligning with the messaging standards chosen for Superannuation Reform. While this implementation replaces the existing SBR message wrapping, it does not replace the eXtensible Business Reporting Language (XBRL) body provided in SBR web services, in fact the ATO implementation of the new system reuses the existing SBR XBRL message body for the majority of the services provided in the new format.

The following information describes how to implement web services consuming the ebMS3/AS4 messaging standard (SBR ebMS3). 

  • SBR ebMS3 web service implementation guide
    The SBR ebMS3 web service implementation guide (WIG) describes common technical components and services that are re-used by all business services. The common services include whole of government gateways that expose services and supports the protocol for message exchange, standard message types, standard response time service levels, standard message structures, a security token service, and a standardised approach to handling business error conditions and transport exceptions.

    There is a separate SBR Core Services WIG. 
  • SBR ebMS3 software developer kit guide
    The SBR ebMS3 software developer kit (SDK) guide identifies the key components and functionality that comprise the SDK solution. Some of these components are re-used from the previously released SBR Core Services SDK and hence the reader is pointed to the reference for existing documentation. For the new components, this document will outline the usage details and the API specification (where applicable).
Name Version number Status Size Published date
SBR ebMS3 Web Services Implementation Guide.docx 1.7 Final 1.96MB 14 December 2017
SBR ebMS3 SDK Developer Guide.docx 1.3 Final 1.80MB 18 June 2015
Last updated: 
15 November 2018
Page ID: 
344