GET Membership Points Current Balance

Read the points a member can spend now: the stored running total, the same row the till reads.

Endpoint

URL: https://api-etl.akaun.com/core2/tnt/dm/crm/membership-points-txn/current-balance/query
Method: GET
Headers: a credential, either Authorization: Bearer <token> (the Bearer prefix is optional) or an AccessId + AccessKey pair, and tenantCode. The authentication page describes both credentials.

Description

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

Read a member’s balance here, not at GET …/membership-points-txn/balance/{card_no}: that route returns the balance of a single lot row rather than a sum, and a read can rewrite that row (the Notes below say more).

cURL Example

curl 'https://api-etl.akaun.com/core2/tnt/dm/crm/membership-points-txn/current-balance/query?calcTotalRecords=true&card_no=GS-0001234' \
  --header 'Authorization: Bearer <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 is the figure the till shows. For what is still valid and until when, read the member’s lots (the control-account rows, shown on Membership Admin’s Points Expiry tab). Do not use GET …/membership-points-txn/balance/{card_no} (or …/balance/{card_no}/{point_currency}) for a valid balance: it returns the balance of a single lot row rather than a sum, and a read can rewrite that row.
• etl-ep twin: …/membership-points-txn/etl-ep/current-balance/query.
• Sample values are synthetic GadgetSphere data.