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_PezcquvDMiJMbLix2hFJVi",
"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"
}
}
Extract Merchant from a transaction description
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_PezcquvDMiJMbLix2hFJVi",
"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"
}
}
The bank transaction description as a string
The body is of type object
.
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.
The response is of type object
.
Was this page helpful?