Skip to content

GET Membership Points Current Balance

Endpoint

URL: https://api.akaun.com/core2/tnt/dm/crm/membership-points-txn/current-balance/query
Method: GET
Headers:

  • Authorization: Bearer <token> (or an AccessId + AccessKey pair)
  • tenantCode: <Tenant Code>
  • Content-Type: application/json

Headers and credentials are described once, on the authentication page; this page does not repeat them.

Description

This endpoint retrieves the current point balance for members based on filtering and pagination criteria.

Served by MembershipPointsTxnController (@GetMapping /current-balance/query); the eleven filters below are exactly the fields of MembershipPointsCurrentBalanceQueryCriteria.

cURL Example 

curl 'https://api.akaun.com/core2/tnt/dm/crm/membership-points-txn/current-balance/query?calcTotalRecords=true&card_no=GS-0001234' \
  --header 'Authorization: <JWT Token>' \
  --header 'tenantCode: gadgetsphere'

Query Parameters

Pagination & Sorting

  • limit (default: 100)
  • offset (default: 0)
  • orderBy
  • order (ASC or DESC)
  • calcTotalRecords (boolean)

Filtering Fields

  • membership_hdr_guid (UUID)
  • card_no
  • point_currency
  • point_balance (BigDecimal)
  • namespace
  • applet_guid (UUID)
  • module_guid (UUID)
  • created_date_to
  • created_date_from
  • updated_date_to
  • updated_date_from

Response

Content-Type: application/json

Example Response 

{
    "totalRecords": 1,
    "offset": 0,
    "limit": 100,
    "code": "OK_RESPONSE",
    "message": "",
    "data": [
        {
            "bl_crm_membership_points_current_balance": {
                "guid": "00000000-0000-4000-8000-000000000041",
                "membership_hdr_guid": "00000000-0000-4000-8000-000000000021",
                "card_no": "GS-0001234",
                "point_currency": "GSPTS",
                "point_balance": 10340.0000000000000000000000,
                "namespace": null,
                "applet_guid": null,
                "module_guid": null,
                "created_date": "2022-12-09T04:12:48.885498Z",
                "updated_date": "2025-11-26T03:49:19.925594Z",
                "status": "ACTIVE",
                "revision": "00000000-0000-4000-8000-000000000042",
                "vrsn": null
            }
        }
    ]
}

Notes

  • calcTotalRecords=true adds overhead; enable only when the UI needs record count.
  • This reads bl_crm_membership_points_current_balance — the running total per card and point currency, maintained by the balance-update processor after every transaction line. It includes points that have since expired. For the valid balance (unexpired control-account rows only) use GET …/membership-points-txn/balance/{card_no} or …/balance/{card_no}/{point_currency} on the same controller.
  • etl-ep twin: …/membership-points-txn/etl-ep/current-balance/query.
  • Sample values are synthetic GadgetSphere data.