SEON user docs logoSEON user docs logoSEON user docs logo
Search input icon

Tag API

Introduction

The Tag API allows you to categorize your transactions. Tag information will be displayed on the Admin Panel, and you can filter transactions based on them. With the Tag API, you have the ability to get, add, update and delete tag information, all of which can also be done via the Admin panel.

Good to know

  • You can create new tags by sending them via the API or adding them through the Admin panel.
  • You can add a maximum of 50 tags to one transaction in a single request.
  • One transaction can have a maximum of 100 tags.
  • A single tag cannot exceed 256 characters in length.
  • If you tag multiple transactions at once with the ‘Multiple’ tagging option, please add a maximum of 500 transactions to each request.
  • Calling the update endpoints results in the removal and replacement of tags associated with the specified transactions.

Add request

Request Attributes

TypeRequired
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/[transaction_id]/add
PHP
Generic
Generic

Update request

Request Attributes

TypeRequired
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/[transaction_id]/update
PHP
Generic
Generic

Delete request

Request Attributes

TypeRequired
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/[transaction_id]/delete
PHP
Generic
Generic

Add / update / delete response

The endpoint returns JSON structured response.

JSON Attributes

Type
data
object
error
object
success
boolean
Response
{
 "success": true,
 "data": {
  "tags": [
   "tag1",
   "tag2"
  ]
 },
 "error": {}
}

Add request (multiple)

Request Attributes

TypeRequired
transaction_ids
array yes
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/bulk-add
PHP
Generic
Generic

Update request (multiple)

Request Attributes

TypeRequired
transaction_ids
array yes
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/bulk-update
PHP
Generic
Generic

Delete request (multiple)

Request Attributes

TypeRequired
transaction_ids
array yes
tags
array yes

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/tag-api/v1/tags/bulk-delete
PHP
Generic
Generic

Add / update / delete response (multiple)

The endpoint returns JSON structured response.

JSON Attributes

Type
data
object
error
object
success
boolean
Response
{
 "success": true,
 "data": {
  "updated_items": [
   {
    "transaction_id": "transaction_id1",
    "tags": [
     "tag1",
     "tag2"
    ]
   },
   {
    "transaction_id": "transaction_id2",
    "tags": [
     "tag1",
     "tag2"
    ]
   }
  ]
 },
 "error": {}
}

Get all tags on a transaction - request

You must replace [transaction_id] with your transaction_id that you have provided during the Fraud API call or was generated automatically.

HTTP Endpoint

GET

https://api.seon.io/SeonRestService/tag-api/v1/tags/[transaction_id]
PHP
Generic
Generic

Get all tags on a transaction - response

The endpoint returns JSON structured response.

JSON Attributes

Type
data
object
error
object
success
boolean
Response
{
 "success": true,
 "data": {
  "tags": [
   "tag1",
   "tag2",
   "tag3"
  ]
 },
 "error": {}
}

Remove all tags from a transaction - request

You must replace [transaction_id] with your transaction_id that you have provided during the Fraud API call or was generated automatically.

HTTP Endpoint

DELETE

https://api.seon.io/SeonRestService/tag-api/v1/tags/[transaction_id]
PHP
Generic
Generic

Remove all tags from a transaction - response

The endpoint returns JSON structured response.

JSON Attributes

Type
data
object
error
object
success
boolean
Response
{
 "success": true,
 "data": {
  "tags": [
   "tag1",
   "tag2",
   "tag3"
  ]
 },
 "error": {}
}