API ReferenceTransactions

Synchronously enrich transactions

Enriches a transaction with information about entities, locations and categories. Besides the original id that was submitted, the response only contains the enriched fields.

To view the complete transaction, including the original fields, such as description or amount, you can use any of the Transactions API listing methods.

Complete guide: Transaction Enrichment.

Headers

X-Api-KeystringRequired
X-Application-IdstringRequired

Request

This endpoint expects an object.
idstringRequired>=1 character
A unique identifier of the transaction
descriptionstringRequired>=0 characters<=1024 characters
The description string of the transaction
datestringRequired

The date that the transaction was posted. Uses ISO 8601 format (YYYY-MM-DD)

amountdoubleRequired>=0

The amount of the transaction in the currency. Must be a positive value. For example, if the currency is USD, then it’s the amount in dollars.

entry_typeenumRequired

The direction of the flow of the money from the perspective of the account holder. outgoing to represent money leaving the account, such as purchases or fees, while incoming represents money entering the account, such as income or refunds.

Allowed values:
currencyenumRequired
The currency of the transaction in ISO 4217 format
account_holder_idstringRequired

The unique ID of the account holder. Unsetting it will disable categorization.

locationobjectOptional
Location of where the transaction has taken place. This can greatly improve entity identification, especially under ambiguity.

Response

Enriched transactions.
created_atdatetime
The timestamp of when the account holder was created.
idstring>=1 character

A unique identifier for the transaction. If two transactions are submitted with the same id the most recent one will replace the previous one.

entitiesobjectOptional
Entities found by identity identification
categoriesobjectOptional
locationobjectOptional
errorobjectOptional

Errors