v1

latestOpenAPI 3.1.02026-08-04127114.4 KB

Enrichment

Retrieve Enrichment by Batch Request ID

Developers may use this endpoint in conjunction with the asynchronous cleanup endpoints to retrieve the results of a transaction cleanup operation by its batch operation ID. The operation ID can be extracted from the webhook that the async cleanup endpoint sends when enrichment is complete.

get/cleanup/{batch_request_id}

Path parameters

batch_request_idstring required

The Batch Request ID of the enrichment request.

Response

Success

Example response

{
  "enrichedTransactions": [
    {
      "address": "123 Main St",
      "city": "Urbana",
      "container": "Transaction",
      "isPhysical": true,
      "merchantAddress1": "123 Main St",
      "merchantCity": "Urbana",
      "merchantCountry": "US",
      "merchantLatitude": "38.9517",
      "merchantLongitude": "-92.3341",
      "merchantName": "Dollar General",
      "merchantPhoneNumber": "555-555-5555",
      "merchantState": "MO",
      "merchantType": "retail",
      "merchantZip": "65401",
      "receiptDate": "2024-05-01T12:00:00Z",
      "requestId": "04f00a35-a8fa-40fd-a2ee-4af7be22ed0a",
      "settlement": "debit",
      "sourceId": "1234",
      "state": "MO",
      "subtype": "purchase",
      "subType": "purchase",
      "tenant_id": "TNT-4b7d4b7d-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
      "website": "https://links.fingoal.com/dollar-general",
      "zip_code": "65401"
    }
  ]
}