# Introduction ## Docs - [Clear account-level triggers](https://docs.spade.com/api-reference/action-triggers/clear-account-level-triggers.md): Clear all merchant action triggers at the account scope. - [Clear card-level triggers](https://docs.spade.com/api-reference/action-triggers/clear-card-level-triggers.md): Clear all merchant action triggers at the card scope. - [Clear program-level triggers](https://docs.spade.com/api-reference/action-triggers/clear-program-level-triggers.md): Clear all merchant action triggers at the program scope. - [Clear user-level triggers](https://docs.spade.com/api-reference/action-triggers/clear-user-level-triggers.md): Clear all merchant action triggers at the user scope. - [Get account-level trigger status](https://docs.spade.com/api-reference/action-triggers/get-account-level-trigger-status.md): Get the status and version of the latest merchant action trigger registration at the account scope. - [Get card-level trigger status](https://docs.spade.com/api-reference/action-triggers/get-card-level-trigger-status.md): Get the status and version of the latest merchant action trigger registration at the card scope. - [Get program-level trigger status](https://docs.spade.com/api-reference/action-triggers/get-program-level-trigger-status.md): Get the status and version of the latest merchant action trigger registration at the program scope. - [Get user-level trigger status](https://docs.spade.com/api-reference/action-triggers/get-user-level-trigger-status.md): Get the status and version of the latest merchant action trigger registration at the user scope. - [Incremental trigger operations at account scope](https://docs.spade.com/api-reference/action-triggers/incremental-trigger-operations-at-account-scope.md): Perform incremental operations on merchant action triggers at the account scope. - [Incremental trigger operations at card scope](https://docs.spade.com/api-reference/action-triggers/incremental-trigger-operations-at-card-scope.md): Perform incremental operations on merchant action triggers at the card scope. - [Incremental trigger operations at program scope](https://docs.spade.com/api-reference/action-triggers/incremental-trigger-operations-at-program-scope.md): Perform incremental operations on merchant action triggers at the program scope. - [Incremental trigger operations at user scope](https://docs.spade.com/api-reference/action-triggers/incremental-trigger-operations-at-user-scope.md): Perform incremental operations on merchant action triggers at the user scope. - [Register merchant triggers at account scope](https://docs.spade.com/api-reference/action-triggers/register-merchant-triggers-at-account-scope.md): Register merchant action triggers at the account scope. - [Register merchant triggers at card scope](https://docs.spade.com/api-reference/action-triggers/register-merchant-triggers-at-card-scope.md): Register merchant action triggers at the card scope. - [Register merchant triggers at program scope](https://docs.spade.com/api-reference/action-triggers/register-merchant-triggers-at-program-scope.md): Register merchant action triggers at the program scope. - [Register merchant triggers at user scope](https://docs.spade.com/api-reference/action-triggers/register-merchant-triggers-at-user-scope.md): Register merchant action triggers at the user scope. - [Enrich a batch of card transactions](https://docs.spade.com/api-reference/card-enrichment/enrich-a-batch-of-card-transactions.md): Submit a batch of transactions for enrichment. This endpoint will return a `batchId` which can be used in the `/batches/{batchId}` and `/batches/{batchId}/results` endpoints to check the status of the batch job and retrieve the results. - [Enrich a batch of card transactions with DE43 data](https://docs.spade.com/api-reference/card-enrichment/enrich-a-batch-of-card-transactions-with-de43-data.md): Submit a batch of card transactions for enrichment where de43 data in the request body takes precedence over the other fields in the request body. Just like the `/transactions/cards/enrich/parse` endpoint, the transactions can omit `city` and `merchantName` fields if the `de43` field is present. Thi… - [Enrich a card transaction](https://docs.spade.com/api-reference/card-enrichment/enrich-a-card-transaction.md): When working with this endpoint, note that several of the input fields are optional (region, acquirerId, etc.). However, we *strongly* recommend including all of the fields that you have available. Some optional fields can substantially improve performance. - [Enrich a card transaction](https://docs.spade.com/api-reference/card-enrichment/enrich-a-card-transaction-1.md): Enrich a card transaction. Please use `/transactions/cards/enrich` instead. This endpoint now aliases to `/transactions/cards/enrich`. - [Enrich a card transaction with an unparsed de43](https://docs.spade.com/api-reference/card-enrichment/enrich-a-card-transaction-with-an-unparsed-de43.md): Enrich a card transaction where parsed de43 data takes precedence over the other fields in the request body. This otherwise endpoint is identical to `/transactions/cards/enrich` except that `city` and `merchantName` are now optional, but only when `de43` is included. Note: Because DE43 format is not… - [Enrich a card transaction with an unparsed de43](https://docs.spade.com/api-reference/card-enrichment/enrich-a-card-transaction-with-an-unparsed-de43-1.md): Enrich a card transaction. Please use `/transactions/cards/enrich/parse` instead. This endpoint now aliases to `/transactions/cards/enrich/parse`. - [Get the results of a batch card enrichment job](https://docs.spade.com/api-reference/card-enrichment/get-the-results-of-a-batch-card-enrichment-job.md): Get the results of a batch card enrichment job. - [Get the status of a batch card enrichment job](https://docs.spade.com/api-reference/card-enrichment/get-the-status-of-a-batch-card-enrichment-job.md): Get the status of a batch job. - [Create a custom integration-level category](https://docs.spade.com/api-reference/category-personalization/create-a-custom-integration-level-category.md): Create a custom integration-level category. - [Create a custom user-level category](https://docs.spade.com/api-reference/category-personalization/create-a-custom-user-level-category.md): Create a custom user-level category. - [Create a user-level counterparty category personalization](https://docs.spade.com/api-reference/category-personalization/create-a-user-level-counterparty-category-personalization.md): Create a user-level counterparty category personalization. - [Create an integration-level counterparty category personalization](https://docs.spade.com/api-reference/category-personalization/create-an-integration-level-counterparty-category-personalization.md): Create an integration-level counterparty category personalization. - [Delete a counterparty category personalization](https://docs.spade.com/api-reference/category-personalization/delete-a-counterparty-category-personalization.md): Delete a counterparty category personalization. - [Delete a custom integration-level category](https://docs.spade.com/api-reference/category-personalization/delete-a-custom-integration-level-category.md): Delete a custom integration-level category. - [Delete a custom user-level category](https://docs.spade.com/api-reference/category-personalization/delete-a-custom-user-level-category.md): Delete a custom user-level category. - [Delete a user-level counterparty category personalization](https://docs.spade.com/api-reference/category-personalization/delete-a-user-level-counterparty-category-personalization.md): Delete a user-level counterparty category personalization. - [Delete all custom integration-level categories](https://docs.spade.com/api-reference/category-personalization/delete-all-custom-integration-level-categories.md): Delete all custom integration-level categories. - [Delete all custom user-level categories](https://docs.spade.com/api-reference/category-personalization/delete-all-custom-user-level-categories.md): Delete all custom user-level categories. - [Delete all integration-level counterparty category personalizations](https://docs.spade.com/api-reference/category-personalization/delete-all-integration-level-counterparty-category-personalizations.md): Delete all integration-level counterparty category personalizations. - [Delete all user-level counterparty category personalizations](https://docs.spade.com/api-reference/category-personalization/delete-all-user-level-counterparty-category-personalizations.md): Delete all user-level counterparty category personalizations. - [Get all default and custom integration-level categories](https://docs.spade.com/api-reference/category-personalization/get-all-default-and-custom-integration-level-categories.md): Fetch categories from Spade's database. - [Get all integration-level counterparty category personalizations](https://docs.spade.com/api-reference/category-personalization/get-all-integration-level-counterparty-category-personalizations.md): Fetch counterparty category personalizations from Spade's database. - [Get all user-level counterparty category personalizations](https://docs.spade.com/api-reference/category-personalization/get-all-user-level-counterparty-category-personalizations.md): Fetch user-level counterparty category personalizations from Spade's database. - [Get categories](https://docs.spade.com/api-reference/category-personalization/get-categories.md): Fetch custom user-level categories from Spade's database. - [Report a card enrichment as incorrect](https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect.md): Endpoint to report a card enrichment as incorrect. An `enrichmentId` and an `errorDescription` are required fields to report an enrichment. Optional request fields such as `incorrectLocation`, `incorrectLocationDescription`, `incorrectCategory`, `incorrectCategoryDescription`, `incorrectChannel`, `i… - [Report fraud on a transaction](https://docs.spade.com/api-reference/feedback-and-reporting/report-fraud-on-a-transaction.md): An endpoint for reporting suspected fraud on a transaction which was not related to a chargeback, decline, or refund. If you've already indicated suspected fraud in a chargeback, decline, or refund, it's not necessary to send a request to this endpoint. The `isFraud`, `fraudType`, and `fraudNotes` f… - [Report that a card decline occurred](https://docs.spade.com/api-reference/feedback-and-reporting/report-that-a-card-decline-occurred.md): An endpoint for reporting that a card decline has occurred on a transaction. The `declineCode`, `declineDescription`, and `declineNotes` properties can be used to provide information about the decline. The `isFraud`, `fraudType`, and `fraudNotes` are used to provide information about fraud or suspec… - [Report that a chargeback occurred](https://docs.spade.com/api-reference/feedback-and-reporting/report-that-a-chargeback-occurred.md): An endpoint for reporting that a chargeback process has occurred on a transaction. The `state` and `chargebackNotes` properties can be used to provide information about the chargeback. The `isFraud`, `fraudType`, and `fraudNotes` are used to provide information about fraud or suspected fraud related… - [Report that a refund occurred](https://docs.spade.com/api-reference/feedback-and-reporting/report-that-a-refund-occurred.md): An endpoint for reporting that a refund has occurred on a transaction associated with an enrichment. The `refundNotes` property can be used to provide information about the refund. The `isFraud`, `fraudType`, and `fraudNotes` are used to provide information about fraud or suspected fraud related to… - [Get the results of a batch merchant matching job](https://docs.spade.com/api-reference/merchant-matching/get-the-results-of-a-batch-merchant-matching-job.md): Get the results of a batch merchant matching job. - [Get the status of a batch merchant matching job](https://docs.spade.com/api-reference/merchant-matching/get-the-status-of-a-batch-merchant-matching-job.md): Get the status of a batch merchant matching job. - [Match a batch of merchants](https://docs.spade.com/api-reference/merchant-matching/match-a-batch-of-merchants.md): Submit a batch of merchants for matching. This endpoint will return a `batchId` which can be used in the `/batches/{batchId}` and `/batches/{batchId}/results` endpoints to check the status of the batch job and retrieve the results. - [Match a merchant](https://docs.spade.com/api-reference/merchant-matching/match-a-merchant.md): Match a merchant to a Spade Counterparty and Location. - [Search for merchants](https://docs.spade.com/api-reference/merchant-search/search-for-merchants.md): This endpoint is in beta. To request access, contact [sales@spade.com](mailto:sales@spade.com). - [Enrich a batch of transfers](https://docs.spade.com/api-reference/transfer-enrichment/enrich-a-batch-of-transfers.md): Submit a batch of transfers for enrichment. This endpoint will return a `batchId` which can be used in the `/batches/{batchId}` and `/batches/{batchId}/results` endpoints to check the status of the batch job and retrieve the results. - [Enrich a transfer transaction](https://docs.spade.com/api-reference/transfer-enrichment/enrich-a-transfer-transaction.md): Enrich a transfer transaction such as an ACH withdrawal, ACH deposit, or wire transfer. - [Get the results of a batch transfer enrichment job](https://docs.spade.com/api-reference/transfer-enrichment/get-the-results-of-a-batch-transfer-enrichment-job.md): Get the results of a batch transfer enrichment job. - [Get the status of a batch transfer enrichment job](https://docs.spade.com/api-reference/transfer-enrichment/get-the-status-of-a-batch-transfer-enrichment-job.md): Get the status of a batch transfer enrichment job. - [Enrich a batch of universal transactions](https://docs.spade.com/api-reference/universal-enrichment/enrich-a-batch-of-universal-transactions.md): Submit a batch of universal transactions for enrichment. This endpoint will return a `batchId` which can be used in the `/batches/{batchId}` and `/batches/{batchId}/results` endpoints to check the status of the batch job and retrieve the results. - [Enrich a universal transaction](https://docs.spade.com/api-reference/universal-enrichment/enrich-a-universal-transaction.md): Enrich any type of transaction such as an aggregator transaction, card transaction, ACH withdrawal, ACH deposit, or wire transfer. - [Get the results of a batch universal enrichment job](https://docs.spade.com/api-reference/universal-enrichment/get-the-results-of-a-batch-universal-enrichment-job.md): Get the results of a batch universal enrichment job. - [Changelog](https://docs.spade.com/changelog/changelog.md) - [Batch enrichment guide](https://docs.spade.com/reference/batch-enrichment-guide.md): Enrich many transactions at once - [Batch merchant matching guide](https://docs.spade.com/reference/batch-merchant-matching-guide.md): Merchant matching is not enabled by default. To request access, please contact us at . - [Card enrichment guide](https://docs.spade.com/reference/card-enrichment-guide.md) - [Category personalization guide](https://docs.spade.com/reference/category-personalization-guide.md) - [Glossary](https://docs.spade.com/reference/concepts.md): The following outlines the major concepts you will encounter while integrating with the Spade Card Transaction Enrichment API. Our goal is to enrich your transactions with high quality data, providing as much insight and clarity as possible. - [Overview](https://docs.spade.com/reference/enrichment-guides.md) - [Error reporting guide](https://docs.spade.com/reference/error-reporting-guide.md): Report potential enrichment errors and receive updates via callbacks - [FAQ](https://docs.spade.com/reference/faq.md) - [Improving user experience with Spade](https://docs.spade.com/reference/improved-ux.md) - [Integrating with Spade's API](https://docs.spade.com/reference/integrate-with-spades-api.md) - [Integration category personalization guide](https://docs.spade.com/reference/integration-category-personalization-guide.md) - [Introduction](https://docs.spade.com/reference/introduction.md) - [Understanding match scores](https://docs.spade.com/reference/match-score-guide.md) - [Merchant matching guide](https://docs.spade.com/reference/merchant-matching-guide.md) - [Merchant search guide](https://docs.spade.com/reference/merchant-search-guide.md): Search Spade's merchant database to power autocomplete experiences - [Mobile app data](https://docs.spade.com/reference/mobile-app-data.md) - [Real-time merchant matching guide](https://docs.spade.com/reference/real-time-merchant-matching-guide.md): Merchant matching is not enabled by default. To request access, please contact us at . - [Realtime action triggers guide](https://docs.spade.com/reference/realtime-action-triggers-guide.md): Register action triggers and receive triggered actions in your enrichment responses - [Recurring transaction guide](https://docs.spade.com/reference/recurring-transaction-guide.md): Understand how we identify recurring transactions - [Reducing latency](https://docs.spade.com/reference/reducing-latency.md) - [Risk insights](https://docs.spade.com/reference/risk-insights.md) - [Spade graphics](https://docs.spade.com/reference/spade-graphics.md) - [Transfer enrichment guide](https://docs.spade.com/reference/transfer-enrichment.md) - [Understanding enriched data](https://docs.spade.com/reference/understanding-enriched-data.md) - [Universal data enrichment guide](https://docs.spade.com/reference/universal-data-enrichment.md) - [User category personalization guide](https://docs.spade.com/reference/user-category-personalization-guide.md) ## OpenAPI Specs - [spec](https://docs.spade.com/api-reference/spec.yml)