Fileactive Accounts Statement API Fileactive Accounts Statement API
redocly logo API docs by Redocly

Fileactive Accounts Statement API (2.1.1)

Download OpenAPI specification:Download

Fileactive Account Statement API.

Authorisation

Operations related to authentication & authorisation.

Auth Token Request

ANZ use OAuth 2.0 to authenticate inbound token requests, a bearer token is returned as a response which is then used to authorise against ANZ resources

Authorizations:
(apiKeyAuthoAuth2)
Request Body schema: application/x-www-form-urlencoded

Information and examples of Auth request body

grant_type
required
string

Specify the type credential requested

client_assertion_type
required
string

Describes the type of client assertion provided in the message request

scope
required
any
required
object (ClientAssertion)

Responses

Response samples

Content type
application/json
{
  • "expires_in": 3600,
  • "token_type": "Bearer",
  • "access_token": "eaaa13ee-b596-a8cc-b9d4-f778f8bb9377"
}

Statements

Operations related to account statements

Statement Request

Get the statement of an account - For IntraDay or Prior Day

Authorizations:
(apiKeyAuthbearerAuth)
Request Body schema: application/json

Statement Request of an account on Intraday/Priorday basis.

accountId
required
string (Account Identifier) [ 1 .. 35 ] characters ^[a-zA-Z0-9.]*$

Uniquely identify the account. For AU and NZ domestic accounts this will include BSB + account number.

extract
string (Extract)

Extract is a request to API for generating statement details for a Prior Day. If no extract is passed, default will be IntraDay.

sortOrder
string (Sort order)
Enum: "forward" "backward"

Sort transactions "forward" (default) from least recent to most recent or "backward" from most recent to least recent.

cursor
string (Cursor) ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

Statement entry cursor used for call back if requesting additional pages. Cursor is not applicable for Prior Day, as all statements will be sent in single CAMT.053

maxEntries
string (Maximum Entries.) [ 1 .. 1000 ]

Maximum number of entries to return (1-1000), default to 1000. This is not applicable for Prior Day.

includeNarrative
string (Include Narative.)

Include extended narrative relevant (e.g. NPP 280 characters), (default: true).

startDate
string (Start Date of the prior day request.)

Start Date (AEST format) can be passed for Prior Day upto 7 days backdated.

endDate
string (End Date of the prior day request.)

End Date (AEST format) can be anything within 7 days from Start Date.

Responses

Request samples

Content type
application/json
Example
{
  • "accountId": "012123999999999",
  • "sortOrder": "forward",
  • "cursor": "MjAyMjA3MDQ6Ng==",
  • "maxEntries": 1,
  • "includeNarrative": true
}

Response samples

Content type
application/json
Example
{
  • "accountId": "012123999999999",
  • "sortOrder": "forward",
  • "payload": "[camt.052.001.06 XML]",
  • "requestKey": "71d6fb19-7515-40dc-b045-e17550b67600",
  • "cursor": "MjAyMjA3MDQ6Ng==",
  • "moreTransactionsAvailable": true
}

Get Statement Request for prior day.

Get the statement of an account - For prior day or a date range (upto 7 days)

Authorizations:
(apiKeyAuthbearerAuth)
path Parameters
REQUESTKEY
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 325ea624-ac19-47e2-94ef-a1ab4e487275

Internal End to End key need to be passed for getting Prior day statement

Responses

Response samples

Content type
application/json
{
  • "accountId": "012123999999999",
  • "extract": "priorday",
  • "sortOrder": "forward",
  • "payload": "[camt.053.001.06 XML]",
  • "requestKey": "71d6fb19-7515-40dc-b045-e17550b67600",
  • "moreTransactionsAvailable": false
}

StatementRequest

accountId
required
string (Account Identifier) [ 1 .. 35 ] characters ^[a-zA-Z0-9.]*$

Uniquely identify the account. For AU and NZ domestic accounts this will include BSB + account number.

extract
string (Extract)

Extract is a request to API for generating statement details for a Prior Day. If no extract is passed, default will be IntraDay.

sortOrder
string (Sort order)
Enum: "forward" "backward"

Sort transactions "forward" (default) from least recent to most recent or "backward" from most recent to least recent.

cursor
string (Cursor) ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[...

Statement entry cursor used for call back if requesting additional pages. Cursor is not applicable for Prior Day, as all statements will be sent in single CAMT.053

maxEntries
string (Maximum Entries.) [ 1 .. 1000 ]

Maximum number of entries to return (1-1000), default to 1000. This is not applicable for Prior Day.

includeNarrative
string (Include Narative.)

Include extended narrative relevant (e.g. NPP 280 characters), (default: true).

startDate
string (Start Date of the prior day request.)

Start Date (AEST format) can be passed for Prior Day upto 7 days backdated.

endDate
string (End Date of the prior day request.)

End Date (AEST format) can be anything within 7 days from Start Date.

{
  • "accountId": "012123999999999",
  • "extract": "priorday",
  • "sortOrder": "forward",
  • "cursor": "MjAyMjA3MDQ6Ng==",
  • "maxEntries": "string",
  • "includeNarrative": "string",
  • "startDate": "string",
  • "endDate": "string"
}

StatementResponse

accountId
required
string

Uniquely identify the account.

sortOrder
required
string
Enum: "forward" "backward"

Sort transactions "forward" (default) from least recent to most recent or "backward" from most recent to least recent. Sort Order will always be forward incase of priorday.

payload
required
string (Camt05200106Xml)

Message payload. Provided as camt.052.001.06 xml. An empty camt.052.001.06 XML will be returned incase of PriorDay.

CAMT.052.001.06 xml message implementation guide with examples
requestKey
required
string[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...

Unique identifier used to correlate the message with ANZ

cursor
string

Statement entry cursor used for call back if requesting additional pages.

moreTransactionsAvailable
required
boolean

More transactions available, use cursor in subsequent calls. It will be false by default for Prior Day.

{
  • "accountId": "012123999999999",
  • "sortOrder": "forward",
  • "payload": "[camt.052.001.06 XML]",
  • "requestKey": "71d6fb19-7515-40dc-b045-e17550b67600",
  • "cursor": "MjAyMjA3MDQ6Ng==",
  • "moreTransactionsAvailable": true
}

GetStatementResponse

accountId
required
string

Uniquely identify the account.

extract
required
string (Extract)

Extract is a request to API for generating statement details for a Prior Day.

sortOrder
required
string

SortOrder will be forward by default for priorday.

payload
required
string (Camt05300106Xml)

Message payload. Provided as camt.053.001.06 xml.

CAMT.053.001.06 xml message implementation guide with examples
requestKey
required
string[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...

Unique identifier used to correlate the message with ANZ

moreTransactionsAvailable
required
boolean

More transactions available will be false by default for Prior Day.

{
  • "accountId": "012123999999999",
  • "extract": "priorday",
  • "sortOrder": "forward",
  • "payload": "[camt.053.001.06 XML]",
  • "requestKey": "71d6fb19-7515-40dc-b045-e17550b67600",
  • "moreTransactionsAvailable": false
}