Authentication

OAuth2
- OAuth2post

Customers API

Manage Customers

Connect API

Create a Connection
Manage a Connection
Ingest First Party Data

Financial Data API

Retrieve authorised payments
- Retrieve Authorised Payments V2get
Retrieve Financial Data
Manage Financial Data

Enrichment API

Enrichment Resources
- Retrieve Available Categorisation Models V2get
- Retrieve Categories V2get
Enrichment Totals

Goals API

Savings Goals

Smart Finders API

Regular Payments Finder
Income Finder
Loan Finder
- Retrieve Loan Transactionsget
Debt Finder
- Retrieve Debt Collection Transactionsget
Product Finder
Subscription Finder
- Retrieve Subscriptionsget

Insights API

Retrieve Actionable Insights
Custom Signals
Everyday Money Management
- Retrieve Money Managementget
Customer Characteristics
- Retrieve Customer Characteristicsget
Income and Expenditure Insight

Characteristics API

Retrieve Customer Characteristics

Assess API

Customer Applications
Customer Application Links
- Retrieve Customer Application URLpost
Aggregation Buckets
Assess Affordability
- Create Spending Groupspost
Retrieve Affordability Report

Payments API

Initiate Payment - Bud license
Initiate Payment - Client license
Manage Payments

KYC API

Perform KYC Check

Authentication

OAuth2
- OAuth2post

Customers API

Manage Customers

Connect API

Create a Connection
Manage a Connection
Ingest First Party Data

Financial Data API

Retrieve authorised payments
- Retrieve Authorised Payments V2get
Retrieve Financial Data
Manage Financial Data

Enrichment API

Enrichment Resources
- Retrieve Available Categorisation Models V2get
- Retrieve Categories V2get
Enrichment Totals

Goals API

Savings Goals

Smart Finders API

Regular Payments Finder
Income Finder
Loan Finder
- Retrieve Loan Transactionsget
Debt Finder
- Retrieve Debt Collection Transactionsget
Product Finder
Subscription Finder
- Retrieve Subscriptionsget

Insights API

Retrieve Actionable Insights
Custom Signals
Everyday Money Management
- Retrieve Money Managementget
Customer Characteristics
- Retrieve Customer Characteristicsget
Income and Expenditure Insight

Characteristics API

Retrieve Customer Characteristics

Assess API

Customer Applications
Customer Application Links
- Retrieve Customer Application URLpost
Aggregation Buckets
Assess Affordability
- Create Spending Groupspost
Retrieve Affordability Report

Payments API

Initiate Payment - Bud license
Initiate Payment - Client license
Manage Payments

KYC API

Perform KYC Check

Retrieve Refresh Status

get https://api-sandbox.thisisbud.com/v1/open-banking/refresh/{task_id}

Check the status of an account information refresh task e.g. progress on account information download. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be collected via the Retrieve Financial Data endpoints. Successful requests will include step (1-4) and associated text values to indicate the current progress of the refresh task.

Path Params

task_id

uuid

required

Bud Task identifier returned from an async task for the requested action

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

Bud Customer identifier

Responses

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

data

object

required

A task view.

task_id

string

Bud Task identifier returned from an async task for the requested action

provider

string

The provider (ASPSP) associated with this task

result

string

The result of the operation. Either success or various error codes.

success task_not_found account_not_found internal_error internal_timeout internal_transient_error failed_validation request_validation auth_denied auth_expired connection_not_found connection_expired connection_revoked connection_status connection_permission provider_not_found provider_failure provider_timeout provider_maintenance provider_request_limit provider_endpoint_unimplemented provider_endpoint_deprecated provider_reauthenticate failed_body_decode

status

string

The general status of a task

Pending Complete Failed

reconnect_required

boolean

Indicator as to whether the account needs to be connected again, through SCA authentication.

step

number

The step that this task is currently where 4 = Completed.

1 2 3 4

text

string

A description of the step this task is currently at. In order from step 1 to step 4.

Fetching access token Fetching accounts Fetching balances and transactions Completed

metadata

object

required

Refresh Response Metadata

has_new_transactions

boolean

To describe whether new transactions have been pulled from the relevant
ASPSP during the refresh. Note that if this field is set to false then
there is no need to make a request to any other downstream endpoints to
collect the data related to that customer.

status

string

The general status of a task

Pending Complete Failed

next_url

string

The URL to call to obtain the results of the task

next_url_delay

integer

Recommended delay in milliseconds before next call

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

code_id

string

required

A descriptive enough string that is linked to the reason for the error.

message

string

required

errors

array of objects

required

Contains a list of error messages

Array of Error Object*

object

405

The request uses an unexpected HTTP method

5XX

An unexpected error occurred on the server side

Updated over 1 year ago

Initiate Refresh

Retrieve Customer Consents

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.thisisbud.com/v1/open-banking/refresh/task_id \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated over 1 year ago

Initiate Refresh

Retrieve Customer Consents

Did this page help you?

Authentication
OAuth2
OAuth2post

Customers API
Manage Customers
Update Customer Contextput
Retrieve Customer Contextget
Remove Customerdelete
Create Customer(s)post
Create Customerpost
Create Customers V3 (Batch)post
Create Customer V3post

Connect API
Create a Connection
Retrieve Connection Statusget
Submit Authorisation Codes V2post
Submit Authorisation Codespost
Retrieve Authorisation URLget
Initiate Provider Authorisationpost
Retrieve Authorisation Gateway URL (v2)post
Retrieve OB Providersget
Manage a Connection
Reconfirm Consentpost
Retrieve Revoke Consent Statusget
Initiate Revoke Consentpost
Retrieve Customer Consentsget
Retrieve Refresh Statusget
Initiate Refreshpost
Ingest First Party Data
Retrieve Ingestion Task Statusget
Retrieve Transaction Ingestion Task Statusget
Ingest Transactions V2post
Ingest Transactionspost
Retrieve Accounts Ingestion Task Statusget
Ingest Accountspost

Financial Data API
Retrieve authorised payments
Retrieve Authorised Payments V2get
Retrieve Financial Data
Retrieve Transactionsget
Retrieve Accountsget
Retrieve Transactions V2get
Retrieve Balances Over Time By Accountget
Retrieve Balances Over Timeget
Retrieve Account By ID V2get
Retrieve Accounts V2get
Manage Financial Data
Create Transaction Rule(s)post
Correct Transaction Categories V2post
Correct Transaction Categories V1post
Remove Provider Datadelete

Enrichment API
Enrichment Resources
Retrieve Categories V2get
Retrieve Available Categorisation Models V2get
Enrichment Totals
Retrieve Benefits Totalsget
Retrieve Merchant Totals V2get
Retrieve Category Totals Trendsget
Retrieve Category Totals V2get
Retrieve Category Totalsget

Goals API
Savings Goals
Remove Savings Goal Actiondelete
Update Savings Goal Actionpatch
Retrieve Savings Goal Actionsget
Create Savings Goal Actionpost
Remove Savings Goaldelete
Update Savings Goalpatch
Remove All Savings Goalsdelete
Retrieve Savings Goalsget
Create Savings Goalpost

Smart Finders API
Regular Payments Finder
Retrieve Forecasted Transactions V1get
Retrieve Forecasted Transactions V2get
Retrieve Regular Transactionsget
Income Finder
Retrieve Benefits Transactionsget
Retrieve Income Transactions V1get
Retrieve Salary Informationget
Retrieve Income Transactions V2get
Loan Finder
Retrieve Loan Transactionsget
Debt Finder
Retrieve Debt Collection Transactionsget
Product Finder
Retrieve Energy Paymentsget
Initiate Energy Payments Discoverypost
Retrieve Financial Products V2get
Subscription Finder
Retrieve Subscriptionsget

