Addition of a Know Your Customers (KYC) API allowing clients to perform KYC checks on businesses or their customers.
[BREAKING] The X-Customer-Secret is now a required field within the headers of the /v1/open-banking/authorisation-gateway-url endpoint. Please note that this change will only come into effect in three months time on the 1st of May 2021. All clients with exisitng integrations will be contacted via email by their relevant account manager to inform them of this change. This should provide clients with enough time adjust their integration before the change coming into force. Please contact [email protected] or your account manager if you have any questions, issues or concerns relating to this update.
Addition of the changelog to the api docs, and further information around updates and versioning.
Documentation Bug Fix: redirect_url field is now shown as required within the POST/v1/open-banking/authorisation-url endpoint. This affects those clients using Bud's TSP Aggregation Service.
Introduction of a new payment service within Bud's Payment API. Clients are now able to initiate Scheduled Payments from Bud's Payments service. The scheduled payments service is available to those clients using Bud as a TPP (i.e. via Bud Pay) and as a TSP.
Bud have now released their First Party Transactions Ingestion endpoint. This allows clients to simply post Bud some of their customer's transactions, which will then be run through each of Bud's enrichment and insights services and then stored securely. This opens up Bud's plethora of Insights services, Signal, and Financial Review to those clients with first-party transactional data.
Few changes to the Payments endpoint responses, including:
the GET providers endpoint, required_actions field now becomes an array (as opposed to an object) and is populated with string enums which are now clearly described in the schema.
the response of the create Single Payment and Standing Order endpoints now includes a required_action field as opposed to required_actions (since there will only ever be one next required action). If this field appears within the response then clients must take another action in order to complete the payment flow.
the payment status endpoint also now includes the required_action field, which if not null, clearly indicates that the client is required to perform the necessary action in order for the payment to complete.
updated the payment service enums within the response of the GET providers endpoint, since each provider can now potentially offer domestic-single-payment, domestic-standing-order and (soon to be) domestic-scheduled-payment services.
Added extra information within the description of various Rent Recognition endpoints. This should provide clients with a much clearer understanding of which endpoints are needed and why in order to integrate the entire RR journey.
Added a new POST /v2/customers endpoint that allows clients to create up to 200 customers in a single request.
[BREAKING] Deprecated Financial Assistant endpoints (warnings / trends / forecast) and introduced these endpoints under a new API called Signal with updated urls and operation_ids.
Altered description of the OB Aggregation TPP Retrieve Authorisation Gateway URL to include for information into its usage.
Introduction of a new set of Payments based endpoints allowing customers to set up and authorise standing orders from one of Bud’s supported providers. This comes in the form of:
a new TPP endpoint, where clients can now request a new Bud Pay URL to allows customers to set up a new standing order; and
a new set of TSP endpoints, allowing clients to integrate Bud APIs to allow their customers to initiate standing orders.
Addition of the period field to the GET/v1/salary endpoint to provide an indication into any regulatory associated with a predicted salary transaction.
Added a new endpoint for the OB Aggregation TSP flow - POST/v1/open-banking/authorisation-codes. It allows clients to send back the parameters they receive from the bank once the customer has completed the authorisation process. This allows Bud to match the state to the relevant task id, and also provides the relevant code that will allow Bud to start fetching the customer’s data from the provider.
Financial Assistant service added to the Insights API. This includes three brand new endpoints that help customers to better manage their financial world.
Retrieve Warnings: provides a list of potential scenarios where a customer might suffer some financial expense (e.g. in their overdraft, cannot cover bills, late payment and late income)
Retrieve Trends: provides the key trends associated with a customer’s transactional data broken down by month
Retrieve Forecast - provides a list of the regular and predicted transactions over a given period, noting whether they are booked, pending or predicted.
Affordability Service added to the documentation, including a brand new endpoint to help clients to assess their customers affordability. The Create Spending Groups endpoint allows clients to create their own custom group, e.g. Discretionary Spend, where they can select which of Bud’s categories and/or subcategories will make up the group. All transactions for that customer assigned to the categories/subcategories within the group will be bucketed up and the client will be able to see the total income and expenditure in those categories over a given period of time.
