Collection

Collection APIs

APIs to collection revenue

create

POST//bankAccountServiceMapping/_create

Body

application/json

BankAccountServiceMapping*array of BankAccountServiceMapping

RequestInfo*RequestInfo (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

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('//bankAccountServiceMapping/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "BankAccountServiceMapping": [
        {
          "bankAccount": "text",
          "businessDetails": "text",
          "tenantId": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

search

POST//bankAccountServiceMapping/_search

Query parameters

Response

200201401403404

OK

Request

JavaScriptCurlPython

const response = await fetch('//bankAccountServiceMapping/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Searches the Payment based on search criteria

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

POST//payments/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Successful response

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.

PaymentPayment (object)

Request

JavaScriptCurlPython

const response = await fetch('//payments/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

[
  {
    "responseInfo": {
      "apiId": "text",
      "ver": "text",
      "resMsgId": "text",
      "msgId": "text",
      "status": "SUCCESSFUL"
    },
    "Payment": {
      "tenantId": "text",
      "id": "text",
      "totalDue": 0,
      "totalAmountPaid": 0,
      "transactionNumber": "text",
      "transactionDate": 0,
      "paymentMode": "CASH",
      "instrumentDate": 0,
      "instrumentNumber": "text",
      "instrumentStatus": "APPROVED",
      "ifscCode": "text",
      "additionalDetails": {},
      "paymentDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "totalDue": 0,
          "totalAmountPaid": 0,
          "manualReceiptNumber": "text",
          "receiptNumber": "text",
          "receiptType": "text",
          "businessService": "text",
          "billId": "text",
          "bill": {
            "paidBy": "text",
            "mobileNumber": "text",
            "payerName": "text",
            "payerAddress": "text",
            "payerEmail": "text",
            "payerId": "text",
            "status": "ACTIVE",
            "reasonForCancellation": "text",
            "isCancelled": false,
            "additionalDetails": {},
            "collectionModesNotAllowed": [
              "text"
            ],
            "partPaymentAllowed": false,
            "isAdvanceAllowed": false,
            "minimumAmountToBePaid": 0,
            "businessService": "text",
            "totalAmount": 0,
            "consumerCode": "text",
            "billNumber": "text",
            "billDate": 0,
            "billDetails": [
              {
                "id": "text",
                "tenantId": "text",
                "demandId": "text",
                "billId": "text",
                "amount": 0,
                "amountPaid": 0,
                "fromPeriod": 0,
                "toPeriod": 0,
                "receiptDate": "2024-11-21",
                "channel": "text",
                "manualReceiptNumber": "text",
                "manualReceiptDate": 0,
                "collectionType": "text",
                "billDescription": "text",
                "expiryDate": 0,
                "displayMessage": "text",
                "cancellationRemarks": "text",
                "billAccountDetails": [
                  {
                    "id": "text",
                    "tenantId": "text",
                    "billDetailId": "text",
                    "demandDetailId": "text",
                    "amount": 0,
                    "adjustedAmount": 0,
                    "taxHeadCode": "text",
                    "additionalDetails": {},
                    "purpose": "ARREAR",
                    "auditDetails": {
                      "createdBy": "text",
                      "lastModifiedBy": "text"
                    }
                  }
                ]
              }
            ]
          },
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "paidBy": "text",
      "mobileNumber": "text",
      "payerName": "text",
      "payerAddress": "text",
      "payerEmail": "text",
      "payerId": "text",
      "paymentStatus": "NEW",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  }
]

plainSearch

POST//payments/_plainsearch

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.

PaymentPayment (object)

Request

JavaScriptCurlPython

const response = await fetch('//payments/_plainsearch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 0,
        "totalAmountPaid": 0,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": false,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": false,
          "isAdvanceAllowed": false,
          "minimumAmountToBePaid": 0,
          "businessService": "text",
          "totalAmount": 0,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 0,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 0,
              "amountPaid": 0,
              "fromPeriod": 0,
              "toPeriod": 0,
              "receiptDate": "2024-11-21",
              "channel": "text",
              "manualReceiptNumber": "text",
              "manualReceiptDate": 0,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 0,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "amount": 0,
                  "adjustedAmount": 0,
                  "taxHeadCode": "text",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text"
                  }
                }
              ]
            }
          ]
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

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//payments/_create

Body

*/*

Creates payment for list of bill

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.

PaymentPayment (object)

Response

201400

Payment created sucessfully.

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.

PaymentPayment (object)

Request

JavaScriptCurlPython

const response = await fetch('//payments/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 0,
        "totalAmountPaid": 0,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": false,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": false,
          "isAdvanceAllowed": false,
          "minimumAmountToBePaid": 0,
          "businessService": "text",
          "totalAmount": 0,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 0,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 0,
              "amountPaid": 0,
              "fromPeriod": 0,
              "toPeriod": 0,
              "receiptDate": "2024-11-21",
              "channel": "text",
              "manualReceiptNumber": "text",
              "manualReceiptDate": 0,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 0,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "amount": 0,
                  "adjustedAmount": 0,
                  "taxHeadCode": "text",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text"
                  }
                }
              ]
            }
          ]
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

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//payments/_validate

Body

*/*

The request to be validated

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.

PaymentPayment (object)

Response

201400

Payment info validated sucessfully.

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.

PaymentPayment (object)

Request

JavaScriptCurlPython

const response = await fetch('//payments/_validate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 0,
        "totalAmountPaid": 0,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": false,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": false,
          "isAdvanceAllowed": false,
          "minimumAmountToBePaid": 0,
          "businessService": "text",
          "totalAmount": 0,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 0,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 0,
              "amountPaid": 0,
              "fromPeriod": 0,
              "toPeriod": 0,
              "receiptDate": "2024-11-21",
              "channel": "text",
              "manualReceiptNumber": "text",
              "manualReceiptDate": 0,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 0,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "amount": 0,
                  "adjustedAmount": 0,
                  "taxHeadCode": "text",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text"
                  }
                }
              ]
            }
          ]
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  }
}

