The push notifications service is a daily file transfer service from Inland Revenue. It provides software with an overnight notification of changes to return status for intermediaries and customers using their software.
About push notifications
The push notifications service uses Secure File Transfer Protocol (SFTP) to provide software with notifications of changes to return status.
This service is currently only available for income tax.
We expect to extend this service in future to accommodate additional notification types.
If you have any questions about this service or using gateway services, email GatewayServices@ird.govt.nz
Software developer kit (SDK)
Download the push notifications software developer kit and sample files to:
- find out technical requirements and specifications
- view the processes and data definitions for the sample payloads.
Use the Getting started guide to find out how to access our sandbox (mock services) and test environments.
Push notification service business use cases
The following are examples of sequences of the gateway services and operations that could be used to achieve a specific business outcome. The numbers for each use case are the order in which these operations should be called when using this services.
|Number||Use case||Return service/file operation||Push notification service|
|1||Submit a new income tax return, then at a later date receive a push notification that status updates are available for the return||1||2|
|2||Amend an income tax return, then at a later date receive a push notification that status updates are available for the return||1||2|