{ "opencollection": "1.0.0", "info": { "name": "CDR Banking API", "version": "1.36.0" }, "items": [ { "info": { "name": "Banking Accounts", "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.\n\nObsolete versions: [v1](includes/obsolete/get-accounts-v1.html), [v2](includes/obsolete/get-accounts-v2.html)." }, { "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": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "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)." } ] }, { "info": { "name": "Banking Account Balances", "type": "folder" }, "items": [ { "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.\n\nObsolete versions: [v1](includes/obsolete/get-bulk-balances-v1.html)." }, { "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": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain the balance for a single specified account." } ] }, { "info": { "name": "Banking Account Transactions", "type": "folder" }, "items": [ { "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": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." }, { "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-field-types) 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-field-types) common type." }, { "name": "min-amount", "value": "", "type": "query", "description": "Filter transactions to only transactions with amounts higher than or equal to this amount." }, { "name": "max-amount", "value": "", "type": "query", "description": "Filter transactions to only transactions with amounts less than or equal to 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 endpoints that retrieve transactions: