Try   HackMD

Setu Collect Broadcast API - Draft version

Workflow

Assumptions

  • biller and payer are already on collect network

Scenario

  • biller has a new bill to collect. They broadast the information on collect network
  • Payer sees all these notifications. They would have already integrated to this API. This is an additional event type. They will get the mobile number and the parameters to fetch the bill. If the mobile number belongs in their customer base, they can alert the user when they receive information and make the user pay. Upto them to build the right experience.

(UPI 2.0 this can happen automatically if there is a mandate.)

Biller

Biller broadcasts the presence of a bill. They send across

  1. The mobile number of the customer
  2. Customer identifier for the bill

API URL

https://sandbox.setu.co/api/utilities/broadcast

request

{ "eventType": "COLLECT_ALERT_MOBILE", "eventData": { "mobileNumber": "9XXXXXXXXXX", "customerIdentifiers": [ { "attibuteName": "loanNumber", "attributeValue": "UXADE911221" } ] } }

response

{ "success": true, "status": 200 }

Payer

Payer listens to the notification and acts on it. They receive the following information

  1. The mobile number of the bill
  2. Customer identifier for the bill
  3. Biller product instance ID

API URL

https://<partner-base-api-url>/notifications

request

{ "eventType": "COLLECT_ALERT_MOBILE", "eventData": { "mobileNumber": "9XXXXXXXXXX", "customerIdentifiers": [ { "attibuteName": "loanNumber", "attributeValue": "UXADE911221" } ], "billerProductInstanceID": "25XXXXXXXXXXXXXXX5" } }

response

{ "success": true, "status": 200 }