How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bud Financial Retrieve Affordability Report V2 API

Breakdown your customer's transactions by fixed/flexible spend and discretionary vs non discretionary high-level totals.Retrieve Affordability Report V2 endpoints are designed to closely reflect the assess dashboard aggregations/definitions.

Bud Financial Retrieve Affordability Report V2 API is one of 32 APIs that Bud Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Retrieve Affordability Report V2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2.10.10.

Requests are made against a single base URL, https://api-sandbox.thisisbud.com.

2 operations 2 paths 32 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.10.10
Base URL
https://api-sandbox.thisisbud.com
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bud Financial Retrieve Affordability Report V2 API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

  • OAuth2 — Authentication flow: 1. Perform OAuth2 Client Credentials authentication using API Credentials (clientid,clientsecret) to obtain an accesstoken against /v1/oau…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Retrieve Affordability Report V2 2

Breakdown your customer's transactions by fixed/flexible spend and discretionary vs non discretionary high-level totals. Retrieve Affordability Report V2 endpoints are designed to…

GET
/affordability/v2/report
Retrieve Affordability Report V2
v2_affordability_report 10 params → 2004004014055XX
GET
/affordability/v2/transactions
Retrieve Affordability Transactions V2
v2_affordability_transactions_get 7 params → 2004004014055XX

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Transaction (19 properties), Merchant (7 properties), Enrichments (7 properties), Processor (6 properties). Each schema is shown below with its type and property counts.

Token
object
The token item.
2 properties 2 required
TransactionsLinks
object
Transaction Links
1 property 1 required
Location
object
Location enrichment associated with a Transaction
3 properties
AffordabilityCriteria
MonthlyIncomeExpenditurePrediction
object
Monthly Income & Expenditure Predictions
4 properties 2 required
IncomeAndExpenditureTransactionsLinks
object
Income & Expenditure Transactions Links
2 properties 2 required
CriteriaEssentialExpenditure
string
Essential expenditure criteria will include all transactions which fall under categories deemed to be essential to a persons day to day life. These expenditure…
CriteriaFlexibleExpenditure
string
Flexible expenditure criteria will include all transactions which fall under the categories defined/expected to be inconsistent. inconsistent in the sense of b…
MonthlyRangePrediction
object
Monthly Range
4 properties 2 required
CriteriaInternalTransfers
string
Internal transfers criteria returns all credit/debit transactions deemed to be made between an individual financial pool. If we drill down to the account level…
BudMonetaryValue
string
The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. Example: 10.98
Enrichments
object
Contextual enrichments associated with a Transaction
7 properties
schemas-DateTimeISO8601
string
ISO Date Format
ClientAttributes
object
An optional map of key-value string pairs that allows clients to attach arbitrary metadata to the transaction. This field can be used to store any relevant inf…
1 property
Transaction
object
A financial transaction
19 properties 8 required
CriteriaNonessentialExpenditure
string
Non essential expenditure criteria will include all transactions which fall under categories deemed to be non essential to a persons day to day life. These exp…
AffordabilityReport
object
Retrieve Affordability Report Response Data
3 properties 3 required
V2AffordabilityReportResponse
object
Expected response structure
2 properties 2 required
Processor
object
Processor enrichment associated with a Transaction, as generated using a combination of Bud's artificial intelligence models and database of known payment proc…
6 properties
CriteriaNetDisposableIncome
string
Net Disposable Income criteria will return all transactions falling within the income category grouping. Typically includes exclusively credit transactions.
BudCurrency
string
The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount. Example: GBP
ReportTotal
object
4 properties 2 required
BudTransactionType
object
The code and a description of the transaction type. Providing these fields may help improve enrichment accuracy.
2 properties
Categories
object
Categories enrichment associated with a Transaction, as generated by Bud's artificial intelligence models. Currently two levels of category are supported, with…
2 properties
MonthlyTotal
object
2 properties 2 required
Regularity
object
Regularity enrichment associated with a Transaction, as generated by Bud's artificial intelligence models. Transactions that are similar and have a known frequ…
3 properties
Category
object
Category associated with a Transaction
2 properties 2 required
TimezoneIdentifier
string
Timezone identifier (e.g. Europe/London) to make dates relativised to the target location. In the case of daylight savings in a location, this ensures that the…
AffordabilityTransactionResponse
object
Expected response structure
3 properties 2 required
CriteriaFixedExpenditure
string
Fixed expenditure criteria will include all transactions which fall under the categories defined/expected to be consistent. Consistent in the sense of both tim…
BudAmount
object
The monetary amount.
2 properties 2 required
Merchant
object
Merchant enrichment associated with a Transaction, as generated using a combination of Bud's artificial intelligence models and database of known merchants.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bud-co-retrieve-affordability-report-v2-api-openapi.yml Raw ↑

Other APIs Bud Financial publishes across the network.

Bud Financial Aggregation Buckets API
Bud Financial Correct Financial Data API
Bud Financial Create a Connection API
Bud Financial Custom Insights API
Bud Financial Customer Application Links API
Bud Financial Customer Applications API
Bud Financial Debt Collection Finder API
Bud Financial Enrichment Resources API
Bud Financial Enrichment Totals API
Bud Financial Frontend Widgets API
Bud Financial Income Finder API
Bud Financial Ingest First Party Data API
Where this information came from

This is an independent, third-party profile of Bud Financial Retrieve Affordability Report V2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.