Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Debit Wallet Account

This API method allows the calling application to debit a Wallet Account and create appropriate Account Transaction. Currently available for POINTS and CONTINUITY accounts, along with all Stored Value accounts. Please note: by default for Loyalty Points Accounts, EES AIR allows debits of an amount larger than the account's available balance, which would result in a negative balance. This could be mitigated by EES Scheme settings:

  • Disable 'allow negative balance'
  • Enable 'AUTOTOPUP' - EES AIR will detect these negative balances and instantly correct them by bringing a balance to zero (and creating a corresponding Account Transaction of type AUTOTOPUP).
patch/wallet/{walletId}/account/{accountId}/debit

Path parameters

walletIdstring string required

EES AIR Wallet ID

accountIdstring string required

EES AIR Wallet Account ID

Query parameters

include'childAccountTransactions'

Request optional and additional entities, currently supported: Child Account Transactions

Request body

Example request

{
  "details": {
    "details": {
      "key1": "Value1",
      "key2": "AnotherValue"
    }
  }
}

Response

OK

accountTransactionIdstring

The account transaction id.

accountIdstring

The account id related to this transaction.

parentAccountTransactionIdstring

The parent account transaction.

event'CREATE' | 'REDEEM' | 'UNLOCK' | 'UNREDEEM' | 'VERIFY' | 'ACTIVATE' | 'INACTIVATE' | 'REACTIVATE' | 'LOAD' | 'CREDIT' | 'DEBIT' | 'BALANCE' | 'INVALIDATE' | 'BLOCK' | 'UNBLOCK' | 'RESEND' | 'STOLEN' | 'CANCEL' | 'VOID' | 'REISSUE' | 'REFUND' | 'TRANSFER' | 'TRANSFER_IN' | 'TOPUP' | 'AUTOTOPUP' | 'STAMP' | 'SPEND'

The type of transaction.

valueinteger

The value related to this account transaction. Typically, if an account transaction like credit was executed with a value, then this value will be stored here. For Continuity, however, this value should always be 0, and the same for Coupon (since there is no value for a coupon).

sourcestring

The source of this transaction e.g. from a client, or automated.

transactionDetailsobject

An simple object of key value pairs representing the transaction details. For Points and Continuity, this can contain a JSON encoded object with the details of the amounts applied to each balance.

propertiesobject

Properties related to the account transaction.

dateCreatedstring

Date this account transaction was created

lastUpdatedstring

Date this account transaction was last updated

Example response

{
  "dateCreated": "2017-01-17T13:20:48+00:00",
  "lastUpdated": "2017-01-17T13:20:48+00:00",
  "children": [
    {
      "dateCreated": "2017-01-17T13:20:48+00:00",
      "lastUpdated": "2017-01-17T13:20:48+00:00"
    }
  ],
  "rewardAccounts": [
    {
      "dateCreated": "2017-01-17T13:20:48+00:00",
      "lastUpdated": "2017-01-17T13:20:48+00:00"
    }
  ],
  "included": {
    "attributes": {
      "dateCreated": "2017-01-17T13:20:48+00:00",
      "lastUpdated": "2017-01-17T13:20:48+00:00",
      "children": [
        {
          "dateCreated": "2017-01-17T13:20:48+00:00",
          "lastUpdated": "2017-01-17T13:20:48+00:00"
        }
      ],
      "rewardAccounts": [
        {
          "dateCreated": "2017-01-17T13:20:48+00:00",
          "lastUpdated": "2017-01-17T13:20:48+00:00"
        }
      ]
    }
  }
}