For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
This API allows you to initiate a points redemption request.
A JSON Web Token (JWT) is used for intouch user authentication. CanMakeRequest access is required to generate this token.
Request body parameters
Parameter (Parameters marked * are mandatory)
Type
Description
entityInfo*
Object
Information about the entity (till, store, zone, concept)
- tillId
String
The unique identifier for the till associated with the transaction.
- storeId
String
The unique identifier for the store where the transaction occurs.
- zoneId
String
The unique identifier for the zone or area the store is associated with.
- conceptId
String
The unique identifier for the concept or branding associated with the store.
payload
Object
The payload provides a comprehensive understanding of the information included in the Intouch API payload for points redemption. It contains all the necessary data to facilitate a successful points redemption transaction.
- IntouchAPITask-Payload
Object
Information about the Intouch API task
- hostname*
String
Hostname for the API endpoint. Example - <https://eucrm-new.cc.capillarytech.com>
- path*
String
/v1.1/points/redeem. This is the endpoint for the points redemption API.
- method*
String
POST. The HTTP method used for the request
\pathParams
Object
This field is reserved for any dynamic parameters that may be included in the API endpoint URL Note: In this workflow, pathParams may not be utilized, as the necessary information is typically provided in the request body.
\queryParams*
Object
Additional parameters that can be appended to the API request URL for further customization. For the points redemption, this may include options like skipping validation and setting the response format from intouch API. "queryParams": { "skip_validation": "true", "format": "json"}
\body*
Object
The body section contains the essential data for the points redemption. Refer to Redeem points API documentation for information on the body parameters.
points_redeemed*
String
Indicates the number of points being redeemed by the customer. This should be less than the total available points.
customer*
Object
Contains information about the customer initiating the redemption. For example, the mobile number of the customer.
redemption_time
String
Specifies the date and time of the redemption.
transaction_number
String
Provides a unique identifier for the transaction associated with the redemption.
notes
String
Allows for a brief note or reason to be provided for the redemption
external_reference_number
String
Represents an external reference number associated with the redemption. This can be a reference from an external system or process.
\headers*
Object
Headers provide additional context and information about the request.
- Authorization
String
Contains the authentication credentials needed to access the Intouch API.
- content-type
String
The content type of the request (application/JSON in this case). This field specifies that the payload is in JSON format, ensuring that the data is properly interpreted by the API.
