v1

latestOpenAPI 3.1.02026-07-13385987.3 KB

Enrichment

Enrich and add transactions to the ledger of account holders synchronously.

Add transactions to the ledgers of account holders and get back enriched version of the transactions in the response. Accepts batch sizes up to 4k transactions. A single transaction should take ~100ms. A batch of 4000 transactions should take ~40s.

post/v2/transactions/sync

Request body

transaction_idstring required

A unique identifier of the transaction

account_holder_idstring nullable

The unique ID of the account holder of the transaction

account_holder_type'consumer' | 'business' | 'unknown'

amountnumber required

The amount of the transaction

entry_type'incoming' | 'outgoing' | 'credit' | 'debit' required

The direction of the transaction (incoming or outgoing)

datestring date required

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

iso_currency_codestring required

The currency of the transaction in ISO 4217 format

descriptionstring required

The description string of the transaction

locationstring nullable

Location where the transaction occurred in

countrystring nullable

The country where the transaction was made in ISO 3166-2 format

mccinteger nullable

The Merchant Category Code of the merchant according to ISO 18245

account_holder_namestring nullable

The name of the account holder

Example request

[
  {
    "account_holder_id": "35b927b6-6fda-40aa-93b8-95b47c2b2cad",
    "amount": 10,
    "country": "US",
    "date": "2022-02-02",
    "description": "SQ* STARBUCKS UNION SQUARE",
    "entry_type": "outgoing",
    "iso_currency_code": "USD",
    "transaction_id": "xbx8YP14g565Xk"
  }
]

Response

Enriched transactions

Example response

[
  {
    "intermediaries": [
      {
        "id": "916bc837-55ef-3106-88f6-5a8269ca9f2a",
        "logo": "https://logos.ntropy.com/squareup.com",
        "name": "Square",
        "website": "squareup.com"
      }
    ],
    "labels": [
      "Cafes and coffee shop"
    ],
    "location": "10 Union Square East, New York, New York 10003, US",
    "location_structured": {
      "address": "10 Union Square East",
      "apple_maps_url": "https://maps.apple.com/?q=Starbucks+10+Union+Square+East&sll=40.734834,-73.989782",
      "city": "New York",
      "country": "US",
      "country_name": "United States",
      "google_maps_url": "https://www.google.com/maps/search/?api=1&query=Starbucks%2C10+Union+Square+East%2C+New+York%2C+New+York+10003%2C+US",
      "latitude": "48.734834",
      "longitude": "-73.989782",
      "postcode": "10003",
      "state": "New York"
    },
    "logo": "https://logo.clearbit.com/aws.amazon.com",
    "merchant": "Starbucks",
    "merchant_id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
    "recurrence": "recurring",
    "recurrence_group": {
      "average_amount": 10,
      "first_payment_date": "2020-02-02",
      "id": "3b0c689b-e123-30a6-9f53-878f3ebf46aa",
      "latest_payment_date": "2022-02-02",
      "other_party": "starbucks.com",
      "periodicity": "monthly",
      "periodicity_in_days": 31,
      "total_amount": 240,
      "transaction_ids": [
        "b708fbd8-be76-41c2-86d5-83f8ba05ed85",
        "0e34b24d-646d-416e-8d51-fda5b6e10684"
      ]
    },
    "recurrence_group_id": "3b0c689b-e123-30a6-9f53-878f3ebf46aa",
    "transaction_id": "xbx8YP14g565Xk",
    "website": "starbucks.com"
  }
]