New releases/enhancements

New User Groups to automatically associate with the default loyalty program

Problem Statement

When a group is created using the API POST /v2/userGroup2/, the group gets added to the loyalty program only when a transaction is made by any group member on behalf of the group. So, when a customer facing app/microsite is fetching group details, loyalty data like group slab, points etc. are shown as null instead of the right data. 

Solution

With this release, user groups are automatically added to the default loyalty program at the time of group creation. All the loyalty details like group slab, and points are shown with the right values.


Send SMS to customers from OU specific Sender IDs (API)

Problem Statement

OU enabled brands want to send SMS to customers from the Sender IDs configured for the respective OU. The API /v1.1/communications/sms did not have provision to choose the sender ID, instead all SMS are sent using the default sender ID of the org.  

Solution

Enhancement in v1.1/communications/sms API to include sender ID (sender) from which you want to send SMS. 

  • If no sender ID is passed, the default sender ID of the org will be used. 
  • If an invalid sender ID (sender ID not configured in the org) is passed, the default sender ID of the org will be used. 

Note

  • SMS can be sent with only the sender IDs configured for the org. 
  • To add/view Sender IDs configured for the org and OUs go to Organization Settings > Communication & Gateway > Domains in InTouch.
  • If you pass the sender ID that is not configured in the org, the default sender ID of the org will be used instead.

Card support in Goodwill Points Issual (Member Care)

Problem Statement

In Member Care, Customer Search in Goodwill Points Issual supports mobile, email, external id, name to identify a customer and issue points. But for Card linked loyalty programs, customers need to be identified by their card details and the points need to be issued in the program the card is linked to.   

Solution

Card number and Card External Id support is added to identify a customer. Based on the card details entered, the linked loyalty program is automatically selected in the Program ID field. You can still choose to select a different program other than the one linked with the card. 

For details, see here.

Note 
  • Card here acts only as a customer identifier and to identify the card linked program. Cards with inactive statuses like expired and blocked can also be used to issue goodwill points. If only active cards need to be used to issue goodwill points, please check the card status before issuing the points.

Enhancements to the Send email API to support image attachments 

Problem Statement

No support was present to send images as email attachments via API. Users encode the image in base64 format but the image is not getting uploaded in the right format and the user receiving the email is not able to view the correct image and download it. 

Solution 

A new field “file_encoding_type” is added in `/v1.1/communications/email`  and fileEncodingType in `/v2/communications/email`.  

For all image formats like jpg, png, jpeg, and gif this field’s value needs to be set to “base64”. Image should be base64 encoded and the code to be passed in “file_data”. Only if the “file_encoding_type” is base64, images will get uploaded in the right format.  

For details, see v2/communications/email and /v1.1/communications/email.

Note 

  • For other file types which aren’t base64 encoded like txt, and pdf, file encoding type is not required.

API Support to fetch group transactions

Use Case

In customer facing applications, all the group level transactions made by the group members can be shown. Loyalty details like points issued against each transaction, their expiry details can also be viewed. This is highly useful for both B2B group accounts and B2C user groups to fetch the transaction history of the group and the loyalty details for each transaction.  

For details about the API, see GET userGroup2/transactions

Note :

Only the transactions made by group members as part of the group can be fetched. Individual transactions made by the group members are not available in this API.

Card Support in Goodwill Points Issual from Member Care 

Problem Statement

When you want to issue Goodwill points to a customer, you need to search for the customers using mobile number, email id, external id or name. However, for a card linked loyalty program, you need to search a customer using their card details and then issue points from the program that is linked to the card. 

Solution

Now, you can use card number and card external ID to identify a customer. If you enter card details, the linked loyalty program will be selected automatically in the Program ID field. You can also select a different program.

Note:
  • You can use card details to identify customers and the associated loyalty program. You do not need to select the program manually. 
  • You can use cards with any status (active, expired or blocked) to issue points. Hence, before issuing points, check the status of the card.


OAuth2 Sign-in for Customer Apps

Brands want to allow their customers to access their information/ perform certain actions with the brand from 3rd party partner applications. The customer should be able to access their data with the brand from a brand’s application or an external partner’s application.  

For Example, A customer visiting a partner app of the brand can authenticate themselves and fetch their data with the brand like available points, expiry details or perform actions like redeeming available points, transferring points, etc. 

So, an external app has to access the brand’s customer data from Capillary on behalf of the brand.

Use Cases

  • Brands can integrate with external partners like car manufacturers and embed their apps in their tablets within the car. In the tablet, the customer can fetch their data from the brand and perform certain actions on it.
  • Brands can integrate with partner apps like Paytm where the customers can register into their loyalty program, link loyalty cards to their wallets, pay for a transaction and view the available points, etc via the partner app.
  • This can be applicable to any customer-facing application through which the end customer of a brand can access their data

Solution

Customer Apps can now use OAuth2 Authorization Code flow to get access to customers’ data from Capillary on behalf of the brand. This helps in enhanced security via a standard auth flow.



  1. Partner app initiates by redirecting users to Capillary landing page along with the client key.
  2. Customers are authenticated via OTP on Capillary landing page by communicating with Auth Engine APIs.
  3. Upon Authentication, the landing page will redirect back to a pre configured URL along with an auth code generated by Auth Engine.

  1. Partner app will authenticate the auth code by sending client key and secret and receives the access token and refresh token. The access token is limited to the user whose data is being accessed.
  2. The access token can be used to make calls to the wrapper APIs and can access data limited to the user who is accessing their information. The access token expires after a pre-configured duration and the partner app can refresh the token and obtain a new access token. The partner app can also invalidate these tokens if required. 
To get OAuth2 enabled for your brand, contact your CSM or create a ticket with complete details.

Future Scope

UI will be provided where brands can create/view/update access scopes, clients, generate client credentials, set up client configurations and OTP configurations.