Transaction limit policy breached events
An exampleTransaction Limit Policy Breached event payload:
{
"id": "1czONudbZwh5siu2igQJY94QkFH:33TmBAsfebMrQi6QNE1ge1ecI70",
"type": "transaction_limit_policy_breached",
"data": {
"policy": {
"id": "1czONudbZwh5siu2igQJY94QkFH",
"scope": "APP_SCOPED",
"evaluation_window": "PER_TRANSACTION",
"threshold_type": "HARD",
"threshold_amount": "1234.12",
"threshold_currency": "USD",
"identity_id": "",
"is_active": true,
"created_at": "",
"updated_at": ""
},
"identity_id": "33TmRnrHXVasjXfIQ2e9OBixtwM",
"crypto_transfer_request_id": "1czONudbZwh5siu2igQJY94QkFH",
"transferred_amount": "10000.00"
}
}
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for each event. It can be used to deduplicate events. |
| type | string | The type of event. This is always transaction_limit_policy_breached for transaction limit policy breached events. |
| data.policy.id | string | Unique identifier for the policy that was breached. |
| data.policy.scope | string | Scope of the policy that was breached. Valid values are APP_SCOPED and IDENTITY_SCOPED. |
| data.policy.evaluation_window | string | Evaluation window of the policy that was breached. Valid values are PER_TRANSACTION or PAST_WEEK. |
| data.policy.threshold_type | string | Threshold type of the policy that was breached. Valid values are HARD or SOFT. |
| data.policy.threshold_amount | string | Threshold amount of the policy that was breached. |
| data.policy.threshold_currency | string | Threshold currency of the policy that was breached. |
| data.policy.identity_id | string | The identity ID that the breached policy applies to (only relevant for IDENTITY_SCOPED policies). |
| data.policy.is_active | boolean | Indicates whether the breached policy is currently active or not. This should always be true. |
| data.policy.created_at | string | The timestamp when the breached policy was created. |
| data.policy.updated_at | string | The timestamp when the breached policy was last updated. |
| data.identity_id | string | The ID of the identity that breached the transaction limit policy. |
| data.crypto_transfer_request_id | string | The ID of the cryptocurrency transfer request that triggered the policy breach. |
| data.transferred_amount | string | The amount transferred by the identity that breached the policy over the course of the policy’s evaluation window. |