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 Income Transactions V1

get deprecatedhttps://api-sandbox.thisisbud.com/v1/income

Provides a list of a customer's income based transactions found within their connected accounts, and predicts whether each income transaction is related to a customer's salary_or_wages. Any income which is not salary or wages is given the type other_income, which can include other income sources such as investments or pension income.

Notes:

Transactions are filtered to return the latest income transaction per transaction reference. For instance, if the customer has 4 salary transactions all with the same reference of Monthly Salary, only the latest will be returned.

❗️
Deprecation:
Support will cease for this endpoint on the 1st of November 2023 - please complete your migration to the Retrieve Income V2 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com.

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).

X-From

string

Transaction from date

X-To

string

Transaction to date

Responses

Response body

object

operation_id

string

required

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

data

array of objects

required

Array of Income related transactions

data*

object

account_id

string

required

Unique identifier for the account

transaction_id

string

required

Unique identifier for the transaction

description

string

required

Further details of the transaction. This is the transaction narrative, which is unstructured text

date

string

required

The date of the transaction. In the following format 'Year-Month-Day Hour:Minute:Second'. E.g '2019-07-01T01:00:00+0100'

amount

object

required

The monetary amount.

credit_debit_indicator

string

required

Indication as to whether the transaction was a credit or debit

Credit Debit

enrichment

object

required

Results from required enrichment services for successful marking of income transactions

metadata

object

required

Metadata associated with the response schema

from

string

required

The date from when results were retrieved in the format ISO-8601.
This is either populated with the default value used when retrieving the results, or the user specified parameter.

Example: 2023-01-17

string

required

The date up to when results were retrieved in the format ISO-8601.
This is either populated with the default value used when retrieving the results, or the user specified parameter.

Example: 2023-03-17

results

number

required

Number of results returned

204

No transactions

400

Bad request

401

Unauthorised request

404

No transactions found

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Updated over 1 year ago

Retrieve Salary Information

Retrieve Benefits Transactions

Did this page help you?

Language

Credentials

OAuth2

Bearer


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

Choose an example:

application/json

Updated over 1 year ago

Retrieve Salary Information

Retrieve Benefits Transactions

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

200OK