v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Check Points Transfer Eligibility

Checks if specific points of a customer can be transferred to another customer.

post/points/isTransferable

Request body

programIdinteger

Program ID from which points has to be transferred. Applicable for multi-program orgs.

groupProgramTransferboolean

Pass true to check group points transfer details.

notesstring

Information to store for the current transfer activity.

pointsTobeTransferredinteger required

Number of points to be transferred.

issueOtpboolean

When set to true- It sends an OTP to the sender (fromCustomer) when points are transferable. This OTP can be used to authenticate the transfer. When set to false: No OTP will be generated or sent. The points transfer can still proceed without OTP verification. OTP is not mandatory for points transfer. It can be used for security purposes.

Response

200

Example response

{
  "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
              },
              "modifiedBy": {
                "id": 75155295,
                "code": "sant.p_123",
                "name": "sant.p_123",
                "type": "TILL",
                "referenceId": -1
              },
              "modifiedDate": "2025-02-28T03:59:49Z"
            },
            "identifiers": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com"
              }
            ],
            "commChannels": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com",
                "primary": true
              }
            ],
            "source": "INSTORE",
            "userId": 564955097,
            "autoUpdateTime": "2025-03-25T10:04:40Z",
            "identifiersAll": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com"
              }
            ]
          }
        ],
        "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
            },
            "modifiedBy": {
              "id": 75155295,
              "code": "sant.p_123",
              "name": "sant.p_123",
              "type": "TILL",
              "referenceId": -1
            },
            "modifiedDate": "2025-02-28T03:59:49Z"
          },
          "lifetimePurchases": 12000
        }
      },
      "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
              },
              "modifiedBy": {
                "id": 75155295,
                "code": "sant.p_123",
                "name": "sant.p_123",
                "type": "TILL",
                "referenceId": -1
              },
              "modifiedDate": "2025-03-20T12:03:55Z"
            },
            "identifiers": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com"
              }
            ],
            "commChannels": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com",
                "primary": true
              }
            ],
            "source": "INSTORE",
            "userId": 564955098,
            "autoUpdateTime": "2025-03-25T10:04:40Z",
            "identifiersAll": [
              {
                "type": "email",
                "value": "tom.sawyer@capillarytech.com"
              }
            ]
          }
        ],
        "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
            },
            "modifiedBy": {
              "id": 75155295,
              "code": "sant.p_123",
              "name": "sant.p_123",
              "type": "TILL",
              "referenceId": -1
            },
            "modifiedDate": "2025-03-20T12:03:55Z"
          },
          "lifetimePurchases": 1000
        }
      },
      "transferrable": true
    }
  ]
}