Cash Management

The Cash Instructions API manages and processes cash instructions from the Participants efficiently through a set of RESTful APIs for operations such as creating, updating, and retrieving cash instructions records, as well as handling associated calendar events.

API status

Draft for review. The design is not ready for participants’ builds.

Audience

The primary audience is implementers and maintainers of APIs in participant organisations.

The secondary audience is BAs and other interested parties.

Related resources

For additional information, see:

• API Reference

• Connecting to Markets Systems

• Guide to User Rights Management

• National Electricity Rules Glossary

• Industry Terminology

• OpenAPI Specification v3.0.1

• TLSCertificateManagement

Related rules and procedures

• Related rules, procedures, and guidelines

OpenAPI specification

You can download the OpenAPI Specification for the following environments:

• Pre-production: Cash Management OpenAPI Specification

• Production: Cash Management OpenAPI Specification. TBA

Prerequisites

Before using the Cash Management APIs, see API Requirements in Markets Portal Help. You must see Prerequisites

Payload format

This API supports a JSON format payload.

API gateway

Participants can connect to the AEMO API Gateway through the internet or MarketNet. See URL format in the API Reference.

All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

User rights access

Participant administrators provide access to the Cash Management API using the entity:

EMMS - Prudentials - Cash Dashboard  

For more information, see Guide to User Rights Management.

Authorization

API requests are authorized by Basic HTTP authentication (Basic Auth) using a Base64-encoded username and password. The credentials are assigned by your company’s participant administrator.

In an API request, include the Base64-encoded string in a HTTPS Authorization header. For more information, see Authorization in the API Reference.

Compression

You can submit your API compressed or uncompressed. Compression protocols are gzip or deflate.

Throttling

To control traffic, AEMO implements a throttling limit of <1 request per second per participantId. - This is an example. Check the limit for the API>

If requests exceed the throttling limit, the API responds with a HTTP 429 or 422 status.

Participants systems must manage throttling limits. AEMO can also reject multiple API requests for the same participantId at the same time.

Response codes

See Response codes in the API Reference.

Submission rules

<Include submission rules if applicable>

Submission interfaces

In addition to the API, you can use the following interfaces: How to use Cash Dashboard

Submission size

A submission request or response has a payload limit of 10 MB (compressed or uncompressed).

Submission processing

Submissions are processed in the order AEMO receives them.

Submission response

If the entire submission is valid, you receive a response 200 with transaction ID and other metadata related to the Submission. If your submission has multiple Units and multiple Trading Days in a single request, and one has an error, AEMO rejects the whole submission. If your submission has an error AEMO rejects it with a response code, displaying the source of the problem so you can identify its location. Rectify the issue by updating the values appropriately and resubmitting.

Validation

TBC

Endpoints