Get Points Transfer Summary

Retrieves points transfer summary of a customer.

This includes points that are transferred from the customer account to another customer’s account (Deduction) and points that are received from another customer’s account (Addition).

Example request

curl --location 'https://eu.api.capillarytech.com/v2/customers/564955098/pointsTransfers' \
--header 'Authorization: Basic =' \
--header 'Cookie: _cfuvid=SPpJZvR8VvAMacotHKvjCBzkT.A38OIejYNSsGOXido-1757310494558-0.0.1.1-604800000'

Prerequisites

  • Basic or OAuth credentials
  • Read access to Points access group resource

Rate limit

  • Demo and Testing Clusters: 1,000 requests per minute per API key
  • Other Organizations: The rate limit is brand-specific.

To modify the limit, create a ticket with the Capillary Product support team.

Sample API cURL

https://eu.api.capillarytech.com/v2/customers/343015431/pointsTransfers

curl --location 'https://eu.api.capillarytech.com/v2/customers/565039505/pointsTransfers' \
--header 'Authorization: Basic c2FudC5wXzEyMzpiMmVhMGFhYWI1ZThmODg5ZTAzNGE2NjA5NTIwM2FlNw==' \
--header 'Cookie: _cfuvid=uEUwrBAfGGgkRhH8C6wGyc6ShByhFRsEdpQj1e8WSGU-1750831646379-0.0.1.1-604800000'

Resource information

URIv2/customers/34301543/pointsTransfers
HTTP methodGET
AuthenticationBasic
Pagination supportYes
Rate limitYes
Batch SupportNo

Request Headers

Header KeyDescription
AuthorizationBearer token for authentication. Example: Bearer <your_access_token>.
Content-TypeSpecifies the media type of the request. Use application/json for JSON.
AcceptDefines the response format. Example: application/json or application/xml.
X-Capillary-OrgIdUnique organization ID for which the API is being called.
X-Capillary-App-KeyApplication key for API access.
X-CAP-API-OAUTH-TOKENThis header is a custom authentication header used to pass the OAuth access token for API authentication. Refer to https://docs.capillarytech.com/reference/oauth#/

Query parameter

ParameterTypeRequiredDescription
programIdintegerOptionalFilters transfers for a specific loyalty program; typically needed only for multi-program orgs.
entityTypestringOptionalEntity context; defaults to CUSTOMER when not provided
limitintegerOptionalMaximum number of records to return per page. Default value - 10
offsetintegerOptionalNumber of records to skip before starting to return results (zero-based). Default value - 0
pageintegerOptionalPage number to fetch (alternative to offset). Overrides offset if both are provided. Default value - 1
sortBystringOptionalField to sort by (e.g., pointsTransferDate, pointsTransferred).
sortOrderstringOptionalSort direction: asc (ascending) or desc (descending). Default: desc.

Path parameter

ParameterTypeRequiredDescription
userIdintegerYesUnique ID of the customer whose points transfer summary is requested.

Response Parameter

ParameterTypeDescription
toEntityIdlongUnique ID of the recipient entity (customer or group).
toEntityTypestringType of the recipient entity (e.g., "CUSTOMER").
fromEntityIdlongUnique ID of the sender entity (customer or group).
fromEntityTypestringType of the sender entity (e.g., "CUSTOMER").
pointsTransferDatestringTimestamp of the points transfer (format: YYYY-MM-DD HH:MM:SS).
pointsTransferreddoubleNumber of points transferred.
transferIdlongUnique ID for the transfer transaction.
transferTypestringType of transfer (e.g., "DEDUCTION" for outgoing, "ADDITION" for incoming).
transferredFromobjectDetails of the sender:
  userIdlongSender's unique ID.
  firstNamestringSender's first name
  lastNamestringSender's last name
transferredToobjectDetails of the recipient:
  userIdlongRecipient's unique ID.
  firstNamestringRecipient's first name
  lastNamestringRecipient's last name
notesstringAdditional notes or comments for the transfer (if provided).
programNamestringName of the loyalty program associated with the transfer.

Example response

	{
    "data": [
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-06 13:33:40",
            "pointsTransferred": 20.0,
            "transferId": 1038007,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-06 11:24:48",
            "pointsTransferred": 20.0,
            "transferId": 1038004,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-03 06:59:07",
            "pointsTransferred": 20.0,
            "transferId": 1037928,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:59:56",
            "pointsTransferred": 20.0,
            "transferId": 1037907,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:57:47",
            "pointsTransferred": 20.0,
            "transferId": 1037906,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:56:48",
            "pointsTransferred": 200.0,
            "transferId": 1037905,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:51:43",
            "pointsTransferred": 200.0,
            "transferId": 1037904,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:49:00",
            "pointsTransferred": 200.0,
            "transferId": 1037903,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:24:15",
            "pointsTransferred": 20.0,
            "transferId": 1037901,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:24:14",
            "pointsTransferred": 2000.0,
            "transferId": 1037898,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 10:24:13",
            "pointsTransferred": 2000.0,
            "transferId": 1037894,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 565039506,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 565039505,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-06-02 07:24:58",
            "pointsTransferred": 2000.0,
            "transferId": 1037890,
            "transferType": "DEDUCTION",
            "transferredFrom": {
                "userId": 565039505,
                "firstName": "",
                "lastName": ""
            },
            "transferredTo": {
                "userId": 565039506,
                "firstName": "Madhurima",
                "lastName": "Basak"
            },
            "notes": "",
            "programName": "DocDemoDefaultProgram"
        }
    ],
    "warnings": [],
    "errors": []
}
{
    "data": [
        {
            "toEntityId": 564955098,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 564955097,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-03-26 17:49:22",
            "pointsTransferred": 40.0,
            "transferId": 1035937,
            "transferType": "ADDITION",
            "transferredFrom": {
                "userId": 564955097,
                "firstName": "testgrp1",
                "lastName": "testgrpv2"
            },
            "transferredTo": {
                "userId": 564955098,
                "firstName": "",
                "lastName": ""
            },
            "notes": "Transferred on 28 feb 2025",
            "programName": "DocDemoDefaultProgram"
        },
        {
            "toEntityId": 564955098,
            "toEntityType": "CUSTOMER",
            "fromEntityId": 564955097,
            "fromEntityType": "CUSTOMER",
            "pointsTransferDate": "2025-03-26 17:49:21",
            "pointsTransferred": 40.0,
            "transferId": 1035936,
            "transferType": "ADDITION",
            "transferredFrom": {
                "userId": 564955097,
                "firstName": "testgrp1",
                "lastName": "testgrpv2"
            },
            "transferredTo": {
                "userId": 564955098,
                "firstName": "",
                "lastName": ""
            },
            "notes": "Transferred on 28 feb 2025",
            "programName": "DocDemoDefaultProgram"
        }
    ],
    "warnings": [],
    "errors": []
}

API specific error code

Error CodeDescriptionReason
814No Results FoundInvalid query parameter passed
8015Customer not found for the given identifiersInvalid userId passed
8069Merged customer foundAPI request is made for a customer who has been merged
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!