Overview

📘

Please note

NPP and PayTo apply to Australia only. For platforms operating in the UK, refer to the Bank-to-Bank Transfers guide.

This section lists all APIs to provide additional details about a payment.

  • Transaction Supplementary Data API - This API provides additional details for successfully reconciled NPP and DE payments.
  • Failed NPP Payment Details - This API provides details for failed NPP PayTo payments.

📘

API Testing

Transaction supplementary data API is enabled in Pre-live environment only for NPP pay-ins. However, in production environment, the API returns supplementary details for both NPP and DE pay-ins.

As a prerequisite to using these APIs, please make sure you have:

  • implemented and migrated over to our OAuth authentication framework.

Specifications

This section contains specifications in JSON and YAML formats.