Payment Gateway Service

Initiates a new payment transaction.

Initiates a new payment transaction, on successful validation, a redirect is issued to the payment gateway.

POST/egov-pg-service/transaction/v1/_create

Body

Details of the payment and RequestInfo meta data.

TransactionTransaction (object)

Details of the payment object.

tenantId*string

The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required

txnAmount*string

Transaction Amount, preferably rounded off to two decimal places

billId*string

Unique bill ID associated with the transaction

module*string

Module business code for which the transaction is being initiated, ex PT, WS, PGR etc

moduleId*string

Unique identifier in the module for which the transaction is being initiated

productInfo*string

Brief description for which the transaction is being carried out.

gateway*string

Gateway to be used, from the available list, such as PAYTM, PHONEPE.

callbackUrl*string

URL to which control has to be redirected to from the gateway

txnIdstring

Transaction ID of the payment, generated by the gateway service

userUser (object)

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuid*string

UUID for the user.

userName*string

The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.

name*string

The full name of the user.

mobileNumber*string

Mobile number of the user

emailIdstring

Email address of the user

txnStatusenum

Current status of the transaction

SUCCESSFAILUREPENDING

txnStatusMsgstring

Brief status message for the transaction

gatewayTxnIdstring

Transaction ID returned by the gateway, for reference

gatewayPaymentModestring

Mode of payment used at the gateway

gatewayStatusCodestring

Payment Gateway Specific RAW status code

gatewayStatusMsgstring

Payment Gateway Specific RAW status message

receiptstring

Receipt ID generated for this payment

Response

Payment Initiated successfully, gateway redirection triggered.

Request

Update an existing payment.

Updates an existing payment transaction, to be used only by payment gateways to update status of payments. Verifies the authenticity of the request with the payment gateway. Forward all query params received from payment gateway

POST/egov-pg-service/transaction/v1/_update

Body

Details of the payment response obtained from the payment gateway.

RequestInfoWrapper (object)

Wrapper for Request Info

Response

Payment Status transaction updated successfully

Body

Transactionarray of Transaction (object)

tenantId*string

The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required

txnAmount*string

Transaction Amount, preferably rounded off to two decimal places

billId*string

Unique bill ID associated with the transaction

module*string

Module business code for which the transaction is being initiated, ex PT, WS, PGR etc

moduleId*string

Unique identifier in the module for which the transaction is being initiated

productInfo*string

Brief description for which the transaction is being carried out.

gateway*string

Gateway to be used, from the available list, such as PAYTM, PHONEPE.

callbackUrl*string

URL to which control has to be redirected to from the gateway

txnIdstring

Transaction ID of the payment, generated by the gateway service

userUser (object)

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuid*string

UUID for the user.

userName*string

The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.

name*string

The full name of the user.

mobileNumber*string

Mobile number of the user

emailIdstring

Email address of the user

txnStatusenum

Current status of the transaction

SUCCESSFAILUREPENDING

txnStatusMsgstring

Brief status message for the transaction

gatewayTxnIdstring

Transaction ID returned by the gateway, for reference

gatewayPaymentModestring

Mode of payment used at the gateway

gatewayStatusCodestring

Payment Gateway Specific RAW status code

gatewayStatusMsgstring

Payment Gateway Specific RAW status message

receiptstring

Receipt ID generated for this payment

Request

Response

Update an existing payment.

POST/egov-pg-service/transaction/v1/_update

Body

Details of the payment response obtained from the payment gateway.

RequestInfoWrapper (object)

Wrapper for Request Info

Response

Payment Status transaction updated successfully

Body

Transactionarray of Transaction (object)

tenantId*string

The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required

txnAmount*string

Transaction Amount, preferably rounded off to two decimal places

billId*string

Unique bill ID associated with the transaction

module*string

Module business code for which the transaction is being initiated, ex PT, WS, PGR etc

moduleId*string

Unique identifier in the module for which the transaction is being initiated

productInfo*string

Brief description for which the transaction is being carried out.

gateway*string

Gateway to be used, from the available list, such as PAYTM, PHONEPE.

callbackUrl*string

URL to which control has to be redirected to from the gateway

txnIdstring

Transaction ID of the payment, generated by the gateway service

userUser (object)

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuid*string

UUID for the user.

userName*string

The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.

name*string

The full name of the user.

mobileNumber*string

Mobile number of the user

emailIdstring

Email address of the user

txnStatusenum

Current status of the transaction

SUCCESSFAILUREPENDING

txnStatusMsgstring

Brief status message for the transaction

gatewayTxnIdstring

Transaction ID returned by the gateway, for reference

gatewayPaymentModestring

Mode of payment used at the gateway

gatewayStatusCodestring

Payment Gateway Specific RAW status code

gatewayStatusMsgstring

Payment Gateway Specific RAW status message

receiptstring

Receipt ID generated for this payment

Request

Response

Initiates a new payment transaction.

Initiates a new payment transaction, on successful validation, a redirect is issued to the payment gateway.

POST/egov-pg-service/transaction/v1/_create

Body

Details of the payment and RequestInfo meta data.

TransactionTransaction (object)

Details of the payment object.

tenantId*string

The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required

txnAmount*string

Transaction Amount, preferably rounded off to two decimal places

billId*string

Unique bill ID associated with the transaction

module*string

Module business code for which the transaction is being initiated, ex PT, WS, PGR etc

moduleId*string

Unique identifier in the module for which the transaction is being initiated

productInfo*string

Brief description for which the transaction is being carried out.

gateway*string

Gateway to be used, from the available list, such as PAYTM, PHONEPE.

callbackUrl*string

URL to which control has to be redirected to from the gateway

txnIdstring

Transaction ID of the payment, generated by the gateway service

userUser (object)

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuid*string

UUID for the user.

userName*string

The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.

name*string

The full name of the user.

mobileNumber*string

Mobile number of the user

emailIdstring

Email address of the user

txnStatusenum

Current status of the transaction

SUCCESSFAILUREPENDING

txnStatusMsgstring

Brief status message for the transaction

gatewayTxnIdstring

Transaction ID returned by the gateway, for reference

gatewayPaymentModestring

Mode of payment used at the gateway

gatewayStatusCodestring

Payment Gateway Specific RAW status code

gatewayStatusMsgstring

Payment Gateway Specific RAW status message

receiptstring

Receipt ID generated for this payment

Response

Payment Initiated successfully, gateway redirection triggered.

Request

const response = await fetch('/egov-pg-service/transaction/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "Transaction": [
    {
      "tenantId": "text",
      "txnAmount": "text",
      "billId": "text",
      "module": "text",
      "moduleId": "text",
      "productInfo": "text",
      "gateway": "text",
      "callbackUrl": "text",
      "txnId": "text",
      "user": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "name": "text",
        "mobileNumber": "text",
        "emailId": "text"
      },
      "txnStatus": "SUCCESS",
      "txnStatusMsg": "text",
      "gatewayTxnId": "text",
      "gatewayPaymentMode": "text",
      "gatewayStatusCode": "text",
      "gatewayStatusMsg": "text",
      "receipt": "text"
    }
  ]
}

const response = await fetch('/egov-pg-service/transaction/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();