Payment Gateway Service

Retrieves the current status of a payment

Returns the current status of a payment in our systems; this does not guarantee live payment gateway status.

post

/transaction/v1/_search

Query parameters

txnIdstring

Transaction id generated by the service during creation.

billIdstring · varchar

Unique module based ID for which the transaction is being initiated, if billId is used, module should be included.

user_uuidstring · varchar

User ID of the user as registered in user service, for whom the transaction was carried out.

modulestring

Module name to which the billId belongs to.

moduleIdstring

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

receiptstring

Receipt ID generated for this payment

txnStatusstring

Current status of the transaction

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-pg-service/transaction/v1/_search'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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"
      },
      "txnStatusMsg": "text",
      "gatewayTxnId": "text",
      "gatewayPaymentMode": "text",
      "gatewayStatusCode": "text",
      "gatewayStatusMsg": "text",
      "receipt": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "txnStatus": "SUCCESS"
    }
  ]
}

Successful response

Initiates a new payment transaction.

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

post

/transaction/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Transactionobject

Details of the payment object.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-pg-service/transaction/v1/_create' \
  --header 'Content-Type: application/json'

302

400

302

No body

Payment Initiated successfully, gateway redirection triggered.

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

/transaction/v1/_update

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-pg-service/transaction/v1/_update' \
  --header 'Content-Type: application/json'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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"
      },
      "txnStatusMsg": "text",
      "gatewayTxnId": "text",
      "gatewayPaymentMode": "text",
      "gatewayStatusCode": "text",
      "gatewayStatusMsg": "text",
      "receipt": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "txnStatus": "SUCCESS"
    }
  ]
}

Payment Status transaction updated successfully