v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

Merchants

Extract merchant

Extract Merchant from a transaction description

post/api/merchants/extract

Request body

descriptionstring required

Example request

{
  "description": "PAYPAL* AMZN Mktp 198748320"
}

Response

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_cleanstring nullable

Example response

{
  "description_clean": "Amzn Mktp",
  "merchant": {
    "categories": [
      {
        "code": "7311",
        "description": "Advertising services",
        "slug": "advertising_services"
      }
    ],
    "heron_id": "mrc_gkcx4tKTGc2T5v2QiJVuMV",
    "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"
  }
}