Retrieves the points ledger explode info for customer/ user group.
The Customer Ledger Explode Info API retrieves additional points ledger info for a customer or user group.
A customer points ledger is essentially a record that tracks the points earned, spent, and adjusted within an organization and its affiliates. These points are treated like currency and can be redeemed across various units or loyalty programs within the organization.
For more information, refer to the documentation on Points Ledgers.
Example request
curl --location 'https://eu.api.capillarytech.com/v2/pointsLedger/getLedgerExplodeInfo?identifierName=mobile&identifierValue=918088369835&source=INSTORE&eventIds=634510612' \
--header 'Authorization: Basic aWFtc2hpdkNWI1YTI5MWY=' \
--header 'Cookie: _cfuvid=PsFx0ALxLdrB1NEgHeuRoT3TmBSmBySaXbb3ptIqvJY-1732095262794-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v2/pointsLedger/getLedgerExplodeInfo?identifierName=mobile&identifierValue=918088369835&source=INSTORE&eventName=TransactionAdd&eventReferenceIds=888812880' \
--header 'Authorization: Basic aWFtc2h1YTI5MWY=' \
--header 'Cookie: _cfuvid=PsFx0ALxLdrB1NEgHeuRoT3TmBSmBySaXbb3ptIqvJY-1732095262794-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v2/pointsLedger/getLedgerExplodeInfo?identifierName=id&identifierValue=565039506&source=INSTORE&type=CUSTOMER&eventName=GenericEvent&eventReferenceIds=67587c26-d925-4f8d-9211-a9b4d6f8db8e' \
--header 'Authorization: Basic aWFtc2hpYTI5MWY=' \
--header 'Cookie: _cfuvid=PsFx0ALxLdrB1NEgHeuRoT3TmBSmBySaXbb3ptIqvJY-1732095262794-0.0.1.1-604800000'Prerequisites
- Authentication: Basic or OAuth credentials
- Access points group resource: Read access to customer points group resource
Resource information
| URI | v2/pointsLedger/getLedgerExplodeInfo |
| HTTP Method | GET |
| Pagination | Yes |
| Batch support | No |
| Rate limit information | NA |
Query parameters
Parameter Name | Description |
|---|---|
identifierName* | Identifier type to identify the customer. Supported values: MOBILE, ID, EMAIL, CustomerID, primaryUserId, and EXTERNALID. |
identifierValue* | Value for the identifier. For example, the mobile number or customer ID. |
source* | Source in which the identifier is available. For example, INSTORE, MARTJACK, WECHAT, FACEBOOK, WEB_ENGAGE, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. |
eventIds** | The list of |
eventName** | Name of the event. Supports both behavioral and transactional events. Possible values: Note: Either |
eventReferenceIds** | Reference ID for the event. For transactional events, this is the transaction ID. For behavioral events, this is the unique request ID generated when a behavioral event is triggered. You can add up to ten reference IDs for the specified |
accountId | For a source with multiple accounts, pass the specific accountId in which the customer identifier is available. |
getBillDetails | Setting this to true will return bill details like bill number, amount, discount, line items, etc. |
getPointsEarnedBreakup | Setting this to true will return points breakup details, such as points category name, points allocation strategy name, expiry strategy, etc. |
getCustomFields | Setting this value will return the custom fields set up by the brand. |
getExtendedFields | Setting this field will return the extended fields set up by the brand. |
getMaxConversionDetails | Setting this field to true will return the max conversion details set for Add Transaction. For all line items where delayed accrual is based on fixed or return date, the max of all dates is calculated and shown in the field |
getPaymentModes | Setting this field will show an array of payment modes used (e.g., UPI, CASH, etc.). |
type | Returns entries for type of user—either individual customer or group. Supported values: CUSTOMER, USERGROUP2. |
isPrimaryUser | Returns entry for the primary member of a group, in case of user groups. |
includeAlternateCurrencies | Pass |
alternateCurrencyNames | Filter alternate currencies for the customer based on the name. You can also pass a list of comma-separated currency names. Set |
Example Response
{
"events": [
{
"eventLogId": 30527930,
"eventName": "TargetCompleted",
"eventDetails": {
"eventTime": "2024-10-25 22:59:12.0",
"tillId": 50137565
},
"targetCompletedDetails": {
"targetGroupID": 46750,
"targetGroupName": "TGName",
"targetId": 76041,
"targetName": "TName",
"targetDescription": "TDescription",
"targetPeriodID": 66277,
"targetPeriodName": "Cycle_4",
"targetValue": "1000.000",
"achievedValue": "1200.000",
"sourceId": 641554,
"sourceType": "USERTARGET",
"pointsEarned": {
"promo": [
{
"promotionId": 1133572888,
"promotionName": "Progname",
"programId": 1933,
"programName": "DefaultProgram",
"value": 100.0,
"expiresOn": "2026-11-30 23:59:59.0",
"expiresOnISO": "2026-11-30T23:59:59+05:30",
"expiryType": "fixed"
}
],
"promised": []
}
},
"eventReferenceId": "263985",
"uniqueId": "71730c8b628d0978e21e5e374f50fae606779fd412"
},
{
"eventLogId": 30527931,
"eventName": "TargetCompleted",
"eventDetails": {
"eventTime": "2024-10-25 22:59:12.0",
"tillId": 50137565
},
"targetCompletedDetails": {
"targetGroupID": 46750,
"targetGroupName": "TGName1",
"targetId": 76041,
"targetName": "TName1",
"targetDescription": "TDesc1",
"targetPeriodID": 66277,
"targetPeriodName": "Cycle_4",
"triggerValue": "300.000",
"sourceId": 78104,
"sourceType": "MILESTONE",
"pointsEarned": {
"promo": [
{
"promotionId": 1133572888,
"promotionName": "Promoname",
"programId": 1933,
"programName": "Progname",
"value": 100.0,
"expiresOn": "2025-10-31 23:59:59.0",
"expiryType": "fixed"
}
],
"promised": []
},
"mileStoneName": "Sub target 1"
},
"eventReferenceId": "263986",
"uniqueId": "88248bc99f945f1778f85af7c6ba69e4b90651c6"
},
{
"eventLogId": 30527932,
"eventName": "TargetCompleted",
"eventDetails": {
"eventTime": "2024-10-25 22:59:12.0",
"tillId": 50137565
},
"targetCompletedDetails": {
"targetGroupID": 46750,
"targetGroupName": "TGName1",
"targetId": 76041,
"targetName": "TName1",
"targetDescription": "TDesc1",
"targetPeriodID": 66277,
"targetPeriodName": "Cycle_4",
"triggerValue": "600.000",
"sourceId": 78104,
"sourceType": "MILESTONE",
"pointsEarned": {
"promo": [
{
"promotionId": 1133572888,
"promotionName": "Promoname",
"programId": 1933,
"programName": "Progname",
"value": 100.0,
"expiresOn": "2025-10-31 23:59:59.0",
"expiryType": "fixed"
}
],
"promised": []
},
"mileStoneName": "Sub target 2"
},
"eventReferenceId": "263987",
"uniqueId": "7470f2457563461f66bc1aasgf1760d8ga71ec3ee0174c267"
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 652367550,
"eventName": "PointsRedemption",
"eventDetails": {
"eventTime": "2025-12-03 05:13:39.0",
"eventTimeISO": "2025-12-03T05:13:39Z",
"tillId": 75155297,
"redemptionDetails": {
"pointsRedeemed": "20.000",
"redemptionPurpose": "",
"transactionNumber": "test00transact96",
"billingTime": "2025-07-24 14:00:00.0",
"billingTimeISO": "2025-07-24T14:00:00Z",
"redemptionId": "evjan8",
"notes": "Redeemed to transfer points to the friend",
"groupRedemption": false
}
},
"customFields": [],
"pointsBreakup": [],
"eventReferenceId": "566135941",
"uniqueId": "QGcBZ8Nv3C"
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 634510612,
"eventName": "TransactionAdd",
"eventDetails": {
"eventTime": "2025-07-16 14:00:00.0",
"eventTimeISO": "2025-07-16T14:00:00Z",
"tillId": 75152721
},
"eventReferenceId": "888812880",
"uniqueId": "yFNq8FgavV"
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 44049002,
"eventName": "GenericEvent",
"eventDetails": {
"eventDisplayName": "Walk5Kms",
"tillId": 50789251,
"displayName": "Walk5Kms"
},
"pointsEarned": {
"regular": [],
"promo": [
{
"promotionId": 1133595541,
"promotionName": "Walk5Kms",
"programId": 3500,
"programName": "DocDemoDefaultProgram",
"value": 100.0,
"expiresOn": "2026-11-30 23:59:59.0",
"expiresOnISO": "2026-11-30T23:59:59+05:30",
"promotionStartDate": "2025-11-01 00:00:00.0",
"promotionEndDate": "2026-02-25 23:59:59.0"
}
],
"promised": []
},
"behavioralEventMetadata": {
"label": "Walk5Kms",
"fields": [
{
"fieldName": "mobile",
"fieldType": "customer",
"attributes": {
"accountId": {
"valueType": "ENUM"
},
"addCustomerIfNotExists": {
"valueType": "BOOLEAN",
"value": "true"
},
"identifierType": {
"valueType": "ENUM",
"value": "mobile"
},
"isRequired": {
"valueType": "BOOLEAN",
"value": "true"
},
"source": {
"valueType": "ENUM",
"value": "INSTORE"
}
}
},
{
"fieldName": "stepsWalked",
"fieldType": "double",
"attributes": {
"isPsiData": {
"valueType": "BOOLEAN",
"value": "false"
},
"isRequired": {
"valueType": "BOOLEAN",
"value": "true"
},
"isUniqueKeyField": {
"valueType": "BOOLEAN",
"value": "false"
}
}
}
]
},
"eventReferenceId": "fb98ae16-668d-4c48-826b-1c13fa5344e7",
"uniqueId": "fb98ae16-668d-4c48-826b-1c13fa5344e7"
}
],
"warnings": [
{
"code": 9018,
"message": "no alternate currency found for org with given input params",
"status": false
}
]
}{
"events": [
{
"eventLogId": 27909380,
"eventName": "CustomerRegistration",
“eventReferenceIds“:{RefId1},
"eventDetails": {
"eventTime": "2024-01-18 17:18:00.0",
"tillId": 50697469
},
"pointsEarned": {
"regular": [],
"promo": [],
"promised": []
}
},
{
"eventLogId": 27909380,
"eventName": "CustomerRegistration",
“eventReferenceIds“:{RefId2},
"eventDetails": {
"eventTime": "2024-01-18 17:18:00.0",
"tillId": 50697469
},
"pointsEarned": {
"regular": [],
"promo": [],
"promised": []
}
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 8143509,
"eventName": "AllocateGoodwillPoints",
"eventDetails": {
"eventTime": "2023-07-27 19:14:10.0",
"reason": "POINTS_ISSUE",
"comments": "Customer has reached the milestone. Awarding him 100 points.",
"assocId": 0,
"requestId": 980464
},
"pointsEarned": {
"regular": [],
"promo": [
{
"promotionId": 1114107,
"promotionName": "Goodwill Promotion",
"programId": 890,
"programName": "huhuhuDefaultProgram",
"value": 100.0,
"expiresOn": "2023-08-01 23:59:59.0",
"expiryType": "fixed"
}
],
"promised": []
},
"eventReferenceId": "-1",
"uniqueId": "GzKOlmc0eM"
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 632749682,
"eventName": "PointsRedemption",
"eventDetails": {
"eventTime": "2025-07-03 07:13:20.0",
"tillId": 75152721,
"redemptionDetails": {
"pointsRedeemed": "101.000",
"redemptionPurpose": "testUpdate",
"transactionNumber": "txn-79",
"redemptionId": "kh4Mh7",
"notes": "Redeemed to transfer points to the friend",
"groupRedemption": false
}
},
"customFields": [
{
"name": "card_number",
"value": "123456"
}
],
"pointsBreakup": [],
"eventReferenceId": "564332013",
"uniqueId": "nQmaNo4ay9"
}
],
"warnings": []
}{
"events": [
{
"eventLogId": 24732968,
"eventName": "TransactionAdd",
"eventDetails": {
"eventTime": "2024-03-26 10:38:00.0",
"eventTimeISO": "2024-03-26T10:38:00+05:30",
"tillId": 50671937
},
"billDetails": {
"type": "loyalty",
"billNumber": "num124536",
"grossAmount": 30.0,
"discount": 5.0,
"billAmount": 200.0,
"note": "this is test1",
"source": "instore",
"billDate": "2024-03-26 10:38:00.0",
"billDateISO": "2024-03-26T10:38:00+05:30",
"pointsEarned": {
"regular": [
{
"value": 0.0,
"expiresOn": "2025-03-31 23:59:59.0",
"expiresOnISO": "2025-03-31T23:59:59+05:30",
"programId": 2649,
"programName": "VidhiJainOrgDefaultProgram",
"expiryType": "fixed"
}
],
"promo": [],
"promised": []
},
"pointsEarnedBreakup": {
"regular": [
{
"value": 0.0,
"expiresOn": "2025-03-31 23:59:59.0",
"expiresOnISO": "2025-03-31T23:59:59+05:30",
"awardedOn": "2024-03-26 10:38:00.0",
"awardedOnISO": "2024-03-26T10:38:00+05:30",
"sourceValue": 0.0,
"programId": 2649,
"programName": "VidhiJainOrgDefaultProgram",
"allocationStrategyId": 111526,
"allocationStrategyName": "10x fixed",
"pointsCategoryId": 18871,
"pointsCategoryName": "Main",
"expiryStrategyId": 109281,
"expiryStrategyName": "NUM_MONTHS_END12",
"expiryType": "fixed"
}
],
"promised": []
},
"alternateCurrencyValueEarned": [
{
"regular": [
{
"value": 150.0,
"expiresOn": "2025-03-31 23:59:59.0",
"expiresOnISO": "2025-03-31T23:59:59+05:30",
"programId": 2649,
"programName": "VidhiJainOrgDefaultProgram",
"expiryType": "fixed"
}
],
"promo": [],
"promised": [],
"alternateCurrencyName": "acName",
"alternateCurrencyIdentifier": "P7d8Br"
}
],
"alternateCurrencyValueEarnedBreakup": [
{
"regular": [
{
"value": 0.0,
"expiresOn": "2025-03-31 23:59:59.0",
"expiresOnISO": "2025-03-31T23:59:59+05:30",
"awardedOn": "2024-03-26 10:38:00.0",
"awardedOnISO": "2024-03-26T10:38:00+05:30",
"sourceValue": 0.0,
"programId": 2649,
"programName": "VidhiJainOrgDefaultProgram",
"allocationStrategyId": 111529,
"allocationStrategyName": "alllocate 150",
"pointsCategoryId": 20151,
"pointsCategoryName": "acName_PointCategory",
"expiryStrategyId": 109281,
"expiryStrategyName": "NUM_MONTHS_END12",
"expiryType": "fixed"
}
],
"promised": [],
"alternateCurrencyName": "acName",
"alternateCurrencyIdentifier": "P7d8Br"
}
],
"lineItems": [
{
"id": 2158986015,
"itemCode": "sku_164716451_2",
"source": "instore",
"grossAmount": 0.0,
"discount": 0.0,
"amount": 300.0,
"rate": 10.5,
"qty": 3.0
},
{
"id": 2158986016,
"itemCode": "sku_164716451_3",
"source": "instore",
"grossAmount": 0.0,
"discount": 0.0,
"amount": 300.0,
"rate": 10.5,
"qty": 3.0
},
{
"id": 2158986017,
"itemCode": "sku_164716451_4",
"source": "instore",
"grossAmount": 0.0,
"discount": 0.0,
"amount": 300.0,
"rate": 10.5,
"qty": 3.0
}
]
},
"customFields": [],
"extendedFields": [],
"paymentModes": [],
"pointInTimeSlabs": [
{
"pointInTimeSlabNumber": 2,
"pointInTimeSlabName": "SILVER",
"programId": 2649,
"isDefaultProgram": true
}
],
"eventReferenceId": "2151534230",
"uniqueId": "sC1RXvEHWU"
}
],
"warnings": [
{
"code": 9018,
"message": "alternate currency with given name not found for org, name: dummy",
"status": false
}
]
}Response Parameters
Parameter Name | Type | Description |
|---|---|---|
eventLogId | Integer | A unique identifier for the event. |
eventName | String | Name of the event. |
eventDetails | Object | Contains details about the event. |
-eventTime | String | Indicates the event-triggered date in YYYY-MM-DD HH:MM:SS.s format. Note: This field will be deprecated in the future and is being replaced by eventTimeISO. |
-eventTimeISO | String | Indicates the event-triggered date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
-eventDisplayName | String | Display name of the event, e.g., |
-tillId | Integer | ID of the till where the event was recorded. |
-comments | String | Additional comments provided while issuing goodwill points. |
-assocId | long | User ID of the Intouch user who issued the Goodwill points. |
-displayName | String | Name to display for the event, e.g., |
-redemptionDetails | Array | Includes the details related to the redemption of points. |
--pointsRedeemed | String | The number of points that were redeemed in the transaction. |
--redemptionPurpose | String | Purpose of points redemption. |
--transactionNumber | String | The transaction/bill number associated with the points redemption. |
--redemptionId | String | A unique identifier for the redemption transaction. |
targetCompletedDetails | Array | Object containing details of a completed target. |
-targetGroupID | String | The unique group ID of the target. |
-targetGroupName | String | The unique name of the target group. |
-targetId | Integer | The unique ID of the target. |
-targetName | String | The unique name of the target. |
-targetDescription | String | Description of the target (if added). |
-targetPeriodID | Integer | The unique ID of the target period. |
-targetPeriodName | String | The unique name of the target period. |
-sourceId | Integer | The unique ID of the target source. |
-sourceType | String | The type of source (MILESTONE, STREAKS, UNIFIED). |
pointsEarned | Object | Contains details of points earned in the event. |
-regular | Array | Array of regular points earned (empty in this case). |
-promo | Array | Array of promotional points earned during the event. |
--promotionId | Integer | The ID of the promotion, e.g., |
--promotionName | String | The name of the promotion, e.g., |
--programId | Integer | The ID of the loyalty program associated with the promotion, e.g., |
--programName | String | The name of the loyalty program, e.g., |
--value | Float | The value of the points earned from the promotion, e.g., |
--expiresOn | String | Indicates the promotion expiry date and time. Note: This field will be deprecated in the future and is being replaced by |
--expiresOnISO | String | Indicates the promotion expiry date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
--promotionStartDate | String | The start date of the promotion, e.g., |
--promotionEndDate | String | The end date of the promotion, e.g., |
-promised | Array | Array of promised points (empty in this case). |
behavioralEventMetadata | Object | Metadata about the behavioral event associated with the check-in. |
-label | String | The label for the behavioral event, e.g., |
-fields | Array | An array of fields related to the event's metadata. |
--fieldName | String | The name of the field, e.g., |
--fieldType | String | The type of the field, e.g., |
--attributes.isRequired.valueType | String | The type of value for the |
--attributes.isRequired.value | String | The value indicating if the field is required, e.g., |
--isUniqueKeyField.valueType | String | The type of value for the |
--isUniqueKeyField.value | String | The value indicating if the field is a unique key, e.g., |
eventReferenceId | String | The event request ID. This is generated when the event is sent. This helps to trace the event. For |
uniqueId | String | A unique identifier for this specific event instance, e.g., |
billDetails | Object | Object containing details on the following information: type (type of transaction), bill number (unique transaction number), gross amount, discount, bill amount, note, source, bill date (time in ISO 8601 format), and points earned details. |
-billNumber | String | Unique identifier for the transaction. This is defined when adding the original transaction. |
-billAmount | Float | Total transaction amount for the transaction. |
-note | String | Note for the transaction. |
-returnDate | String | Date when the transaction was returned in in ISO 8601 |
-returnDateISO | String | Indicates the returned transaction date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
-returnAmount | Float | Total amount for the return transaction. |
-billDate | String | Date when the transaction was created in ISO 8601 |
-billDateISO | String | Indicates the transaction created date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
-returnType | Enum | Type of return. Possible values: |
-returnBillId | long | Unique ID for the return transaction that is generated after a return transaction. This is the |
-pointsEarned | Object | Object containing details on the points earned for the transaction. |
-lineItems | Object | Object containing details on line items in the bill. |
customFields | Object | Object containing details on custom fields for the transaction. |
-name | String | Unique name of the custom field. |
-value | Any | Value for the corresponding custom field name. The data type for the value is based on what is configured for the custom field. |
pointsEarnedBreakup | Object | Object containing points earned details with break up. |
awardedOn | String | Indicates the points awarded date in YYYY-MM-DD HH:MM:SS.s format. Note: This field will be deprecated in the future and is being replaced by |
awardedOnISO | String | Indicates the points awarded date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
expiresOn | String | Indicates the points expiry date in YYYY-MM-DD HH:MM:SS.s format. Note: This field will be deprecated in the future and is being replaced by |
expiresOnISO | String | Indicates the points expiry date and time in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
warnings | Array | Warnings, if any. |
Response parameters: Filtered byManualPointsAdjustment event ID
ManualPointsAdjustment event ID{
"events": [
{
"eventLogId": 656317605,
"eventName": "ManualPointsAdjustment",
"eventDetails": {
"eventTime": "2026-01-07 05:43:40.0",
"eventTimeISO": "2026-01-07T05:43:40Z",
"tillId": 75152721
},
"eventReferenceId": "-1",
"uniqueId": "J52P7ttKJL",
"manualPointsAdjustmentDetails": {
"orgId": 100737,
"customerId": 566135941,
"totalPointsDeducted": "100.000",
"createdOn": "2026-01-07 05:43:40",
"createdOnISO": "2026-01-07T05:43:40Z",
"reason": "testing",
"pointsDeductionBreakUpDetails": [
{
"customerId": 566135941,
"loyaltyId": 566135941,
"programId": 973,
"programName": "DocDemoDefaultProgram",
"promotionId": 75984,
"promotionName": "Goodwill Promotion",
"pointAwardedRefType": "POINT_AWARDED_CUSTOMER_PROMOTION",
"pointAwardedRefId": 738338727,
"deductionType": "MANUAL_ADJUSTMENT",
"pointsDeducted": 100.0,
"pointsDeductedStr": "100.000",
"pointsDeductedCurrencyValue": 100.0,
"pointsDeductedCurrencyValueStr": "100.000",
"pointsDeductedOn": "2026-01-07 05:43:40.0",
"pointsDeductedOnISO": "2026-01-07T05:43:40Z",
"pointsDeductedBy": "naman",
"pointsDeductedById": 75152721,
"sourceType": "Bill",
"awardedTillId": 75197941,
"awardedTillDate": "2025-12-03 12:16:59.0"
}
]
}
}
],
"warnings": []
}Parameter name | Type | Description |
|---|---|---|
pointsDeductionBreakUpDetails | List PointsDeductionBreakUpDetail | List containing detailed breakup of loyalty points deductions for a customer. |
customerId | int | Unique identifier of the customer whose points were deducted. |
loyaltyId | Long | Loyalty ID associated with the customer. |
programId | Integer | Unique identifier of the loyalty program. |
programName | String | Name of the loyalty program under which the points were deducted. |
promotionId | Long | Unique identifier of the promotion linked to the points deduction. |
promotionName | String | Name of the promotion associated with the deduction. |
pointAwardedRefType | String | Reference type indicating how the original points were awarded. |
pointAwardedRefId | Long | Reference ID of the original points award transaction. |
deductionType | String | Type of points deduction (e.g., manual adjustment). |
pointsDeducted | BigDecimal | Number of loyalty points deducted. |
pointsDeductedStr | String | Points deducted represented as a formatted string. |
pointsDeductedCurrencyValue | BigDecimal | Currency value equivalent of the deducted points. |
pointsDeductedCurrencyValueStr | String | Currency value of the deducted points as a formatted string. |
pointsDeductedOn | String | Indicates the points deducte date in yyyy-MM-dd HH:mm:ss.S
format. Note: This field will be deprecated in the future and is being replaced by |
pointsDeductedOnISO | Date | Indicates the date and time of the points deducted in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
pointsDeductedBy | String | Username of the user who performed the points deduction. |
pointsDeductedById | Long | Unique identifier of the user who performed the deduction. |
sourceType | String | Source that triggered the points deduction (e.g., Bill). |
awardedTillId | Integer | Identifier of the till where the original points were awarded. |
awardedTillDate | String | Date and time when the original points were awarded. Note: This field will be deprecated in the future and is being replaced by |
awardedTillDateISO | Date | Indicates the date and time of when the original points were awarded in ISO 8601 format, returned in the server timezone. EU server example: 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC). India server example: 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST). Note: The response timezone always matches the server timezone, regardless of the timezone offset in the request. |
Error codes
| HTTP Code | Description |
|---|---|
| 9022 | Event reference IDs are invalid. |
| 11014 | Event name not found. Provide a valid event name. |
| 11023 | Invalid identifiers found. Either EventLogId or (EventName and BillId) are required. |
| 11012 | Invalid userId field value. |
| 11013 | IdentifierName and identifierValue, source can not be empty. |
| 8013 | Invalid identifiername field value. |
| 9003 | Error fetching points ledger data when type is invalid. Provide a valid type. |
| 1632 | group id/externalId/primary userId passed is invalid. |
| 9021 | Invalid identifiers found when invalid eventid is passed. Provide a valid eventId. |
| 11017 | Event id format exception. The provided value is not a valid numeric eventIds . Provide a valid numeric eventIds. |
| 9005 | Invalid alternateCurrencyNames field value. Provide a valid alternateCurrencyNames. |
| 9018 | Alternate currencies not found with provided category filters. Provide a valid alternate currency name. |
| 11021 | EventId and Event References, both cannot be passed. Provide either eventId or eventName and eventReferenceIds. |
| 11019 | Source value capturing status is disabled. To enable it raise a Jira ticket to the Capillary Product Support team. |