post
https://api.sumsub.com/resources/api/kyt/txns//cancel-travel-rule
Overview
Use this method to cancel a Travel Rule transaction before the on-chain transfer is initiated.
Cancelling a transaction indicates that it will no longer proceed, and the counterparty should not expect the digital assets to arrive. If the transaction was initiated through an underlying protocol such as GTR, CODE, or SYGNA, the cancellation is also propagated to that protocol.
Request example
curl -X POST \
'https://api.sumsub.com/resources/api/kyt/txns/66cd891eefa135789ce5265g/cancel-travel-rule' \
-H 'Content-Type: application/json'Response explained
The response is a JSON object containing the following fields:
| Field | Type | Description |
|---|---|---|
status | String | Indicates the outcome of the cancellation request. See possible status values below. |
message | String | Human-readable explanation of the outcome. |
Possible status values
status values| Value | Description |
|---|---|
done | The transaction was successfully cancelled. |
unknown | Cancellation failed due to an unexpected issue. |
alreadyFinal | The transaction is already in a final Travel Rule state and can no longer be cancelled. |
invalidTransaction | The transaction cannot be cancelled (for example, because it is not a Travel Rule transaction). |
alreadyCancelled | The transaction has already been cancelled. |
Response examples
If the request is successfully sent and processed, you will get a response like one of the following:
{
"status": "done",
"message": "Travel rule transaction was cancelled via SNS."
}{
"status": "alreadyCancelled",
"message": "Travel Rule transaction was already cancelled"
}{
"status": "invalidTransaction",
"message": "Not a Travel Rule transaction"
}If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "0f587e62a96ce6b64809021d96abfa34",
"description": "Invalid id 'sftxhdfgnx'"
}