v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get group points ledger

Retrieve a paginated history of group point redemptions and reversals for a group or for a specific member within their group.

get/v2/customers/{id}/crossMemberLedger

Path parameters

idinteger required

Query parameters

scopestring

eventNamestring

transactionRefstring

startDatestring

endDatestring

pageNumberinteger

pageSizeinteger

sortstring

programIdinteger

Headers

Authorizationstring

X-CAP-API-OAUTH-TOKENstring

Response

Successful response

warningsobject[]

Example response

{
  "groupDetails": {
    "groupId": 12345,
    "groupBalance": 1250,
    "memberCount": 4,
    "members": [
      {
        "customerId": 1001,
        "balance": 400
      }
    ]
  },
  "pageDetails": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalEntries": 1,
    "pageCount": 1
  },
  "entries": [
    {
      "eventLogId": 999821,
      "eventName": "CROSS_MEMBER_REDEMPTION",
      "transactingCustomerId": 1003,
      "transactionRef": "TXN-882291",
      "createdDate": "2026-04-01 10:30:00",
      "createdDateISO": "2026-04-01T10:30:00Z",
      "netPointsOnEvent": "-350.000",
      "status": "ACTIVE",
      "userRole": "TRANSACTING",
      "redemptionId": "ABC123",
      "reversalId": "REV456",
      "transactionNumber": "BILL-9999",
      "externalReferenceNumber": "EXT-REF-42",
      "notes": "Buy-1-get-1 redeem",
      "redemptionPurpose": "CASHBACK",
      "entryDetails": [
        {
          "customerId": 1001,
          "points": "-100.000",
          "reversedAmount": "0.000",
          "expiryBatchDate": "2026-04-05T00:00:00Z",
          "status": "ACTIVE",
          "pointsAwardedId": 8812345,
          "pointsAwardedType": "POINT_AWARDED"
        }
      ]
    }
  ]
}