|
AUv1.0.0 (21 APIs)
API Host: https://api.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsGet Account Balance
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listBalance
Get Account DetailNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getAccountDetail
Get Accounts
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listAccounts
Get Balances For Specific AccountsNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listBalancesSpecificAccounts
Get Bulk BalancesNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listBalancesBulk
Get Bulk Direct DebitsNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listDirectDebitsBulk
Get Direct Debits For AccountNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listDirectDebits
Get Direct Debits For Specific AccountsNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listDirectDebitsSpecificAccounts
Get Payee DetailNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getPayeeDetail
Get PayeesNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listPayees
Get Product DetailNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getProductDetail
Get ProductsNOTE: This endpoint currently only returns example data.
Note that the results returned by this end point are expected to be ordered according to updated-since ConventionsIn the product reference payloads there are a number of recurring conventions that are explained here, in one place. Arrays Of FeaturesIn the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:
URIs To More InformationAs 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. These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use difference HTML anchors to focus on a specific topic such as eligibility or fees. Linkage To AccountsFrom 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. For 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. Similarly, 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 actual has been instantiated and created along with the associated decisions inherent in that process. DatesIt 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. In 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 long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listProducts
Get Scheduled Payments BulkNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listScheduledPaymentsBulk
Get Scheduled Payments For Specific AccountsNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listScheduledPaymentsSpecificAccounts
Get Scheduled Payments for AccountNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by listScheduledPayments
Get Transaction DetailNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getTransactionDetail
Get Transactions For AccountNOTE: This endpoint currently only returns example data.
Some general notes that apply to all end points that retrieve transactions:
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getTransactions
Get CustomerNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getCustomer
Get Customer DetailNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getCustomerDetail
Get OutagesNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getOutages
Get StatusNOTE: This endpoint currently only returns example data.
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in AUv1.0.0 by getStatus
|