Payment Gateway Service

Retrieves the current status of a payment

post

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

body

requestInfoanyOptional

Parameter to carry Request metadata in the request body

Query parameters

tenantIdanyRequired

Unique id for a tenant.

txnIdstringOptional

Transaction id generated by the service during creation.

billIdstring · varcharOptional

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

user_uuidstring · varcharOptional

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

modulestringOptional

Module name to which the billId belongs to.

moduleIdstringOptional

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

receiptstringOptional

Receipt ID generated for this payment

txnStatusstringOptional

Current status of the transaction

Responses

200

Successful response

application/json

400

Invalid input.

application/json

post

HTTPcURLJavaScriptPython

POST /egov-pg-service/transaction/v1/_search?tenantId=null HTTP/1.1
Host: 
Accept: */*

{
  "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
      }
    }
  ]
}

Initiates a new payment transaction.

post

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

Body

The payment object, containing all necessary information for initiating a payment and the request body metadata

Responses

302

Payment Initiated successfully, gateway redirection triggered.

400

Payment initiation failed.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Transaction": {
    "tenantId": "text",
    "txnAmount": "text",
    "billId": "text",
    "module": "text",
    "moduleId": "text",
    "productInfo": "text",
    "gateway": "text",
    "callbackUrl": "text"
  }
}

No content

Update an existing payment.

post

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

Body

Wrapper for Request Info

Responses

200

Payment Status transaction updated successfully

application/json

400

Payment status update failed

application/json

post

HTTPcURLJavaScriptPython

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

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "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
      }
    }
  ]
}