Collection

Records the payment in the system

This API generates a transaction number and persists the payment details. The payment information is then pushed to queue for further processing.

post

/_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.

Paymentobject

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/payments/_create' \
  --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"}]}]}},"Payment":{"tenantId":"text","totalAmountPaid":1,"additionalDetails":{},"paidBy":"text","mobileNumber":"text","auditDetails":{},"paymentMode":"CASH","instrumentStatus":"APPROVED","paymentStatus":"NEW","paymentDetails":[{"totalAmountPaid":1,"billId":"text","bill":{"additionalDetails":{},"status":"ACTIVE","collectionModesNotAllowed":[null],"billDetails":[{"billAccountDetails":[{"additionalDetails":{},"auditDetails":{},"purpose":"ARREAR"}]}]},"auditDetails":{}}]}}'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 1,
    "totalAmountPaid": 1,
    "transactionNumber": "text",
    "transactionDate": 1,
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "ifscCode": "text",
    "additionalDetails": {},
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {},
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "paymentDetails": [
      {
        "totalAmountPaid": 1,
        "billId": "text",
        "bill": {
          "additionalDetails": {},
          "status": "ACTIVE",
          "collectionModesNotAllowed": [
            null
          ],
          "billDetails": [
            {
              "billAccountDetails": [
                {
                  "additionalDetails": {},
                  "auditDetails": {},
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        },
        "auditDetails": {}
      }
    ]
  }
}

Payment created sucessfully.

Performs workflow actions on the payment

The API can perform the following operations:

1. Cancellation of receipts in open state.
2. Remittance of instruments such as Cash, Cheque, DD .
3. Dishonoring of instruments such as Cheque, DD.

post

/_workflow

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.

Paymentobject

Workflow object for payment

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/payments/_workflow' \
  --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"}]}]}},"Payment":{"paymentId":"text","tenantId":"text","action":"CANCEL"}}'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 1,
    "totalAmountPaid": 1,
    "transactionNumber": "text",
    "transactionDate": 1,
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "ifscCode": "text",
    "additionalDetails": {},
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {},
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "paymentDetails": [
      {
        "totalAmountPaid": 1,
        "billId": "text",
        "bill": {
          "additionalDetails": {},
          "status": "ACTIVE",
          "collectionModesNotAllowed": [
            null
          ],
          "billDetails": [
            {
              "billAccountDetails": [
                {
                  "additionalDetails": {},
                  "auditDetails": {},
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        },
        "auditDetails": {}
      }
    ]
  }
}

Payment status updated sucessfully.

Validates the PaymentRequest

The API runs the following set of validations on the payment request.

1. Bill is present and is in valid state
2. Amount paid is positive integer
3. Zero amount payment is allowed only if bill amount is zero
4. Payment mode is allowed
5. Partial Payment is allowed based on the businessService
6. Advance payment is allowed based on the businessService

post

/_validate

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.

Paymentobject

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/payments/_validate' \
  --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"}]}]}},"Payment":{"tenantId":"text","totalAmountPaid":1,"additionalDetails":{},"paidBy":"text","mobileNumber":"text","auditDetails":{},"paymentMode":"CASH","instrumentStatus":"APPROVED","paymentStatus":"NEW","paymentDetails":[{"totalAmountPaid":1,"billId":"text","bill":{"additionalDetails":{},"status":"ACTIVE","collectionModesNotAllowed":[null],"billDetails":[{"billAccountDetails":[{"additionalDetails":{},"auditDetails":{},"purpose":"ARREAR"}]}]},"auditDetails":{}}]}}'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 1,
    "totalAmountPaid": 1,
    "transactionNumber": "text",
    "transactionDate": 1,
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "ifscCode": "text",
    "additionalDetails": {},
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {},
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "paymentDetails": [
      {
        "totalAmountPaid": 1,
        "billId": "text",
        "bill": {
          "additionalDetails": {},
          "status": "ACTIVE",
          "collectionModesNotAllowed": [
            null
          ],
          "billDetails": [
            {
              "billAccountDetails": [
                {
                  "additionalDetails": {},
                  "auditDetails": {},
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        },
        "auditDetails": {}
      }
    ]
  }
}

Payment info validated sucessfully.

Searches the Payment based on search criteria

API to search payments based on search parameters like consumerCode, mobileNumber, transactionNumber etc.

post

/_search

Query parameters

pageSizeinteger · max: 100 · default: 20

Number of records returned.

pageNumberinteger · default: 1

Page number

sortstring[] · default: +receiptNumber

Receipt results will be sorted by receiptnumber ascending by default.

idsstring[]

Payment Ids.

consumerCodesstring[]

Consumer Code .

receiptNumbersstring[]

List of receipt numbers.

fromDateinteger · int64

Transaction date, here search will happen as Transaction date is greater or equal to given fromDate.

toDateinteger · int64

Transaction date, here search will happen as Transaction date is lesser or equal to given toDate.

statusstring[]

Search based on the status of the Payment.

instrumentStatusstring[]

Search based on the status of the instrument.

paymentModesstring[]

Search based on the Payment type such as cash, cheque, dd etc.

payerIdsstring[]

The ids of the payer

transactionNumberstring · max: 64

Unique tansaction number for multiple receipts created in one transaction.

mobileNumberstring · max: 64

Unique tansaction number for multiple receipts created in one transaction.

billIdsstring[]

List of bill ids to search receipts.Business details code is mandatory for searching with this criteria.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/payments/_search'

200

400

200

[
  {
    "responseInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "resMsgId": "text",
      "msgId": "text",
      "status": "SUCCESSFUL"
    },
    "Payment": {
      "tenantId": "text",
      "id": "text",
      "totalDue": 1,
      "totalAmountPaid": 1,
      "transactionNumber": "text",
      "transactionDate": 1,
      "instrumentDate": 1,
      "instrumentNumber": "text",
      "ifscCode": "text",
      "additionalDetails": {},
      "paidBy": "text",
      "mobileNumber": "text",
      "payerName": "text",
      "payerAddress": "text",
      "payerEmail": "text",
      "payerId": "text",
      "auditDetails": {},
      "paymentMode": "CASH",
      "instrumentStatus": "APPROVED",
      "paymentStatus": "NEW",
      "paymentDetails": [
        {
          "totalAmountPaid": 1,
          "billId": "text",
          "bill": {
            "additionalDetails": {},
            "status": "ACTIVE",
            "collectionModesNotAllowed": [
              null
            ],
            "billDetails": [
              {
                "billAccountDetails": [
                  {
                    "additionalDetails": {},
                    "auditDetails": {},
                    "purpose": "ARREAR"
                  }
                ]
              }
            ]
          },
          "auditDetails": {}
        }
      ]
    }
  }
]

Successful response