Getting Started

About the API

Participants can use v2 of this API to receive B2B and B2M stop file and message acknowledgment payload validation failure alerts.

1. B2M Stop files:

   • CR: Counts change request activity for the current business day

   • CR NOTIFICATION: Counts change requests related future notification activity.

   • NSRD NOTIFICATION: Counts the number of unprocessed NSRD (5071) transactions queued in MSATS.

   • NSRD RESPONSE: Like the unprocessed NSRD RESPONSE except that it counts the change request responses due to be delivered to the initiating MDP.

   • OUTBOX FILE: Counts the number of unacknowledged outbound B2M messages and accounts for these against the receiving participant.

   • REPORT: Counts the number of unprocessed reports submitted and queued.

2. B2B Stop files:

   • OUTBOX FILE: Counts the number of unacknowledged B2B outbound messages and accounts for these against the receiving participant.

3. B2M message acknowledgment payload validation failure alerts (badack).

4. B2B message acknowledgment payload validation failure alerts (badack).

Getting Access

To use the HubMessageManagementv2 APIs Participants must:

1. Be a Registered Participant with a Participant ID

2. Register with AEMO to use APIs.

3. Request an AEMO e-Hub SSL certificate.

4. Set up your Participant API Gateway to receive AEMO Pushed alert messages.

5. Build the APIs needing implementation at the Participant API Gateway according to the specifications in the Guide to NEM Retail B2M APIs.

External Docs

Below are a list of external links for additional context to the API or Program:

• Section 12 of the MSATS 46.98 Technical Specification

API Details

Authentication Methods

This API is using the following Security Policies:

• URM user name and password (encored in bas64)

• TLS Certificates

Endpoints

Below are the base URLs used for this API:

Parameters

Paths, Headers, Request Body and Responses can be found in the API Reference (OpenAPI Spec).