search

POST//payments/{moduleName}/_search

Path parameters

moduleName*string

moduleName

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

*/*

object

Request

JavaScriptCurlPython

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

workflow

POST//payments/{moduleName}/_workflow

Path parameters

moduleName*string

moduleName

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.

PaymentPaymentWorkflow (object)

Workflow object for payment

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('//payments/{moduleName}/_workflow', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

update

POST//preexistpayments/_update

Response

200201401403404

OK

Request

JavaScriptCurlPython

const response = await fetch('//preexistpayments/_update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

create

POST//remittances/_create

Body

application/json

Remittance*array of Remittance

RequestInfo*RequestInfo (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

*/*

Remittancearray of Remittance

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.

Request

JavaScriptCurlPython

const response = await fetch('//remittances/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Remittance": [
        {
          "referenceNumber": "text",
          "tenantId": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "Remittance": [
    {
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceNumber": "text",
      "remarks": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text",
          "creditAmount": 0,
          "debitAmount": 0,
          "id": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "id": "text",
          "instrument": "text",
          "reconciled": false,
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceReceipts": [
        {
          "id": "text",
          "receipt": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

search

POST//remittances/_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

*/*

Remittancearray of Remittance

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.

Request

JavaScriptCurlPython

const response = await fetch('//remittances/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Remittance": [
    {
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceNumber": "text",
      "remarks": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text",
          "creditAmount": 0,
          "debitAmount": 0,
          "id": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "id": "text",
          "instrument": "text",
          "reconciled": false,
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceReceipts": [
        {
          "id": "text",
          "receipt": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text"
    }
  ],
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

update

POST//remittances/_update

Body

application/json

Remittance*array of Remittance

RequestInfo*RequestInfo (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

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('//remittances/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Remittance": [
        {
          "referenceNumber": "text",
          "tenantId": "text"
        }
      ],
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();