Insights API
Retrieve Actionable Insights
Retrieve Spending Actionable Insight Detailsget
Retrieve Spending Actionable Insightsget
Retrieve Income Actionable Insight Detailsget
Retrieve Income Actionable Insightsget
Retrieve Balances Actionable Insight Detailsget
Retrieve Balances Actionable Insightsget
Custom Signals
Compare Custom Insightget
Retrieve Custom Insightget
Create Custom Insightpost
Retrieve Componentsget
Everyday Money Management
Retrieve Money Managementget
Customer Characteristics
Retrieve Customer Characteristicsget
Income and Expenditure Insight
Retrieve Financial Forecastget
Retrieve Trendsget
Retrieve Financial Insightsget

Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics - Saverget
Retrieve Customer Characteristics - Overdraftget
Retrieve Customer Characteristics - Loanget
Retrieve Customer Characteristics - Credit Cardget
Retrieve Customer Characteristicsget

Assess API
Customer Applications
Delete Customer Applicationdelete
Retrieve Customer Applicationget
Retrieve Customer Applicationsget
Create Customer Applicationpost
Customer Application Links
Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Bucket Totalsget
Delete Bucketsdelete
Update Bucketput
Retrieve Bucketget
Retrieve All Bucketsget
Create Bucketspost
Assess Affordability
Create Spending Groupspost
Retrieve Affordability Report
Retrieve Affordability Transactions V2get
Retrieve Affordability Transactionsget
Retrieve Affordability Reportget

Payments API
Initiate Payment - Bud license
Retrieve Bud Pay URL - Scheduled Paymentpost
Retrieve Bud Pay URL - Standing Orderpost
Retrieve Bud Pay URL - Single Paymentpost
Retrieve Providersget
Initiate Payment - Client license
Confirm Scheduled Paymentpost
Create Scheduled Paymentpost
Confirm Standing Orderpost
Create Standing Orderpost
Confirm Single Paymentpost
Submit Authorisation Codespost
Create Single Paymentpost
Manage Payments
Retrieve Scheduled Payment Statusget
Search for Scheduled Paymentsget
Retrieve Standing Order Payment Statusget
Search for Standing Ordersget
Retrieve Single Payment Statusget
Search for Single Paymentsget

KYC API
Perform KYC Check
Retrieve KYC Checkget
Initiate Person Checkpost
Initiate Company Checkpost

Authentication
OAuth2
OAuth2post

Customers API
Manage Customers
Update Customer Contextput
Retrieve Customer Contextget
Remove Customerdelete
Create Customer(s)post
Create Customerpost
Create Customers V3 (Batch)post
Create Customer V3post

Connect API
Create a Connection
Retrieve Connection Statusget
Submit Authorisation Codes V2post
Submit Authorisation Codespost
Retrieve Authorisation URLget
Initiate Provider Authorisationpost
Retrieve Authorisation Gateway URL (v2)post
Retrieve OB Providersget
Manage a Connection
Reconfirm Consentpost
Retrieve Revoke Consent Statusget
Initiate Revoke Consentpost
Retrieve Customer Consentsget
Retrieve Refresh Statusget
Initiate Refreshpost
Ingest First Party Data
Retrieve Ingestion Task Statusget
Retrieve Transaction Ingestion Task Statusget
Ingest Transactions V2post
Ingest Transactionspost
Retrieve Accounts Ingestion Task Statusget
Ingest Accountspost

Financial Data API
Retrieve authorised payments
Retrieve Authorised Payments V2get
Retrieve Financial Data
Retrieve Transactionsget
Retrieve Accountsget
Retrieve Transactions V2get
Retrieve Balances Over Time By Accountget
Retrieve Balances Over Timeget
Retrieve Account By ID V2get
Retrieve Accounts V2get
Manage Financial Data
Create Transaction Rule(s)post
Correct Transaction Categories V2post
Correct Transaction Categories V1post
Remove Provider Datadelete

