Sign in

v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Enrichment

Historical Transaction Enrichment

The historical transaction enrichment endpoint is designed for enriching a large number of transactions. It is optimized to handle substantial payloads and efficiently process large backlogs of data.

This endpoint is asynchronous. A webhook will be sent to the provided URL when a batch of transactions has been enriched.

To maximize throughput for this endpoint, follow these guidelines:

  • Group transactions by uid and include all transactions for a single uid in the same payload.
  • Limit each request to approximately 1,000 transactions. The payload can include multiple uids.
post/cleanup

Request body

Example request

{
  "transactions": [
    {
      "accountType": "checking",
      "amountnum": 19.99,
      "date": "2024-05-01",
      "identifiers": {
        "sfmc_contact_id": "sfmc-1234",
        "banno_end_user_id": "banno-1234"
      },
      "original_description": "Cottonwood Supermarket & Deli",
      "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
      "settlement": "debit",
      "uid": "user123",
      "accountid": "account456"
    }
  ]
}

Response

Success

transactions_receivedboolean

Denotes whether FinSight API has successfully received the transactions.

transactions_validatedboolean

Denotes whether or not the transaction payload successfully passed FinSight API validation.

processingboolean

Denotes whether the asynchronous enrichment process has commenced.

num_transactions_processinginteger

The number of transactions that have been received.

batch_request_idstring

A unique ID associated with the request for debugging.