POST
/
api
/
transactions
curl --request POST \
  --url https://app.herondata.io/api/transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "amount": -42.42,
      "balance": 423,
      "categories_default": "shopping",
      "currency": "USD",
      "date": "2020-04-27",
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "end_user_id": "my_best_customer_203948",
      "mcc_code": "<string>",
      "order": 123,
      "reference_id": "my_favourite_transaction_231098",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}'
{
  "_summary": {
    "request_id": "<string>"
  },
  "transactions": [
    {
      "account_id": "checking_account_202348",
      "amount": -42.42,
      "balance": 423,
      "categories": [
        {
          "annotator": "predicted",
          "confidence": 0.5,
          "heron_id": "ctg_CbgtZSQ7iAJwcZJXpMkc3F",
          "label": "Rent",
          "model_version": "fd2c49bb-6ed2-4b33-96bb-3a378cf4b51d"
        }
      ],
      "currency": "USD",
      "description": "GOOGLE *ADS12340929 [email protected] US",
      "description_clean": "GOOGLE ADS",
      "duplicate_of_id": "<any>",
      "end_user_id": "my_best_customer_203948",
      "has_matching_transaction": true,
      "is_potential_duplicate": true,
      "is_recurring": true,
      "merchant": {
        "categories": [
          {
            "code": "7311",
            "description": "Advertising services",
            "slug": "advertising_services"
          }
        ],
        "group_id": "Uber",
        "heron_id": "mrc_PwJ4WqW86qm99sA9W6XGhk",
        "icon_url": "<string>",
        "is_priority": true,
        "logo_url": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "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_adXwG4vYrjHawuU2rAwo3E",
      "timestamp": "2021-11-12T10:38:05Z",
      "transaction_code": "card"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json

Response

200
application/json
OK

The response is of type object.