Transaction Enrichment #

Stack Partners with leading technology providers to offer transaction enrichment in a clean, standard and reliable API. To use the Transaction Enrichment service, you can either link an existing entity, and attach each enriched transaction to that entity or create a new entity with basic information and link the entity id. The minimum access_level for an entity to use this service is 1.

Link an entity #

Before you link an entity, ensure that you have already created either an individual entity or a business entity

Endpoint #

{BASE_URL}/transactions/enrichment/entity

Method: POST.

Sample Request #

curl --location --request POST 'https://api.stack-ft.com/transactions/enrichment/entity' \
--header 'Authorization: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entity_id": "i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36"
}'

Sample Response #

{
    "status": "success",
    "entity": {
        "entity_id": "i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36"
    },
    "request_id": "d755456b-954e-48c3-8328-15a22e3ee27d"
}

Enrich a transaction #

When enriching a transaction, you also have to provide the linked entity_id. When you pass the entity_id, the transaction is automatically linked to that entity. This also allows us do things like determine subscription, personas, bills and expenses, income.

Endpoint #

{BASE_URL}/transactions/enrichment/enrich

Method: POST.

date object #

Sample Request #

curl --location --request POST 'https://api.stack-ft.com/transactions/enrichment/enrich' \
--header 'Authorization: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entity_id": "i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36",
    "amount": 59.03,
    "direction": "debit",
    "description": "AMZN Mktp US*N87AP5UI3 Amzn.com/bi WA",
    "currency": "USD",
    "country": "US",
    "date": {
        "day": 4,
        "month": 1,
        "year": 2023
    }
}'

Sample Response #

{
  "status": "success",
  "transaction": {
    "entity_id": "i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36",
    "transaction_id": "5d2cff61-2b55-4de5-bdbf-ae191f3433f7",
    "merchant_name": "Amazon",
    "mcc": [
      5942
    ],
    "merchant_website": "amazon.com",
    "merchant_location": "us, wa",
    "transaction_category": [
      "goods",
      "ecommerce"
    ],
    "transaction_direction": "debit"
  }
}

Get entity transactions #

This allows you to get a list of all transactions associated with an entity. This API returns a maximum of 100 items per page.

Endpoint #

{BASE_URL}/transactions/enrichment/entity/transactions

Method: GET.

Sample Request #

curl --location --request GET 'https://api.stack-ft.com/transactions/enrichment/entity/transactions?entity_id=i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36' \
--header 'Authorization: API_KEY' \
--data-raw ''

Sample Response #

{
  "status": "success",
  "total_pages": 1,
  "transactions": [
    {
      "entity_id": "i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36",
      "transaction_id": "5d2cff61-2b55-4de5-bdbf-ae191f3433f7",
      "merchant_name": "Amazon",
      "mcc": [
        5942
      ],
      "merchant_website": "amazon.com",
      "merchant_location": "us, wa",
      "transaction_category": [
        "goods",
        "ecommerce"
      ],
      "transaction_direction": "debit"
    }
  ]
}

Get entity subscriptions #

This allows you to get a list of all subscriptions associated with an entity.

Endpoint #

{BASE_URL}/transactions/enrichment/entity/subscriptions

Method: GET.

Sample Request #

curl --location --request GET 'https://api.stack-ft.com/transactions/enrichment/entity/subscriptions?entity_id=i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36' \
--header 'Authorization: API_KEY' \
--data-raw ''

Get entity income #

This allows you to get an entity's assumed income based on reported transactions.

Endpoint #

{BASE_URL}/transactions/enrichment/entity/income

Method: GET.

Sample Request #

curl --location --request GET 'https://api.stack-ft.com/transactions/enrichment/entity/income?entity_id=i_uuid_5b240456-ff05-4d9c-908c-241525a6ca36' \
--header 'Authorization: API_KEY' \
--data-raw ''

Currency-Country Pair #