get
https://{host}/v2/points/transfer
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/points/transfer?identifierName=mobile&source=INSTORE&identifierValue=919777785207' \
--header 'Authorization: Basic bWFka2YQ==' \
--header 'Cookie: _cfuvid=IEacVBB7xCaQXaYZNjqhVgGFNNBE1wcNyx6O5vnh4cA-1759831634361-0.0.1.1-604800000'Resource information
| Pagination support | No |
| Rate limit | NA |
| Batch support | No |
Request parameters
| Parameter | Data Type | Description |
|---|---|---|
| source | string | Source in which the customer identifier is available. For example, INSTORE, MARTJACK, WECHAT, WEBSITE, MOBILE_APP |
| identifierName | string | Identifier type used to identify the customer. For example, mobile, email, externalId, id |
| identifierValue | string | Value of the specified identifier type of the customer. |
| accountId | string | string For sources with multiple accounts, pass the specific account ID in which the customer identifier is registered (not applicable for INSTORE). |
Example response
{
"data": [
{
"toEntityId": 564955411,
"toEntityType": "CUSTOMER",
"fromEntityId": 564955302,
"fromEntityType": "CUSTOMER",
"pointsTransferDate": "2025-10-07 10:30:48",
"pointsTransferDateISO": "2025-10-07T10:30:48Z",
"pointsTransferred": 2.0,
"transferId": 1040871,
"transferType": "ADDITION",
"transferredFrom": {
"userId": 564955302,
"firstName": "testgrp4",
"lastName": "testgrpv2",
"externalId": "434548"
},
"transferredTo": {
"userId": 564955411,
"firstName": "testgrp5",
"lastName": "testgrpv2",
"externalId": "434549"
},
"notes": "",
"programName": "DocDemoDefaultProgram"
},
{
"toEntityId": 564955411,
"toEntityType": "CUSTOMER",
"fromEntityId": 564955302,
"fromEntityType": "CUSTOMER",
"pointsTransferDate": "2025-07-02 17:59:32",
"pointsTransferDateISO": "2025-07-02T17:59:32Z",
"pointsTransferred": 2.0,
"transferId": 1038615,
"transferType": "ADDITION",
"transferredFrom": {
"userId": 564955302,
"firstName": "testgrp4",
"lastName": "testgrpv2",
"externalId": "434548"
},
"transferredTo": {
"userId": 564955411,
"firstName": "testgrp5",
"lastName": "testgrpv2",
"externalId": "434549"
},
"notes": "",
"programName": "DocDemoDefaultProgram"
},
{
"toEntityId": 564955411,
"toEntityType": "CUSTOMER",
"fromEntityId": 564955302,
"fromEntityType": "CUSTOMER",
"pointsTransferDate": "2025-06-03 11:00:19",
"pointsTransferDateISO": "2025-06-03T11:00:19Z",
"pointsTransferred": 2.0,
"transferId": 1037933,
"transferType": "ADDITION",
"transferredFrom": {
"userId": 564955302,
"firstName": "testgrp4",
"lastName": "testgrpv2",
"externalId": "434548"
},
"transferredTo": {
"userId": 564955411,
"firstName": "testgrp5",
"lastName": "testgrpv2",
"externalId": "434549"
},
"notes": "",
"programName": "DocDemoDefaultProgram"
}
],
"warnings": [],
"errors": []
}Response Parameter
| Parameter | Type | Description |
|---|---|---|
| toEntityId | Integer | The ID of the entity receiving the points |
| toEntityType | String | The type of entity receiving points (e.g., "CUSTOMER") |
| fromEntityId | Integer | The ID of the entity sending the points |
| fromEntityType | String | The type of entity sending points (e.g., "CUSTOMER") |
| pointsTransferDate | String | The date and time when points were transferred (yyyy-MM-dd HH:mm:ss format) |
| pointsTransferDateISO | String | Indicates the date and time when the points transfer occured 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 | Float | The number of points transferred |
| transferId | Integer | Unique identifier for the transfer transaction |
| transferType | String | Type of transfer (e.g., "DEDUCTION") |
| transferredFrom | Object | Details about the sender |
| -userId | Integer | Unique identifier of the sender user |
| -firstName | String | First name of the sender |
| -lastName | String | Last name of the sender |
| -externalId | String | External identifier of the sender |
| transferredTo | Object | Details about the receiver |
| -userId | Integer | Unique identifier of the receiver user |
| -firstName | String | First name of the receiver |
| -lastName | String | Last name of the receiver |
| -externalId | String | External identifier of the receiver |
| notes | String | Additional notes about the transfer |
| programName | String | Name of the loyalty program associated with the transfer |
| warnings | Array | List of warning messages |
| errors | Array | List of error messages |
API specific error code
| Error code | Description | Reason |
|---|---|---|
| 8015 | Customer not found for the given identifiers | Invalid or missing identifier value in query parameter |