Payment Gateway

Payment Gateway APIs

Facilitates payments, refunds and search transaction details.

PreviousOTP NextPDF Generation

Last updated 1 year ago

Was this helpful?

transactionsV1AvailableGatewaysPost

post

/pg-service/gateway/v1/_search

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

201

401

403

404

[
  "text"
]

transactionsV1CreatePost

post

/pg-service/transaction/v1/_create

Body

ResponseInfoobject

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.

Transactionobject

Details of the payment object.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/egov-pg-service/pg-service/transaction/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"ResponseInfo":{"apiId":"text","ver":"text","ts":1,"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"},"auditDetails":{},"txnStatus":"SUCCESS"}}'

200

201

401

403

404

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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"
    },
    "auditDetails": {},
    "txnStatus": "SUCCESS"
  }
}

transactionsV1SearchPost

post

/pg-service/transaction/v1/_search

Query parameters

billIdstring

consumerCodestring

createdTimeinteger · int64

limitinteger · int32

offsetinteger · int32

receiptstring

tenantIdstring

txnIdstring

txnStatusstring · enum

Options: FAILURE, PENDING, SUCCESS

userUuidstring

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 -L \
  --request POST \
  --url '/egov-pg-service/pg-service/transaction/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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

transactionsV1UpdatePost

post

/pg-service/transaction/v1/_update

Query parameters

paramsobjectrequired

params

Body

requestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/egov-pg-service/pg-service/transaction/v1/_update?params=%5Bobject+Object%5D' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

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