Overview

DIGIT is India's largest open-source platform for Urban Governance. It provides API-based access to governance functions enabling Urban Local Bodies (ULBs) to provide citizen facilities via integration with relevant service players.

Purpose

This document aims to provide information on how to integrate third-party(BBPS) Billing and Collection services with the DIGIT governance platform. It enables system integrators to get the system to create and update bills, record payments, and generate receipts for the amount paid. However, this document does not include information about any third-party system, DIGIT configuration outside the stated scope, installation, or deployment of either the third-party software or DIGIT.

Intended Audience

System Integrators (SI)

Prerequisites

• Knowledge of REST API usage

• Knowledge of JSON

Steps to Integration

1. User - Create a new user with type as SYSTEM for 3rd Party system. The user’s login and its generated token should be bound to a specific set of whitelisted IPs.

2. Bill - The 3rd party should call fetchBill from the server-side to fetch the bill details.

3. Transaction - The 3rd party service will call transaction/_create to initiate a transaction before accepting the payments from the customer.

   After payment completion transaction/_update will be called to mark success or failure of the transaction. The transaction/_update should only be allowed to the user who created the transaction. Transactions once marked successful/failed should not be allowed to be updated. 

   On successful transaction, the receipt should be created automatically with a receiptdate as the transaction create date. In cases when bills are only valid for a day, these bills should be handled for transaction success delays.

API List