failTransaction

Mark a transaction as failed, giving up on its ongoing processing.

Request:

The request args must be a FailTransactionRequest object.

Response:

On success, the result is an empty object.

Side effects:

Marks an aborting transaction as finally failed, giving up on the ongoing recovery.

Expected errors:

The caller can handle the following errors inline: WALLET_TRANSACTION_NOT_FOUND, WALLET_TRANSACTION_ACTION_UNSUPPORTED, WALLET_REQUEST_TRANSACTION_STATE_UNSUPPORTED.

Details:

This is typically used for transactions in an aborting state (for example while recovering an aborted payment via a refund): the user stops waiting for the recovery, and the transaction transitions to the final failed state. The reason is recorded in the transaction’s failReason. Whether a transaction can currently be failed is advertised in its txActions.

interface FailTransactionRequest {
  transactionId: TransactionIdStr;
}