BBPS BillCollect

Notifications

API Playground
Outgoing event alerts sent by Setu to partners.

Currently, there is one event—BILL_SETTLEMENT_STATUS, which triggers a notification as explained below.


Bill settlement status

Bill settled

A SETTLEMENT_SUCCESSFUL notification is sent to the biller after successful settlement from Setu to the biller. This depends on the settlement frequency agreed upon between Setu and the biller.

// Sample JSON structure
{
    "partnerDetails": {
        "appID"             : "string",
        "productInstanceID" : "string"
    },
    "events": [
        {
            "id"        : "f3b41c8f-72fc-485d-b39a-cf497787a039",
            "type"      : "BILL_SETTLEMENT_STATUS",
            "timeStamp" : 1594293083984,
            "data"      : {
                "amountSettled"     : {
                    "currencyCode" : "INR",
                    "value"        : 108400 // in paise
                },
                "platformBillIds"   : ["platformBillId1", "platformBillId2"], // list of strings  
                "status"            : "SETTLEMENT_SUCCESSFUL",
                "transactionId"     : "1074362738220"
            }
        }
    ]
}

As next steps, you can either start your internal reconciliation process or consume our Report APIs ↗ to get detailed settlement reports.

On this page