Easily Integrate
Adatree's Banking API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 17 SDK methods
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
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.
Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
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
Page of results to request (standard pagination)
Page size to request. Default is 25 (standard pagination)
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
Adatree's extension to support account ids for GET /accounts/balances
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.
Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
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
Page of results to request (standard pagination)
Page size to request. Default is 25 (standard pagination)
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
A tokenised identifier for the account which is unique but not shareable
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
A tokenised identifier for the account which is unique but not shareable
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
ID of the account to get transactions for. Must have previously been returned by one of the account list end points.
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
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
Filter transactions to only transactions with amounts higher or equal to than this amount
Filter transactions to only transactions with amounts less than or equal to than this amount
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)
Page of results to request (standard pagination)
Page size to request. Default is 25 (standard pagination)
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
Parameter
Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.
ID of the account to get transactions for. Must have previously been returned by one of the account list end points.
ID of the transaction obtained from a previous call to one of the other transaction end points
The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is "HTTP-date" as in section "7.1.1.1" of RFC7231, e.g., "Tue, 11 Sep 2012 19:43:31 GMT"
The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Format of this field is unclear and might be defined in future as discussed in https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/104
Response
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Adatree
Adatree is a CDR technology intermediary. What does that mean? Simply put, we're the poles and wires connecting Banking, Finance, Energy and Telecommunications with Open Data. Our platform is ready for implementation with out-of-the-box functionality to have you connected to compliant data within a matter of weeks. The new age of data regulations are changing the way FinTech operates. Adatree is your on-ramp to stay plugged into the digital economy. We work with organisations of all sizes and sectors to provide turnkey solutions. We've built a world-class CDR intermediary platform that is the most robust and flexible in market, ready to scale for any Open Data use case. If the scores of awards don't prove it, our list of satisfied clients ought to. When you work with Adatree you're working with genuine CDR experts. We live and breathe this stuff, and strive to make it easy for other businesses to access consumer data with confidence. We'll help you: - Determine which CDR access model is best for your organisation - Implement our fully-compliant white-labelled consent dashboard, tailored to your unique business needs - Meet all compliance and legislative requirements including authentication and consent - Leverage the full CDR ecosystem with every available API - Accelerate your time-to-market to weeks (not months!) with our proven streamlined integration process - Maintain consistent and secure connections to the Consumer Data Right network We know the Consumer Data Right back-to-front and promise to walk you through every stage of the journey. Ready to take the first step? Reach out to our team today: https://www.adatree.com.au/contact