HEherondata
Transactions

Enrich transactions (sync)

Changed on

Enrich and categorize transactions and consume them in a sync response. For business lending and underwriting, please use "Create end user transactions" instead. Please send a maximum of 249 transactions per request.

post/api/transactions

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/transactions
  • Auth
    API key in header x-api-key

Request body

Example request

{
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "amount": -42.42,
      "balance": 423,
      "categories_default": "shopping",
      "currency": "USD",
      "date": "2020-04-27",
      "description": "GOOGLE *ADS12340929 cc@google.com US",
      "end_user_id": "my_best_customer_203948",
      "heron_id": "txn_MAQAVNGKMg6bWhDWRdwfFj",
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_Gncyxk6tRdsWH7vQRiEutj",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

Response

OK

Example response

{
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "amount": -42.42,
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_fSjC3oqLGbPX7rRLvqRgn9",
          "label": "Rent",
          "model_version": "6a921325-76fb-4dcf-8a3d-062984b937f9"
        }
      ],
      "currency": "USD",
      "description": "GOOGLE *ADS12340929 cc@google.com US",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "txn_nMHguAp6nqtBNUXA2b47tg",
      "end_user_id": "my_best_customer_203948",
      "merchant": {
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "heron_id": "mrc_irammkhfKGGy9WBesbp4sk"
      },
      "payment_processor": {
        "heron_id": "mrc_nRYdGU7nYuevb7qem65cEb",
        "icon_url": "https://storage.googleapis.com/heron-merchant-assets/icons/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "logo_url": "https://storage.googleapis.com/heron-merchant-assets/logos/mrc_nRYdGU7nYuevb7qem65cEb.svg",
        "name": "Paypal",
        "url": "https://www.paypal.com"
      },
      "reference_id": "my_favourite_transaction_231098",
      "request_id": "req_Gncyxk6tRdsWH7vQRiEutj",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

Changes

  • bd8008e49534Revision changes
    • warning

      added the new debt.collections.mca enum value to the /////// response property for the response status

    • info

      added the optional property // to the response with the status