Enrichment API
Enrichment Resources
Retrieve Categories V2get
Retrieve Available Categorisation Models V2get
Enrichment Totals
Retrieve Benefits Totalsget
Retrieve Merchant Totals V2get
Retrieve Category Totals Trendsget
Retrieve Category Totals V2get
Retrieve Category Totalsget

Goals API
Savings Goals
Remove Savings Goal Actiondelete
Update Savings Goal Actionpatch
Retrieve Savings Goal Actionsget
Create Savings Goal Actionpost
Remove Savings Goaldelete
Update Savings Goalpatch
Remove All Savings Goalsdelete
Retrieve Savings Goalsget
Create Savings Goalpost

Smart Finders API
Regular Payments Finder
Retrieve Forecasted Transactions V1get
Retrieve Forecasted Transactions V2get
Retrieve Regular Transactionsget
Income Finder
Retrieve Benefits Transactionsget
Retrieve Income Transactions V1get
Retrieve Salary Informationget
Retrieve Income Transactions V2get
Loan Finder
Retrieve Loan Transactionsget
Debt Finder
Retrieve Debt Collection Transactionsget
Product Finder
Retrieve Energy Paymentsget
Initiate Energy Payments Discoverypost
Retrieve Financial Products V2get
Subscription Finder
Retrieve Subscriptionsget

Insights API
Retrieve Actionable Insights
Retrieve Spending Actionable Insight Detailsget
Retrieve Spending Actionable Insightsget
Retrieve Income Actionable Insight Detailsget
Retrieve Income Actionable Insightsget
Retrieve Balances Actionable Insight Detailsget
Retrieve Balances Actionable Insightsget
Custom Signals
Compare Custom Insightget
Retrieve Custom Insightget
Create Custom Insightpost
Retrieve Componentsget
Everyday Money Management
Retrieve Money Managementget
Customer Characteristics
Retrieve Customer Characteristicsget
Income and Expenditure Insight
Retrieve Financial Forecastget
Retrieve Trendsget
Retrieve Financial Insightsget

Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics - Saverget
Retrieve Customer Characteristics - Overdraftget
Retrieve Customer Characteristics - Loanget
Retrieve Customer Characteristics - Credit Cardget
Retrieve Customer Characteristicsget

Assess API
Customer Applications
Delete Customer Applicationdelete
Retrieve Customer Applicationget
Retrieve Customer Applicationsget
Create Customer Applicationpost
Customer Application Links
Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Bucket Totalsget
Delete Bucketsdelete
Update Bucketput
Retrieve Bucketget
Retrieve All Bucketsget
Create Bucketspost
Assess Affordability
Create Spending Groupspost
Retrieve Affordability Report
Retrieve Affordability Transactions V2get
Retrieve Affordability Transactionsget
Retrieve Affordability Reportget

Payments API
Initiate Payment - Bud license
Retrieve Bud Pay URL - Scheduled Paymentpost
Retrieve Bud Pay URL - Standing Orderpost
Retrieve Bud Pay URL - Single Paymentpost
Retrieve Providersget
Initiate Payment - Client license
Confirm Scheduled Paymentpost
Create Scheduled Paymentpost
Confirm Standing Orderpost
Create Standing Orderpost
Confirm Single Paymentpost
Submit Authorisation Codespost
Create Single Paymentpost
Manage Payments
Retrieve Scheduled Payment Statusget
Search for Scheduled Paymentsget
Retrieve Standing Order Payment Statusget
Search for Standing Ordersget
Retrieve Single Payment Statusget
Search for Single Paymentsget

KYC API
Perform KYC Check
Retrieve KYC Checkget
Initiate Person Checkpost
Initiate Company Checkpost

200The request was successfully processed.

400The request contains an invalid payload