1.7.1 Below are different Use cases with sample request

This topic provides information on Below are different Use cases with sample request.

Type 1: EXTERNAL OFFER

Request Body:

{    "messageList": [       {            "message": "Grab the latest mobile
        phones at lower rates. Click here to grab this offer. #redirectUrl/index.html?homeComponent=claim-bank-offer&homeModule=claim-bank-offer&offerId=#offerid,            "paramsMap": {                "url": "https://www.amazon.in/mobile-phones/b/?ie=UTF8&node=1389401031&ref_=nav_cs_mobiles"            },            "destinationType":
        "EMAIL",            "external": "Y"        }    ],    "partyId": "003910",    "totalClaims": 3,    "channel": "OBDX",    "notificationId":"Specially for privileged
        customers",    "expiryDate":"2023-11-30",    "mandatory":"Y"}

Type 2 : INTERNAL OFFER

  • Banks can configure the OBDX application page where user will be redirected. Out of the box implementation is provided for open a new Term deposit, the link will navigate the suer to the bank’s OBDX application’s term deposit page. The link in the offer can contain productid, amount and tenure. ProductID is compulsory other two are optional.
  • ProductName is the actual product ID to be pre-filled. In case of Open TD, it will from the list if the existing products available to users on new TD page
  • Depending on what we want to pre-fill the “params” inside paramsMap key will differ
  • Different options for sending Params for TD open: Replace the values for productName, initialDepositAmount and tenure. Rest all should remain same
    Only ProductId –
    "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",\"class\":\"flow\",
\"isFlow\":true,\"name\":\"td-open\",\"data\":{\"productName\":\"FDFLOT\"}}"
    ProductId and amount
    "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",\"class\":\"flow\",\"isFlow\":true,
\"name\":\"td-open\",\"data\":{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":1000,\"currency\":\"EUR\"}}}"

    ProductId, amount and tenure.

    For tenure set value to day, month, year or set 0 like below E.g. This is for 7 years so year is set to 7 but month and day to be set as 0
    "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",\"class\":\"flow\",\"isFlow\":true,\"name\":
\"td-open\",\"data\":{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":1000,\"currency\":\"EUR\"},\"tenure\":{\"year\":7,\
"month\":0,\"day\":0}}}"

Request Body:

DESTINATION CHANEL: E-mail

SERVICING CHANNEL: OBDX Application

Offer Type : Internal Open TD
{    "messageList": [        {            "message": "Introducing Save Plus: Investment where you can earn up to 9% p.a. Available only for a
        few exclusive customers of Futura Bank. \n Benefits. Earn up to 9% p.a. returns Withdraw
        anytime with zero penalty. This is a Limited Access feature. Only a few days left to avail.
        <br/><br/> <img src=\"/image001.png\" <br/><br/> <A href= #redirectUrl/index.html?homeComponent=claim-bank-offer&homeModule=claim-bank-offer&offerId=#offerid> Click here to
        grab this offer.</A>",            "paramsMap": {                "url": "#offerUrl",                "params": "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",\"class\":\"flow\",\"isFlow\":true,\"name\":\"td-open\",\"data\":{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":2000,\"currency\":\"GBP\"},\"tenure\":{\"year\":0,\"month\":0,\"day\":365}}}"            },            "destinationType": "EMAIL",            "external": "N"        }],    "userId": "RogerBohr",    "totalClaims": 2,    "channel": "OBDX",    "notificationId": "Special TD Offer",    "expiryDate": "2024-3-20",    "mandatory": "Y"}

DESTINATION CHANEL: PUSH (Mobile)

SERVICING CHANNEL: WHATSAPP/OBDX chatbot

Offer Type : Internal Open TD

  • Handled only on device. The user should have allowed the push notifications permission message delivery from his device during login. The user should set have the delivery mode set to Push in application settings.
    Request Body:
    {   
 "messageList": 
[        
{            
"message": "Introducing Save Plus: Investment where you can earn upto 9% p.a. Available only for a few exclusive customers of Futura Bank. 
\n Benefits. Earn up to 9% p.a. returns Withdraw anytime with zero penalty. This is a Limited Access feature. Only a few days left to avail.",
"paramsMap": {},            
"destinationType": "PUSH_NOTIFICATION", "text": "Open TD {#offerid}","image": "https://qph.cf2.quoracdn.net/main-qimg-e2cd185dc8d2411f2e054bf89344995d"        
}    
],    
"userId": "RogerBohr","totalClaims": 2,"channel": "ODA","notificationId": "Special TD Offer","expiryDate": "2024-3-20", "mandatory": "Y"
}

DESTINATION CHANEL: PUSH (Mobile)

SERVICING CHANNEL : OBDX Application

Offer Type : Internal Open TD

  • Handled only on device. The user should have allowed the push notifications permission from his device during login. The user should set have the delivery mode set to Push in application settings.
    Request Body:
    {    
"messageList": 
[        
{            
"message": "Introducing Save Plus: Investment where you can earn upto 9% p.a. Available only for a few exclusive customers of Futura Bank. 
\n Benefits. Earn up to 9% p.a. returns Withdraw anytime with zero penalty. This is a Limited Access feature. 
Only a few days left to avail.", "paramsMap": 
{               
 "url": "#offerUrl", "params": "{\"templateType\":\"accounts\",\"templateTab\":\"TRD\",\"templateMode\":\"TRANSACTION\",\"type\":\"TEMPLATE\",
\"class\":\"flow\",\"isFlow\":true,\"name\":\"td-open\",\"data\":{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":2000,
\"currency\":\"GBP\"},\"tenure\":{\"year\":0,\"month\":0,\"day\":365
}
}
}"            
},           
 "destinationType": "PUSH_NOTIFICATION", "text": "Open TD 
{
#offerid}", "image": "https://qph.cf2.quoracdn.net/main-qimg-e2cd185dc8d2411f2e054bf89344995d"        
}   
 ],    
"userId": "RogerBohr","totalClaims": 2, "channel": "OBDX", "notificationId": "Special TD Offer","expiryDate": "2024-3-20","mandatory": "Y"
    }

DESTINATION CHANEL: WHATSAPP

SERVICING CHANNEL : WHATSAPP/ODA

Offer Type: Internal Open Td

Request Body for sending image and button
{   
          "messageList": [       
          {            
"message": " Experience a world of adventures with Term deposit
          offer #offerid", "paramsMap":
{         
 "tdProduct": "FDFLOT "tenure": "365","tdAmount": "1000 EUR"}, "destinationType": "WHATSAPP","image": "https://www.oracle.com/a/ocom/img/rc66-fs-risktech100.jpg",            
"document": "",  "video": "",  "buttons": ["Book FD {#offerid}"]          
        }    
          ],   
          "partyId": "003910",   
          "totalClaims": 3,   
          "channel": "ODA",   
          "notificationId":"Special offer for bank customers",   
          "expiryDate":"2023-11-30",   
          "mandatory":"Y"
}

PARAMETERS:

Message: This text will be visible in the WhatsApp message

Buttons: Button text. (it will have the offer ID param). This is required to send request to ODA to proceed with term deposit action.

destination Type: WHATSAPP

image: image link. To be shown in WhatsApp message

video/document – link to video and document. It will be displayed ion WhatsApp message

Channel – Not used, so no need to send

External- not used, so no need to send

Request Body for sending image and button
{    
"messageList":
        [        
{            
"message": "8% TD Book Now", "paramsMap":
{         
 "tdProduct": "FDFLOT",  "tenure": "365", "tdAmount": "1000 EUR"}, "destinationType": "WHATSAPP", "image": "", 
"document": "https://docs.oracle.com/cd/F72987_01/um_docs/UserManual Oracle Banking Digital Experience iMessage Payments.pdf","video": "","buttons": 
[   
"Book FD {#offerid}"    
]    
}   
 ],        
 "partyId": "003910",   
          "totalClaims": 12,        
          "channel": "ODA",        
          "expiryDate": "2023-11-30","mandatory": "Y"
}

Note:

The offers delivered on PUSH can be served by Chatbot or WhatsApp if serving channel is ODA. For that below is the configuration in the application:

App config to be set in IOS and Android application

  1. Push notification should be configured as per IOS and Android application user manual
  2. Open application and set these in app.plist(IOS) and property file in Android)
  3. whatsAppToBeChecked YES/NO: YES then the app will first check if WhatsApp is installed then above request will be served by WhatsApp based on correct bank WhatsApp business number.
  4. whatsAppNumber: Bank’s WhatsApp business number
  5. If whatsAppToBeChecked is NO, the push message will be served in ODA chat window.

OFFERS INSIGHTS WIDGET

Request body :
 {    
"messageList":
        [   
            {   
                "message": "Term Deposit",   
                "text":"TD detail",   
                "paramsMap":
        {   
                },   
                "destinationType": "INSIGHT",   
                "buttons":
        [
"TD-OPEN~td-open","TD-DETAILS~td-details"], "links":
        [
"LINK-TD-OPEN~td-open","LINK-TD-DETAILS~td-details"
],   
                "category":"INFO",   
                "external": "N"   
            }   
 ],    
"partyId": "003910", "totalClaims": 2, "channel": "ODA","expiryDate":"2023-11-30"
}
Request body with data field in Button action: 
{    
"messageList":
        [        
{            
"message": "Term Deposit 25",  "text":"TD detail", "paramsMap":     
{           
 },            
"destinationType": "INSIGHT","buttons":
        [
"TD-OPEN~td-open#{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":1000,\"currency\":\"EUR\"},\"tenure\":{\"year\":7,\"month\":0,\"day\":0}}","TD-DETAILS~td-details"],           
 "links":      
["LINK-TD-OPEN~td-open","LINK-TD-DETAILS~td-details"], "category":"INFO","external": "N"        
}    
],        
 "partyId": "003910", "totalClaims": 2,  "channel": "OBDX", "expiryDate":"2023-11-30"
}

Notification received at OBDX side:

Sample value of map notificationDTO.getValues()
{PARTY_ID=003910,TARGET_UNIT=OBDX_BU, CATEGORY=INFO, ENTERPRISE_ROLE_ID=retailuser, MAINLINE=Term Deposit, SECLINE=TD detail,  
BUTTON1=TD-OPEN,BUTTON1_ACTION=td-open#{\"productName\":\"FDFLOT\",\"initialDepositAmount\":{\"amount\":1000,\"currency\":\"EUR\"
},
\"tenure\":{\"year\":7,\"month\":0,\"day\":0
}}, 
BUTTON2=TD-DETAILS, BUTTON2_ACTION=td-details, LINK1=LINK-TD-OPEN, LINK1_ACTION=td-open, LINK2=LINK-TD-DETAILS,LINK2_ACTION=td-details,}

Points to Remember

  1. Mandatory insight fields in request are,
    1. messageList
    2. message
    3. category
    4. atleast one button alongwith action e.g. "buttons": ["TD-OPEN~td-open"]
    5. partyId
  2. In /insights call response, anything after # in Button_Action will be treated as data of that button.

    Figure 1-1 Sample Term Deposit Flow on WhatsApp Banking


    a


    a


    Description of Figure 1-1 follows
    Description of "Figure 1-1 Sample Term Deposit Flow on WhatsApp Banking"

Parent topic: Parameters supported by API