API Reference
Update an existing transaction suspicious activity
/transaction_suspicious_activity https://transaction-api.cable.tech Authentication
- Bearer token in the Authorization header
Request body
Transaction suspicious activity data to update, referenced by ‘suspicious_activity_id’. The ‘timestamp’ field represents the update time. Only the fields to be updated need to be included.
-
suspicious_activity_idstring requiredUnique identifier for a suspicious activity belonging to a transaction. This is the primary key for a transaction suspicious activity and should be unique across all transaction suspicious activities. Updates to a transaction suspicious activity should be made using this identifier.
-
detection_datestringTimestamp at which suspicious activity was detected on a transaction. This should be in the ISO 8601 format.
Format
date-time -
report_idstringUnique identifier for a transaction suspicious activity report for which the suspicious activity belongs to.
-
report_filed_atstringThe time of the transaction suspicious activity report was filed. This should be in ISO 8601 format.
Format
date-time -
related_tx_idslist of stringsUnique identifiers for transactions for which the suspicious activity relates to.
-
related_alert_idstringUnique identifier for a transaction alert for which the suspicious activity relates to.
-
additional_propertieslist of objectsAdditional metadata that relates to a transaction suspicious activity.
-
keystring requiredThe key of the additional property. This should be unique within the additional properties array.
-
valuestring requiredThe value of the additional property.
-
typestring requiredThe type of the additional property value, for example “string”, “number”, “boolean”, “object”, “array”.
Allowed values
STRINGNUMBERBOOLEANOBJECTARRAY -
descriptionstring requiredA description of the additional property. This should provide context for the value.
-
-
timestampstring requiredThe time of the transaction suspicious activity. This should be in ISO 8601 format. When adding a new transaction suspicious activity, this field represents the detection time. When updating a transaction suspicious activity, this represents the time of the update.
Format
date-time
Responses
200 Transaction suspicious activity updated successfully
-
suspicious_activity_idstring requiredUnique identifier for a suspicious activity belonging to a transaction. This is the primary key for a transaction suspicious activity and should be unique across all transaction suspicious activities. Updates to a transaction suspicious activity should be made using this identifier.
-
detection_datestringTimestamp at which suspicious activity was detected on a transaction. This should be in the ISO 8601 format.
Format
date-time -
report_idstringUnique identifier for a transaction suspicious activity report for which the suspicious activity belongs to.
-
report_filed_atstringThe time of the transaction suspicious activity report was filed. This should be in ISO 8601 format.
Format
date-time -
related_tx_idslist of stringsUnique identifiers for transactions for which the suspicious activity relates to.
-
related_alert_idstringUnique identifier for a transaction alert for which the suspicious activity relates to.
-
additional_propertieslist of objectsAdditional metadata that relates to a transaction suspicious activity.
-
keystring requiredThe key of the additional property. This should be unique within the additional properties array.
-
valuestring requiredThe value of the additional property.
-
typestring requiredThe type of the additional property value, for example “string”, “number”, “boolean”, “object”, “array”.
Allowed values
STRINGNUMBERBOOLEANOBJECTARRAY -
descriptionstring requiredA description of the additional property. This should provide context for the value.
-
-
timestampstring requiredThe time of the transaction suspicious activity. This should be in ISO 8601 format. When adding a new transaction suspicious activity, this field represents the detection time. When updating a transaction suspicious activity, this represents the time of the update.
Format
date-time
Errors
- 400 Invalid transaction suspicious activity data
- 401 Unauthorized request
- 404 Transaction suspicious activity not found
- 429 Rate limit exceeded
- 500 Server error
- default General error
-
codeinteger requiredFormat
int32 -
messagestring required -
errorslist of objectsDetailed information about errors in specific fields.
-
fieldstring -
messagestring
-