--- updatedAt: 2026-06-03T11:10:26.000Z agentTools: projectIndex: https://docs-us.thisisbud.com/llms.txt --- # Correction Merchant Search Allows a customer to find a merchant to be used for a correction. # OpenAPI definition ````json { "openapi": "3.0.3", "info": { "version": "1.0.0", "title": "Financial Data API", "contact": { "name": "API Support", "url": "http://www.thisisbud.com/support", "email": "contact@thisisbud.com" }, "x-logo": { "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAATAAAABuCAQAAAAKAYdLAAAACXBIWXMAAC4jAAAuIwF4pT92AAAAB3RJTUUH4wQDDggcbXcx7wAABeJJREFUeNrt3W2IFVUcx/HvXRW1VdQedy1bZVfoYX0osVQyfSGElKbRA5oFIaIlhAkWUYm6gvqqDMHMoBeKlhayCCZC2AMRPay7aJrSZmauZhQqaj7t7u1Fi965987s7D1n7pk7/j73zX2Y85//mXt2Zu45Z2ZBREREREREREREREREREREREREREREREREREREREREREREREREROIiZSFGH+YxgsOs5U/X1bFiPDPpQT3bu1DmcaZyg+vErWpjD+s47zoN6Mte0qRJc4Iq18lYMJv2jvosD11mRUeJpD32UO7664BFGQl94DoZY704fbU2rQwKVWYwbc6bQlSPBaYbtMz4K7nP53lpGkK/q8+7MTxUmeEWtmJcGX+j5psmM0I3l9vCirKAV36OuE46QsbfaHL/9opnL9tcpxBf3V0nkAgzWMRj9HadhrH+3Gk7pBqYDZdY3oXfnHE2gc1U2gyoQ6Rk+pKZdgOqgYnXF7TYDGe3gcWgW85QH9cJxMAVm8HsNrBqhhV1U9g33XUCzo1gsM1wdhtYio8ZWsytYdksFrpOwbGhbLYb0PavyLs5wA+c9v28lRa+Zzt/+y5RwwKqaOCdgCjZRvEit/A1a7jou8xwJjOMAb7D+ylqqCmw1imeZ0oCBrv7Mzp+/QofFTDCdZG13Jw3Wi1nOpbZT9+QGUziUkeZ3T49z+P4pqCRuCkhM1jjfMwwqsdG182rsAaWJs0JxuWJ9knGEq+EzODHjDLTcj5NsbjgwehwDazm6vyL5D2MG5i7booKdjE25917M57XhoxUG1hmJUsjrmWtlVl18ZQ2DeCyH6ycT7kpIJ+wuQWVeZJXI69HcpsXHDQN4LajtZIlkcbvzWqn9St1R3nPNIT93wzt/MSZPO+nqKA65699Nos5FdHmgZkMzHnvIj9zLm9+Q7jd0nqP8VtkdSqWNppYxT+u08g+yW8OnKRXw4ac08hnPUscyvjkw5AZXM4os9jzyY6sdZ3h5YC++jLm0lrASf50T5krzEn0QbOLbB8in2FvwKfNPJczCXd0hLV7wPPqL8bybt691//aWWfhkPo2681PjZPDbgP7lYZOl1nNJs9rW4elXD2zfkK8wIFOy2w1XuuWyOpTkuw2sHOhlqrzvIqu59gbuYEdIcqcjSyb65SLX5EHOepgrbuKtJ6nHNQtxtx0U5xM8DoXMkez7K5xM7Tp4iS4WOvszvss5feSP9Fvo5EVnDDfHGJfpd157Y48xFRGmfaEaWcu/qqYZxpCDcxcqR8Mg9xlGkANzNz+BDcx4zEJNTBzv5gPCSeXTvJtmM+3PJqIKdNj6GE3pJsG5mIwOMp1ptnABgd1sq+G7ebnXZncHCKjG3+M1zpLTzMz7AZ00cBG5pmlFb3JmkQTSpPd21HZbWD9Qy21zPPK/zricNH6+B7mvZFreTpEtAFWt0dpsnoWZreBVTG+kyVS1GVN4/vDd9lJVIRY5yzfPdPlrPHHdTwYItr1bkLcTia8M1qPM9F3yRRjcuaYprNmHxzyfNbQyQlnGTM47ynhndFan7WuCywLODz35I2sC9DCXheZHBNpsXvZmu1fkZXs5rjPnPzb8hyAzrIzINr9HOBIwNXat+ZcleS1hame1714izc55jNvbVDBtz7pyWuJuI15P/tnx1F0UwzsQpprO5nil2KIQSZbqcspnwp57+iu2MQT1mMmhNue/MMR3xfwMi8VYRhnmJqXP/MG1lZwyVNMy9l/FR4tf/mdvB553Uz2sXFn+n1YaGCNBZZr5mH25by7xzCb3PKrmM+lgmK1BV4hdc0+2g2zjq8m1wlAOY1dvqXGKep87oZYzUmDW3Vs8+myuIf6Am6AsiT0Nljp/CYl0Twaze9ZaaN3u5w5jAy5L2ylhe/4nAu+S1Qwl+oCsrjCV2wM2KXfwSPUcmPIGv9LPZ91Ye1TEnEb80ztNLE+Dv8MS0RERERERERERERERERERERERERERERERERERERERERERERERERs+Q/rhi5WauEgfQAAAABJRU5ErkJggg==" }, "description": "These endpoints handle the aggregation and retrieval of financial data. They are designed to be generic across\na range of ingestion sources and regions.\n" }, "tags": [ { "name": "Retrieve Financial Data", "x-displayName": "Retrieve Financial Data", "description": "Retrieve a customer's financial data from a range of sources.\n" }, { "name": "Correct Financial Data", "x-displayName": "Correct Financial Data", "description": "Manipulate Transactions held on the Bud platform by finding similar transactions and submitting corrections.\n" } ], "x-readme": { "explorer-enabled": false, "proxy-enabled": true }, "servers": [ { "url": "https://api-sandbox.thisisbud.com", "description": "Bud US" } ], "paths": { "/financial/v3/accounts": { "get": { "tags": [ "Retrieve Financial Data" ], "summary": "Retrieve Accounts V3", "description": "Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below.\n> 📘 Note: > > For more information on the Account object, please refer to our handy [guide](https://docs.thisisbud.com/docs/accounts).\n", "operationId": "financial_v3_accounts_get", "security": [ { "OAuth2": [] } ], "parameters": [ { "in": "header", "name": "X-Client-Id", "schema": { "type": "string" }, "required": true, "description": "The API Client Identifier (Service Application Identifier).", "example": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" }, { "in": "header", "name": "X-Customer-Id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "A unique identifier for a Customer, as registered on Bud's platform.", "example": "c3339af9-2426-44d4-9c4d-ddb8fd281e23" }, { "in": "header", "name": "X-Customer-Idempotent-Identifier", "schema": { "type": "string" }, "description": "Use the internal client identifier, provided in the `client_metadata` object when creating the customer in __Create Customer V3__, in place of an `X-Customer-Id` header.\n" }, { "in": "query", "name": "currency", "schema": { "type": "string" }, "example": "GBP", "description": "Use this parameter to filter the results returned on the `currency` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `currency` will be returned." }, { "in": "query", "name": "provider", "schema": { "type": "string" }, "example": "BankOfBud", "description": "Use this parameter to filter the results returned on the `provider` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `provider` will be returned." }, { "in": "query", "name": "account_type", "schema": { "type": "string" }, "example": "current_account", "description": "Use this parameter to filter the results returned on the `account_type` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `account_type` will be returned.\nCurrently supported values include (but are not necessarily limited to):\n - `auto_loan`\n - `boat_loan`\n - `brokerage`\n - `business_loan`\n - `certificate_of_deposit`\n - `charge_card`\n - `checking_account`\n - `credit_card`\n - `current_account`\n - `debit_card`\n - `disability_insurance`\n - `e_money`\n - `health_insurance`\n - `home_equity_loan`\n - `insurance`\n - `investment`\n - `ira`\n - `liability_insurance`\n - `life_insurance`\n - `line_of_credit`\n - `loan`\n - `money_market`\n - `mortgage`\n - `other`\n - `personal_loan`\n - `pre_paid_card`\n - `property_insurance`\n - `roth`\n - `rv_loan`\n - `safe_deposit_box`\n - `savings`\n - `student_loan`\n - `travel_insurance`\n - `vehicle_insurance`\n - `wealth_account`\n" }, { "in": "query", "name": "account_category", "schema": { "type": "string" }, "example": "credit", "description": "The account category that the account type is a part of Currently supported values include (but are not necessarily limited to):\n - `credit`\n - `depository`\n - `insurance`\n - `investment`\n - `loan`\n - `savings`\n - `other` \n" }, { "in": "query", "name": "usage_type", "schema": { "type": "string" }, "example": "personal", "description": "Use this parameter to filter the results returned on the `usage_type` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `usage_type` will be returned.\nCurrently supported values include (but are not necessarily limited to):\n - `personal`\n - `business`\n" }, { "in": "query", "name": "holder_relationship_type", "schema": { "type": "string" }, "example": "joint", "description": "Use this parameter to filter the results returned on the `holder_relationship_type` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `holder_relationship_type` will be returned.\nCurrently supported values include (but are not necessarily limited to):\n - `sole`\n - `joint`\n - `delegate`\n - `unknown`\n" }, { "in": "query", "name": "include_all_balances", "schema": { "type": "boolean" }, "example": true, "description": "Use this parameter to include all balances associated with each account. If this parameter is not provided then only the pending and booked balance will be returned where available.\n" }, { "in": "query", "name": "exclude_restricted", "schema": { "type": "boolean" }, "example": true, "description": "Exclude accounts with a `restriction` of `restricted`." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Retrieve Accounts Response", "type": "object", "required": [ "operation_id", "data", "metadata" ], "properties": { "operation_id": { "type": "string", "enum": [ "financial_v3_accounts_get" ] }, "data": { "type": "array", "items": { "$ref": "#/paths/~1financial~1v3~1accounts~1{account_id}/get/responses/200/content/application~1json/schema/properties/data" } }, "metadata": { "type": "object", "required": [ "parameters", "results" ], "properties": { "parameters": { "type": "object", "properties": { "currencies": { "description": "The Currency values supplied in the request to generate the given result set.", "type": "array", "items": { "title": "Currency", "description": "The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount.\n\nExample: `GBP`\n", "type": "string" } }, "account_types": { "description": "The Account Type values supplied in the request to generate the given result set.\n\nCurrently supported values include (but are not necessarily limited to):\n - `charge_card`\n - `credit_card`\n - `current_account`\n - `e_money`\n - `investment`\n - `loan`\n - `mortgage`\n - `other`\n - `pre_paid_card`\n - `savings`\n", "type": "array", "items": { "type": "string" } }, "account_categories": { "description": "The account category that the account type is a part of\n\nCurrently supported values include (but are not necessarily limited to):\n - `credit`\n - `depository`\n - `insurance`\n - `investment`\n - `loan`\n - `savings`\n - `other`\n", "type": "array", "items": { "type": "string" } }, "usage_types": { "description": "The Usage Type values supplied in the request to generate the given result set.\n\nCurrently supported values include (but are not necessarily limited to):\n - `personal`\n - `business`\n", "type": "array", "items": { "type": "string" } }, "holder_types": { "description": "The Holder Type values supplied in the request to generate the given result set.\n\nCurrently supported values include (but are not necessarily limited to):\n - `sole`\n - `joint`\n - `delegate`\n - `unknown`\n", "type": "array", "items": { "type": "string" } }, "providers": { "description": "The Provider values supplied in the request to generate the given result set.", "type": "array", "items": { "type": "string" } }, "include_all_balances": { "type": "boolean", "description": "All balances and credit lines stored for the accounts are returned" } } }, "results": { "type": "number", "description": "The number of accounts returned in the results" } } } } }, "examples": { "Account": { "value": { "operation_id": "financial_v3_accounts_get", "data": [ { "account_id": "RxsYshVGded4JeilkXgWKdXA", "currency": "USD", "holders": [ { "name": "Olivia Johnson", "relationship": "unknown" } ], "account_name": "Plaid Checking", "suggested_name": "Plaid Checking", "account_type": "checking_account", "usage_type": "personal", "account_category": "depository", "provider": "plaid", "opening_date_time": "2019-01-10T00:00:00-07:00", "identifiers": { "plaid_account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk7", "plaid_official_name": "Plaid Gold Standard 0% Interest Checking" }, "balances": { "booked": { "date": "2023-01-12T00:00:00Z", "amount": { "value": "3552.61", "currency": "USD" }, "credit_debit_indicator": "credit" }, "pending": { "date": "2023-01-12T00:00:00Z", "amount": { "value": "3552.61", "currency": "USD" }, "credit_debit_indicator": "credit" } }, "credit_lines": { "limit": { "date": "2023-01-12T00:00:00Z", "amount": { "value": "1000.00", "currency": "USD" } } } }, { "account_id": "97282bfc-84a5-44f6-9a3e-399903f92f7a", "currency": "USD", "holders": [ { "name": "Dave Jeffries", "relationship": "unknown" } ], "suggested_name": "Checking Account 8990", "account_type": "checking_account", "usage_type": "personal", "account_category": "depository", "status": "closed", "closed_at": "2023-01-12T00:00:00Z", "provider": "capital one", "provider_display_name": "Capital One", "provider_logo": "https://assets.thisisbud.com/merchants/capital_one.png", "identifiers": { "us_account_number": "33818990" }, "balances": { "booked": { "date": "2023-01-12T00:00:00Z", "amount": { "value": "2552.61", "currency": "USD" }, "credit_debit_indicator": "credit" }, "pending": { "date": "2023-01-11T00:00:00Z", "amount": { "value": "2552.61", "currency": "USD" }, "credit_debit_indicator": "credit" } }, "credit_lines": { "limit": { "date": "2023-01-11T00:00:00Z", "amount": { "value": "1000.00", "currency": "USD" } } } } ], "metadata": { "parameters": { "currencies": [ "USD" ] }, "results": 2 } } } } } } }, "400": { "description": "The request contains an invalid payload.", "content": { "application/json": { "schema": { "title": "Bad Request Response", "type": "object", "description": "Expected response structure", "required": [ "operation_id", "code_id", "message", "errors" ], "properties": { "operation_id": { "title": "Operation Id Field", "type": "string", "description": "A unique identifier/reference associated with a given endpoint/operation" }, "code_id": { "type": "string", "description": "A descriptive enough string that is linked to the reason for the error." }, "message": { "type": "string" }, "errors": { "anyOf": [ { "title": "Error Object", "type": "object", "nullable": true, "description": "Contains a field specific error message", "additionalProperties": { "type": "string" } }, { "title": "Array of Error Object", "description": "Contains a list of error messages", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } ] } } }, "examples": { "CustomerID Not Sent": { "value": { "operation_id": "financial_v3_accounts_get", "code_id": "failed_validation", "message": "Invalid request payload.", "errors": { "X-Customer-Id": "not present" } } } } } } }, "401": { "description": "Unauthorised", "content": { "application/json": { "schema": { "title": "Server Error Response", "type": "object", "required": [ "operation_id", "code_id", "message" ], "properties": { "operation_id": { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema/properties/operation_id" }, "code_id": { "type": "string", "description": "A descriptive enough string that is linked to the reason for the error." }, "message": { "type": "string", "description": "An actual user friendly error message." }, "errors": { "anyOf": [ { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema/properties/errors/anyOf/0" }, { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema/properties/errors/anyOf/1" } ] } } }, "example": { "operation_id": "unknown", "code_id": "unknown", "message": "Unauthorised request" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/401/content/application~1json/schema" }, "example": { "operation_id": "unknown", "code_id": "unknown", "message": "An error occurred while processing your request. Get in touch with us and provide us your request id: 7ef63242-ba6d-4661-8014-f9eaa9cb2ad8" } } } } } } }, "/corrections/v2/merchants/search/{merchant_query}": { "get": { "tags": [ "Correct Financial Data" ], "summary": "Correction Merchant Search", "description": "Allows a customer to find a merchant to be used for a correction.\n", "operationId": "corrections_v2_merchant_search_get", "security": [ { "OAuth2": [] } ], "parameters": [ { "$ref": "#/paths/~1financial~1v3~1accounts/get/parameters/0" }, { "$ref": "#/paths/~1financial~1v3~1accounts/get/parameters/1" }, { "$ref": "#/paths/~1financial~1v3~1accounts/get/parameters/2" }, { "in": "path", "name": "merchant_query", "schema": { "type": "string", "minLength": 3 }, "required": true, "description": "Merchant Name Query" } ], "responses": { "200": { "description": "The request was successfully processed", "content": { "application/json": { "schema": { "title": "Customer Merchant Correction Search Response", "type": "object", "description": "Expected response structure for the merchant corrections search endpoint", "required": [ "operation_id", "data", "metadata" ], "properties": { "operation_id": { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema/properties/operation_id" }, "data": { "title": "Customer Merchant Corrections Request Payload", "type": "array", "description": "List of merchant that matched the query. Best match first", "items": { "type": "object", "required": [ "id", "display_name", "slug", "logo" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID corresponding to the merchant, if available. Subject to version control." }, "display_name": { "type": "string", "description": "UI friendly display name for the merchant." }, "slug": { "type": "string", "description": "Unique human readable identifier of the merchant. Not subject to version control." }, "logo": { "type": "string", "description": "A url to the merchant logo. If not available a placeholder is used" }, "website": { "type": "string", "description": "URL supplying merchant website, if available." } } } }, "metadata": { "title": "Customer Merchant Corrections Search Response Metadata", "type": "object", "required": [ "query", "results" ], "properties": { "query": { "type": "string", "description": "Query used in the request" }, "results": { "type": "number", "description": "Number of results returned" } } } } }, "example": { "operation_id": "corrections_v2_merchant_search_get", "data": [ { "id": "f2b21ff7-836d-468c-8928-e81060d49988", "display_name": "Apple", "slug": "apple", "logo": "https://assets.thisisbud.com/datasci-images/merchant_logos/f2b21ff7-836d-468c-8928-e81060d49988/v1/apple.jpeg", "website": "https://www.apple.com" }, { "id": "a3240c82-728d-4d63-b1b8-9569cae844e8", "display_name": "Tappily", "slug": "tappily", "logo": "https://assets.thisisbud.com/datasci-images/merchant_logos/a3240c82-728d-4d63-b1b8-9569cae844e8/v1/tappily.jpeg", "website": "https://www.tappily.co.uk" }, { "id": "bbf422fd-0db3-4988-a037-36476f6bd774", "display_name": "Zapp", "slug": "zapp", "logo": "https://assets.thisisbud.com/datasci-images/merchant_logos/bbf422fd-0db3-4988-a037-36476f6bd774/v1/zapp.jpeg", "website": "https://tryzapp.com" }, { "id": "b97244e4-c1bf-4c70-a529-e250fc5baf39", "display_name": "WAPPA LTD", "slug": "wappaltd", "logo": "https://assets.thisisbud.com/bud-datasci-images/merchant_logo_placeholder.png" }, { "id": "2270343a-110d-4554-8871-33f2e18f8311", "display_name": "Apple Pay", "slug": "applepay", "logo": "https://assets.thisisbud.com/datasci-images/merchant_logos/2270343a-110d-4554-8871-33f2e18f8311/v2/applepay.jpeg", "website": "https://www.apple.com" } ], "metadata": { "query": "appl", "results": 5 } } } } }, "400": { "description": "The request contains an invalid payload.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema" }, "examples": { "Invalid Query Size": { "summary": "query size to small", "value": { "operation_id": "corrections_v2_merchant_search_get", "code_id": "failed_validation", "message": "invalid search query size", "errors": {} } } } } } }, "401": { "description": "Unauthorised request" }, "405": { "description": "An unexpected HTTP method was used" }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/paths/~1financial~1v3~1accounts/get/responses/400/content/application~1json/schema" }, "examples": { "Too Many Requests": { "summary": "making too many requests to endpoint", "value": { "operation_id": "unknown", "code_id": "unknown", "message": "Too many requests", "errors": {} } } } } } }, "5XX": { "description": "An unexpected error occurred on the server side" } } } } }, "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/v1/oauth/token", "scopes": {} } }, "description": "\nAuthentication flow:\n\n1. Perform OAuth2 Client Credentials authentication using API Credentials (`client_id`,`client_secret`) to obtain an `access_token` against `/v1/oauth/token` endpoint,\n2. Use `access_token` as Bearer Authorisation for every other API request,\n3. Include `X-Client-Id` (=client_id) within the header of every API request,\n4. Note that some of the requests may also require `X-Customer-Id` to be provided within the request header.\n\n### Examples\nObtain OAuth2 `access_token` and `refresh_token` using `grant_type=client_credentials` and HTTP Basic auth header\n\n```\ncurl --basic --user {{client_id}}:{{client_secret}} \\\n -X POST https://api-sandbox.thisisbud.com/v1/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d grant_type=client_credentials\n```\n\nSuccessful response:\n```\n{\n \"operation_id\": \"oauth_token_post\",\n \"data\": {\n \"access_token\": \"dd0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff15\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"refresh_token\": \"fac32cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n }\n}\n```\n\nRefresh `access_token` token using `refresh_token` against `/v1/oauth/token` endpoint with `grant_type=refresh_token`\n\n```\ncurl -X POST \\\n https://api-sandbox.thisisbud.com/v1/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -H 'X-Client-Id: {{client_id}}' \\\n -d 'grant_type=refresh_token&refresh_token={{refresh_token}}'\n```\n\nSuccessful response:\n```\n{\n \"operation_id\": \"oauth_token_post\",\n \"data\": {\n \"access_token\": \"cc0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff94\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"refresh_token\": \"ffc30cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n }\n}\n```\n" } } } } ````