Transaction Data APIChecks

Update an existing transaction check

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Transaction check data to update, referenced by ‘check_id’. The ‘timestamp’ field represents the update time. Only the fields to be updated need to be included.

check_idstringRequired
Unique identifier for a monitoring check belonging to a transaction. This is the primary key for a transaction check and should be unique across all transaction checks. Updates to a transaction check should be made using this identifier.
timestampdatetimeRequired
The time of the transaction check. This should be in ISO 8601 format. When adding a new transaction check, this field represents the creation time. When updating a transaction check, this represents the time of the update.
additional_propertieslist of objectsOptional
Additional metadata that relates to a transaction check.
related_tx_idstringOptional
Unique identifier for the transaction for which the check is related to.
statusenumOptional
Allowed values:
typeenumOptional
The type of monitoring check that is being performed.
Allowed values:

Response

Transaction check updated successfully
check_idstring
Unique identifier for a monitoring check belonging to a transaction. This is the primary key for a transaction check and should be unique across all transaction checks. Updates to a transaction check should be made using this identifier.
timestampdatetime
The time of the transaction check. This should be in ISO 8601 format. When adding a new transaction check, this field represents the creation time. When updating a transaction check, this represents the time of the update.
statusenum
Allowed values:
typeenum
The type of monitoring check that is being performed.
Allowed values:
related_tx_idstring
Unique identifier for the transaction for which the check is related to.
additional_propertieslist of objects
Additional metadata that relates to a transaction check.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error