Initiate Refresh V2

post

https://api-sandbox.thisisbud.com/open-banking/v2/refresh

Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from all providers with an existing connection.

By default this task will retrieve transactions since the last pull of transactions less seven days. This can be overridden using the from body parameter to a maximum of 90 days previously. On completion of this task Bud will send a webhook to your configured endpoint including details of the refresh completed and the status of the refresh for each provider. Alternatively the status of the task can be checked using the Retrieve Refresh Status V2 endpoint. Please check that the task has completed successfully before trying to access the Customer's data or initiating another refresh.

If a similar refresh (same providers) for this customer has been initiated within the last hour, the endpoint will return the task_id of the previous task instead of refreshing the data again.

If the customer's consent has been revoked or expired for a provider, Bud will be unable to refresh the customers account at that provider. This will be confirmed in the response of the refresh status endpoint associated with the task_id provided in the response to this endpoint, where the reconnect_required field will set to true and status set to Completed. If the consent within the Bud system was marked as Authorised at this point the consent will be updated to Revoked

To simplify your integration Bud is able to take control of your background refreshes and manage these regularly for you. Full details can be found on the following guide

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

providers

array of strings

Optional parameter defining the name of the providers that a refresh should be completed for. If this is not specified a refresh is completed for all providers that a customer has an authorised consent with.

providers

from

string

The datetime (ISO 8601) that defines the time since when the Customer's data needs to be collected. Defaults to the datetime of the last pull of transactions less seven days to account for any potential changes to the most recent set of transactions. Refreshes can only go back to a maximum of 90 days from the current date.

string

The datetime (ISO 8601) that defines the time up to which the Customer's data needs to be collected. Defaults to the current datetime.

resources

array of strings

Optional list of resources that should be refreshed. Default behaviour is to refresh all resources defined on the customers consent

resources

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

X-Customer-Ip-Address

string

required

The IP address of the personal device the customer is initiating the refresh from. This header should only be supplied if the customer has initiated the refresh from a personal device, and never if the refresh has been initated from an automated process such as a script. The IP address is forwarded to the provider and can help avoid hitting limits on how frequently a refresh can be initiated.

Responses

405

The request uses an unexpected HTTP method

5XX

An unexpected error occurred on the server side

Callbacks

202A new Task has been generated to request the Customer's bank account refresh. The generated task_id can be used to check the Task's status.

400The request contains an invalid payload.