Payment Gateway

Payment Gateway APIs

Facilitates payments, refunds and search transaction details.

transactionsV1AvailableGatewaysPost

post

Responses

200

OK

*/*

Responsestring[]

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /egov-pg-service/pg-service/gateway/v1/_search HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

transactionsV1CreatePost

post

Body

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /egov-pg-service/pg-service/transaction/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 479

{
  "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",
    "user": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "name": "text",
      "mobileNumber": "text",
      "emailId": "text"
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

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

transactionsV1SearchPost

post

Query parameters

billIdstringOptional

consumerCodestringOptional

createdTimeinteger · int64Optional

limitinteger · int32Optional

offsetinteger · int32Optional

receiptstringOptional

tenantIdstringOptional

txnIdstringOptional

txnStatusstring · enumOptionalPossible values:

userUuidstringOptional

Body

Wrapper for Request Info

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /egov-pg-service/pg-service/transaction/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

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

transactionsV1UpdatePost

post

Query parameters

Body

Wrapper for Request Info

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /egov-pg-service/pg-service/transaction/v1/_update?params=[object+Object] HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

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