Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Cancel a Wallet Transaction using a WalletId and a TransactionId

This API method allows the calling application to cancel a wallet transaction using a specific walletId and transactionId, processing the accounts attached to the transaction and removing them from the transaction so they can be used elsewhere, then finally cancelling the wallet transaction so that it cannot be reused.

patch/services/wallet/{walletId}/transaction/{transactionId}/cancel

Path parameters

walletIdstring string required

EES AIR Wallet ID

transactionIdstring string required

EES AIR Wallet Transaction ID

Request body

Response

OK

walletTransactionIdstring required

Wallet Transaction ID

parentWalletTransactionIdstring nullable required

Parent Wallet Transaction ID

walletIdstring nullable required

Wallet ID

referencestring nullable required

Calling party's reference to this transaction

identityIdstring nullable required

The Identity ID responsible for this transaction.

typestring nullable required

Transaction Type, defined per retailer

status'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED' | 'FULFILLING' | 'FULFILLED' required

Transaction status

statestring nullable required

Transaction state

transactionDateTimestring date-time required

Transaction date-time in ATOM format.

transactionDateTimeOffsetstring string

The offset of the date-time from UTC in format "+00:00".

expiryDatestring date-time nullable required

Transaction Expiry Timestamp (date-time in ATOM format), when transaction should expiry and automatically be settled.

channelstring required

Channel used for Transaction creation or update

dateCreatedstring date-time required

Date this Wallet Transaction was created

lastUpdatedstring date-time required

Date this Wallet Transaction was last updated