Checks if specific points of a customer can be transferred to another customer.
Checks if specific points of a customer can be transferred to another customer. You can also issue OTP
that is used to authenticate customer to transfer points ( pointsTransfer
API ). By default, the value is set to false. OTP is not mandatory for points transfer and can be used for security purposes.
Notes
- Points added during customer creation cannot be transferred, points rewarded through transaction are transferable.
- This API is applicable only for individual-to-individual transfers within the Intouch platform. It does not support group-to-group transfers.
- For detailed information about the APIs and for hands-on testing, refer to the API overview documentation and step-by-step guide on making your first API call
Prerequisites
- The config ALLOW_POINTS_TRANSFER should be enabled for the org. To enable this, create a JIRA ticket to the Product Support team.
Response Body
{
"data": [
{
"pointsTobeTransferred": 20,
"transferFrom": {
"id": 564955097,
"profiles": [
{
"firstName": "testgrp1",
"lastName": "testgrpv2",
"attribution": {
"createDate": "2025-02-18T03:54:14Z",
"createdBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-02-28T03:59:49Z"
},
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "434545"
},
{
"type": "mobile",
"value": "919777785203"
}
],
"commChannels": [
{
"type": "email",
"value": "[email protected]",
"primary": true,
"verified": false,
"meta": {
"residence": false,
"office": false
},
"attributes": {}
},
{
"type": "mobile",
"value": "919777785203",
"primary": true,
"verified": false,
"meta": {
"residence": false,
"office": false
},
"attributes": {}
}
],
"source": "INSTORE",
"userId": 564955097,
"accountId": "",
"conflictingProfileList": [],
"autoUpdateTime": "2025-03-25T10:04:40Z",
"identifiersAll": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "434545"
},
{
"type": "mobile",
"value": "919777785203"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty",
"attributionV2": {
"createDate": "2025-02-18T03:54:14Z",
"createdBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-02-28T03:59:49Z"
},
"lifetimePurchases": 12000
},
"segments": {},
"extendedFields": {}
},
"transferTo": {
"id": 564955098,
"profiles": [
{
"firstName": "testgrp2",
"lastName": "testgrpv2",
"attribution": {
"createDate": "2025-02-18T03:57:21Z",
"createdBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-20T12:03:55Z"
},
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "434546"
},
{
"type": "mobile",
"value": "919777785611"
}
],
"commChannels": [
{
"type": "email",
"value": "[email protected]",
"primary": true,
"verified": false,
"meta": {
"residence": false,
"office": false
},
"attributes": {}
},
{
"type": "mobile",
"value": "919777785611",
"primary": true,
"verified": false,
"meta": {
"residence": false,
"office": false
},
"attributes": {}
}
],
"source": "INSTORE",
"userId": 564955098,
"accountId": "",
"conflictingProfileList": [],
"autoUpdateTime": "2025-03-25T10:04:40Z",
"identifiersAll": [
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "434546"
},
{
"type": "mobile",
"value": "919777785611"
}
]
}
],
"loyaltyInfo": {
"loyaltyType": "loyalty",
"attributionV2": {
"createDate": "2025-02-18T03:57:21Z",
"createdBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedBy": {
"id": 75155295,
"code": "sant.p_123",
"name": "sant.p_123",
"type": "TILL",
"referenceId": -1,
"default": false
},
"modifiedDate": "2025-03-20T12:03:55Z"
},
"lifetimePurchases": 1000
},
"segments": {},
"extendedFields": {}
},
"transferrable": true
}
],
"warnings": [],
"errors": []
}
Response Parameters
Parameter | Data Type | Description |
---|---|---|
data | Array | Contains details of the points transfer request. |
pointsTobeTransferred | Float | Number of points to be transferred. |
transferFrom | Object | Details of the customer transferring the points. |
| Long | Unique identifier of the customer transferring points. |
| Array | List of profile details of the transferring customer. |
-- firstName | String | First name of the transferring customer. |
-- lastName | String | Last name of the transferring customer. |
-- identifiers | Array | List of identifiers for the transferring customer (e.g., email, mobile, external ID). |
-- commChannels | Array | List of communication channels (email, mobile) for the transferring customer. |
loyaltyInfo | Object | Loyalty details of the transferring customer. |
| String | Type of loyalty program. |
| Float | Total purchases made by the transferring customer. |
transferTo | Object | Details of the customer receiving the points. |
| Long | Unique identifier of the customer receiving points. |
| Array | List of profile details of the receiving customer. |
-- firstName | String | First name of the receiving customer. |
-- lastName | String | Last name of the receiving customer. |
-- identifiers | Array | List of identifiers for the receiving customer (e.g., email, mobile, external ID). |
-- commChannels | Array | List of communication channels (email, mobile) for the receiving customer. |
| Object | Loyalty details of the receiving customer. |
-- loyaltyType | String | Type of loyalty program. |
-- lifetimePurchases | Float | Total purchases made by the receiving customer. |
transferrable | Boolean | Indicates if the points transfer is possible. |
warnings | Array | List of warnings, if any. |
errors | Array | List of errors, if any. |
API specific error codes
Error code | Description | Reason |
---|---|---|
885 | Invalid program id passed | The program id provided is invalid or unsupported. |
8013 | Invalid identifier passed | The costumer id was invalid or unsupported |
8015 | Costumer not found for the given identifiers | Customer id provided is invalid or not found. |
3316 | Group redemption action executed for non-group redemption payload. | Group redemption action is unsupported for non-group redemption payload. |