Payment Reference Number API

Last modified
On this page

API Description

The Payment Reference Number API allows software users to request a Payment Reference Number (PRN) for a specific payment that will be credited to the intended tax return lodgment.

A PRN can be generated based on information provided.

  • Transaction ID for a specific lodgment.
  • Role Type Code identifies the tax role obligation associated with a specific tax account.

Use Cases

OECD PRN High Level Flow - Use transaction ID of the lodgment and role type code to get a Payment Reference Number for paying the tax liabilities to ATO.

The Payment Reference Number API can be used to obtain a Payment Reference Number (PRN) associated to a liability for a specific transaction.

Scenario 1: Client Application Software calls ATO API to lodge a tax return which will retrieve a PRN associated to a liability for the lodgment transaction using the Payment Reference Number API. 

Example: Lodging Entity lodges a Global and Domestic Minimum Tax Return using client application software which consumes ATO APIs (Global and Domestic Minimum Tax Return API, Global and Domestic Minimum Group Entity Tax Return API).

OECD PRN Scenario 1 - Client application software calling ATO Global and Domestic Minimum Group Entity Tax Return API which will consume ATO Payment Reference Number API to get a PRN for making payment to ATO for the tax liabilities reported.

In the Global and Domestic Minimum Group Entity Tax Return API, when the entity has a liability, the API will send a request to the Payment Reference Number API to obtain a PRN for the Group Entity to make a payment to the ATO via the existing payment channels. The PRN obtained will be included in the response of the Global and Domestic Minimum Group Entity Tax Return API.

Scenario 2: Payment Reference Number API is used as a standalone API to retrieve a PRN that is associated to a liability for a specific transaction.

OECD PRN Scenario2 - Make a Standalone Call to ATO Payment Reference Number API.

Provide transaction ID of the lodgment transaction and the tax account role type code in the request to the PRN API. A PRN will be returned for payment to ATO for the tax return lodged.

Scopes

ato.apGlobalDomesticMinimumTax

Rate Limit

Not Applicable

Response Messages

For response messages specific to the Payment Reference Number API, see Payment Reference Number API - response messages.

For response messages common to all the APIs available in our API Catalogue, see Common response messages.

Release Notes

API Version: 0.1.3

  • Release date: 21 Nov 2025 (Sandbox)
  • Description: Initial release for testing.

Go back to Global and Domestic Minimum Tax