Superannuation Product API’s #
EXPERIMENTAL
Current Version: 0.0.1 Superannuation sector experimental product API’s to describe superannuation products.
Abstract #
This standards provides a product API set for publicly available superannuation products. It aligns to the product API interface used in the banking and energy sectors.
Introduction #
The API covers retail superannuation products. Product data includes:
- Name of fund
- Provider
- Status
- Investment Types
- Fees
- Performance
- Links - PDS, Fund and Provider details
The product API contains two API’s
| API | Method | Path | Description |
|---|---|---|---|
| Get Products | GET | {ProviderURI} /super/products | Returns a list of Super Funds offered to the market |
| Get ProductDetail | GET | {ProviderURI} /super/products{productId} | Returns a specific Fund details offered to the market |
Specification #
The experimental standards are published below:
| Reference | Link |
|---|---|
| Superannuation Product API | html |
| Superannuation Product API | json |
Requirements Language #
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174].
Terminology #
| Term | Definition |
|---|---|
Normative References #
| Reference | Description |
|---|---|
| RFC2119 | Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, https://www.rfc-editor.org/info/rfc2119. |
| RFC8174 | Leiba, B., “Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words”, BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, https://www.rfc-editor.org/info/rfc8174. |
Informative References #
| Reference | Description |
|---|---|