latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Transaction request

Cancel transaction request

Cancel a transaction request that has not yet been fully signed or delivered. The only supported state transition is to "canceled". For transaction request full, the request must be in "pendingApproval" or "pendingDelivery" state. For transaction request lite, the request must be in "pendingApproval", "pendingUserCommitment", "pendingUserGShare", "pendingUserRShare", or "pendingUserSignature" state.

put/api/v2/wallet/{walletId}/txrequests/{txRequestId}

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f
txRequestIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Request body

state'canceled' required

For transaction request full, the current state must be "pendingApproval" or "pendingDelivery". For transaction request lite, the current state must be "pendingApproval", "pendingUserCommitment", "pendingUserGShare", "pendingUserRShare", or "pendingUserSignature".

cancellationReasonstring

The reason for the cancellation

Response

OK

OR

Example response

{
  "intent": {
    "messageRaw": "for EVM: test message"
  },
  "txRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "walletId": "59cd72485007a239fb00282ed480da1f",
  "enterpriseId": "59cd72485007a239fb00282ed480da1f",
  "date": "2021-01-01T00:00:00.000Z",
  "createdDate": "2021-01-01T00:00:00.000Z"
}