Check if Points Transferable

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

📘

Note

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

👍

Note

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.](https://docs.capillarytech.com/reference/make-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 Parameters

ParameterData TypeDescription
dataArrayContains details of the points transfer request.
pointsTobeTransferredFloatNumber of points to be transferred.
transferFromObjectDetails of the customer transferring the points.
- idLongUnique identifier of the customer transferring points.
- profilesArrayList of profile details of the transferring customer.
-- firstNameStringFirst name of the transferring customer.
-- lastNameStringLast name of the transferring customer.
-- identifiersArrayList of identifiers for the transferring customer (e.g., email, mobile, external ID).
-- commChannelsArrayList of communication channels (email, mobile) for the transferring customer.
loyaltyInfoObjectLoyalty details of the transferring customer.
- loyaltyTypeStringType of loyalty program.
- lifetimePurchasesFloatTotal purchases made by the transferring customer.
transferToObjectDetails of the customer receiving the points.
- idLongUnique identifier of the customer receiving points.
- profilesArrayList of profile details of the receiving customer.
-- firstNameStringFirst name of the receiving customer.
-- lastNameStringLast name of the receiving customer.
-- identifiersArrayList of identifiers for the receiving customer (e.g., email, mobile, external ID).
-- commChannelsArrayList of communication channels (email, mobile) for the receiving customer.
- loyaltyInfo (under transferTo)ObjectLoyalty details of the receiving customer.
-- loyaltyTypeStringType of loyalty program.
-- lifetimePurchasesFloatTotal purchases made by the receiving customer.
transferrableBooleanIndicates if the points transfer is possible.
warningsArrayList of warnings, if any.
errorsArrayList of errors, if any.

API specific error codes

Error codeDescriptionReason
885Invalid program id passedThe program id provided is invalid or unsupported.
8013Invalid identifier passedThe costumer id was invalid or unsupported
8015Costumer not found for the given identifiersCustomer id provided is invalid or not found.
3316Group redemption action executed for non-group redemption payload.Group redemption action is unsupported for non-group redemption payload.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!