get
https://{host}/v2/customers//pointsTransfers
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).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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
Resource information
| URI | v2/customers/34301543/pointsTransfers |
|---|---|
| HTTP method | GET |
| Authentication | Basic |
| Pagination support | Yes |
| Batch Support | No |
Request Headers
| Header Key | Description |
|---|---|
| Authorization | Bearer token for authentication. Example: Bearer <your_access_token>. |
| Content-Type | Specifies the media type of the request. Use application/json for JSON. |
| Accept | Defines the response format. Example: application/json or application/xml. |
| X-Capillary-OrgId | Unique organization ID for which the API is being called. |
| X-Capillary-App-Key | Application key for API access. |
| X-CAP-API-OAUTH-TOKEN | This 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
| Parameter | Type | Required | Description |
|---|---|---|---|
| programId | integer | Optional | Filters transfers for a specific loyalty program; typically needed only for multi-program orgs. |
| entityType | string | Optional | Supported values: CUSTOMER |
| limit | integer | Optional | Maximum number of records to return per page. Default value: 10 |
| offset | integer | Optional | Number of records to skip before starting to return results. The count starts from 0.\ Default value: 0 |
| page | integer | Optional | Page number to fetch. Default value: 1. If you provide both, the page value takes priority, and the offset value is ignored. If you give neither, the API fetches page 1 by default. |
| sortBy | string | Optional | Field to sort by (e.g., pointsTransferDate, pointsTransferred). |
| sortOrder | string | Optional | Sort direction: asc (ascending) or desc (descending). Default: desc. |
Path parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | integer | Yes | Unique ID of the customer whose points transfer summary is requested. |
Response Parameter
| Parameter | Type | Description |
|---|---|---|
| toEntityId | long | Unique ID of the recipient entity (customer or group). |
| toEntityType | string | Type of the recipient entity (e.g., "CUSTOMER"). |
| fromEntityId | long | Unique ID of the sender entity (customer or group). |
| fromEntityType | string | Type of the sender entity (e.g., "CUSTOMER"). |
| pointsTransferDate | string | Indicates the points tranfer date and time in the server time zone in YYYY-MM-DDHH:MM:SS. format. Note: This field will be deprecated in the future and is being replaced by pointsTransferDateISO. |
| pointsTransferDateISO | string | Indicates the points transfer date and time in ISO 8601 format, returned in the server time zone. EU server example India server example Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| pointsTransferred | double | Number of points transferred. |
| transferId | long | Unique ID for the transfer transaction. |
| transferType | string | Type of transfer (e.g., "DEDUCTION" for outgoing, "ADDITION" for incoming). |
| transferredFrom | object | Details of the sender: |
| userId | long | Sender's unique ID. |
| firstName | string | Sender's first name |
| lastName | string | Sender's last name |
| transferredTo | object | Details of the recipient: |
| userId | long | Recipient's unique ID. |
| firstName | string | Recipient's first name |
| lastName | string | Recipient's last name |
| notes | string | Additional notes or comments for the transfer (if provided). |
| programName | string | Name of the loyalty program associated with the transfer. |
Example response
{
"data": [
{
"toEntityId": 564955098,
"toEntityType": "CUSTOMER",
"fromEntityId": 564955097,
"fromEntityType": "CUSTOMER",
"pointsTransferDate": "2025-03-26 17:49:22",
"pointsTransferDateISO": "2025-03-26T17:49:22Z",
"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",
"pointsTransferDateISO": "2025-03-26T17:49:21Z",
"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 Code | Description | Reason |
|---|---|---|
| 814 | No Results Found | Invalid query parameter passed |
| 8015 | Customer not found for the given identifiers | Invalid userId passed |
| 8069 | Merged customer found | API request is made for a customer who has been merged |