Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Tier Membership Transaction

Debit a Customer's Tier Membership Balances

This API allows a calling application to decrease the Tier Membership Balances for a customer. This API completes a negative movement of balances only. The values passed in the balances of the request are validated to always be positive integers.

patch/tier/membership/{tierMembershipId}/debit

Path parameters

tierMembershipIdstring required

The ID of the Tier Membership for a given customer

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Request body

walletTransactionIdstring

The ID of a Wallet Transaction to associate to this Tier Membership Transaction.

Response

An object displaying the details of a Tier Membership Transaction against a customer's Tier Membership.

Example response

{
  "membership": {
    "expiryDate": "2024-03-11T16:33:00+00:00",
    "tierBalancesResetDate": "2024-03-11T16:33:00+00:00",
    "dateCreated": "2024-03-11T16:33:00+00:00",
    "lastUpdated": "2024-03-11T16:33:00+00:00"
  },
  "transactions": [
    {
      "dateCreated": "2024-03-11T16:33:00+00:00",
      "lastUpdated": "2024-03-11T16:33:00+00:00"
    }
  ]
}