v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Void Points Exchange

This API method allows the calling application to Void a Reward Bank exchange transaction using the original Wallet Transaction Reference. This operation will reverse the original exchange transaction, crediting the points account with the original transaction amount and also cancelling the reward associated with the exchange. If there was an exchange limit set against the Reward Bank, or the Reward Bank Link, the usage will be decremented to allow a further exchange to be made.

This operation will fail if the Reward associated with the original exchange has a status of USED. If the Reward has already been cancelled or is otherwise no longer valid to reinstate (e.g. EXPIRED), the Void Exchange operation will still occur and credit points and usage but the Reward will remain in its current state. Additionally if an exchange limit has been set against a personal Reward Bank with an expiry and the date has passed, the Void Exchange will still occur without reactivating the Reward Bank Link.

patch/services/wallet/{walletId}/transaction/exchange/pointsreward/void

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

referencestring required

Wallet Transaction Reference of the original Exchange.

Example request

{
  "reference": "exchange222333444"
}

Response

OK

walletTransactionIdstring

Wallet Transaction ID

parentWalletTransactionIdstring

Parent Wallet Transaction ID

walletIdstring

Wallet ID

referencestring

Calling party's reference to this transaction

transactionDateTimestring

Calling party's Transaction Date Time

identityIdstring

Wallet Identity ID used for this transaction.

typestring

Wallet Transaction Type

status'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED'

Wallet Transaction status

statestring

Wallet Transaction state

expiryDatestring

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

channelstring

Channel used for Transaction creation or update

dateCreatedstring

Date this Wallet Transaction was created

lastUpdatedstring

Date this Wallet Transaction was last updated