Sign in

v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Enrichment

Base Transaction Enrichment

FinGoal's base transaction enrichment endpoint is a new and improved model for enriching daily user, historical, or one off user transactions. It accepts additional accountTypes that previous enrichment endpoints did not, including businessChecking, businessSavings, businessCreditCard, businessLoan, loan, investments.

Requests that include many users (by uid) will not deteriorate the endpoint's performance and it has much higher throughput than previous enrichment endpoints.

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:

  • Limit each request to a total of approximately 1,000 transactions.
  • Transactions can be distributed among any number of users as long as the total number of transactions does not exceed 1,000.
post/cleanup/base

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"
    }
  ]
}

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.