Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Redeem Account and Credit Loyalty Points

This API method allows the calling application to Redeem a Coupon Account and in turn Credit an existing Points Account within an individual consumer's wallet. It also creates an Account Transaction for each, and creates a REDEEM_CREDIT Wallet Transaction.

post/services/wallet/{walletId}/transaction/redeemCredit

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

redeemAccountIdstring string required

EES AIR Coupon Account ID

creditAccountIdstring string required

EES AIR Points Account ID

Example request

{
  "redeemAccountId": "1000",
  "creditAccountId": "1001",
  "walletTransaction": {
    "meta": {
      "metaFoo": "metaBar"
    }
  },
  "redeemAccountTransaction": {
    "amount": 1000,
    "details": {
      "reason": "we want to redeem an account"
    },
    "reasonCode": "REDEEM"
  },
  "creditAccountTransaction": {
    "amount": 1000,
    "details": {
      "reason": "we want to credit an account"
    },
    "reasonCode": "CREDIT"
  },
  "location": {
    "storeId": "testOutletUnitIncomingIdentifier"
  }
}

Response

Created

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