Transaction Data APIChecks

Update an existing transaction check

Headers

AuthorizationstringRequired

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

AuthorizationstringRequired

Request

This endpoint expects an object.
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.

statusenumOptional
Allowed values:
typeenumOptional

The type of monitoring check that is being performed.

Allowed values:
related_tx_idstringOptional

Unique identifier for the transaction for which the check is related to.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction check.

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.

statusenumOptional
Allowed values:
typeenumOptional

The type of monitoring check that is being performed.

Allowed values:
related_tx_idstringOptional

Unique identifier for the transaction for which the check is related to.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction check.

Errors