Categorize a Transaction

This takes a transaction and returns a parent category, a child tag and the merchant where the transaction occured. See List Categories to get all available categories.

Stage	URL
Staging	https://stgbackend.kliqr.services/api/tag/categorize/single

Body (urlencoded)

Property	Description
description	This is the description string from a bank transaction	required
timestamp	timestamp of the transaction	required
amount	amount of the transaction	required
isCredit	1 for credit, 0 for debit	required
cu_id	customer's user id	required
lat	latitude	optional
lon	longitude	optional

Sample Request (POST)

POST

/api/tag/categorize/single

Success Response (200 OK)

{
  "success": true,
  "data": {
    "category": {
      "id": 107,
      "name": "car & transport",
      "icon": "https://storage.googleapis.com/kliqr-dvr-static-files/tag-icons/v2/png/transportation_n_car.png",
      "icon_svg": "https://storage.googleapis.com/kliqr-dvr-static-files/tag-icons/v2/svg/transportation_n_car.svg"
    },
    "tag": {
      "id": 1,
      "name": "uber",
      "icon": "https://storage.googleapis.com/kliqr-dvr-static-files/tag-icons/v2/png/uber.png",
      "icon_svg": "https://storage.googleapis.com/kliqr-dvr-static-files/tag-icons/v2/svg/uber.svg"
    },
    "merchant": {
      "id": 394,
      "name": "Uber",
      "icon": "https://www.kliqr.com/image/miv/1x/Uber.png",
      "icon_sq": "https://www.kliqr.com/image/miv/sq/Uber.png"
    },
    "request_id": 11119452
  }
}

Failure Response - No tag Found (404 Not Found)

{
  "success": false,
  "error": "No Tag Found",
  "data": {
    "request_id": 2536
  }
}

Authentication Failure Response (403 Forbidden)

{
  "success": false,
  "error": "User authentication failed"
}