Statements API
Statements API allows you to list configured statements, their accounts, and statement dates. You can also download individual statement files.
List statement configs
Request
GET /statements
Request body
None.
Response
This is a paginated resource. The list is sorted by statement configuration code.
| Field | Format | Data |
|---|---|---|
links |
Array of Links | Links to related resources and documentation. |
data |
Array of Statement Configuration Model | A paginated list of statement configurations. |
HTTP Status Codes
See HTTP Status Codes for more.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | Authorisation succeeded and your software/network can access the API. |
401 |
UNAUTHORIZED | Authorisation failed. View more. |
List statement accounts
Request
GET /statements/{configCode}/accounts
Path parameters
| Parameter Name | Format | Description |
|---|---|---|
configCode |
string |
The statement configuration code. |
Request body
None.
Response
This is a paginated resource. The list is sorted by account number.
| Field | Format | Data |
|---|---|---|
links |
Array of Links | Links to related resources and documentation. |
data |
Array of Statement Account Model | A paginated list of statement accounts. |
HTTP Status Codes
See HTTP Status Codes for more.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | Authorisation succeeded and your software/network can access the API. |
401 |
UNAUTHORIZED | Authorisation failed. View more. |
404 |
NOT FOUND | The configCode path parameter may be incorrect. |
List statement dates
Request
GET /statements/{configCode}
Path parameters
| Parameter Name | Format | Description |
|---|---|---|
configCode |
string |
The statement configuration code. |
Request body
None.
Response
This is a paginated resource. The list is sorted by date descending.
| Field | Format | Data |
|---|---|---|
links |
Array of Links | Links to related resources and documentation. |
data |
Array of File Download Model | A paginated list of file download models. |
HTTP Status Codes
See HTTP Status Codes for more.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | Authorisation succeeded and your software/network can access the API. |
401 |
UNAUTHORIZED | Authorisation failed. View more. |
404 |
NOT FOUND | The configCode path parameter may be incorrect. |
Get statement file
Request
GET /statements/{configCode}/{date}
Path parameters
| Parameter Name | Format | Description |
|---|---|---|
configCode |
string |
The statement configuration code. |
date |
date |
The date of the statement. |
Request body
None.
Response
Statement file data.
HTTP Status Codes
See HTTP Status Codes for more.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | Authorisation succeeded and your software/network can access the API. |
401 |
UNAUTHORIZED | Authorisation failed. View more. |
404 |
NOT FOUND | The configCode or date path parameter may be incorrect. |
Get statement file (index)
Request
GET /statements/{configCode}/{date}/{index}
Path parameters
| Parameter Name | Format | Description |
|---|---|---|
configCode |
string |
The statement configuration code. |
date |
date |
The date of the statement. |
index |
number |
The index of the statement file. Starting at 1. |
Request body
None.
Response
Statement file data.
HTTP Status Codes
See HTTP Status Codes for more.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | Authorisation succeeded and your software/network can access the API. |
401 |
UNAUTHORIZED | Authorisation failed. View more. |
404 |
NOT FOUND | The configCode, date, or index path parameter may be incorrect. |
Statement configuration model
| Field | Format | Description |
|---|---|---|
configCode |
string |
The statement configuration code. |
format |
string |
The statement file format. |
links |
Array of Links | Links to related resources and documentation. |
Example statement configuration response
{
"configCode": "CONFIG_1",
"format": "EXCTENDED_CSV",
"links": []
}
Statement account model
| Field | Format | Description |
|---|---|---|
bsbAccountNumber |
string |
The full account number identifying the account. |
alias |
string |
The alias of the account. |
Example credit card response
{
"alias": "Account name",
"bsbAccountNumber": "032000000007"
}
File download model
| Field | Format | Description |
|---|---|---|
links |
Array of Links | Links to the file resource. |
date |
date |
The file statement date. |
Example file download response - single-file bank statement format
Links will contain one download link for the primary statement
{
"links": [
{
"rel": "primary",
"requestMethod": "GET",
"href": ".../rest/v1/statements/CONFIG_1/2026-08-17"
}
],
"date": "2026-08-17"
}
Example file download response - multiple-file bank statement format
Links will contain one download link for the primary statement, plus additional download links for the additional file(s). Each URL will end with the index of the file, starting at 1.
{
"links": [
{
"rel": "primary",
"requestMethod": "GET",
"href": ".../rest/v1/statements/CONFIG_2/2026-08-17/1"
},
{
"rel": "additional",
"requestMethod": "GET",
"href": ".../rest/v1/statements/CONFIG_2/2026-08-17/2"
}
],
"date": "2026-08-17"
}