v1

latestOpenAPI 3.1.02026-08-04127114.4 KB

Webhooks

Enrichment Data-Rich Webhook

Data-rich Transaction Enrichment webhook. When transaction enrichment completes, you will receive a POST request containing the full enriched transaction data directly in the payload.

This webhook type (ENRICHMENT_DATA) sends the complete enrichment results, including all enriched transactions and any failed transactions.

Use this webhook type when you want to receive enrichment results directly without needing to fetch them from a separate endpoint.

postWebhookenrichmentData

Headers

X-Webhook-Verificationstring

A SHA-256 HMAC signature of the webhook payload that can be used to verify the authenticity of the webhook.

Payload

tenant_idstring

The ID of the tenant associated with this webhook, if from a tenant environment.

Example payload

{
  "enrichedTransactions": {
    "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"
      }
    ]
  },
  "failedTransactions": {
    "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"
      }
    ]
  },
  "tenant_id": "TEN-123456"
}

Response

Success