> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/local-governance/v2.7/platform/configure-digit/services-overview/core-services/payment-gateway-services.md).

# Payment Gateway Service

## Overview

eGov Payment Gateway acts as a liaison between eGov apps and external payment gateways facilitating payments, reconciliation of payments and lookup of transactions status.

## Pre-requisites <a href="#pre-requisites" id="pre-requisites"></a>

Before you proceed with the documentation, make sure the following pre-requisites are met -

* *Java 8*
* Kafka server is up and running
* egov-persister service is running and has pg service persister config path added in it
* PSQL server is running and the database is created to store transaction data.

## Key Functionalities <a href="#key-functionalities" id="key-functionalities"></a>

* Create or initiate a transaction, to make a payment against a bill.
* Make payment for multiple bill details \[multi module] for a single consumer code at once.
* Transactions are initiated with a call to the transaction/\_create API - various validations are carried out to ensure the sanctity of the request.
* The response includes a generated transaction id and a redirect URL to the payment gateway itself.
* Various validations are carried out to verify the authenticity of the request and the status is updated accordingly. If the transaction is successful, a receipt is generated for the same.

#### Payment Flow <a href="#payment-flow" id="payment-flow"></a>

![](/files/-MKK08PrObcbJL-4TsD0)

![](/files/-MKK08PsT92-lQ_h-uYX)

#### Reconciliation <a href="#reconciliation" id="reconciliation"></a>

* Reconciliation is carried out by two jobs scheduled via a Quartz clustered scheduler.
* The early reconciliation job is set to run every 15 minutes \[configurable via app properties] and aims at reconciling transactions created 15 - 30 minutes ago and are in a PENDING state.
* The daily reconciliation job is set to run once every day and aims at reconciling all transactions that are in the PENDING state, except for the ones created 30 minutes ago.

#### Extensions <a href="#extensions" id="extensions"></a>

* Axis, Phonepe and Paytm payment gateways are implemented.
* Additional gateways can be added by implementing the [Gateway](https://raw.githubusercontent.com/egovernments/egov-services/master/core/egov-pg-service/src/main/java/org/egov/pg/service/Gateway.java) interface. No changes are required to the core packages.

## Configuration Details

The following properties in the application.properties file in egov-pg-service have to be added and set to default value after integrating with the new payment gateway. In the below table properties for AXIS bank, payment gateway is shown the same relevant property needs to be added for other payment gateways.

| Property                         | Remarks                                                  |
| -------------------------------- | -------------------------------------------------------- |
| axis.active                      | Bollean lag to set the payment gateway active/inactive   |
| axis.currency                    | Currency representation for merchant, default(INR)       |
| axis.merchant.id                 | Payment merchant Id                                      |
| axis.merchant.secret.key         | Secret key for payment merchant                          |
| axis.merchant.user               | User name to access the payment merchant for transaction |
| axis.merchant.pwd                | Password of the user tp access payment merchant          |
| axis.merchant.access.code        | Access code                                              |
| axis.merchant.vpc.command.pay    | Pay command                                              |
| axis.merchant.vpc.command.status | commans status                                           |
| axis.url.debit                   | Url for making payment                                   |
| axis.url.status                  | URL to get the status of the transaction                 |

## Deployment Details <a href="#deployment-details" id="deployment-details"></a>

1. Deploy the latest version of egov-pg-service
2. Add pg service persister yaml path in persister configuration

## Integration Details <a href="#integration" id="integration"></a>

### Integration Scope <a href="#integration-scope" id="integration-scope"></a>

The egov-pg-service acts as communication/contact between eGov apps and external payment gateways.

### Integration Benefits <a href="#integration-benefits" id="integration-benefits"></a>

* Record of every transaction against a bill.
* Record of payment for multiple bill details for a single consumer code at once.

### Steps to Integration <a href="#steps-to-integration" id="steps-to-integration"></a>

1. To integrate, host of egov-pg-service should be overwritten in helm chart
2. /pg-service/transaction/v1/\_create should be added in the module to initiate a new payment transaction, on successful validation
3. /pg-service/transaction/v1/\_update should be added as the update endpoint to updates an existing payment transaction. This endpoint is issued only by payment gateways to update the status of payments. It verifies the authenticity of the request with the payment gateway and forwards all query params received from a payment gateway
4. */pg-service/transaction/v1/\_search* should be added as the search endpoint for retrieving the current status of a payment in our system.

## Reference Docs

### Doc Links <a href="#doc-links" id="doc-links"></a>

| Title                | Link                                                                                                                                             |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Swagger API Contract | <https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/core/egov-pg-service/egov-pg-service.yml#!/> |

### API List <a href="#api-list" id="api-list"></a>

| Title                               | Link                                                          |
| ----------------------------------- | ------------------------------------------------------------- |
| /pg-service/transaction/v1/\_create | <https://www.getpostman.com/collections/a0dfce4274235164c520> |
| /pg-service/transaction/v1/\_update | <https://www.getpostman.com/collections/a0dfce4274235164c520> |
| /pg-service/transaction/v1/\_search | <https://www.getpostman.com/collections/a0dfce4274235164c520> |
| /pg-service/gateway/v1/\_search     | <https://www.getpostman.com/collections/a0dfce4274235164c520> |

(Note: All the APIs are in the same postman collection, therefore, the same link is added in each row)

[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)All content on this page by [eGov Foundation ](https://egov.org.in/)is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/local-governance/v2.7/platform/configure-digit/services-overview/core-services/payment-gateway-services.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.