Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Gift Points

This API method allows the calling application to perform a Gift operation. A Gift means a specified amount of points from a giver's points account will be used to credit a receiver’s points account. If for any reason this operation could not be completed, EES AIR will perform a rollback operation. If the rollback is successful, everything would be restored to the state before this Gift operation. An error message would be returned explaining why this operation failed. Please note that a rollback would leave traces in EES AIR in the form of a Voided Wallet Transaction and a Voided Account Transaction. If for any reason the rollback mechanism fails, this endpoint would return the HTTP 207 (Multi-Status) header with all details.

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

amountnumber required

Amount to be gifted

accountIdstring string required

EES AIR Account ID the donation is being sent from

toWalletIdstring string required

ESS Wallet ID the donation is being sent to

toAccountIdstring string required

ESS AIR Account ID the donation is being sent to

locationobject

This optional Request attribute allows to override a location arisen from a used API KEY to specify exactly in which Outlet this transaction has happened

Example request

{
  "amount": 50,
  "accountId": "169440",
  "toWalletId": "654334",
  "toAccountId": "356354",
  "walletTransaction": {
    "reference": "some unique reference",
    "state": "SOME_STATE",
    "meta": {
      "foo": "bar"
    }
  },
  "childWalletTransaction": {
    "reference": "some other unique reference",
    "state": "SOME_STATE",
    "meta": {
      "foo": "bar"
    }
  },
  "giftAccountTransaction": {
    "details": {
      "key1": "foo"
    }
  },
  "giftInAccountTransaction": {
    "details": {
      "key2": "bar"
    }
  },
  "location": {
    "storeId": "1234"
  }
}

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