Payment Gateway

Payment Gateway APIs

Facilitates payments, refunds and search transaction details.

transactionsV1AvailableGatewaysPost

POST/egov-pg-service/pg-service/gateway/v1/_search

Response

200201401403404

OK

Body

*/*

itemsstring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/egov-pg-service/pg-service/gateway/v1/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

[
  "text"
]

transactionsV1CreatePost

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

Body

application/json

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

TransactionTransaction (object)

Details of the payment object.

Response

200201401403404

OK

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

TransactionTransaction (object)

Details of the payment object.

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "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"
    },
    "txnStatus": "SUCCESS",
    "txnStatusMsg": "text",
    "gatewayTxnId": "text",
    "gatewayPaymentMode": "text",
    "gatewayStatusCode": "text",
    "gatewayStatusMsg": "text",
    "receipt": "text",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 0,
      "lastModifiedTime": 0
    }
  }
}

transactionsV1SearchPost

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

Query parameters

Body

application/json

requestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Transactionarray of Transaction (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

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

transactionsV1UpdatePost

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

Query parameters

Body

application/json

requestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Transactionarray of Transaction (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

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