Bud Financial Ingest First Party Data 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 Ingest First Party Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
7 operations
across 7 paths,
and defines 59 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.
The identity and technical contract details declared by the specification.
Ingest First Party Data 7
Initiate the asynchronous process of pushing a customer's account information (i.e. first party data) onto the Bud platform. These asynchronous requests create a task to store the…
POST
/v2/ingest/accounts
Ingest Accounts
v2_ingest_accounts_post
3 params
body
→ 2022044004015XX
POST
/ingestion/v3/accounts/close
Close Accounts
v3_ingest_accounts_close_post
1 param
body
→ 2044004015XX
POST
/ingestion/v3/accounts/reopen
Reopen Accounts
v3_ingest_accounts_reopen_post
1 param
body
→ 2044004015XX
POST
/v2/ingest/transactions
Ingest Transactions
v2_ingest_transactions_post
6 params
body
→ 2002024004015035045XX
POST
/ingestion/v3/transactions/book
Book Transactions
v3_ingest_transactions_book_post
1 param
body
→ 2024004015XX
POST
/ingestion/v3/transactions/decline
Decline Transactions
v3_ingest_transactions_decline_post
1 param
body
→ 2024004015XX
GET
/ingestion/v3/tasks/{task_id}
Retrieve Ingestion Task Status
v3_ingest_status_get
2 params
→ 2004014044055XX
Token
object
The token item.
2 properties
2 required
InpAmount
Amount structure
BodyDecodeError
object
4 properties
4 required
ValidationInvalid
array
list of invalid fields for a transaction
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
IngestV2SyncMetadata
object
Metadata on the created task, including the taskid
3 properties
1 required
IngestAccountDetails
object
Schema to define any further details about a given account
4 properties
2 required
IngestCreditLine
object
A set of elements used to provide details on the credit line
3 properties
2 required
OverallIngestResponseStatus
string
Ingest response status.
IngestFirstPartyDataWithCustomerID
object
2 properties
1 required
CustomerID
string
A unique identifier for a Customer, as registered on Bud's platform.
IngestTransactionsV3Request
array
Ingest transaction expected request body.
IngestAccountsRequest
array
Ingest accounts expected request body.
IngestV2SyncResponse
object
FPIIngestSucceededWebhookBody
object
The payload sent to the client defined webhook (via the console) when an First Party Ingestion task succeeds.
1 property
1 required
schemas-TransactionForSyncIngest
object
A financial transaction
14 properties
8 required
Location
object
Location enrichment associated with a Transaction
3 properties
TransactionWindow
object
The transaction window is used to describe the entire period for which you have provided full coverage for the transactions within the request. It is used by B…
3 properties
3 required
IngestV2SyncResponseData
object
1 property
1 required
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
IngestStatusV3Response
object
Report on the status of an ingestion task
3 properties
3 required
TransactionSettlementV3WebookBody
object
The payload send to the client defined webhook (via the console) when a Book or Decline settlement task is Completed.
1 property
1 required
IngestCustomerAccount
object
An account item.
11 properties
6 required
BudClientAttributes
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
TransactionSettlementV3Response
object
2 properties
2 required
IngestV2AsyncResponse
object
SynchronousEnrichmentsList
array
The list of enrichments product to execute during the synchronous execution of the request. Based on this list, the transactions sent will be processed through…
TaskNotFoundError
object
3 properties
3 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
FirstPartyIngestionGenericError
object
4 properties
4 required
BudCurrency
string
The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount. Example: GBP
IngestResponseV3SubTaskWithCustomerID
object
1 property
1 required
BudTransactionType
object
The code and a description of the transaction type. Providing these fields may help improve enrichment accuracy.
2 properties
IngestResponseV3SubTaskWithCustomerIdempotentIdentifier
object
1 property
1 required
IngestV2Response
object
1 property
1 required
BudAmount
object
The monetary amount.
2 properties
2 required
TransactionWindowArray
array
If not provided, the transaction window is inferred from the date of the first and last transactions. Only a single window per customer account is supported.
AccountsDataValidationError
object
4 properties
4 required
SyncEnrichments
object
Contextual enrichments associated with a Transaction
6 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
Category
object
Category associated with a Transaction
2 properties
2 required
ValidationMissing
array
list of required missing fields for a transaction
CustomerTransactionV3
object
A schema for Bud V3 transaction format
17 properties
5 required
IngestStatusTaskMetadata
object
Expected response structure.
8 properties
2 required
IngestFirstPartyDataWithCustomerIdempotentIdentifier
object
1 property
1 required
IngestV2Metadata
object
Metadata on the created task, including the taskid
3 properties
1 required
ValidationError
object
4 properties
4 required
IngestResponseV3SubTask
object
A single customer ingest task status
3 properties
1 required
FPIIngestFailedWebhookBody
object
The payload sent to the client defined webhook (via the console) when an First Party Ingestion task fails.
1 property
1 required
BadRequestErrorWihoutErrRequired
object
4 properties
3 required
IngestCustomerWithAccounts
object
A customer with a accounts data.
1 property
1 required
IngestAccountBalance
object
Information surrounding a Customer's Account Balance
7 properties
4 required
CustomerSecret
string
The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.
OperationId
string
A unique identifier/reference associated with a given endpoint/operation
IngestTaskResult
string
Indicates the outcome of the ingest task. Either success or various error codes: | code | description | | ---- | ----------- | | success | Ingestion completed…
TransactionSettlementV3Request
array
ReopenAccountsRequest
array
IngestAccountIdentifiers
object
Schema to define identifiers for a given account
2 properties
2 required
CloseAccountsRequest
array
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bud Financial publishes across the network.
