Initiate Refresh

post

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

Instruct Bud to retrieve the latest account infomation for a customer. Refresh the accounts from a single provider with an existing connection. If the customer's consent has been revoked or expired for this provider, Bud will be unable to refresh the account. 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.

Body Params

provider

string

required

The name of the provider the task is trying to connect to

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

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

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

Bud Customer identifier

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

Responses

405

The request uses an unexpected HTTP method

5XX

An unexpected error occurred on the server side

Callbacks

Language

Credentials

OAuth2

Response

Choose an example:

application/json

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