Fair Use Implementation Guide
This guidance should be front of mind when integrating the Bud platform
You must ensure that you only call Bud’s endpoints for new transactions, balances and enrichments required for your product use case. This should be in line with your open banking consent model and contracted refresh limits. Refresh limits will be documented in your signed Service Schedule with Bud, however, please reach out to us if you are unsure how to determine these limits. In addition, when calling Bud endpoints following the initial bank account connection or first party ingestion process, historical transactions, balances and enrichments should be saved into storage and any subsequent calls to Bud endpoints should only be to request new transactions, balances and enrichments.
An example of fair usage is outlined below:
PFM client is contracted for one background refresh and two customer initiated refreshes per customer per day.
PFM customer registers with the PFM app and successfully connects their bank account to the Bud Platform. Once the bank account connection process is complete, PFM client calls Bud endpoints to retrieve the last 12 months of transactions, balances and enrichments and saves this data into storage.
Bud performs a daily background refresh on PFM customer and sends PFM client a webhook notification to say there are new transactions. PFM client calls Bud endpoints to retrieve the new transactions, balances and enrichments and saves this data into storage.
PFM customer signs in to the PFM app which triggers PFM client to perform a customer initiated refresh. Bud sends the PFM client a webhook notification to say there are no new transactions available. PFM client does not need to make any calls to Bud endpoints following this customer initiated refresh as there are no new transactions.
Later that same day, PFM customer signs in to the PFM app once more which triggers PFM client to perform a customer initiated refresh. Bud sends the PFM client a webhook notification to say there are new transactions available. PFM client calls Bud endpoints to retrieve the new transactions, balances and enrichments and saves this data into storage.
This guidance should be front of mind when integrating the Bud platform along with our best practice recommendations to ensure an efficient implementation.
If you have any questions about fair usage or best practice please reach out to your Technical Delivery contact or [email protected].
Updated 6 days ago