Skip to main content
POST
/
api
/
merchants
/
extract
cURL
curl --request POST \
  --url https://app.herondata.io/api/merchants/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "PAYPAL* AMZN Mktp 198748320"
}
'
{
  "description_clean": "Amzn Mktp",
  "merchant": {
    "categories": [
      {
        "code": "7311",
        "description": "Advertising services",
        "slug": "advertising_services"
      }
    ],
    "confidence": null,
    "group_id": "<string>",
    "heron_id": "mrc_P5tQnYgLDNSteV5c25ZRez",
    "icon_url": "<string>",
    "logo_url": "<string>",
    "name": "Amazon",
    "url": "https://www.amazon.com/"
  },
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json

The bank transaction description as a string

​
description
string
required
Example:

"PAYPAL* AMZN Mktp 198748320"

Response

200 - application/json

The merchant key is not null when we find a positive match to our database. When we could not match a merchant, merchant is null and description_clean is set to a substring of the original description that our models identified as the relevant entity.

​
description_clean
string | null
Example:

"Amzn Mktp"

​
merchant
object
​
payment_processor
object