openapi: 3.0.3 info: contact: email: contact@dsb.gov.au name: Data Standards Body url: https://dsb.gov.au/ description: Specifications for resource endpoints applicable to data holders in the Banking sector. license: name: MIT License url: https://opensource.org/licenses/MIT title: CDR Banking Accounts API version: 1.36.0 servers: - description: MTLS url: https://mtls.dh.example.com/cds-au/v1 tags: - name: Accounts paths: /banking/accounts: get: tags: - Accounts summary: Get Accounts description: Obtain a list of accounts operationId: listAccounts parameters: - name: product-category in: query description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. schema: type: string enum: - TRANS_AND_SAVINGS_ACCOUNTS - TERM_DEPOSITS - TRAVEL_CARDS - REGULATED_TRUST_ACCOUNTS - RESIDENTIAL_MORTGAGES - CRED_AND_CHRG_CARDS - PERS_LOANS - MARGIN_LOANS - LEASES - TRADE_FINANCE - OVERDRAFTS - BUSINESS_LOANS - name: open-status in: query description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed schema: type: string default: ALL enum: - OPEN - CLOSED - ALL - name: is-owned in: query description: Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts schema: type: boolean x-cds-type: Boolean x-cds-type: Boolean - name: page in: query description: Page of results to request (standard pagination) schema: type: integer default: 1 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: page-size in: query description: Page size to request. Default is 25 (standard pagination) schema: type: integer default: 25 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '2' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingAccountList' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '422': description: Unprocessable Entity headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:accounts.basic:read - default: - bank:accounts.basic:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited /banking/accounts/balances: get: tags: - Accounts summary: Get Bulk Balances description: Obtain balances for multiple, filtered accounts operationId: listBalancesBulk parameters: - name: product-category in: query description: Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. schema: type: string enum: - TRANS_AND_SAVINGS_ACCOUNTS - TERM_DEPOSITS - TRAVEL_CARDS - REGULATED_TRUST_ACCOUNTS - RESIDENTIAL_MORTGAGES - CRED_AND_CHRG_CARDS - PERS_LOANS - MARGIN_LOANS - LEASES - TRADE_FINANCE - OVERDRAFTS - BUSINESS_LOANS - name: open-status in: query description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed schema: type: string default: ALL enum: - OPEN - CLOSED - ALL - name: is-owned in: query description: Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts schema: type: boolean x-cds-type: Boolean x-cds-type: Boolean - name: page in: query description: Page of results to request (standard pagination) schema: type: integer default: 1 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: page-size in: query description: Page size to request. Default is 25 (standard pagination) schema: type: integer default: 25 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '1' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingAccountsBalanceList' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '422': description: Unprocessable Entity headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:accounts.basic:read - default: - bank:accounts.basic:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited post: tags: - Accounts summary: Get Balances For Specific Accounts description: Obtain balances for a specified list of accounts operationId: listBalancesSpecificAccounts parameters: - name: page in: query description: Page of results to request (standard pagination) schema: type: integer default: 1 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: page-size in: query description: Page size to request. Default is 25 (standard pagination) schema: type: integer default: 25 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '1' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 requestBody: description: The list of account IDs to obtain balances for content: application/json: schema: $ref: '#/components/schemas/RequestAccountIds' required: true responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingAccountsBalanceList' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '422': description: Unprocessable Entity headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:accounts.basic:read - default: - bank:accounts.basic:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited x-codegen-request-body-name: accountIds /banking/accounts/{accountId}/balance: get: tags: - Accounts summary: Get Account Balance description: Obtain the balance for a single specified account operationId: getBalance parameters: - name: accountId in: path description: ID of the specific account requested required: true schema: type: string x-cds-type: ASCIIString x-cds-type: ASCIIString - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '1' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string default: '1' - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingAccountsBalanceById' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '404': description: Not Found headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:accounts.basic:read - default: - bank:accounts.basic:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited /banking/accounts/{accountId}: get: tags: - Accounts summary: Get Account Detail description: Obtain detailed information on a single account operationId: getAccountDetail parameters: - name: accountId in: path description: A tokenised identifier for the account which is unique but not shareable required: true schema: type: string x-cds-type: ASCIIString x-cds-type: ASCIIString - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '4' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingAccountById' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '404': description: Not Found headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:accounts.detail:read - default: - bank:accounts.detail:read x-version: '4' x-auth-type: Application User x-throttling-tier: Unlimited /banking/accounts/{accountId}/transactions: get: tags: - Accounts summary: Get Transactions For Account description: "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the date/time which will be defined as:\n\t\t- Posted date/time if available, then\n\t\t- Execution date/time if available, then\n\t\t- A reasonable date/time nominated by the data holder using internal data structures\n- For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account\n- For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information accross the subsidiary transactions as possible, is required to be shared" operationId: getTransactions parameters: - name: accountId in: path description: ID of the account to get transactions for. Must have previously been returned by one of the account list end points. required: true schema: type: string x-cds-type: ASCIIString x-cds-type: ASCIIString - name: oldest-time in: query description: Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type schema: type: string x-cds-type: DateTimeString x-cds-type: DateTimeString - name: newest-time in: query description: Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type schema: type: string x-cds-type: DateTimeString x-cds-type: DateTimeString - name: min-amount in: query description: Filter transactions to only transactions with amounts higher or equal to than this amount schema: type: string x-cds-type: AmountString x-cds-type: AmountString - name: max-amount in: query description: Filter transactions to only transactions with amounts less than or equal to than this amount schema: type: string x-cds-type: AmountString x-cds-type: AmountString - name: text in: query description: Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not) schema: type: string - name: page in: query description: Page of results to request (standard pagination) schema: type: integer default: 1 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: page-size in: query description: Page size to request. Default is 25 (standard pagination) schema: type: integer default: 25 x-cds-type: PositiveInteger x-cds-type: PositiveInteger - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '1' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseBankingTransactionList' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '404': description: Not Found headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '422': description: Unprocessable Entity headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:transactions:read - default: - bank:transactions:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited /banking/accounts/{accountId}/transactions/{transactionId}: get: tags: - Accounts summary: Get Transaction Detail description: Obtain detailed information on a transaction for a specific account operationId: getTransactionDetail parameters: - name: accountId in: path description: ID of the account to get transactions for. Must have previously been returned by one of the account list end points required: true schema: type: string x-cds-type: ASCIIString x-cds-type: ASCIIString - name: transactionId in: path description: ID of the transaction obtained from a previous call to one of the other transaction end points required: true schema: type: string x-cds-type: ASCIIString x-cds-type: ASCIIString - name: x-v in: header description: Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) required: true schema: type: string default: '2' - name: x-min-v in: header description: Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. schema: type: string - name: x-fapi-interaction-id in: header description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string format: uuid - name: x-fapi-auth-date in: header description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls. schema: type: string - name: x-fapi-customer-ip-address in: header description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. schema: type: string - name: x-cds-client-headers in: header description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. schema: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string x-cds-type: Base64 x-cds-type: Base64 responses: '200': description: Success headers: x-v: description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with. schema: type: string x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: anyOf: - $ref: '#/components/schemas/ResponseBankingTransactionByIdV2' - $ref: '#/components/schemas/ResponseBankingTransactionById' '400': description: Bad Request headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '404': description: Not Found headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' '406': description: Not Acceptable headers: x-fapi-interaction-id: description: An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResponseErrorList' security: - PSUOAuth2Security: - bank:transactions:read - default: - bank:transactions:read x-version: '1' x-auth-type: Application User x-throttling-tier: Unlimited components: schemas: BankingTransactionDetail_extendedData_nppPayload: required: - extendedDescription - service - serviceVersion type: object properties: extendedDescription: type: string description: An extended string description. Only present if specified by the extensionUType field endToEndId: type: string description: An end to end ID for the payment created at initiation purposeCode: type: string description: Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1) service: type: string description: Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. enum: - X2P1 - IFTI - BSCT - CATSCT serviceVersion: type: string description: Two-digit NPP service overlay version with leading zero. BankingProductCategory: type: string description: The category to which a product or account belongs. See [here](https://consumerdatastandardsaustralia.github.io/standards/#product-categories) for more details enum: - TRANS_AND_SAVINGS_ACCOUNTS - TERM_DEPOSITS - TRAVEL_CARDS - REGULATED_TRUST_ACCOUNTS - RESIDENTIAL_MORTGAGES - CRED_AND_CHRG_CARDS - PERS_LOANS - MARGIN_LOANS - LEASES - TRADE_FINANCE - OVERDRAFTS - BUSINESS_LOANS ResponseErrorList: required: - errors type: object properties: errors: type: array items: $ref: '#/components/schemas/ResponseErrorList_errors' BankingTransactionDetail_extendedDataV2: type: object properties: payer: type: string description: Label of the originating payer. Mandatory for inbound payment payee: type: string description: Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID) extensionUType: type: string description: Optional extended data provided specific to transaction originated via NPP enum: - nppPayload nppPayload: $ref: '#/components/schemas/BankingTransactionDetail_extendedData_nppPayload' BankingProductFeature: required: - featureType type: object properties: featureType: type: string description: The type of feature described enum: - CARD_ACCESS - ADDITIONAL_CARDS - UNLIMITED_TXNS - FREE_TXNS - FREE_TXNS_ALLOWANCE - LOYALTY_PROGRAM - OFFSET - OVERDRAFT - REDRAW - INSURANCE - BALANCE_TRANSFERS - INTEREST_FREE - INTEREST_FREE_TRANSFERS - DIGITAL_WALLET - DIGITAL_BANKING - NPP_PAYID - NPP_ENABLED - DONATE_INTEREST - BILL_PAYMENT - COMPLEMENTARY_PRODUCT_DISCOUNTS - BONUS_REWARDS - NOTIFICATIONS - OTHER additionalValue: type: string description: Generic field containing additional information relevant to the [featureType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc) additionalInfo: type: string description: Display text providing more information on the feature. Mandatory if the [feature type](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductfeaturetypedoc) is set to OTHER additionalInfoUri: type: string description: Link to a web page with more information on this feature x-cds-type: URIString x-conditional: - additionalValue - additionalInfo ResponseBankingTransactionList: required: - data - links - meta type: object properties: data: $ref: '#/components/schemas/ResponseBankingTransactionList_data' links: $ref: '#/components/schemas/LinksPaginated' meta: $ref: '#/components/schemas/MetaPaginated' BankingTransactionDetail: allOf: - $ref: '#/components/schemas/BankingTransaction' - required: - extendedData type: object properties: extendedData: $ref: '#/components/schemas/BankingTransactionDetail_extendedData' CommonSimpleAddress: required: - addressLine1 - city - state type: object properties: mailingName: type: string description: Name of the individual or business formatted for inclusion in an address used for physical mail addressLine1: type: string description: First line of the standard address object addressLine2: type: string description: Second line of the standard address object addressLine3: type: string description: Third line of the standard address object postcode: type: string description: Mandatory for Australian addresses city: type: string description: Name of the city or locality state: type: string description: Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT country: type: string description: A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present. default: AUS x-cds-type: ExternalRef x-conditional: - postcode BankingProductDepositRate: required: - depositRateType - rate type: object properties: depositRateType: type: string description: The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning enum: - FIXED - BONUS - BUNDLE_BONUS - VARIABLE - INTRODUCTORY - FLOATING - MARKET_LINKED rate: type: string description: The rate to be applied x-cds-type: RateString calculationFrequency: type: string description: The period after which the rate is applied to the balance. applicationFrequency: type: string description: The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) x-cds-type: ExternalRef applicationType: type: string description: The type of application for the rate enum: - PERIODIC - AT_MATURITY additionalValue: type: string description: Generic field containing additional information relevant to the [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](https://consumerdatastandardsaustralia.github.io/standards/#tocSproductdepositratetypedoc) additionalInfo: type: string description: Display text providing more information on the rate additionalInfoUri: type: string description: Link to a web page with more information on this rate x-cds-type: URIString applicabilityConditions: type: array description: Conditions that must be met for this rate to apply items: type: object properties: additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString additionalValue: type: string rateApplicabilityType: type: string enum: - NEW_CUSTOMER - RECURRING_DEPOSIT - MIN_BALANCE - MAX_BALANCE - OTHER tiers: type: array description: Rate tiers applicable for this rate items: type: object required: - minimumValue - name - unitOfMeasure properties: name: type: string unitOfMeasure: type: string enum: - DOLLAR - PERCENT - MONTH - DAY minimumValue: type: string maximumValue: type: string rateApplicationMethod: type: string enum: - WHOLE_BALANCE - PER_TIER applicabilityConditions: type: array items: type: object properties: additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString additionalValue: type: string rateApplicabilityType: type: string enum: - NEW_CUSTOMER - RECURRING_DEPOSIT - MIN_BALANCE - MAX_BALANCE - OTHER additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString x-conditional: - additionalValue ResponseBankingAccountById: required: - data - links type: object properties: data: $ref: '#/components/schemas/BankingAccountDetail' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' ResponseBankingAccountsBalanceList: required: - data - links - meta type: object properties: data: $ref: '#/components/schemas/ResponseBankingAccountsBalanceList_data' links: $ref: '#/components/schemas/LinksPaginated' meta: $ref: '#/components/schemas/MetaPaginated' BankingTermDepositAccount: required: - lodgementDate - maturityDate - maturityInstructions type: object properties: lodgementDate: type: string description: The lodgement date of the original deposit x-cds-type: DateString maturityDate: type: string description: Maturity date for the term deposit x-cds-type: DateString maturityAmount: type: string description: Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated x-cds-type: AmountString maturityCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString maturityInstructions: type: string description: Current instructions on action to be taken at maturity enum: - ROLLED_OVER - PAID_OUT_AT_MATURITY CommonPAFAddress: required: - localityName - postcode - state type: object properties: dpid: type: string description: Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier thoroughfareNumber1: type: integer description: Thoroughfare number for a property (first number in a property ranged address) x-cds-type: PositiveInteger thoroughfareNumber1Suffix: type: string description: Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated thoroughfareNumber2: type: integer description: Second thoroughfare number (only used if the property has a ranged address eg 23-25) x-cds-type: PositiveInteger thoroughfareNumber2Suffix: type: string description: Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated flatUnitType: type: string description: Type of flat or unit for the address flatUnitNumber: type: string description: Unit number (including suffix, if applicable) floorLevelType: type: string description: Type of floor or level for the address floorLevelNumber: type: string description: Floor or level number (including alpha characters) lotNumber: type: string description: Allotment number for the address buildingName1: type: string description: Building/Property name 1 buildingName2: type: string description: Building/Property name 2 streetName: type: string description: The name of the street streetType: type: string description: The street type. Valid enumeration defined by Australia Post PAF code file streetSuffix: type: string description: The street type suffix. Valid enumeration defined by Australia Post PAF code file postalDeliveryType: type: string description: Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file postalDeliveryNumber: type: integer description: Postal delivery number if the address is a postal delivery type x-cds-type: PositiveInteger postalDeliveryNumberPrefix: type: string description: Postal delivery number prefix related to the postal delivery number postalDeliveryNumberSuffix: type: string description: Postal delivery number suffix related to the postal delivery number localityName: type: string description: Full name of locality postcode: type: string description: Postcode for the locality state: type: string description: State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT description: Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) BankingTransactionDetail_extendedData_x2p101Payload: required: - extendedDescription type: object properties: extendedDescription: type: string description: An extended string description. Only present if specified by the extensionUType field endToEndId: type: string description: An end to end ID for the payment created at initiation purposeCode: type: string description: Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service LinksPaginated: required: - self type: object properties: self: type: string description: Fully qualified link that generated the current response document x-cds-type: URIString first: type: string description: URI to the first page of this set. Mandatory if this response is not the first page x-cds-type: URIString prev: type: string description: URI to the previous page of this set. Mandatory if this response is not the first page x-cds-type: URIString next: type: string description: URI to the next page of this set. Mandatory if this response is not the last page x-cds-type: URIString last: type: string description: URI to the last page of this set. Mandatory if this response is not the last page x-cds-type: URIString x-conditional: - prev - next - first - last BankingProductFee: required: - feeType - name type: object properties: name: type: string description: Name of the fee feeType: type: string description: The type of fee enum: - PERIODIC - TRANSACTION - WITHDRAWAL - DEPOSIT - PAYMENT - PURCHASE - EVENT - UPFRONT - EXIT - CASH_ADVANCE - DISHONOUR - ENQUIRY - LATE_PAYMENT - OTHER - UPFRONT_PER_PLAN - VARIATION feeMethodUType: type: string description: The U type of fee method enum: - fixedAmount - rateBased - variable fixedAmount: type: object properties: amount: type: string x-cds-type: AmountString rateBased: type: object properties: rate: type: string x-cds-type: RateString rateType: type: string enum: - BALANCE - TRANSACTION - ACCRUED accrualFrequency: type: string amountRange: type: object properties: feeMinimum: type: string x-cds-type: AmountString feeMaximum: type: string x-cds-type: AmountString variable: type: object properties: feeMinimum: type: string x-cds-type: AmountString feeMaximum: type: string x-cds-type: AmountString feeCap: type: string x-cds-type: AmountString feeCapPeriod: type: string currency: type: string default: AUD additionalValue: type: string additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString discounts: type: array description: An optional list of discounts to this fee that may be available items: type: object properties: description: type: string discountType: type: string enum: - BALANCE - TRANSACTION - PAYMENTS - FEE_CAP discountMethodUType: type: string enum: - fixedAmount - rateBased fixedAmount: type: object properties: amount: type: string rateBased: type: object properties: rate: type: string rateType: type: string amountRange: type: object properties: discountMinimum: type: string discountMaximum: type: string eligibility: type: array items: type: object properties: discountEligibilityType: type: string enum: - BUSINESS - PENSIONER - STUDENT - STAFF - OTHER additionalValue: type: string additionalInfo: type: string additionalInfoUri: type: string additionalValue: type: string additionalInfo: type: string additionalInfoUri: type: string x-conditional: - additionalValue - fixedAmount - rateBased - variable BankingCreditCardAccount: required: - minPaymentAmount - paymentDueAmount - paymentDueDate type: object properties: minPaymentAmount: type: string description: The minimum payment amount due for the next card payment x-cds-type: AmountString paymentDueAmount: type: string description: The amount due for the next card payment x-cds-type: AmountString paymentCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString paymentDueDate: type: string description: Date that the next payment for the card is due x-cds-type: DateString ResponseBankingTransactionByIdV2: required: - data - links type: object properties: data: $ref: '#/components/schemas/BankingTransactionDetailV2' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' BankingBalance: required: - accountId - availableBalance - currentBalance type: object properties: accountId: type: string description: A unique ID of the account adhering to the standards for ID permanence x-cds-type: ASCIIString currentBalance: type: string description: The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing x-cds-type: AmountString availableBalance: type: string description: Balance representing the amount of funds available for transfer. Assumed to be zero or positive x-cds-type: AmountString creditLimit: type: string description: Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent x-cds-type: AmountString amortisedLimit: type: string description: Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent x-cds-type: AmountString currency: type: string description: The currency for the balance amounts. If absent assumed to be AUD x-cds-type: CurrencyString purses: type: array description: Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards items: $ref: '#/components/schemas/BankingBalancePurse' RequestAccountIds: required: - data type: object properties: data: $ref: '#/components/schemas/RequestAccountIds_data' meta: $ref: '#/components/schemas/Meta' CommonPhysicalAddress: required: - addressUType type: object properties: addressUType: type: string description: The type of address object present enum: - simple - paf simple: $ref: '#/components/schemas/CommonSimpleAddress' paf: $ref: '#/components/schemas/CommonPAFAddress' x-conditional: - simple - paf Meta: type: object ResponseBankingAccountsBalanceList_data: required: - balances type: object properties: balances: type: array description: The list of balances returned items: $ref: '#/components/schemas/BankingBalance' ResponseBankingAccountsBalanceById: required: - data - links type: object properties: data: $ref: '#/components/schemas/BankingBalance' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' BankingTransactionDetailV2: allOf: - $ref: '#/components/schemas/BankingTransaction' - required: - extendedData type: object properties: extendedData: $ref: '#/components/schemas/BankingTransactionDetail_extendedDataV2' ResponseBankingAccountList_data: required: - accounts type: object properties: accounts: type: array description: The list of accounts returned. If the filter results in an empty set then this array may have no records items: $ref: '#/components/schemas/BankingAccount' MetaPaginated: required: - totalPages - totalRecords type: object properties: totalRecords: type: integer description: The total number of records in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination). x-cds-type: NaturalNumber totalPages: type: integer description: The total number of pages in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination). x-cds-type: NaturalNumber ResponseErrorList_errors: required: - code - detail - title type: object properties: code: type: string description: Error code title: type: string description: Error title detail: type: string description: Error details meta: type: object properties: {} description: Optional additional data for specific error types BankingTransaction: required: - accountId - amount - description - isDetailAvailable - reference - status - type type: object properties: accountId: type: string description: ID of the account for which transactions are provided x-cds-type: ASCIIString transactionId: type: string description: A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type x-cds-type: ASCIIString isDetailAvailable: type: boolean description: True if extended information is available using the transaction detail end point. False if extended data is not available x-cds-type: Boolean type: type: string description: The type of the transaction enum: - FEE - INTEREST_CHARGED - INTEREST_PAID - TRANSFER_OUTGOING - TRANSFER_INCOMING - PAYMENT - DIRECT_DEBIT - OTHER status: type: string description: Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction enum: - PENDING - POSTED description: type: string description: The transaction description as applied by the financial institution postingDateTime: type: string description: The time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement x-cds-type: DateTimeString valueDateTime: type: string description: Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry x-cds-type: DateTimeString executionDateTime: type: string description: The time the transaction was executed by the originating customer, if available x-cds-type: DateTimeString amount: type: string description: The value of the transaction. Negative values mean money was outgoing from the account x-cds-type: AmountString currency: type: string description: The currency for the transaction amount. AUD assumed if not present x-cds-type: CurrencyString reference: type: string description: The reference for the transaction provided by the originating institution. Empty string if no data provided merchantName: type: string description: Name of the merchant for an outgoing payment to a merchant merchantCategoryCode: type: string description: The merchant category code (or MCC) for an outgoing payment to a merchant billerCode: type: string description: BPAY Biller Code for the transaction (if available) billerName: type: string description: Name of the BPAY biller for the transaction (if available) crn: type: string description: BPAY CRN for the transaction (if available) apcaNumber: type: string description: 6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable. x-conditional: - transactionId - postingDateTime BankingProductLendingRate: required: - lendingRateType - rate type: object properties: lendingRateType: type: string description: The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning enum: - FIXED - VARIABLE - INTRODUCTORY - DISCOUNT - PENALTY - FLOATING - MARKET_LINKED - CASH_ADVANCE - PURCHASE - BUNDLE_DISCOUNT_FIXED - BUNDLE_DISCOUNT_VARIABLE rate: type: string description: The rate to be applied x-cds-type: RateString comparisonRate: type: string description: A comparison rate equivalent for this rate x-cds-type: RateString calculationFrequency: type: string description: The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) x-cds-type: ExternalRef applicationFrequency: type: string description: The period after which the calculated amount(s) are applied to the account. applicationType: type: string description: The type of application for the rate enum: - PERIODIC - AT_MATURITY interestPaymentDue: type: string description: When loan payments are due to be paid within each period. enum: - IN_ARREARS - IN_ADVANCE repaymentType: type: string description: Options in place for repayments. enum: - INTEREST_ONLY - PRINCIPAL_AND_INTEREST loanPurpose: type: string description: The reason for taking out the loan. enum: - OWNER_OCCUPIED - INVESTMENT additionalValue: type: string description: Generic field containing additional information relevant to the lendingRateType specified. additionalInfo: type: string description: Display text providing more information on the rate. additionalInfoUri: type: string description: Link to a web page with more information on this rate x-cds-type: URIString applicabilityConditions: type: array description: Conditions that must be met for this rate to apply items: type: object properties: additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString additionalValue: type: string rateApplicabilityType: type: string enum: - NEW_CUSTOMER - RECURRING_DEPOSIT - MIN_BALANCE - MAX_BALANCE - OTHER tiers: type: array description: Rate tiers applicable for this rate items: type: object required: - minimumValue - name - unitOfMeasure properties: name: type: string unitOfMeasure: type: string enum: - DOLLAR - PERCENT - MONTH - DAY minimumValue: type: string maximumValue: type: string rateApplicationMethod: type: string enum: - WHOLE_BALANCE - PER_TIER applicabilityConditions: type: array items: type: object properties: additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString additionalValue: type: string rateApplicabilityType: type: string enum: - NEW_CUSTOMER - RECURRING_DEPOSIT - MIN_BALANCE - MAX_BALANCE - OTHER additionalInfo: type: string additionalInfoUri: type: string x-cds-type: URIString x-conditional: - additionalValue ResponseBankingTransactionList_data: required: - transactions type: object properties: transactions: type: array items: $ref: '#/components/schemas/BankingTransaction' BankingBalancePurse: required: - amount type: object properties: amount: type: string description: The balance available for this additional currency purse x-cds-type: AmountString currency: type: string description: The currency for the purse x-cds-type: CurrencyString BankingAccountDetail: allOf: - $ref: '#/components/schemas/BankingAccount' - type: object properties: bsb: type: string description: The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces accountNumber: type: string description: The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces bundleName: type: string description: Optional field to indicate if this account is part of a bundle that is providing additional benefit for to the customer specificAccountUType: type: string description: The type of structure to present account specific fields. enum: - termDeposit - creditCard - loan termDeposit: type: array items: $ref: '#/components/schemas/BankingTermDepositAccount' creditCard: $ref: '#/components/schemas/BankingCreditCardAccount' loan: $ref: '#/components/schemas/BankingLoanAccount' depositRate: type: string description: current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call x-cds-type: RateString lendingRate: type: string description: The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call x-cds-type: RateString depositRates: type: array description: Fully described deposit rates for this account based on the equivalent structure in Product Reference items: $ref: '#/components/schemas/BankingProductDepositRate' lendingRates: type: array description: Fully described deposit rates for this account based on the equivalent structure in Product Reference items: $ref: '#/components/schemas/BankingProductLendingRate' features: type: array description: Array of features of the account based on the equivalent structure in Product Reference with the following additional field items: type: object allOf: - $ref: '#/components/schemas/BankingProductFeature' - type: object properties: isActivated: type: string description: True if the feature is already activated and false if the feature is available for activation. Defaults to true if absent. (note this is an additional field appended to the feature object defined in the Product Reference payload) fees: type: array description: Fees and charges applicable to the account based on the equivalent structure in Product Reference items: $ref: '#/components/schemas/BankingProductFee' addresses: type: array description: The addresses for the account to be used for correspondence items: $ref: '#/components/schemas/CommonPhysicalAddress' x-conditional: - termDeposit - creditCard - loan RequestAccountIds_data: required: - accountIds type: object properties: accountIds: type: array items: type: string description: Array of specific accountIds to obtain authorisations for x-cds-type: ASCIIString BankingAccount: required: - accountId - accountOwnership - displayName - maskedNumber - productCategory - productName type: object properties: accountId: type: string description: A unique ID of the account adhering to the standards for ID permanence x-cds-type: ASCIIString creationDate: type: string description: Date that the account was created (if known) x-cds-type: DateString displayName: type: string description: The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. nickname: type: string description: A customer supplied nick name for the account openStatus: type: string description: Open or closed status for the account. If not present then OPEN is assumed default: OPEN enum: - OPEN - CLOSED isOwned: type: boolean description: Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed default: true x-cds-type: Boolean accountOwnership: type: string description: Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers. default: UNKNOWN enum: - UNKNOWN - ONE_PARTY - TWO_PARTY - MANY_PARTY - OTHER maskedNumber: type: string description: A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number x-cds-type: MaskedAccountString productCategory: $ref: '#/components/schemas/BankingProductCategory' productName: type: string description: The unique identifier of the account as defined by the data holder (akin to model number for the account) ResponseBankingTransactionById: required: - data - links type: object properties: data: $ref: '#/components/schemas/BankingTransactionDetail' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' ResponseBankingAccountList: required: - data - links - meta type: object properties: data: $ref: '#/components/schemas/ResponseBankingAccountList_data' links: $ref: '#/components/schemas/LinksPaginated' meta: $ref: '#/components/schemas/MetaPaginated' BankingTransactionDetail_extendedData: required: - service type: object properties: payer: type: string description: Label of the originating payer. Mandatory for inbound payment payee: type: string description: Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID) extensionUType: type: string description: Optional extended data provided specific to transaction originated via NPP enum: - x2p101Payload x2p101Payload: $ref: '#/components/schemas/BankingTransactionDetail_extendedData_x2p101Payload' service: type: string description: 'Identifier of the applicable overlay service. Valid values are: X2P1.01' enum: - X2P1.01 Links: required: - self type: object properties: self: type: string description: Fully qualified link that generated the current response document x-cds-type: URIString BankingLoanAccount: required: - loanEndDate - nextInstalmentDate - repaymentFrequency type: object properties: originalStartDate: type: string description: Optional original start date for the loan x-cds-type: DateString originalLoanAmount: type: string description: Optional original loan value x-cds-type: AmountString originalLoanCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString loanEndDate: type: string description: Date that the loan is due to be repaid in full x-cds-type: DateString nextInstalmentDate: type: string description: Next date that an instalment is required x-cds-type: DateString minInstalmentAmount: type: string description: Minimum amount of next instalment x-cds-type: AmountString minInstalmentCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString maxRedraw: type: string description: Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account x-cds-type: AmountString maxRedrawCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString minRedraw: type: string description: Minimum redraw amount x-cds-type: AmountString minRedrawCurrency: type: string description: If absent assumes AUD x-cds-type: CurrencyString offsetAccountEnabled: type: boolean description: Set to true if one or more offset accounts are configured for this loan account x-cds-type: Boolean offsetAccountIds: type: array description: The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation items: type: string x-cds-type: ASCIIString repaymentType: type: string description: Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST default: PRINCIPAL_AND_INTEREST enum: - INTEREST_ONLY - PRINCIPAL_AND_INTEREST repaymentFrequency: type: string description: The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) x-cds-type: ExternalRef