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).

Prerequisites

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

API endpoint example

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.

Query parameter

ParameterTypeDescription
limitintMaximum number of records to return per page. Default value - 10
offsetintNumber of records to skip before starting to return results (zero-based). Default value - 0
pageintPage number to fetch (alternative to offset). Overrides offset if both are provided. Default value - 1
sortBystringField to sort by (e.g., pointsTransferDate, pointsTransferred).
sortOrderstringSort direction: asc (ascending) or desc (descending). Default: desc.

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.
{
    "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": []
}

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!