Collection Service

v2 configuration details

Overview

The Collection service is to serve as a revenue collection platform for all the billing systems through cash, cheque, dd, swipe machine. It enables payment for all services provided by the eGov platform at a single point for the Citizen and counter collection in municipal alike.

Pre-requisites

Prior Knowledge of Java/J2EE
Prior Knowledge of SpringBoot
Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON, etc
Prior Knowledge of Kafka and related concepts like Producer, Consumer, Topic, etc.
Following services should be up and running:
- egov-localization
- egov-mdms
- egov-idgen
- egov-url-shortening
- billing-service

Key Functionalities

Allows citizens to create a payment.
Allows employees to create the payment for the citizen indirectly.
provides facilities to capture partial and advanced payment based on configs.
allows payment cancellation to help with scenarios of bad checks and other failed payment scenarios.
Integrates with billing-service for demand back-update of payment.

Deployment Details

deploy the latest version of the collection-services docker build.

Configuration Details

The MDMS data configuration uses the same data updated by Billing-Service

Billing Service | Configuration-Details: Refer MDMS data config from here.

Following are the properties in the application.properties

Property

Value

Remarks

collection.receipts.search.paginate

true/false

By setting this property true, show you the search result of receipt in a bucket(page) which contains a certain number of records.

is.payment.search.uri.modulename.mandatory=true

TRUE/FALSE

Make module name in URI path mandatory

collection.receipts.search.default.size

Certain number (say 30)

Give the 30 records at a time and next 30 results are in the next page.

collection.is.user.create.enabled

true/false

By setting this property true, enabling the creation of user with receipt creation

receiptnumber.idname

receipt.id - Registered at Namecheap.com

This property is used for creation of receipt number using ID-GEN service

receiptnumber.servicebased

true/false

If servicebased is set to false, use default state level format for the format of receipt number and if it is set to true the format for the receipt number has to be mentioned in MDMS

receiptnumber.state.level.format

[cy:MM]/[fy:yyyy-yy]/[SEQ_COLL_RCPT_NUM]

Default state level format for the receipt number.

collection.payments.search.paginate

true/false

By setting this property true, show you the search result of payment records in a bucket(page) which contains a certain number of records.

``kafka.topics.payment.create.name``

egov.collection.payment-create

The kafka topic on which the record has to push/pull when payment is created.

``kafka.topics.payment.cancel.name``

egov.collection.payment-cancel

The kafka topic on which the record has to push/pull when payment is cancelled.

kafka.topics.payment.update.name``

egov.collection.payment-update

The kafka topic on which the record has to push/pull when payment is updated.

Integration

Integration Scope

Collection service can be integrated with any organization or system that wants a payment system to keep track of its payments. Organizations can customize part of the application or its functionality based on their requirements.

Integration Benefits

Easy payments and tracking of payments.
Configurable functionalities according to client requirement

Steps to Integration

Customer can create a payment using the /payments/_create
Actors on the system can keep track of payments using /payments/_searchendpoint
Once the payment is done but it encounters a technical issue outside of the system then it can be cancelled with /payments/_workflow
For employees to access the payments API the respective module name should be appended after the payment API path - /payments/PT/_workflow - here PT refers to property module.