v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Create Goodwill Transaction

This API method allows the calling application to perform a Goodwill transaction for an EES AIR Account, Create an Account Transaction and create a GOODWILL Wallet Transaction

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

amountinteger required

Goodwill Amount

accountIdstring string required

EES AIR Account ID

Example request

{
  "amount": 10,
  "accountId": "133121",
  "walletTransaction": {
    "meta": {
      "metaFoo": "metaBar"
    },
    "transactionDateTime": "2020-04-01T15:15:14+00:00"
  },
  "goodwillAccountTransaction": {
    "details": {
      "detailsFoo": "detailsBar",
      "reason": "A Reason #2"
    },
    "reasonCode": "AA"
  },
  "location": {
    "storeId": "32432"
  }
}

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