{ "openapi": "3.0.3", "info": { "title": "CDR Banking API", "version": "1.36.0", "description": "Specifications for resource endpoints applicable to data holders in the Banking sector.", "license": { "name": "MIT License", "url": "https://opensource.org/licenses/MIT" }, "contact": { "name": "Data Standards Body", "email": "contact@dsb.gov.au", "url": "https://dsb.gov.au/" } }, "servers": [ { "description": "MTLS", "url": "https://mtls.dh.example.com/cds-au/v1" } ], "tags": [ { "name": "Banking Products", "x-shortName": "Products", "description": "Banking Product endpoints" }, { "name": "Banking Accounts", "x-shortName": "Accounts", "description": "Banking Account endpoints" }, { "name": "Banking Account Balances", "x-shortName": "Account Balances", "description": "Banking Account Balance endpoints" }, { "name": "Banking Account Transactions", "x-shortName": "Transactions", "description": "Banking Account Transaction endpoints" }, { "name": "Banking Account Direct Debits", "x-shortName": "Direct Debits", "description": "Banking Account Direct Debit endpoints" }, { "name": "Banking Account Scheduled Payments", "x-shortName": "Scheduled Payments", "description": "Banking Account Scheduled Payment endpoints" }, { "name": "Banking Payees", "x-shortName": "Payees", "description": "Banking Payee endpoints" } ], "paths": { "/banking/accounts": { "get": { "tags": [ "Banking Accounts" ], "summary": "Get Accounts", "description": "Obtain a list of accounts.\n\nObsolete versions: [v1](includes/obsolete/get-accounts-v1.html), [v2](includes/obsolete/get-accounts-v2.html).", "operationId": "listBankingAccounts", "parameters": [ { "$ref": "#/components/parameters/QueryBankingProductCategory" }, { "$ref": "#/components/parameters/QueryBankingAccountOpenStatus" }, { "$ref": "#/components/parameters/QueryBankingAccountIsOwned" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListBankingAccounts200" }, "400": { "$ref": "#/components/responses/ListBankingAccounts400" }, "406": { "$ref": "#/components/responses/ListBankingAccounts406" }, "422": { "$ref": "#/components/responses/ListBankingAccounts422" } }, "x-scopes": [ "bank:accounts.basic:read" ], "x-version": "3" } }, "/banking/accounts/balances": { "get": { "tags": [ "Banking Account Balances" ], "summary": "Get Bulk Balances", "description": "Obtain balances for multiple, filtered accounts.\n\nObsolete versions: [v1](includes/obsolete/get-bulk-balances-v1.html).", "operationId": "listBankingBalancesBulk", "parameters": [ { "$ref": "#/components/parameters/QueryBankingProductCategory" }, { "$ref": "#/components/parameters/QueryBankingAccountOpenStatus" }, { "$ref": "#/components/parameters/QueryBankingAccountIsOwned" }, { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/ListBankingBalancesBulk200" }, "400": { "$ref": "#/components/responses/ListBankingBalancesBulk400" }, "406": { "$ref": "#/components/responses/ListBankingBalancesBulk406" }, "422": { "$ref": "#/components/responses/ListBankingBalancesBulk422" } }, "x-scopes": [ "bank:accounts.basic:read" ], "x-version": "2" }, "post": { "tags": [ "Banking Account Balances" ], "summary": "Get Balances For Specific Accounts", "description": "Obtain balances for a specified list of accounts.", "operationId": "listBankingBalancesSpecificAccounts", "parameters": [ { "$ref": "#/components/parameters/QueryPage" }, { "$ref": "#/components/parameters/QueryPageSize" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "requestBody": { "$ref": "#/components/requestBodies/RequestAccountIds" }, "responses": { "200": { "$ref": "#/components/responses/ListBankingBalancesSpecificAccounts200" }, "400": { "$ref": "#/components/responses/ListBankingBalancesSpecificAccounts400" }, "406": { "$ref": "#/components/responses/ListBankingBalancesSpecificAccounts406" }, "422": { "$ref": "#/components/responses/ListBankingBalancesSpecificAccounts422" } }, "x-scopes": [ "bank:accounts.basic:read" ], "x-version": "1" } }, "/banking/accounts/{accountId}/balance": { "get": { "tags": [ "Banking Account Balances" ], "summary": "Get Account Balance", "description": "Obtain the balance for a single specified account.", "operationId": "getBankingBalance", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetBankingBalance200" }, "400": { "$ref": "#/components/responses/GetBankingBalance400" }, "404": { "$ref": "#/components/responses/GetBankingBalance404" }, "406": { "$ref": "#/components/responses/GetBankingBalance406" } }, "x-scopes": [ "bank:accounts.basic:read" ], "x-version": "1" } }, "/banking/accounts/{accountId}": { "get": { "tags": [ "Banking Accounts" ], "summary": "Get Account Detail", "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), [v4](includes/obsolete/get-account-detail-v4.html).", "operationId": "getBankingAccountDetail", "parameters": [ { "$ref": "#/components/parameters/PathAccountId" }, { "$ref": "#/components/parameters/HeaderXV" }, { "$ref": "#/components/parameters/HeaderXMinV" }, { "$ref": "#/components/parameters/HeaderXFAPIInteractionId" }, { "$ref": "#/components/parameters/HeaderXFAPIAuthDate" }, { "$ref": "#/components/parameters/HeaderXFAPICustomerIPAddress" }, { "$ref": "#/components/parameters/HeaderXCDSClientHeaders" } ], "responses": { "200": { "$ref": "#/components/responses/GetBankingAccountDetail200" }, "400": { "$ref": "#/components/responses/GetBankingAccountDetail400" }, "404": { "$ref": "#/components/responses/GetBankingAccountDetail404" }, "406": { "$ref": "#/components/responses/GetBankingAccountDetail406" } }, "x-scopes": [ "bank:accounts.detail:read" ], "x-version": "5" } }, "/banking/accounts/{accountId}/transactions": { "get": { "tags": [ "Banking Account Transactions" ], "summary": "Get Transactions For Account", "description": "Obtain transactions for a specific account.\n\nSome general notes that apply to all endpoints that retrieve transactions: