v1

latestOpenAPI 3.1.02026-07-227350156.5 KB

Category Action Triggers

Get user-level category trigger status

Get the status and version of the latest category action trigger registration at the user scope.

User-level triggers apply to all transactions for all cards belonging to the specified user.

Important: Triggers are only applied to enrichment responses when the status is succeeded.

To learn more about action triggers, please read the Category Action Triggers Guide.

get/users/{userId}/category-action-triggers

Response

Successful operation

status'succeeded' | 'failed'

The current status of the action trigger registration. Category trigger registrations are processed synchronously, so the status is always one of:

succeeded: Registration complete, triggers are now active
failed: Registration failed, check your request and retry

versioninteger

The version number of this registration. Increments with each PUT, PATCH, or DELETE request to this scope.

totalCountinteger

The total number of active category triggers registered for this scope. Present on GET responses; omitted on PUT and PATCH responses.

Example response

{
  "status": "succeeded",
  "version": 1,
  "categoryTriggers": [
    {
      "id": "travel-reward-1",
      "categoryId": "020-001-000-000",
      "action": {
        "type": "REWARD",
        "rewardPercent": 3
      }
    }
  ],
  "totalCount": 10
}