{ "opencollection": "1.0.0", "info": { "name": "CDR Accounts Banking API", "version": "1.36.0" }, "items": [ { "info": { "name": "Banking", "type": "folder" }, "items": [ { "info": { "name": "Get Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "product-category", "value": "", "type": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned." }, { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed" }, { "name": "is-owned", "value": "", "type": "query", "description": "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain a list of accounts" }, { "info": { "name": "Get Bulk Balances", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/balances", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "product-category", "value": "", "type": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned." }, { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed" }, { "name": "is-owned", "value": "", "type": "query", "description": "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain balances for multiple, filtered accounts" }, { "info": { "name": "Get Balances For Specific Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/balances", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain balances for a specified list of accounts" }, { "info": { "name": "Get Account Balance", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId/balance", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "ID of the specific account requested" } ] }, "docs": "Obtain the balance for a single specified account" }, { "info": { "name": "Get Account Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "A tokenised identifier for the account which is unique but not shareable" } ] }, "docs": "Obtain detailed information on a single account" }, { "info": { "name": "Get Transactions For Account", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId/transactions", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "ID of the account to get transactions for. Must have previously been returned by one of the account list end points." }, { "name": "oldest-time", "value": "", "type": "query", "description": "Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type" }, { "name": "newest-time", "value": "", "type": "query", "description": "Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type" }, { "name": "min-amount", "value": "", "type": "query", "description": "Filter transactions to only transactions with amounts higher or equal to than this amount" }, { "name": "max-amount", "value": "", "type": "query", "description": "Filter transactions to only transactions with amounts less than or equal to than this amount" }, { "name": "text", "value": "", "type": "query", "description": "Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain transactions for a specific account.\n\nSome general notes that apply to all end points that retrieve transactions:\n\n- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order\n- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering a" }, { "info": { "name": "Get Transaction Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId/transactions/:transactionId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "ID of the account to get transactions for. Must have previously been returned by one of the account list end points" }, { "name": "transactionId", "value": "", "type": "path", "description": "ID of the transaction obtained from a previous call to one of the other transaction end points" } ] }, "docs": "Obtain detailed information on a transaction for a specific account" }, { "info": { "name": "Get Direct Debits For Account", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId/direct-debits", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain direct debit authorisations for a specific account" }, { "info": { "name": "Get Bulk Direct Debits", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/direct-debits", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "product-category", "value": "", "type": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned." }, { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed" }, { "name": "is-owned", "value": "", "type": "query", "description": "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain direct debit authorisations for multiple, filtered accounts" }, { "info": { "name": "Get Direct Debits For Specific Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/direct-debits", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain direct debit authorisations for a specified list of accounts" }, { "info": { "name": "Get Scheduled Payments for Account", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/accounts/:accountId/payments/scheduled", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain scheduled, outgoing payments for a specific account" }, { "info": { "name": "Get Scheduled Payments Bulk", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/payments/scheduled", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "product-category", "value": "", "type": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned." }, { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed" }, { "name": "is-owned", "value": "", "type": "query", "description": "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments" }, { "info": { "name": "Get Scheduled Payments For Specific Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://mtls.dh.example.com/cds-au/v1/banking/payments/scheduled", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain scheduled payments for a specified list of accounts" }, { "info": { "name": "Get Payees", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/payees", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query", "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" }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain a list of pre-registered payees" }, { "info": { "name": "Get Payee Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/payees/:payeeId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "payeeId", "value": "", "type": "path", "description": "The ID used to locate the details of a particular payee" } ] }, "docs": "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" }, { "info": { "name": "Get Products", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/products", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" } ], "params": [ { "name": "effective", "value": "", "type": "query", "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'" }, { "name": "updated-since", "value": "", "type": "query", "description": "Only include products that have been updated after the specified date and time. If absent defaults to include all products" }, { "name": "brand", "value": "", "type": "query", "description": "Filter results based on a specific brand" }, { "name": "product-category", "value": "", "type": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all products returned." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)" }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)" } ] }, "docs": "Obtain a list of products that are currently openly offered to the market\n\nNote that the results returned by this end point are expected to be ordered according to updated-since\n\n### Conventions\nIn the product reference payloads there are a number of recurring conventions that are explained here, in one place.\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- E" }, { "info": { "name": "Get Product Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/banking/products/:productId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "ID of the specific product requested" } ] }, "docs": "Obtain detailed information on a single product offered openly to the market.\n\nNOTE: This version must be implemented by **July 2026**\n\nObsolete versions: [v1](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-product-detail-v1.html) [v2](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-product-detail-v2.html) [v3](https://consumerdatastandardsaustralia.github.io/standards/includes/obsolete/get-products-v3.html),[v4](https://consumer" } ] } ], "bundled": true }