Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Donate Points

This API method allows the calling application to perform a Donate operation. A Donation means a requested amount from an EES AIR Donor Account will be used to credit (transferred-in) into recipient's Account within EES AIR. If for any reasons this operation could not be completed, EES AIR will perform a Rollback operation. And if successful, everything would be restored to the state before this donation call. Returned error code and an error message would explain why this operation failed. Please note this would leave traces in EES AIR in the form of VOIDED Wallet Transaction and VOIDED Wallet Account Transaction. If for any reasons Rollback mechanism fails, this endpoint would return the HTTP 207 (Multi-Status) header with all details, allowing to rectify this situation.

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

amountnumber required

Amount to be donated

accountIdstring string required

EES AIR Account ID

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": 1000,
  "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"
    }
  },
  "donateAccountTransaction": {
    "details": {
      "key1": "foo"
    }
  },
  "donateInAccountTransaction": {
    "details": {
      "key2": "bar"
    }
  }
}

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