User Center Notifications Sample Use Cases
Notifications API is a flexible tool which may cater for an endless range of use cases. In this section we would like to share with you some common examples of how it can be used in practice.
Below are some use cases that demonstrate the practical applications of user center notifications.
Use Case 1: New Card Activation Notification
This use case involves sending a notification to inform users that their new card is ready for use, ensuring they are aware of their card's availability and can start using it promptly.
When a merchant user receives a new card, you can send a User Center notification via our API to notify the user.
To perform this step you will need to include into the notification body payload the following:
merchantId - it will identify the required Merchant
userIds - it will identify the list of all intended users for this notification
targetScreen - in this case it will be CARD_DETAILS, so that a merchant user will be directed by your notification to the screen of a particular card
cardId - it will identify the exact card we want a merchant user to see in our notification
Your notification payload may then look like this:
{
"externalId":"6694d6fb0e6e8132f348ab15_yourID",
"data":{
"targetScreen":"CARD_DETAILS"
"objectIds": {
"cardId": "51283672-9812-9719-2718--00768568868"
}
},
"titleI18n":{
"es":"Su nueva tarjeta está lista!",
"en":"Your new card is ready!"
},
"messageI18n":{
"es":"Ya puede empezar a utilizarlo",
"en":"You can start using it now" },
"externalType":"NEW_CARD_yourExternalType",
"receivers":\[
{
"merchantId":"5e3befdfac8b8e96a4f0972e",
"userIds":[
"5e3befdfac8b8e96a4f0972g",
"5e3befdfac8b8e96a4f0972h"
]
}
]
}
The merchant user receives the notification in their notification center on both the SME web platform and SME app.
Upon clicking on the notification, the user is redirected to the cards screen where they see their new card details and can start using it.
Use Case 2: Error Notification during KYC Process
During the Know Your Customer (KYC) process, if an error occurs or an issue arises, you can send a user center notification to inform the merchant user about the problem.
To perform this step you will need to include into the notification body payload the following:
merchantId - it will identify the required Merchant
userIds - it will identify the list of all intended users for this notification
targetScreen - in this case it will be KYC, so that a merchant user will be directed by your notification to the screen of a particular KYC flow (in most cases to its part where the user has stopped their KYC process)
complianceProvider - you will have to identify the compliance provider
Your notification payload may then look like this:
{
"externalId": "6694d6fb0e6e8132f348ab15",
"data": {
"targetScreen": "KYC",
"objectIds": {
"complianceProvider": "YOUR_COMPLIANCE_PROVIDER"
}
},
"titleI18n": {
"es": "Por favor, complete su proceso KYC",
"en": "Please complete your KYC process"
},
"messageI18n": {
"es": "Vaya a su perfil KYC",
"en": "Go to your KYC profile"
},
"externalType": "KYC",
"receivers": \[
{
"merchantId": "66be16738ae809616ccce90e",
"userIds": [
"66be16738ae809616ccce90f"
]
}
]
}
The notification is received in the merchant user's notification center on the SME web platform and SME app.
After clicking on the notification, the user is directed to the specific screen within the KYC process to rectify the issue and proceed with their application.
Use Case 3 - Director Profile Completion Notification for a Custom Onboarding Workflow
In a custom onboarding workflow app, when the director profile needs to be completed, you can send a User Center Notification to the relevant merchant user.
To perform this step you will need to include into the notification body payload the following:
merchantId - it will identify the required Merchant
userIds - it will identify the list of all intended users for this notification
targetScreen - in this case it will be WORKFLOWS_APP, so that a merchant user will be directed by your notification to a particular custom workflow app
marketplaceKey - you will have to identify the required app by adding this key. Marketplace key can be found on the app’s details page (Slug URL) in the Configuration platform or copied from the app’s url, when the app is installed for your Customer.
extraUrl - it will allow you to direct a user to a particular page within your workflow app. You can get it by opening the required page of your installed workflow app and copying a navigation part of the url (/your-slug-url#/your-extra-url )
Your notification payload may then look like this:
{
"externalId": "6694d6fb0e6e8132f348ab15",
"data": {
"targetScreen": "WORKFLOWS_APP",
"extraUrl":"your-extra-url",
"objectIds": {
"marketplaceKey": "your-slug-url"
}
},
"titleI18n": {
"es": "Complete el perfil del director de la empresa",
"en": "Please complete the company director profile"
},
"messageI18n": {
"es": "Abrir la página del perfil del director",
"en": "Open the director profile page" },
"externalType": "ONBOARDING",
"receivers": \[
{
"merchantId": "647055b9dcf0456bd28b67c1",
"userIds": [
"6470566ddcf0456bd28b67ce"
]
}
]
}
The merchant user receives the notification in their notification center on both the SME web platform and SME app.
Upon clicking on the notification, the merchant user is redirected to the specific director profile page within the custom onboarding workflow app.