{ "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 API", "version" : "1.34.1" }, "servers" : [ { "description" : "MTLS", "url" : "https://mtls.dh.example.com/cds-au/v1" } ], "tags" : [ { "description" : "Banking Product endpoints", "name" : "Banking Products", "x-shortName" : "Products" }, { "description" : "Banking Account endpoints", "name" : "Banking Accounts", "x-shortName" : "Accounts" }, { "description" : "Banking Account Balance endpoints", "name" : "Banking Account Balances", "x-shortName" : "Account Balances" }, { "description" : "Banking Account Transaction endpoints", "name" : "Banking Account Transactions", "x-shortName" : "Transactions" }, { "description" : "Banking Account Direct Debit endpoints", "name" : "Banking Account Direct Debits", "x-shortName" : "Direct Debits" }, { "description" : "Banking Account Scheduled Payment endpoints", "name" : "Banking Account Scheduled Payments", "x-shortName" : "Scheduled Payments" }, { "description" : "Banking Payee endpoints", "name" : "Banking Payees", "x-shortName" : "Payees" } ], "paths" : { "/banking/accounts" : { "get" : { "description" : "Obtain a list of accounts.\n\nObsolete versions: [v1](includes/obsolete/get-accounts-v1.html).", "operationId" : "listBankingAccounts", "parameters" : [ { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, { "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "explode" : true, "in" : "query", "name" : "open-status", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "CLOSED", "OPEN" ], "type" : "string" }, "style" : "form" }, { "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.", "explode" : true, "in" : "query", "name" : "is-owned", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Accounts", "tags" : [ "Banking Accounts" ], "x-scopes" : [ "bank:accounts.basic:read" ], "x-version" : "2" } }, "/banking/accounts/balances" : { "get" : { "description" : "Obtain balances for multiple, filtered accounts.", "operationId" : "listBankingBalancesBulk", "parameters" : [ { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, { "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "explode" : true, "in" : "query", "name" : "open-status", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "CLOSED", "OPEN" ], "type" : "string" }, "style" : "form" }, { "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.", "explode" : true, "in" : "query", "name" : "is-owned", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Bulk Balances", "tags" : [ "Banking Account Balances" ], "x-scopes" : [ "bank:accounts.basic:read" ], "x-version" : "1" }, "post" : { "description" : "Obtain balances for a specified list of accounts.", "operationId" : "listBankingBalancesSpecificAccounts", "parameters" : [ { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "requestBody" : { "$ref" : "#/components/requestBodies/RequestAccountIds" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Balances For Specific Accounts", "tags" : [ "Banking Account Balances" ], "x-scopes" : [ "bank:accounts.basic:read" ], "x-version" : "1" } }, "/banking/accounts/{accountId}/balance" : { "get" : { "description" : "Obtain the balance for a single specified account.", "operationId" : "getBankingBalance", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceById" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Account Balance", "tags" : [ "Banking Account Balances" ], "x-scopes" : [ "bank:accounts.basic:read" ], "x-version" : "1" } }, "/banking/accounts/{accountId}" : { "get" : { "description" : "Obtain detailed information on a single account.\n\nObsolete versions: [v1](includes/obsolete/get-account-detail-v1.html), [v2](includes/obsolete/get-account-detail-v2.html), [v3](includes/obsolete/get-account-detail-v3.html).", "operationId" : "getBankingAccountDetail", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountByIdV4" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Account Detail", "tags" : [ "Banking Accounts" ], "x-scopes" : [ "bank:accounts.detail:read" ], "x-version" : "4" } }, "/banking/accounts/{accountId}/transactions" : { "get" : { "description" : "Obtain transactions for a specific account.\n\nSome general notes that apply to all endpoints that retrieve transactions:", "operationId" : "listBankingTransactions", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "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-field-types) common type.", "explode" : true, "in" : "query", "name" : "oldest-time", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "DateTimeString" }, { "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-field-types) common type.", "explode" : true, "in" : "query", "name" : "newest-time", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "DateTimeString" }, { "description" : "Filter transactions to only transactions with amounts higher than or equal to this amount.", "explode" : true, "in" : "query", "name" : "min-amount", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "AmountString" }, { "description" : "Filter transactions to only transactions with amounts less than or equal to this amount.", "explode" : true, "in" : "query", "name" : "max-amount", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "AmountString" }, { "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).", "explode" : true, "in" : "query", "name" : "text", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingTransactionList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Transactions For Account", "tags" : [ "Banking Account Transactions" ], "x-scopes" : [ "bank:transactions:read" ], "x-version" : "1" } }, "/banking/accounts/{accountId}/transactions/{transactionId}" : { "get" : { "description" : "Obtain detailed information on a transaction for a specific account.\n\nObsolete versions: [v1](includes/obsolete/get-transaction-detail-v1.html).", "operationId" : "getBankingTransactionDetail", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "description" : "The _transactionId_ to obtain data for. _transactionId_ values are returned by transaction list endpoints.", "explode" : false, "in" : "path", "name" : "transactionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingTransactionId" }, "style" : "simple" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingTransactionByIdV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Transaction Detail", "tags" : [ "Banking Account Transactions" ], "x-scopes" : [ "bank:transactions:read" ], "x-version" : "2" } }, "/banking/accounts/{accountId}/direct-debits" : { "get" : { "description" : "Obtain direct debit authorisations for a specific account.", "operationId" : "listDirectDebits", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Direct Debits For Account", "tags" : [ "Banking Account Direct Debits" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "1" } }, "/banking/accounts/direct-debits" : { "get" : { "description" : "Obtain direct debit authorisations for multiple, filtered accounts.", "operationId" : "listDirectDebitsBulk", "parameters" : [ { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, { "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "explode" : true, "in" : "query", "name" : "open-status", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "CLOSED", "OPEN" ], "type" : "string" }, "style" : "form" }, { "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.", "explode" : true, "in" : "query", "name" : "is-owned", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Bulk Direct Debits", "tags" : [ "Banking Account Direct Debits" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "1" }, "post" : { "description" : "Obtain direct debit authorisations for a specified list of accounts.", "operationId" : "listDirectDebitsSpecificAccounts", "parameters" : [ { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "requestBody" : { "$ref" : "#/components/requestBodies/RequestAccountIds" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Direct Debits For Specific Accounts", "tags" : [ "Banking Account Direct Debits" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "1" } }, "/banking/accounts/{accountId}/payments/scheduled" : { "get" : { "description" : "Obtain scheduled, outgoing payments for a specific account.\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-account-v1.html).", "operationId" : "listScheduledPayments", "parameters" : [ { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Scheduled Payments for Account", "tags" : [ "Banking Account Scheduled Payments" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "2" } }, "/banking/payments/scheduled" : { "get" : { "description" : "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments.\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-bulk-v1.html).", "operationId" : "listScheduledPaymentsBulk", "parameters" : [ { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, { "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "explode" : true, "in" : "query", "name" : "open-status", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "CLOSED", "OPEN" ], "type" : "string" }, "style" : "form" }, { "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.", "explode" : true, "in" : "query", "name" : "is-owned", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Scheduled Payments Bulk", "tags" : [ "Banking Account Scheduled Payments" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "2" }, "post" : { "description" : "Obtain scheduled payments for a specified list of accounts.\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html).", "operationId" : "listScheduledPaymentsSpecificAccounts", "parameters" : [ { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "requestBody" : { "$ref" : "#/components/requestBodies/RequestAccountIds" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Scheduled Payments For Specific Accounts", "tags" : [ "Banking Account Scheduled Payments" ], "x-scopes" : [ "bank:regular_payments:read" ], "x-version" : "2" } }, "/banking/payees" : { "get" : { "description" : "Obtain a list of pre-registered payees.\n\nObsolete versions: [v1](includes/obsolete/get-payees-v1.html).", "operationId" : "listBankingPayees", "parameters" : [ { "description" : "Filter on the payee _type_ field. In addition to normal _type_ field values, `ALL` can be specified to retrieve all payees. If absent the assumed value is `ALL`.", "explode" : true, "in" : "query", "name" : "type", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "BILLER", "DIGITAL_WALLET", "DOMESTIC", "INTERNATIONAL" ], "type" : "string" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingPayeeListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Payees", "tags" : [ "Banking Payees" ], "x-scopes" : [ "bank:payees:read" ], "x-version" : "2" } }, "/banking/payees/{payeeId}" : { "get" : { "description" : "Obtain detailed information on a single payee.\n\nNote that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.\n\nObsolete versions: [v1](includes/obsolete/get-payee-detail-v1.html).", "operationId" : "getBankingPayeeDetail", "parameters" : [ { "description" : "The _payeeId_ to obtain data for. _payeeId_ values are returned by payee list endpoints.", "explode" : false, "in" : "path", "name" : "payeeId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingPayeeId" }, "style" : "simple" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingPayeeByIdV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } } }, "summary" : "Get Payee Detail", "tags" : [ "Banking Payees" ], "x-scopes" : [ "bank:payees:read" ], "x-version" : "2" } }, "/banking/products" : { "get" : { "description" : "Obtain a list of products that are currently openly offered to the market.\n\nNote that the results returned by this endpoint are expected to be ordered in descending order according to _lastUpdated_.\n\n### Conventions\nIn the product reference payloads there are a number of recurring conventions that are explained below.\n\n#### Arrays Of Features\n\nIn the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:\n\n- Each element in an array has the same structure so that clients can reliably interpret the payloads\n- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.\n- Each element has a field named [_additionalValue_](#productfeaturetypedoc). This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the `ADDITIONAL_CARDS` feature is the number of cards allowed while the contents of this field for the `MAX_LIMIT` constraint would be the maximum credit limit allowed for the product.\n- An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.\n- An element in these arrays may contain an _additionalInfo_ and _additionalInfoUri_ field. The _additionalInfo_ field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The _additionalInfoUri_ provides a link to externally hosted information specifically relevant to that feature of the product.\n- Depending on the type of data being represented there may be additional specific fields.\n\n#### URIs To More Information\n\nAs the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.\n\nThese URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use different HTML anchors to focus on a specific topic such as eligibility or fees.\n\n#### Linkage To Accounts\nFrom the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge. Rates and features of the product may change and a discount may be negotiated for the account.\n\nFor this reason, while _productCategory_ is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.\n\nSimilarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actually has been instantiated and created along with the associated decisions inherent in that process.\n\n#### Dates\nIt is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a _lastUpdated_ field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the _updated-since_ query parameter.\n\nIn addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no longer offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.\n\nObsolete versions: [v1](includes/obsolete/get-products-v1.html), [v2](includes/obsolete/get-products-v2.html), [v3](includes/obsolete/get-products-v3.html).", "operationId" : "listBankingProducts", "parameters" : [ { "description" : "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.", "explode" : true, "in" : "query", "name" : "effective", "required" : false, "schema" : { "default" : "CURRENT", "enum" : [ "ALL", "CURRENT", "FUTURE" ], "type" : "string" }, "style" : "form" }, { "description" : "Only include products that have been updated after the specified date and time. If absent defaults to include all products.", "explode" : true, "in" : "query", "name" : "updated-since", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "DateTimeString" }, { "description" : "Filter results based on a specific brand.", "explode" : true, "in" : "query", "name" : "brand", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingProductListV3" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" } }, "servers" : [ { "description" : "TLS", "url" : "https://tls.dh.example.com/cds-au/v1" } ], "summary" : "Get Products", "tags" : [ "Banking Products" ], "x-version" : "4" } }, "/banking/products/{productId}" : { "get" : { "description" : "Obtain detailed information on a single product offered openly to the market.\n\nObsolete versions: [v1](includes/obsolete/get-product-detail-v1.html), [v2](includes/obsolete/get-product-detail-v2.html), [v3](includes/obsolete/get-product-detail-v3.html), [v4](includes/obsolete/get-product-detail-v4.html), [v5](includes/obsolete/get-product-detail-v5.html).", "operationId" : "getBankingProductDetail", "parameters" : [ { "description" : "The _productId_ to obtain data for. _productId_ values are returned by product list endpoints.", "explode" : false, "in" : "path", "name" : "productId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingProductId" }, "style" : "simple", "x-cds-type" : "ASCIIString" }, { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingProductByIdV6" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" } }, "servers" : [ { "description" : "TLS", "url" : "https://tls.dh.example.com/cds-au/v1" } ], "summary" : "Get Product Detail", "tags" : [ "Banking Products" ], "x-version" : "6" } } }, "components" : { "headers" : { "XV" : { "description" : "The [payload version](#response-headers) that the endpoint has responded with.", "explode" : false, "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, "XFAPIInteractionId" : { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } }, "parameters" : { "HeaderXV" : { "description" : "Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).", "explode" : false, "in" : "header", "name" : "x-v", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, "HeaderXMinV" : { "description" : "Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.", "explode" : false, "in" : "header", "name" : "x-min-v", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "HeaderXFAPIInteractionId" : { "description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.", "explode" : false, "in" : "header", "name" : "x-fapi-interaction-id", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "HeaderXFAPIAuthDate" : { "description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-auth-date", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true }, "HeaderXFAPICustomerIPAddress" : { "description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-fapi-customer-ip-address", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "HeaderXCDSClientHeaders" : { "description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "explode" : false, "in" : "header", "name" : "x-cds-client-headers", "required" : false, "schema" : { "type" : "string" }, "style" : "simple", "x-conditional" : true, "x-cds-type" : "Base64" }, "PathAccountId" : { "description" : "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.", "explode" : false, "in" : "path", "name" : "accountId", "required" : true, "schema" : { "$ref" : "#/components/schemas/BankingAccountId" }, "style" : "simple" }, "QueryBankingAccountOpenStatus" : { "description" : "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.", "explode" : true, "in" : "query", "name" : "open-status", "required" : false, "schema" : { "default" : "ALL", "enum" : [ "ALL", "CLOSED", "OPEN" ], "type" : "string" }, "style" : "form" }, "QueryBankingProductCategory" : { "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.", "explode" : true, "in" : "query", "name" : "product-category", "required" : false, "schema" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "style" : "form" }, "QueryBankingAccountIsOwned" : { "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.", "explode" : true, "in" : "query", "name" : "is-owned", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, "QueryPage" : { "description" : "Page of results to request (standard pagination).", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 1, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, "QueryPageSize" : { "description" : "Page size to request. Default is 25 (standard pagination).", "explode" : true, "in" : "query", "name" : "page-size", "required" : false, "schema" : { "default" : 25, "type" : "integer" }, "style" : "form", "x-cds-type" : "PositiveInteger" }, "QueryNewestTime" : { "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-field-types) common type.", "explode" : true, "in" : "query", "name" : "newest-time", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "DateTimeString" }, "QueryOldestTime" : { "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-field-types) common type.", "explode" : true, "in" : "query", "name" : "oldest-time", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "DateTimeString" }, "QueryMinAmount" : { "description" : "Filter transactions to only transactions with amounts higher than or equal to this amount.", "explode" : true, "in" : "query", "name" : "min-amount", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "AmountString" }, "QueryMaxAmount" : { "description" : "Filter transactions to only transactions with amounts less than or equal to this amount.", "explode" : true, "in" : "query", "name" : "max-amount", "required" : false, "schema" : { "type" : "string" }, "style" : "form", "x-cds-type" : "AmountString" }, "QueryBankingTransactionText" : { "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).", "explode" : true, "in" : "query", "name" : "text", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } }, "requestBodies" : { "RequestAccountIds" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RequestAccountIdListV1" } } }, "description" : "Request payload containing a list of _accountId_ values to obtain data for.", "required" : true } }, "responses" : { "ListBankingAccounts200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingAccounts400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingAccounts406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingAccounts422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesBulk200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesBulk400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesBulk406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesBulk422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesSpecificAccounts200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesSpecificAccounts400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesSpecificAccounts406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingBalancesSpecificAccounts422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingBalance200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceById" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingBalance400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingBalance404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingBalance406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingAccountDetail200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingAccountByIdV4" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingAccountDetail400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingAccountDetail404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingAccountDetail406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingTransactions200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingTransactionList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingTransactions400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingTransactions404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingTransactions406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingTransactions422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingTransactionDetail200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingTransactionByIdV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingTransactionDetail400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingTransactionDetail404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingTransactionDetail406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebits200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebits400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebits404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebits406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebits422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsBulk200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsBulk400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsBulk406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsBulk422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsSpecificAccounts200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsSpecificAccounts400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsSpecificAccounts406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListDirectDebitsSpecificAccounts422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPayments200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPayments400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPayments404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPayments406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPayments422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsBulk200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsBulk400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsBulk406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsBulk422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsSpecificAccounts200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsSpecificAccounts400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsSpecificAccounts406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListScheduledPaymentsSpecificAccounts422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingPayees200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingPayeeListV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingPayees400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingPayees406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingPayees422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingPayeeDetail200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingPayeeByIdV2" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" }, "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingPayeeDetail400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingPayeeDetail404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingPayeeDetail406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "GetBankingPayeeDetail422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
", "headers" : { "x-fapi-interaction-id" : { "$ref" : "#/components/headers/XFAPIInteractionId" } } }, "ListBankingProducts200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingProductListV3" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" } } }, "ListBankingProducts400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "ListBankingProducts406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "ListBankingProducts422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "GetBankingProductDetail200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseBankingProductByIdV6" } } }, "description" : "Successful response", "headers" : { "x-v" : { "$ref" : "#/components/headers/XV" } } }, "GetBankingProductDetail400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "GetBankingProductDetail404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" }, "GetBankingProductDetail406" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseErrorListV2" } } }, "description" : "The following error codes **MUST** be supported:
" } }, "schemas" : { "RequestAccountIdListV1" : { "properties" : { "data" : { "$ref" : "#/components/schemas/RequestAccountIdListV1_data" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data" ], "type" : "object" }, "ResponseBankingProductListV3" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingProductListV3_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "BankingProductV5" : { "properties" : { "productId" : { "$ref" : "#/components/schemas/BankingProductId" }, "effectiveFrom" : { "description" : "The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate.", "type" : "string", "x-cds-type" : "DateTimeString" }, "effectiveTo" : { "description" : "The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products.", "type" : "string", "x-cds-type" : "DateTimeString" }, "lastUpdated" : { "description" : "The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered).", "type" : "string", "x-cds-type" : "DateTimeString" }, "productCategory" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "name" : { "description" : "The display name of the product.", "type" : "string" }, "description" : { "description" : "A description of the product.", "type" : "string" }, "brand" : { "description" : "A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required.", "type" : "string" }, "brandName" : { "description" : "An optional display name of the brand.", "type" : "string" }, "applicationUri" : { "description" : "A link to an application web page where this product can be applied for.", "type" : "string", "x-cds-type" : "URIString" }, "isTailored" : { "description" : "Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable.", "type" : "boolean" }, "additionalInformation" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2" }, "cardArt" : { "description" : "Information about any cards available with the account.", "items" : { "$ref" : "#/components/schemas/BankingProductCardArt" }, "type" : "array" } }, "required" : [ "brand", "description", "isTailored", "lastUpdated", "name", "productCategory", "productId" ], "type" : "object" }, "BankingProductCardArt" : { "properties" : { "cardScheme" : { "description" : "Card scheme available with the account.", "enum" : [ "AMEX", "EFTPOS", "MASTERCARD", "VISA", "OTHER" ], "type" : "string" }, "cardType" : { "description" : "Card type available with the account.", "enum" : [ "CHARGE", "CREDIT", "DEBIT" ], "type" : "string" }, "title" : { "description" : "Display label for the specific image.", "type" : "string" }, "imageUri" : { "description" : "URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "cardScheme", "cardType", "imageUri" ], "type" : "object" }, "BankingProductAdditionalInformationV2" : { "description" : "Object that contains links to additional information on specific topics.", "properties" : { "overviewUri" : { "description" : "General overview of the product. Mandatory if _additionalOverviewUris_ includes one or more supporting documents.", "type" : "string", "x-cds-type" : "URIString" }, "termsUri" : { "description" : "Terms and conditions for the product. Mandatory if _additionalTermsUris_ includes one or more supporting documents.", "type" : "string", "x-cds-type" : "URIString" }, "eligibilityUri" : { "description" : "Eligibility rules and criteria for the product. Mandatory if _additionalEligibilityUris_ includes one or more supporting documents.", "type" : "string", "x-cds-type" : "URIString" }, "feesAndPricingUri" : { "description" : "Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if _additionalFeesAndPricingUris_ includes one or more supporting documents.", "type" : "string", "x-cds-type" : "URIString" }, "bundleUri" : { "description" : "Description of a bundle that this product can be part of. Mandatory if _additionalBundleUris_ includes one or more supporting documents.", "type" : "string", "x-cds-type" : "URIString" }, "additionalOverviewUris" : { "description" : "An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the _overviewUri_. Only to be used if there is a primary _overviewUri_.", "items" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" }, "type" : "array" }, "additionalTermsUris" : { "description" : "An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the _termsUri_. Only to be used if there is a primary _termsUri_.", "items" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" }, "type" : "array" }, "additionalEligibilityUris" : { "description" : "An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the _eligibilityUri_. Only to be used if there is a primary _eligibilityUri_.", "items" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" }, "type" : "array" }, "additionalFeesAndPricingUris" : { "description" : "An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the _feesAndPricingUri_. Only to be used if there is a primary _feesAndPricingUri_.", "items" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" }, "type" : "array" }, "additionalBundleUris" : { "description" : "An array of additional bundles for the product, if applicable. To be treated as secondary documents to the _bundleUri_. Only to be used if there is a primary _bundleUri_.", "items" : { "$ref" : "#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris" }, "type" : "array" } }, "type" : "object", "x-conditional" : [ "overviewUri", "termsUri", "eligibilityUri", "feesAndPricingUri", "bundleUri" ] }, "BankingProductAdditionalInformationV2_additionalInformationUris" : { "properties" : { "description" : { "description" : "Display text providing more information about the document URI.", "type" : "string" }, "additionalInfoUri" : { "description" : "The URI describing the additional information.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "additionalInfoUri" ], "type" : "object" }, "ResponseBankingProductByIdV6" : { "properties" : { "data" : { "$ref" : "#/components/schemas/BankingProductDetailV6" }, "links" : { "$ref" : "#/components/schemas/Links" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links" ], "type" : "object" }, "BankingProductDetailV6" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingProductV5" }, { "$ref" : "#/components/schemas/BankingProductDetailV6_allOf" } ] }, "BankingProductBundle" : { "properties" : { "name" : { "description" : "Name of the bundle.", "type" : "string" }, "description" : { "description" : "Description of the bundle.", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the bundle.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on the bundle criteria and benefits.", "type" : "string", "x-cds-type" : "URIString" }, "productIds" : { "description" : "Array of _productID_ values for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints.", "items" : { "$ref" : "#/components/schemas/BankingProductId" }, "type" : "array" } }, "required" : [ "description", "name" ], "type" : "object" }, "BankingProductFeatureV3" : { "properties" : { "featureType" : { "description" : "The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc).", "enum" : [ "ADDITIONAL_CARDS", "BALANCE_TRANSFERS", "BILL_PAYMENT", "BONUS_REWARDS", "CARD_ACCESS", "CASHBACK_OFFER", "COMPLEMENTARY_PRODUCT_DISCOUNTS", "DIGITAL_BANKING", "DIGITAL_WALLET", "DONATE_INTEREST", "EXTRA_REPAYMENTS", "FRAUD_PROTECTION", "FREE_TXNS", "FREE_TXNS_ALLOWANCE", "FUNDS_AVAILABLE_AFTER", "GUARANTOR", "INSTALMENT_PLAN", "INSURANCE", "INTEREST_FREE", "INTEREST_FREE_TRANSFERS", "LOYALTY_PROGRAM", "NOTIFICATIONS", "NPP_ENABLED", "NPP_PAYID", "OFFSET", "OTHER", "OVERDRAFT", "REDRAW", "RELATIONSHIP_MANAGEMENT", "UNLIMITED_TXNS" ], "type" : "string" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_featureType_](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [_featureType_](#tocSproductfeaturetypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the feature. Mandatory if [_featureType_](#tocSproductfeaturetypedoc) is set to `OTHER`.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this feature.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "featureType" ], "type" : "object", "x-conditional" : [ "additionalValue", "additionalInfo" ] }, "BankingProductConstraintV3" : { "properties" : { "constraintType" : { "description" : "The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc).", "enum" : [ "MAX_BALANCE", "MAX_LIMIT", "MAX_LVR", "MIN_BALANCE", "MIN_LIMIT", "MIN_LVR", "OPENING_BALANCE", "OTHER" ], "type" : "string" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_constraintType_](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [_constraintType_](#tocSproductconstrainttypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the constraint. Mandatory if the [_constraintType_](#tocSproductconstrainttypedoc) value is `OTHER`.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on the constraint.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "constraintType" ], "type" : "object", "x-conditional" : [ "additionalValue", "additionalInfo" ] }, "BankingProductEligibilityV2" : { "properties" : { "eligibilityType" : { "description" : "The type of eligibility criteria described. For further details, refer to [Product Eligibility Types](#tocSproducteligibilitytypedoc).", "enum" : [ "BUSINESS", "EMPLOYMENT_STATUS", "MAX_AGE", "MIN_AGE", "MIN_INCOME", "MIN_TURNOVER", "NATURAL_PERSON", "OTHER", "PENSION_RECIPIENT", "RESIDENCY_STATUS", "STAFF", "STUDENT" ], "type" : "string" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_eligibilityType_](#tocSproducteligibilitytypedoc) specified. Whether mandatory or not is dependent on the value of [_eligibilityType_](#tocSproducteligibilitytypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc) criteria. Mandatory if the field is set to `OTHER`.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this eligibility criteria.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "eligibilityType" ], "type" : "object", "x-conditional" : [ "additionalValue", "additionalInfo" ] }, "BankingProductFeeV2" : { "properties" : { "name" : { "description" : "Name of the fee.", "type" : "string" }, "feeType" : { "description" : "The type of fee. For further details, refer to [Product Fee Types](#tocSproductfeetypedoc).", "enum" : [ "CASH_ADVANCE", "DEPOSIT", "DISHONOUR", "ENQUIRY", "EVENT", "EXIT", "LATE_PAYMENT", "OTHER", "PAYMENT", "PERIODIC", "PURCHASE", "REPLACEMENT", "TRANSACTION", "UPFRONT", "UPFRONT_PER_PLAN", "VARIATION", "WITHDRAWAL" ], "example" : "CASH_ADVANCE", "type" : "string" }, "feeMethodUType" : { "description" : "Reference to the applicable fee charging method structure.", "enum" : [ "fixedAmount", "rateBased", "variable" ], "type" : "string" }, "fixedAmount" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingFeeAmount" } ], "description" : "Mandatory if the _feeMethodUType_ value is `fixedAmount`. Where the fee is a specific amount." }, "rateBased" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingFeeRate" } ], "description" : "Mandatory if the _feeMethodUType_ value is `rateBased`. Where the fee is based on a type of rate." }, "variable" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingFeeRange" } ], "description" : "Mandatory if the _feeMethodUType_ value is `variable`. Where the amount or rate may not be known until the fee is incurred." }, "feeCap" : { "description" : "The cap amount if multiple occurrences of the fee are capped to a limit.", "type" : "string", "x-cds-type" : "AmountString" }, "feeCapPeriod" : { "description" : "Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type" : "string", "x-cds-type" : "ExternalRef" }, "currency" : { "default" : "AUD", "description" : "The currency the fee will be charged in. Assumes `AUD` if absent.", "type" : "string", "x-cds-type" : "CurrencyString" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_feeType_](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [_feeType_](#tocSproductfeetypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the fee. Mandatory if the [_feeType_](#tocSproductfeetypedoc) value is `OTHER`.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this fee.", "type" : "string", "x-cds-type" : "URIString" }, "discounts" : { "description" : "An optional list of discounts to this fee that may be available.", "items" : { "$ref" : "#/components/schemas/BankingProductDiscountV2" }, "type" : "array" } }, "required" : [ "feeMethodUType", "feeType", "name" ], "type" : "object", "x-conditional" : [ "fixedAmount", "rateBased", "variable", "additionalValue", "additionalInfo" ] }, "BankingFeeAmount" : { "properties" : { "amount" : { "description" : "The specific amount charged for the fee each time it is incurred.", "type" : "string", "x-cds-type" : "AmountString" } }, "required" : [ "amount" ], "type" : "object" }, "BankingFeeRate" : { "properties" : { "rateType" : { "description" : "Type of fee rate calculation.", "enum" : [ "BALANCE", "INTEREST_ACCRUED", "TRANSACTION" ], "type" : "string" }, "rate" : { "description" : "The fee rate calculated according to the _rateType_.", "type" : "string", "x-cds-type" : "RateString" }, "accrualFrequency" : { "description" : "The indicative frequency with which the fee is calculated on the account if applicable. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type" : "string", "x-cds-type" : "ExternalRef" }, "amountRange" : { "$ref" : "#/components/schemas/BankingFeeRange" } }, "required" : [ "rate", "rateType" ], "type" : "object", "x-conditional" : [ "balanceRate", "transactionRate", "accruedRate" ] }, "BankingFeeRange" : { "description" : "A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.", "properties" : { "feeMinimum" : { "description" : "The minimum fee that will be charged per occurrence.", "type" : "string", "x-cds-type" : "AmountString" }, "feeMaximum" : { "description" : "The maximum fee that will be charged per occurrence.", "type" : "string", "x-cds-type" : "AmountString" } }, "type" : "object" }, "BankingProductDiscountV2" : { "description" : "Note that the currency of the fee discount is expected to be the same as the currency of the fee itself.", "properties" : { "description" : { "description" : "Description of the discount.", "type" : "string" }, "discountType" : { "description" : "The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc).", "enum" : [ "BALANCE", "DEPOSITS", "ELIGIBILITY_ONLY", "FEE_CAP", "PAYMENTS" ], "type" : "string" }, "discountMethodUType" : { "description" : "Reference to the applicable fee discount method structure.", "enum" : [ "fixedAmount", "rateBased" ], "type" : "string" }, "fixedAmount" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingFeeDiscountAmount" } ], "description" : "Mandatory if the _discountMethodUType_ value is `fixedAmount`. Where the discount is a specific amount." }, "rateBased" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingFeeDiscountRate" } ], "description" : "Mandatory if the _discountMethodUType_ value is `rateBased`. Where the discount is based on a type of rate. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee." }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_discountType_](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [_discountType_](#tocSproductdiscounttypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the discount.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this discount.", "type" : "string", "x-cds-type" : "URIString" }, "eligibility" : { "description" : "Eligibility constraints that apply to this discount. Mandatory if _discountType_ is `ELIGIBILITY_ONLY`.", "items" : { "$ref" : "#/components/schemas/BankingProductDiscountEligibility" }, "type" : "array" } }, "required" : [ "description", "discountMethodUType", "discountType" ], "type" : "object", "x-conditional" : [ "fixedAmount", "rateBased", "additionalValue", "eligibility" ] }, "BankingFeeDiscountAmount" : { "properties" : { "amount" : { "description" : "The specific amount discounted from the fee each time it is incurred.", "type" : "string", "x-cds-type" : "AmountString" } }, "required" : [ "amount" ], "type" : "object" }, "BankingFeeDiscountRate" : { "properties" : { "rateType" : { "description" : "Type of fee rate discount calculation.", "enum" : [ "BALANCE", "FEE", "INTEREST_ACCRUED", "TRANSACTION" ], "type" : "string" }, "rate" : { "description" : "The fee rate discount calculated according to the _rateType_.", "type" : "string", "x-cds-type" : "RateString" }, "amountRange" : { "$ref" : "#/components/schemas/BankingFeeDiscountRange" } }, "required" : [ "rate", "rateType" ], "type" : "object" }, "BankingFeeDiscountRange" : { "description" : "A minimum or maximum fee discount amount where a specific fixed amount is not known until the fee is incurred.", "properties" : { "discountMinimum" : { "description" : "The minimum fee discount that will be applied per occurrence.", "type" : "string", "x-cds-type" : "AmountString" }, "discountMaximum" : { "description" : "The maximum fee discount that will be applied per occurrence.", "type" : "string", "x-cds-type" : "AmountString" } }, "type" : "object" }, "BankingProductDiscountEligibility" : { "properties" : { "discountEligibilityType" : { "description" : "The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc).", "enum" : [ "BUSINESS", "EMPLOYMENT_STATUS", "INTRODUCTORY", "MAX_AGE", "MIN_AGE", "MIN_INCOME", "MIN_TURNOVER", "NATURAL_PERSON", "OTHER", "PENSION_RECIPIENT", "RESIDENCY_STATUS", "STAFF", "STUDENT" ], "type" : "string" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc).", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this eligibility constraint.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "discountEligibilityType" ], "type" : "object", "x-conditional" : [ "additionalInfo", "additionalValue" ] }, "BankingProductDepositRateV2" : { "properties" : { "depositRateType" : { "description" : "The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc.) For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc).", "enum" : [ "BONUS", "BUNDLE_BONUS", "FIXED", "FLOATING", "INTRODUCTORY", "MARKET_LINKED", "VARIABLE" ], "example" : "VARIABLE", "type" : "string" }, "rate" : { "description" : "The rate to be applied.", "type" : "string", "x-cds-type" : "RateString" }, "calculationFrequency" : { "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).", "type" : "string", "x-cds-type" : "ExternalRef" }, "applicationType" : { "description" : "The type of approach used to apply the rate to the account.", "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], "example" : "PERIODIC", "type" : "string" }, "applicationFrequency" : { "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). Mandatory if the _applicationType_ value is `PERIODIC`.", "type" : "string", "x-cds-type" : "ExternalRef" }, "tiers" : { "description" : "Rate tiers applicable for this rate.", "items" : { "$ref" : "#/components/schemas/BankingProductRateTierV4" }, "type" : "array" }, "applicabilityConditions" : { "description" : "Applicability conditions for the rate.", "items" : { "$ref" : "#/components/schemas/BankingProductRateConditionV2" }, "type" : "array" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_depositRateType_](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [_depositRateType_](#tocSproductdepositratetypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the rate.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this rate.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "applicationType", "depositRateType", "rate" ], "type" : "object", "x-conditional" : [ "additionalValue", "applicationFrequency" ] }, "BankingProductLendingRateV3" : { "properties" : { "lendingRateType" : { "description" : "The type of rate (`FIXED`, `VARIABLE`, etc.) For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc).", "enum" : [ "BALANCE_TRANSFER", "BUNDLE_DISCOUNT_FIXED", "BUNDLE_DISCOUNT_VARIABLE", "CASH_ADVANCE", "DISCOUNT", "FIXED", "FLOATING", "INTRODUCTORY", "MARKET_LINKED", "PENALTY", "PURCHASE", "VARIABLE" ], "example" : "FIXED", "type" : "string" }, "rate" : { "description" : "The rate to be applied.", "type" : "string", "x-cds-type" : "RateString" }, "comparisonRate" : { "description" : "A comparison rate equivalent for this rate.", "type" : "string", "x-cds-type" : "RateString" }, "calculationFrequency" : { "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).", "type" : "string", "x-cds-type" : "ExternalRef" }, "applicationType" : { "description" : "The type of approach used to apply the rate to the account.", "enum" : [ "MATURITY", "PERIODIC", "UPFRONT" ], "example" : "PERIODIC", "type" : "string" }, "applicationFrequency" : { "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). Mandatory if the _applicationType_ value is `PERIODIC`.", "type" : "string", "x-cds-type" : "ExternalRef" }, "interestPaymentDue" : { "description" : "When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.", "enum" : [ "IN_ADVANCE", "IN_ARREARS" ], "type" : "string" }, "repaymentType" : { "description" : "Option in place for repayments.", "enum" : [ "INTEREST_ONLY", "OTHER", "PRINCIPAL_AND_INTEREST", "UNCONSTRAINED" ], "type" : "string" }, "loanPurpose" : { "description" : "The reason for taking out the loan.", "enum" : [ "INVESTMENT", "OTHER", "OWNER_OCCUPIED", "UNCONSTRAINED" ], "type" : "string" }, "tiers" : { "description" : "Rate tiers applicable for this rate.", "items" : { "$ref" : "#/components/schemas/BankingProductRateTierV4" }, "type" : "array" }, "applicabilityConditions" : { "description" : "Applicability conditions for the rate.", "items" : { "$ref" : "#/components/schemas/BankingProductRateConditionV2" }, "type" : "array" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the [_lendingRateType_](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [_lendingRateType_](#tocSproductlendingratetypedoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the rate.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this rate.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "applicationType", "lendingRateType", "loanPurpose", "rate", "repaymentType" ], "type" : "object", "x-conditional" : [ "additionalValue", "applicationFrequency" ] }, "BankingProductRateTierV4" : { "description" : "Defines the criteria and conditions for which a rate applies.", "properties" : { "name" : { "description" : "A display name for the tier.", "type" : "string" }, "unitOfMeasure" : { "description" : "The unit of measure that applies to the _minimumValue_ and _maximumValue_ values, e.g.,", "enum" : [ "DAY", "DOLLAR", "MONTH", "PERCENT" ], "type" : "string" }, "minimumValue" : { "description" : "The number of _unitOfMeasure_ units that form the lower bound of the tier. The tier should be inclusive of this value.", "type" : "string" }, "maximumValue" : { "description" : "The number of _unitOfMeasure_ units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as _minimumValue_. Where this is the same as the _minimumValue_ value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.", "type" : "string" }, "rateApplicationMethod" : { "description" : "The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps').", "enum" : [ "PER_TIER", "WHOLE_BALANCE" ], "type" : "string" }, "applicabilityConditions" : { "description" : "Applicability conditions for the rate tier.", "items" : { "$ref" : "#/components/schemas/BankingProductRateConditionV2" }, "type" : "array" }, "additionalInfo" : { "description" : "Display text providing more information on the rate tier.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this rate tier.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "minimumValue", "name", "unitOfMeasure" ], "type" : "object" }, "BankingProductRateConditionV2" : { "description" : "Defines a condition for the applicability of a rate.", "properties" : { "rateApplicabilityType" : { "description" : "Category of applicability condition associated with the rate. For more information refer to [Rate and Tier Applicability Types](#tocSbankingproductrateconditiondoc).", "enum" : [ "MIN_DEPOSITS", "MIN_DEPOSIT_AMOUNT", "DEPOSIT_BALANCE_INCREASED", "EXISTING_CUST", "NEW_ACCOUNTS", "NEW_CUSTOMER", "NEW_CUSTOMER_TO_GROUP", "ONLINE_ONLY", "OTHER", "MIN_PURCHASES", "MAX_WITHDRAWALS", "MAX_WITHDRAWAL_AMOUNT" ], "example" : "NEW_CUSTOMER", "type" : "string" }, "additionalValue" : { "description" : "Generic field containing additional information relevant to the _rateApplicabilityType_ specified. Whether mandatory or not is dependent on the value of [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc).", "type" : "string" }, "additionalInfo" : { "description" : "Display text providing more information on the condition. Mandatory if the [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc) value is `OTHER`.", "type" : "string" }, "additionalInfoUri" : { "description" : "Link to a web page with more information on this condition.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "rateApplicabilityType" ], "type" : "object", "x-conditional" : [ "additionalValue", "additionalInfo" ] }, "ResponseBankingAccountListV2" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingAccountListV2_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "BankingAccountV2" : { "properties" : { "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Unique identifier for the account." }, "creationDate" : { "description" : "Date that the account was created (if known).", "type" : "string", "x-cds-type" : "DateString" }, "displayName" : { "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-field-types) common type.", "type" : "string" }, "nickname" : { "description" : "A customer supplied nickname for the account.", "type" : "string" }, "openStatus" : { "default" : "OPEN", "description" : "Open or closed status for the account. If not present then `OPEN` is assumed.", "enum" : [ "CLOSED", "OPEN" ], "type" : "string" }, "isOwned" : { "default" : true, "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.", "type" : "boolean" }, "accountOwnership" : { "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.", "enum" : [ "UNKNOWN", "ONE_PARTY", "TWO_PARTY", "MANY_PARTY", "OTHER" ], "type" : "string" }, "maskedNumber" : { "description" : "A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number.", "type" : "string", "x-cds-type" : "MaskedAccountString" }, "productCategory" : { "$ref" : "#/components/schemas/BankingProductCategory" }, "productName" : { "description" : "The unique identifier of the account as defined by the data holder (akin to model number for the account).", "type" : "string" } }, "required" : [ "accountId", "accountOwnership", "displayName", "maskedNumber", "productCategory", "productName" ], "type" : "object" }, "ResponseBankingAccountByIdV4" : { "properties" : { "data" : { "$ref" : "#/components/schemas/BankingAccountDetailV4" }, "links" : { "$ref" : "#/components/schemas/Links" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links" ], "type" : "object" }, "BankingAccountDetailV4" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountV2" }, { "$ref" : "#/components/schemas/BankingAccountDetailV4_allOf" } ] }, "BankingTermDepositAccount" : { "properties" : { "lodgementDate" : { "description" : "The lodgement date of the original deposit.", "type" : "string", "x-cds-type" : "DateString" }, "maturityDate" : { "description" : "Maturity date for the term deposit.", "type" : "string", "x-cds-type" : "DateString" }, "maturityAmount" : { "description" : "Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated.", "type" : "string", "x-cds-type" : "AmountString" }, "maturityCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "maturityInstructions" : { "description" : "Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments.", "enum" : [ "HOLD_ON_MATURITY", "PAID_OUT_AT_MATURITY", "ROLLED_OVER" ], "type" : "string" } }, "required" : [ "lodgementDate", "maturityDate", "maturityInstructions" ], "type" : "object" }, "BankingCreditCardAccount" : { "properties" : { "minPaymentAmount" : { "description" : "The minimum payment amount due for the next card payment.", "type" : "string", "x-cds-type" : "AmountString" }, "paymentDueAmount" : { "description" : "The amount due for the next card payment.", "type" : "string", "x-cds-type" : "AmountString" }, "paymentCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "paymentDueDate" : { "description" : "Date that the next payment for the card is due.", "type" : "string", "x-cds-type" : "DateString" } }, "required" : [ "minPaymentAmount", "paymentDueAmount", "paymentDueDate" ], "type" : "object" }, "BankingLoanAccountV3" : { "properties" : { "originalStartDate" : { "description" : "Optional original start date for the loan.", "type" : "string", "x-cds-type" : "DateString" }, "originalLoanAmount" : { "description" : "Optional original loan value.", "type" : "string", "x-cds-type" : "AmountString" }, "originalLoanCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "loanEndDate" : { "description" : "Date that the loan is due to be repaid in full.", "type" : "string", "x-cds-type" : "DateString" }, "nextInstalmentDate" : { "description" : "Next date that an instalment is required.", "type" : "string", "x-cds-type" : "DateString" }, "minInstalmentAmount" : { "description" : "Minimum amount of next instalment.", "type" : "string", "x-cds-type" : "AmountString" }, "minInstalmentCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "maxRedraw" : { "description" : "Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account.", "type" : "string", "x-cds-type" : "AmountString" }, "maxRedrawCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "minRedraw" : { "description" : "Minimum redraw amount.", "type" : "string", "x-cds-type" : "AmountString" }, "minRedrawCurrency" : { "default" : "AUD", "description" : "If absent assumes `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "offsetAccountEnabled" : { "description" : "Set to `true` if one or more offset accounts are configured for this loan account.", "type" : "boolean" }, "offsetAccountIds" : { "description" : "The _accountId_ values 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" : { "$ref" : "#/components/schemas/BankingAccountId" }, "type" : "array" }, "repaymentType" : { "description" : "Option in place for repayments.", "enum" : [ "INTEREST_ONLY", "OTHER", "PRINCIPAL_AND_INTEREST", "UNCONSTRAINED" ], "type" : "string" }, "repaymentFrequency" : { "description" : "The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).", "type" : "string", "x-cds-type" : "ExternalRef" } }, "required" : [ "repaymentType" ], "type" : "object" }, "ResponseBankingTransactionList" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingTransactionList_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginatedTransaction" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "BankingTransaction" : { "properties" : { "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Unique identifier for the account." }, "transactionId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingTransactionId" } ], "description" : "Unique identifier for the transaction. 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. Mandatory if the _isDetailAvailable_ value is `true`." }, "isDetailAvailable" : { "description" : "`true` if extended information is available using the transaction detail endpoint. `false` if extended data is not available.", "type" : "boolean" }, "type" : { "description" : "The type of the transaction.", "enum" : [ "DIRECT_DEBIT", "FEE", "INTEREST_CHARGED", "INTEREST_PAID", "OTHER", "PAYMENT", "TRANSFER_INCOMING", "TRANSFER_OUTGOING" ], "type" : "string" }, "status" : { "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" ], "type" : "string" }, "description" : { "description" : "The transaction description as applied by the financial institution.", "type" : "string" }, "postingDateTime" : { "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.", "type" : "string", "x-cds-type" : "DateTimeString" }, "valueDateTime" : { "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.", "type" : "string", "x-cds-type" : "DateTimeString" }, "executionDateTime" : { "description" : "The time the transaction was executed by the originating customer, if available.", "type" : "string", "x-cds-type" : "DateTimeString" }, "amount" : { "description" : "The value of the transaction. Negative values mean money was outgoing from the account.", "type" : "string", "x-cds-type" : "AmountString" }, "currency" : { "default" : "AUD", "description" : "The currency for the transaction amount. `AUD` assumed if not present.", "type" : "string", "x-cds-type" : "CurrencyString" }, "reference" : { "description" : "The reference for the transaction provided by the originating institution. Empty string if no data provided.", "type" : "string" }, "merchantName" : { "description" : "Name of the merchant for an outgoing payment to a merchant.", "type" : "string" }, "merchantCategoryCode" : { "description" : "The merchant category code (or MCC) for an outgoing payment to a merchant.", "type" : "string" }, "billerCode" : { "description" : "BPAY Biller Code for the transaction (if available).", "type" : "string" }, "billerName" : { "description" : "Name of the BPAY biller for the transaction (if available).", "type" : "string" }, "crn" : { "description" : "BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.", "type" : "string" }, "apcaNumber" : { "description" : "6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.", "type" : "string" } }, "required" : [ "accountId", "amount", "description", "isDetailAvailable", "reference", "status", "type" ], "type" : "object", "x-conditional" : [ "transactionId", "postingDateTime", "crn" ] }, "ResponseBankingTransactionByIdV2" : { "properties" : { "data" : { "$ref" : "#/components/schemas/BankingTransactionDetailV2" }, "links" : { "$ref" : "#/components/schemas/Links" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links" ], "type" : "object" }, "BankingTransactionDetailV2" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingTransaction" }, { "$ref" : "#/components/schemas/BankingTransactionDetailV2_allOf" } ] }, "ResponseBankingAccountsBalanceList" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingAccountsBalanceList_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "ResponseBankingAccountsBalanceById" : { "properties" : { "data" : { "$ref" : "#/components/schemas/BankingBalance" }, "links" : { "$ref" : "#/components/schemas/Links" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links" ], "type" : "object" }, "BankingBalance" : { "properties" : { "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Unique identifier for the account." }, "currentBalance" : { "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.", "type" : "string", "x-cds-type" : "AmountString" }, "availableBalance" : { "description" : "Balance representing the amount of funds available for transfer. Assumed to be zero or positive.", "type" : "string", "x-cds-type" : "AmountString" }, "creditLimit" : { "description" : "Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent.", "type" : "string", "x-cds-type" : "AmountString" }, "amortisedLimit" : { "description" : "Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent.", "type" : "string", "x-cds-type" : "AmountString" }, "currency" : { "default" : "AUD", "description" : "The currency for the balance amounts. If absent assumed to be `AUD`.", "type" : "string", "x-cds-type" : "CurrencyString" }, "purses" : { "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" }, "type" : "array" } }, "required" : [ "accountId", "availableBalance", "currentBalance" ], "type" : "object" }, "BankingBalancePurse" : { "properties" : { "amount" : { "description" : "The balance available for this additional currency purse.", "type" : "string", "x-cds-type" : "AmountString" }, "currency" : { "description" : "The currency for the purse.", "type" : "string", "x-cds-type" : "CurrencyString" } }, "required" : [ "amount" ], "type" : "object" }, "ResponseBankingPayeeListV2" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingPayeeListV2_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "ResponseBankingPayeeByIdV2" : { "properties" : { "data" : { "$ref" : "#/components/schemas/BankingPayeeDetailV2" }, "links" : { "$ref" : "#/components/schemas/Links" }, "meta" : { "$ref" : "#/components/schemas/Meta" } }, "required" : [ "data", "links" ], "type" : "object" }, "BankingPayeeV2" : { "properties" : { "payeeId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingPayeeId" } ], "description" : "Unique identifier for the payee." }, "nickname" : { "description" : "The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels.", "type" : "string" }, "description" : { "description" : "A description of the payee provided by the customer.", "type" : "string" }, "type" : { "description" : "The type of payee.", "enum" : [ "BILLER", "DIGITAL_WALLET", "DOMESTIC", "INTERNATIONAL" ], "type" : "string" }, "creationDate" : { "description" : "The date the payee was created by the customer.", "type" : "string", "x-cds-type" : "DateString" } }, "required" : [ "nickname", "payeeId", "type" ], "type" : "object" }, "BankingPayeeDetailV2" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingPayeeV2" }, { "$ref" : "#/components/schemas/BankingPayeeDetailV2_allOf" } ] }, "BankingDomesticPayee" : { "properties" : { "payeeAccountUType" : { "description" : "Type of account object included. Valid values are: ", "enum" : [ "account", "card", "payId" ], "type" : "string" }, "account" : { "$ref" : "#/components/schemas/BankingDomesticPayeeAccount" }, "card" : { "$ref" : "#/components/schemas/BankingDomesticPayeeCard" }, "payId" : { "$ref" : "#/components/schemas/BankingDomesticPayeePayId" } }, "required" : [ "payeeAccountUType" ], "type" : "object", "x-conditional" : [ "account", "card", "payId" ] }, "BankingDomesticPayeeAccount" : { "properties" : { "accountName" : { "description" : "Name of the account to pay to.", "type" : "string" }, "bsb" : { "description" : "BSB of the account to pay to.", "type" : "string" }, "accountNumber" : { "description" : "Number of the account to pay to.", "type" : "string" } }, "required" : [ "accountNumber", "bsb" ], "type" : "object" }, "BankingDomesticPayeeCard" : { "properties" : { "cardNumber" : { "description" : "Name of the account to pay to.", "type" : "string", "x-cds-type" : "MaskedPANString" } }, "required" : [ "cardNumber" ], "type" : "object" }, "BankingDomesticPayeePayId" : { "properties" : { "name" : { "description" : "The name assigned to the PayID by the owner of the PayID.", "type" : "string" }, "identifier" : { "description" : "The identifier of the PayID (dependent on type).", "type" : "string" }, "type" : { "description" : "The type of the PayID.", "enum" : [ "ABN", "EMAIL", "ORG_IDENTIFIER", "TELEPHONE" ], "type" : "string" } }, "required" : [ "identifier", "type" ], "type" : "object" }, "BankingBillerPayee" : { "properties" : { "billerCode" : { "description" : "BPAY Biller Code of the Biller.", "type" : "string" }, "crn" : { "description" : "BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type.", "type" : "string" }, "billerName" : { "description" : "Name of the Biller.", "type" : "string" } }, "required" : [ "billerCode", "billerName" ], "type" : "object", "x-conditional" : [ "crn" ] }, "BankingInternationalPayee" : { "properties" : { "beneficiaryDetails" : { "$ref" : "#/components/schemas/BankingInternationalPayee_beneficiaryDetails" }, "bankDetails" : { "$ref" : "#/components/schemas/BankingInternationalPayee_bankDetails" } }, "required" : [ "bankDetails", "beneficiaryDetails" ], "type" : "object" }, "BankingDigitalWalletPayee" : { "properties" : { "name" : { "description" : "The display name of the wallet as given by the customer, else a default value defined by the data holder.", "type" : "string" }, "identifier" : { "description" : "The identifier of the digital wallet (dependent on type).", "type" : "string" }, "type" : { "description" : "The type of the digital wallet identifier.", "enum" : [ "EMAIL", "CONTACT_NAME", "TELEPHONE" ], "type" : "string" }, "provider" : { "description" : "The provider of the digital wallet.", "enum" : [ "PAYPAL_AU", "OTHER" ], "type" : "string" } }, "required" : [ "identifier", "name", "provider", "type" ], "type" : "object" }, "ResponseBankingDirectDebitAuthorisationList" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingDirectDebitAuthorisationList_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "BankingDirectDebit" : { "properties" : { "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Unique identifier for the account." }, "authorisedEntity" : { "$ref" : "#/components/schemas/BankingAuthorisedEntity" }, "lastDebitDateTime" : { "description" : "The date and time of the last debit executed under this authorisation.", "type" : "string", "x-cds-type" : "DateTimeString" }, "lastDebitAmount" : { "description" : "The amount of the last debit executed under this authorisation.", "type" : "string", "x-cds-type" : "AmountString" } }, "required" : [ "accountId", "authorisedEntity" ], "type" : "object" }, "BankingAuthorisedEntity" : { "properties" : { "description" : { "description" : "Description of the authorised entity derived from previously executed direct debits.", "type" : "string" }, "financialInstitution" : { "description" : "Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme.", "type" : "string" }, "abn" : { "description" : "Australian Business Number for the authorised entity.", "type" : "string" }, "acn" : { "description" : "Australian Company Number for the authorised entity.", "type" : "string" }, "arbn" : { "description" : "Australian Registered Body Number for the authorised entity.", "type" : "string" } }, "type" : "object", "x-conditional" : [ "financialInstitution" ] }, "ResponseBankingScheduledPaymentsListV2" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseBankingScheduledPaymentsListV2_data" }, "links" : { "$ref" : "#/components/schemas/LinksPaginated" }, "meta" : { "$ref" : "#/components/schemas/MetaPaginated" } }, "required" : [ "data", "links", "meta" ], "type" : "object" }, "BankingScheduledPaymentV2" : { "properties" : { "scheduledPaymentId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingScheduledPaymentId" } ], "description" : "Unique identifier for the scheduled payment." }, "nickname" : { "description" : "The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.", "type" : "string" }, "payerReference" : { "description" : "The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided.", "type" : "string" }, "payeeReference" : { "description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.", "type" : "string" }, "status" : { "description" : "Indicates whether the schedule is currently active. The value `SKIP` is equivalent to `ACTIVE` except that the customer has requested the next normal occurrence to be skipped.", "enum" : [ "ACTIVE", "INACTIVE", "SKIP" ], "type" : "string" }, "from" : { "$ref" : "#/components/schemas/BankingScheduledPaymentFrom" }, "paymentSet" : { "items" : { "$ref" : "#/components/schemas/BankingScheduledPaymentSetV2" }, "type" : "array" }, "recurrence" : { "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrence" } }, "required" : [ "from", "payerReference", "paymentSet", "recurrence", "scheduledPaymentId", "status" ], "type" : "object", "x-conditional" : [ "payeeReference" ] }, "BankingScheduledPaymentSetV2" : { "description" : "The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.", "properties" : { "to" : { "$ref" : "#/components/schemas/BankingScheduledPaymentToV2" }, "isAmountCalculated" : { "default" : false, "description" : "Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then `false` is assumed.", "type" : "boolean" }, "amount" : { "description" : "The amount of the next payment if known. Mandatory unless the _isAmountCalculated_ field is set to `true`. Must be zero or positive if present.", "type" : "string", "x-cds-type" : "AmountString" }, "currency" : { "default" : "AUD", "description" : "The currency for the payment. `AUD` assumed if not present.", "type" : "string", "x-cds-type" : "CurrencyString" } }, "required" : [ "to" ], "type" : "object", "x-conditional" : [ "amount" ] }, "BankingScheduledPaymentToV2" : { "description" : "Object containing details of the destination of the payment. Used to specify a variety of payment destination types.", "properties" : { "toUType" : { "description" : "The type of object provided that specifies the destination of the funds for the payment.", "enum" : [ "accountId", "biller", "digitalWallet", "domestic", "international", "payeeId" ], "type" : "string" }, "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Present if _toUType_ is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent." }, "payeeId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingPayeeId" } ], "description" : "Present if _toUType_ is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a _payeeId_ should not be provided and the full payee details should be provided instead." }, "nickname" : { "description" : "The short display name of the payee as provided by the customer unless _toUType_ is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.", "type" : "string" }, "payeeReference" : { "description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.", "type" : "string" }, "digitalWallet" : { "$ref" : "#/components/schemas/BankingDigitalWalletPayee" }, "domestic" : { "$ref" : "#/components/schemas/BankingDomesticPayee" }, "biller" : { "$ref" : "#/components/schemas/BankingBillerPayee" }, "international" : { "$ref" : "#/components/schemas/BankingInternationalPayee" } }, "required" : [ "toUType" ], "type" : "object", "x-conditional" : [ "accountId", "payeeId", "digitalWallet", "domestic", "biller", "international", "nickname", "payeeReference" ] }, "BankingScheduledPaymentFrom" : { "description" : "Object containing details of the source of the payment. Currently only specifies an _accountId_ but provided as an object to facilitate future extensibility and consistency with the _to_ object.", "properties" : { "accountId" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingAccountId" } ], "description" : "Unique identifier for the account." } }, "required" : [ "accountId" ], "type" : "object" }, "BankingScheduledPaymentRecurrence" : { "description" : "Object containing the detail of the schedule for the payment.", "properties" : { "nextPaymentDate" : { "description" : "The date of the next payment under the recurrence schedule.", "type" : "string", "x-cds-type" : "DateString" }, "recurrenceUType" : { "description" : "The type of recurrence used to define the schedule.", "enum" : [ "eventBased", "intervalSchedule", "lastWeekDay", "onceOff" ], "type" : "string" }, "onceOff" : { "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff" }, "intervalSchedule" : { "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule" }, "lastWeekDay" : { "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday" }, "eventBased" : { "$ref" : "#/components/schemas/BankingScheduledPaymentRecurrenceEventBased" } }, "required" : [ "recurrenceUType" ], "type" : "object", "x-conditional" : [ "onceOff", "intervalSchedule", "lastWeekDay", "eventBased" ] }, "BankingScheduledPaymentRecurrenceOnceOff" : { "description" : "Indicates that the payment is a once off payment on a specific future date. Mandatory if _recurrenceUType_ is set to `onceOff`.", "properties" : { "paymentDate" : { "description" : "The scheduled date for the once off payment.", "type" : "string", "x-cds-type" : "DateString" } }, "required" : [ "paymentDate" ], "type" : "object" }, "BankingScheduledPaymentRecurrenceIntervalSchedule" : { "description" : "Indicates that the schedule of payments is defined by a series of intervals. Mandatory if _recurrenceUType_ is set to `intervalSchedule`.", "properties" : { "finalPaymentDate" : { "description" : "The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.", "type" : "string", "x-cds-type" : "DateString" }, "paymentsRemaining" : { "description" : "Indicates the number of payments remaining in the schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely.", "example" : 1, "type" : "integer", "x-cds-type" : "PositiveInteger" }, "nonBusinessDayTreatment" : { "default" : "ON", "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.", "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], "type" : "string" }, "intervals" : { "description" : "An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry.", "items" : { "$ref" : "#/components/schemas/BankingScheduledPaymentInterval" }, "type" : "array" } }, "required" : [ "intervals" ], "type" : "object" }, "BankingScheduledPaymentInterval" : { "properties" : { "interval" : { "description" : "An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_.", "type" : "string", "x-cds-type" : "ExternalRef" }, "dayInInterval" : { "description" : "Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is `P1D`. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.", "type" : "string", "x-cds-type" : "ExternalRef" } }, "required" : [ "interval" ], "type" : "object" }, "BankingScheduledPaymentRecurrenceLastWeekday" : { "description" : "Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if _recurrenceUType_ is set to `lastWeekDay`.", "properties" : { "finalPaymentDate" : { "description" : "The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.", "type" : "string", "x-cds-type" : "DateString" }, "paymentsRemaining" : { "description" : "Indicates the number of payments remaining in the schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.", "example" : 1, "type" : "integer", "x-cds-type" : "PositiveInteger" }, "interval" : { "description" : "The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_.", "type" : "string", "x-cds-type" : "ExternalRef" }, "lastWeekDay" : { "description" : "The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.", "enum" : [ "FRI", "MON", "SAT", "SUN", "THU", "TUE", "WED" ], "type" : "string" }, "nonBusinessDayTreatment" : { "default" : "ON", "description" : "Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.", "enum" : [ "AFTER", "BEFORE", "ON", "ONLY" ], "type" : "string" } }, "required" : [ "interval", "lastWeekDay" ], "type" : "object" }, "BankingScheduledPaymentRecurrenceEventBased" : { "description" : "Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if _recurrenceUType_ is set to `eventBased`.", "properties" : { "description" : { "description" : "Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer.", "type" : "string" } }, "required" : [ "description" ], "type" : "object" }, "CommonPhysicalAddress" : { "properties" : { "addressUType" : { "description" : "The type of address object present.", "enum" : [ "paf", "simple" ], "type" : "string" }, "simple" : { "$ref" : "#/components/schemas/CommonSimpleAddress" }, "paf" : { "$ref" : "#/components/schemas/CommonPAFAddress" } }, "required" : [ "addressUType" ], "type" : "object", "x-conditional" : [ "simple", "paf" ] }, "CommonSimpleAddress" : { "description" : "Required if _addressUType_ is set to `simple`.", "properties" : { "mailingName" : { "description" : "Name of the individual or business formatted for inclusion in an address used for physical mail.", "type" : "string" }, "addressLine1" : { "description" : "First line of the standard address object.", "type" : "string" }, "addressLine2" : { "description" : "Second line of the standard address object.", "type" : "string" }, "addressLine3" : { "description" : "Third line of the standard address object.", "type" : "string" }, "postcode" : { "description" : "Mandatory for Australian addresses.", "type" : "string" }, "city" : { "description" : "Name of the city or locality.", "type" : "string" }, "state" : { "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`.", "type" : "string" }, "country" : { "default" : "AUS", "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.", "type" : "string", "x-cds-type" : "ExternalRef" } }, "required" : [ "addressLine1", "city", "state" ], "type" : "object", "x-conditional" : [ "postcode" ] }, "CommonPAFAddress" : { "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). Required if _addressUType_ is set to `paf`.", "properties" : { "dpid" : { "description" : "Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.", "type" : "string" }, "thoroughfareNumber1" : { "description" : "Thoroughfare number for a property (first number in a property ranged address).", "type" : "integer", "x-cds-type" : "PositiveInteger" }, "thoroughfareNumber1Suffix" : { "description" : "Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated.", "type" : "string" }, "thoroughfareNumber2" : { "description" : "Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25).", "type" : "integer", "x-cds-type" : "PositiveInteger" }, "thoroughfareNumber2Suffix" : { "description" : "Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated.", "type" : "string" }, "flatUnitType" : { "description" : "Type of flat or unit for the address.", "type" : "string" }, "flatUnitNumber" : { "description" : "Unit number (including suffix, if applicable).", "type" : "string" }, "floorLevelType" : { "description" : "Type of floor or level for the address.", "type" : "string" }, "floorLevelNumber" : { "description" : "Floor or level number (including alpha characters).", "type" : "string" }, "lotNumber" : { "description" : "Allotment number for the address.", "type" : "string" }, "buildingName1" : { "description" : "Building/Property name 1.", "type" : "string" }, "buildingName2" : { "description" : "Building/Property name 2.", "type" : "string" }, "streetName" : { "description" : "The name of the street.", "type" : "string" }, "streetType" : { "description" : "The street type. Valid enumeration defined by Australia Post PAF code file.", "type" : "string" }, "streetSuffix" : { "description" : "The street type suffix. Valid enumeration defined by Australia Post PAF code file.", "type" : "string" }, "postalDeliveryType" : { "description" : "Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file.", "type" : "string" }, "postalDeliveryNumber" : { "description" : "Postal delivery number if the address is a postal delivery type.", "type" : "integer", "x-cds-type" : "PositiveInteger" }, "postalDeliveryNumberPrefix" : { "description" : "Postal delivery number prefix related to the postal delivery number.", "type" : "string" }, "postalDeliveryNumberSuffix" : { "description" : "Postal delivery number suffix related to the postal delivery number.", "type" : "string" }, "localityName" : { "description" : "Full name of locality.", "type" : "string" }, "postcode" : { "description" : "Postcode for the locality.", "type" : "string" }, "state" : { "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`.", "type" : "string" } }, "required" : [ "localityName", "postcode", "state" ], "type" : "object" }, "Links" : { "properties" : { "self" : { "description" : "Fully qualified link that generated the current response document.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "self" ], "type" : "object" }, "Meta" : { "type" : "object" }, "LinksPaginated" : { "properties" : { "self" : { "description" : "Fully qualified link that generated the current response document.", "type" : "string", "x-cds-type" : "URIString" }, "first" : { "description" : "URI to the first page of this set. Mandatory if this response is not the first page.", "type" : "string", "x-cds-type" : "URIString" }, "prev" : { "description" : "URI to the previous page of this set. Mandatory if this response is not the first page.", "type" : "string", "x-cds-type" : "URIString" }, "next" : { "description" : "URI to the next page of this set. Mandatory if this response is not the last page.", "type" : "string", "x-cds-type" : "URIString" }, "last" : { "description" : "URI to the last page of this set. Mandatory if this response is not the last page.", "type" : "string", "x-cds-type" : "URIString" } }, "required" : [ "self" ], "type" : "object", "x-conditional" : [ "prev", "next", "first", "last" ] }, "MetaPaginated" : { "properties" : { "totalRecords" : { "description" : "The total number of records in the full set. See [pagination](#pagination).", "type" : "integer", "x-cds-type" : "NaturalNumber" }, "totalPages" : { "description" : "The total number of pages in the full set. See [pagination](#pagination).", "type" : "integer", "x-cds-type" : "NaturalNumber" } }, "required" : [ "totalPages", "totalRecords" ], "type" : "object" }, "MetaPaginatedTransaction" : { "allOf" : [ { "$ref" : "#/components/schemas/MetaPaginated" }, { "$ref" : "#/components/schemas/MetaPaginatedTransaction_allOf" } ] }, "ResponseErrorListV2" : { "properties" : { "errors" : { "description" : "List of errors.", "items" : { "$ref" : "#/components/schemas/ErrorV2" }, "type" : "array" } }, "required" : [ "errors" ], "type" : "object" }, "ErrorV2" : { "properties" : { "code" : { "description" : "The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the _meta_ object. Otherwise, the value is the error code URN.", "type" : "string" }, "title" : { "description" : "A short, human-readable summary of the problem that **MUST NOT** change from occurrence to occurrence of the problem represented by the error code.", "type" : "string" }, "detail" : { "description" : "A human-readable explanation specific to this occurrence of the problem.", "type" : "string" }, "meta" : { "$ref" : "#/components/schemas/ErrorV2_meta" } }, "required" : [ "code", "detail", "title" ], "type" : "object", "x-conditional" : [ "meta" ] }, "BankingProductCategory" : { "description" : "The category to which a product or account belongs. See [here](#product-categories) for more details.", "enum" : [ "BUSINESS_LOANS", "CRED_AND_CHRG_CARDS", "LEASES", "MARGIN_LOANS", "OVERDRAFTS", "PERS_LOANS", "REGULATED_TRUST_ACCOUNTS", "RESIDENTIAL_MORTGAGES", "TERM_DEPOSITS", "TRADE_FINANCE", "TRANS_AND_SAVINGS_ACCOUNTS", "TRAVEL_CARDS" ], "type" : "string" }, "NppPaymentService" : { "description" : "Identifier of the applicable overlay service. The _service_ is used in conjunction with the _serviceVersion_. See [here](#npp-services) for more details.", "enum" : [ "X2P1", "IFTI", "BSCT", "CATSCT" ], "example" : "X2P1", "type" : "string" }, "BankingProductId" : { "description" : "A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.", "type" : "string", "x-cds-type" : "ASCIIString" }, "BankingAccountId" : { "description" : "A unique identifier for a Banking account, generated according to [CDR ID Permanence](#id-permanence) requirements.", "type" : "string", "x-cds-type" : "ASCIIString" }, "BankingTransactionId" : { "description" : "A unique identifier for a Banking transaction, generated according to [CDR ID Permanence](#id-permanence) requirements.", "type" : "string", "x-cds-type" : "ASCIIString" }, "BankingScheduledPaymentId" : { "description" : "A unique identifier for a Banking scheduled payment, generated according to [CDR ID Permanence](#id-permanence) requirements.", "type" : "string", "x-cds-type" : "ASCIIString" }, "BankingPayeeId" : { "description" : "A unique identifier for a Banking payee, generated according to [CDR ID Permanence](#id-permanence) requirements.", "type" : "string", "x-cds-type" : "ASCIIString" }, "RequestAccountIdListV1_data" : { "properties" : { "accountIds" : { "description" : "Array of _accountId_ values to obtain data for.", "items" : { "$ref" : "#/components/schemas/BankingAccountId" }, "type" : "array" } }, "required" : [ "accountIds" ], "type" : "object" }, "ResponseBankingProductListV3_data" : { "properties" : { "products" : { "description" : "The list of products returned. If the filter results in an empty set then this array may have no records.", "items" : { "$ref" : "#/components/schemas/BankingProductV5" }, "type" : "array" } }, "required" : [ "products" ], "type" : "object" }, "BankingProductDetailV6_allOf" : { "properties" : { "bundles" : { "description" : "An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of _productID_ values of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also.", "items" : { "$ref" : "#/components/schemas/BankingProductBundle" }, "type" : "array" }, "features" : { "description" : "Array of features and limitations of the product.", "items" : { "$ref" : "#/components/schemas/BankingProductFeatureV3" }, "type" : "array" }, "constraints" : { "description" : "Constraints on the application for the product such as minimum balances or limit thresholds.", "items" : { "$ref" : "#/components/schemas/BankingProductConstraintV3" }, "type" : "array" }, "eligibility" : { "description" : "Eligibility criteria for the product.", "items" : { "$ref" : "#/components/schemas/BankingProductEligibilityV2" }, "type" : "array" }, "fees" : { "description" : "Fees applicable to the product.", "items" : { "$ref" : "#/components/schemas/BankingProductFeeV2" }, "type" : "array" }, "depositRates" : { "description" : "Interest rates available for deposits.", "items" : { "$ref" : "#/components/schemas/BankingProductDepositRateV2" }, "type" : "array" }, "lendingRates" : { "description" : "Interest rates charged against lending balances.", "items" : { "$ref" : "#/components/schemas/BankingProductLendingRateV3" }, "type" : "array" } }, "type" : "object" }, "ResponseBankingAccountListV2_data" : { "properties" : { "accounts" : { "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/BankingAccountV2" }, "type" : "array" } }, "required" : [ "accounts" ], "type" : "object" }, "BankingAccountDetailV4_allOf" : { "properties" : { "bsb" : { "description" : "The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.", "type" : "string" }, "accountNumber" : { "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.", "type" : "string" }, "bundleName" : { "description" : "Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.", "type" : "string" }, "specificAccountUType" : { "description" : "The type of structure to present account specific fields.", "enum" : [ "creditCard", "loan", "termDeposit" ], "type" : "string" }, "termDeposit" : { "description" : "Mandatory if the _specificAccountUType_ value is `termDeposit`.", "items" : { "$ref" : "#/components/schemas/BankingTermDepositAccount" }, "type" : "array" }, "creditCard" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingCreditCardAccount" } ], "description" : "Mandatory if the _specificAccountUType_ value is `creditCard`." }, "loan" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingLoanAccountV3" } ], "description" : "Mandatory if the _specificAccountUType_ value is `loan`." }, "depositRate" : { "description" : "Current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call.", "type" : "string", "x-cds-type" : "RateString" }, "lendingRate" : { "description" : "The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.", "type" : "string", "x-cds-type" : "RateString" }, "depositRates" : { "description" : "Fully described deposit rates for this account based on the equivalent structure in Product Reference.", "items" : { "$ref" : "#/components/schemas/BankingProductDepositRateV2" }, "type" : "array" }, "lendingRates" : { "description" : "Fully described lending rates for this account based on the equivalent structure in Product Reference.", "items" : { "$ref" : "#/components/schemas/BankingProductLendingRateV3" }, "type" : "array" }, "features" : { "description" : "Array of features of the account based on the equivalent structure in Product Reference with the following additional field.", "items" : { "allOf" : [ { "$ref" : "#/components/schemas/BankingProductFeatureV3" }, { "properties" : { "isActivated" : { "default" : "UNKNOWN", "description" : "**Note:** This is an additional field appended to the feature structure defined in the Product Reference payload.", "enum" : [ "ACTIVATED", "NOT_ACTIVATED", "UNKNOWN" ], "type" : "string" } }, "type" : "object" } ], "type" : "object" }, "type" : "array" }, "fees" : { "description" : "Fees and charges applicable to the account based on the equivalent structure in Product Reference.", "items" : { "$ref" : "#/components/schemas/BankingProductFeeV2" }, "type" : "array" }, "addresses" : { "description" : "The addresses for the account to be used for correspondence.", "items" : { "$ref" : "#/components/schemas/CommonPhysicalAddress" }, "type" : "array" } }, "type" : "object", "x-conditional" : [ "termDeposit", "creditCard", "loan" ] }, "ResponseBankingTransactionList_data" : { "properties" : { "transactions" : { "items" : { "$ref" : "#/components/schemas/BankingTransaction" }, "type" : "array" } }, "required" : [ "transactions" ], "type" : "object" }, "BankingTransactionDetailV2_allOf_extendedData_nppPayload" : { "description" : "Required if the _extensionUType_ value is `nppPayload`.", "properties" : { "extendedDescription" : { "description" : "An extended string description. Required if the _extensionUType_ value is `nppPayload`.", "type" : "string" }, "endToEndId" : { "description" : "An end to end ID for the payment created at initiation.", "type" : "string" }, "purposeCode" : { "description" : "Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).", "type" : "string", "x-cds-type" : "ExternalRef" }, "service" : { "$ref" : "#/components/schemas/NppPaymentService" }, "serviceVersion" : { "description" : "Two-digit NPP service overlay version with leading zero.", "example" : "03", "type" : "string", "x-cds-type" : "ExternalRef" } }, "required" : [ "service", "serviceVersion" ], "type" : "object", "x-conditional" : [ "extendedDescription" ] }, "BankingTransactionDetailV2_allOf_extendedData" : { "properties" : { "payer" : { "description" : "Label of the originating payer. Mandatory for inbound payment.", "type" : "string" }, "payee" : { "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).", "type" : "string" }, "extensionUType" : { "description" : "Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.", "enum" : [ "nppPayload" ], "type" : "string" }, "nppPayload" : { "$ref" : "#/components/schemas/BankingTransactionDetailV2_allOf_extendedData_nppPayload" } }, "type" : "object", "x-conditional" : [ "payer", "payee", "nppPayload" ] }, "BankingTransactionDetailV2_allOf" : { "properties" : { "extendedData" : { "$ref" : "#/components/schemas/BankingTransactionDetailV2_allOf_extendedData" } }, "required" : [ "extendedData" ], "type" : "object" }, "ResponseBankingAccountsBalanceList_data" : { "properties" : { "balances" : { "description" : "The list of balances returned.", "items" : { "$ref" : "#/components/schemas/BankingBalance" }, "type" : "array" } }, "required" : [ "balances" ], "type" : "object" }, "ResponseBankingPayeeListV2_data" : { "properties" : { "payees" : { "description" : "The list of payees returned.", "items" : { "$ref" : "#/components/schemas/BankingPayeeV2" }, "type" : "array" } }, "required" : [ "payees" ], "type" : "object" }, "BankingPayeeDetailV2_allOf" : { "properties" : { "payeeUType" : { "description" : "Type of object included that describes the payee in detail.", "enum" : [ "biller", "digitalWallet", "domestic", "international" ], "type" : "string" }, "biller" : { "$ref" : "#/components/schemas/BankingBillerPayee" }, "domestic" : { "$ref" : "#/components/schemas/BankingDomesticPayee" }, "digitalWallet" : { "$ref" : "#/components/schemas/BankingDigitalWalletPayee" }, "international" : { "$ref" : "#/components/schemas/BankingInternationalPayee" } }, "required" : [ "payeeUType" ], "type" : "object", "x-conditional" : [ "biller", "digitalWallet", "domestic", "international" ] }, "BankingInternationalPayee_beneficiaryDetails" : { "properties" : { "name" : { "description" : "Name of the beneficiary.", "type" : "string" }, "country" : { "description" : "Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code.", "type" : "string", "x-cds-type" : "ExternalRef" }, "message" : { "description" : "Response message for the payment.", "type" : "string" } }, "required" : [ "country" ], "type" : "object" }, "BankingInternationalPayee_bankDetails_bankAddress" : { "properties" : { "name" : { "description" : "Name of the recipient Bank.", "type" : "string" }, "address" : { "description" : "Address of the recipient Bank.", "type" : "string" } }, "required" : [ "address", "name" ], "type" : "object" }, "BankingInternationalPayee_bankDetails" : { "properties" : { "country" : { "description" : "Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code.", "type" : "string", "x-cds-type" : "ExternalRef" }, "accountNumber" : { "description" : "Account Targeted for payment.", "type" : "string" }, "bankAddress" : { "$ref" : "#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress" }, "beneficiaryBankBIC" : { "description" : "Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html).", "type" : "string", "x-cds-type" : "ExternalRef" }, "fedWireNumber" : { "description" : "Number for Fedwire payment (Federal Reserve Wire Network).", "type" : "string" }, "sortCode" : { "description" : "Sort code used for account identification in some jurisdictions.", "type" : "string" }, "chipNumber" : { "description" : "Number for the Clearing House Interbank Payments System.", "type" : "string" }, "routingNumber" : { "description" : "International bank routing number.", "type" : "string" }, "legalEntityIdentifier" : { "description" : "The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html).", "type" : "string", "x-cds-type" : "ExternalRef" } }, "required" : [ "accountNumber", "country" ], "type" : "object" }, "ResponseBankingDirectDebitAuthorisationList_data" : { "properties" : { "directDebitAuthorisations" : { "description" : "The list of authorisations returned.", "items" : { "$ref" : "#/components/schemas/BankingDirectDebit" }, "type" : "array" } }, "required" : [ "directDebitAuthorisations" ], "type" : "object" }, "ResponseBankingScheduledPaymentsListV2_data" : { "properties" : { "scheduledPayments" : { "description" : "The list of scheduled payments to return.", "items" : { "$ref" : "#/components/schemas/BankingScheduledPaymentV2" }, "type" : "array" } }, "required" : [ "scheduledPayments" ], "type" : "object" }, "MetaPaginatedTransaction_allOf" : { "properties" : { "isQueryParamUnsupported" : { "default" : false, "description" : "`true` if _text_ query parameter is not supported.", "type" : "boolean" } }, "type" : "object" }, "ErrorV2_meta" : { "description" : "Additional data for customised error codes.", "properties" : { "urn" : { "description" : "The CDR error code URN which the application-specific error code extends. Mandatory if the error _code_ is an application-specific error rather than a standardised error code.", "type" : "string" } }, "type" : "object", "x-conditional" : [ "urn" ] } } } }