Collection

Collection APIs

APIs to collection revenue

create

post

/bankAccountServiceMapping/_create

Body

RequestInfoobjectrequired

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.

BankAccountServiceMappingBankAccountServiceMapping[]required

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//bankAccountServiceMapping/_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"}]}]}},"BankAccountServiceMapping":[{"bankAccount":"text","businessDetails":"text","tenantId":"text"}]}'

200

201

401

403

404

200

{}

OK

search

post

/bankAccountServiceMapping/_search

Query parameters

bankAccountany

businessDetailsany

tenantIdany

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

201

401

403

404

200

No body

OK

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

tenantIdstring · varcharrequired

Unique id for a tenant.

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.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//payments/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"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

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",
      "paidBy": "text",
      "mobileNumber": "text",
      "payerName": "text",
      "payerAddress": "text",
      "payerEmail": "text",
      "payerId": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "paymentMode": "CASH",
      "instrumentStatus": "APPROVED",
      "paymentStatus": "NEW",
      "additionalDetails": {},
      "paymentDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "totalDue": 1,
          "totalAmountPaid": 1,
          "manualReceiptNumber": "text",
          "receiptNumber": "text",
          "receiptType": "text",
          "receiptDate": 1,
          "businessService": "text",
          "billId": "text",
          "bill": {
            "paidBy": "text",
            "mobileNumber": "text",
            "payerName": "text",
            "payerAddress": "text",
            "payerEmail": "text",
            "payerId": "text",
            "reasonForCancellation": "text",
            "isCancelled": true,
            "partPaymentAllowed": true,
            "isAdvanceAllowed": true,
            "minimumAmountToBePaid": 1,
            "businessService": "text",
            "totalAmount": 1,
            "consumerCode": "text",
            "billNumber": "text",
            "billDate": 1,
            "status": "ACTIVE",
            "additionalDetails": {},
            "collectionModesNotAllowed": [
              "text"
            ],
            "billDetails": [
              {
                "id": "text",
                "tenantId": "text",
                "demandId": "text",
                "billId": "text",
                "amount": 1,
                "amountPaid": 1,
                "fromPeriod": 1,
                "toPeriod": 1,
                "receiptDate": "2025-02-22",
                "receiptType": {},
                "channel": "text",
                "voucherHeader": {},
                "boundary": {},
                "manualReceiptNumber": "text",
                "manualReceiptDate": 1,
                "collectionType": "text",
                "billDescription": "text",
                "expiryDate": 1,
                "displayMessage": "text",
                "cancellationRemarks": "text",
                "billAccountDetails": [
                  {
                    "id": "text",
                    "tenantId": "text",
                    "billDetailId": "text",
                    "demandDetailId": "text",
                    "order": 1,
                    "amount": 1,
                    "adjustedAmount": 1,
                    "taxHeadCode": "text",
                    "auditDetails": {
                      "createdBy": "text",
                      "lastModifiedBy": "text",
                      "createdTime": 1,
                      "lastModifiedTime": 1
                    },
                    "purpose": "ARREAR",
                    "additionalDetails": {}
                  }
                ]
              }
            ]
          },
          "additionalDetails": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ]
    }
  }
]

Successful response

plainSearch

post

/payments/_plainsearch

Query parameters

billIdsstring[]

businessServicesstring[]

consumerCodesstring[]

fromDateinteger · int64

idsstring[]

instrumentStatusstring[]

isCountRequestboolean

limitinteger · int32

mobileNumberstring

offsetinteger · int32

payerIdsstring[]

paymentModesstring[]

receiptNumbersstring[]

statusstring[]

tenantIdstring

tenantIdsstring[]

toDateinteger · int64

transactionNumberstring

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

curl -L \
  --request POST \
  --url '//payments/_plainsearch' \
  --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

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",
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 1,
        "totalAmountPaid": 1,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "receiptDate": 1,
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "status": "ACTIVE",
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-02-22",
              "receiptType": {},
              "channel": "text",
              "voucherHeader": {},
              "boundary": {},
              "manualReceiptNumber": "text",
              "manualReceiptDate": 1,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 1,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "order": 1,
                  "amount": 1,
                  "adjustedAmount": 1,
                  "taxHeadCode": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  },
                  "purpose": "ARREAR",
                  "additionalDetails": {}
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }
}

OK

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

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: */*' \
  --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,"paidBy":"text","mobileNumber":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"paymentMode":"CASH","instrumentStatus":"APPROVED","paymentStatus":"NEW","additionalDetails":{},"paymentDetails":[{"id":"text","tenantId":"text","totalDue":1,"totalAmountPaid":1,"manualReceiptNumber":"text","receiptNumber":"text","receiptType":"text","receiptDate":1,"businessService":"text","billId":"text","bill":{"paidBy":"text","mobileNumber":"text","payerName":"text","payerAddress":"text","payerEmail":"text","payerId":"text","reasonForCancellation":"text","isCancelled":true,"partPaymentAllowed":true,"isAdvanceAllowed":true,"minimumAmountToBePaid":1,"businessService":"text","totalAmount":1,"consumerCode":"text","billNumber":"text","billDate":1,"status":"ACTIVE","additionalDetails":{},"collectionModesNotAllowed":["text"],"billDetails":[{"id":"text","tenantId":"text","demandId":"text","billId":"text","amount":1,"amountPaid":1,"fromPeriod":1,"toPeriod":1,"receiptDate":"2025-02-22","receiptType":{},"channel":"text","voucherHeader":{},"boundary":{},"manualReceiptNumber":"text","manualReceiptDate":1,"collectionType":"text","billDescription":"text","expiryDate":1,"displayMessage":"text","cancellationRemarks":"text","billAccountDetails":[{"id":"text","tenantId":"text","billDetailId":"text","demandDetailId":"text","order":1,"amount":1,"adjustedAmount":1,"taxHeadCode":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"purpose":"ARREAR","additionalDetails":{}}]}]},"additionalDetails":1,"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1}}]}}'

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",
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 1,
        "totalAmountPaid": 1,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "receiptDate": 1,
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "status": "ACTIVE",
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-02-22",
              "receiptType": {},
              "channel": "text",
              "voucherHeader": {},
              "boundary": {},
              "manualReceiptNumber": "text",
              "manualReceiptDate": 1,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 1,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "order": 1,
                  "amount": 1,
                  "adjustedAmount": 1,
                  "taxHeadCode": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  },
                  "purpose": "ARREAR",
                  "additionalDetails": {}
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }
}

Payment created 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

/payments/_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: */*' \
  --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,"paidBy":"text","mobileNumber":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"paymentMode":"CASH","instrumentStatus":"APPROVED","paymentStatus":"NEW","additionalDetails":{},"paymentDetails":[{"id":"text","tenantId":"text","totalDue":1,"totalAmountPaid":1,"manualReceiptNumber":"text","receiptNumber":"text","receiptType":"text","receiptDate":1,"businessService":"text","billId":"text","bill":{"paidBy":"text","mobileNumber":"text","payerName":"text","payerAddress":"text","payerEmail":"text","payerId":"text","reasonForCancellation":"text","isCancelled":true,"partPaymentAllowed":true,"isAdvanceAllowed":true,"minimumAmountToBePaid":1,"businessService":"text","totalAmount":1,"consumerCode":"text","billNumber":"text","billDate":1,"status":"ACTIVE","additionalDetails":{},"collectionModesNotAllowed":["text"],"billDetails":[{"id":"text","tenantId":"text","demandId":"text","billId":"text","amount":1,"amountPaid":1,"fromPeriod":1,"toPeriod":1,"receiptDate":"2025-02-22","receiptType":{},"channel":"text","voucherHeader":{},"boundary":{},"manualReceiptNumber":"text","manualReceiptDate":1,"collectionType":"text","billDescription":"text","expiryDate":1,"displayMessage":"text","cancellationRemarks":"text","billAccountDetails":[{"id":"text","tenantId":"text","billDetailId":"text","demandDetailId":"text","order":1,"amount":1,"adjustedAmount":1,"taxHeadCode":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"purpose":"ARREAR","additionalDetails":{}}]}]},"additionalDetails":1,"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1}}]}}'

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",
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "paymentMode": "CASH",
    "instrumentStatus": "APPROVED",
    "paymentStatus": "NEW",
    "additionalDetails": {},
    "paymentDetails": [
      {
        "id": "text",
        "tenantId": "text",
        "totalDue": 1,
        "totalAmountPaid": 1,
        "manualReceiptNumber": "text",
        "receiptNumber": "text",
        "receiptType": "text",
        "receiptDate": 1,
        "businessService": "text",
        "billId": "text",
        "bill": {
          "paidBy": "text",
          "mobileNumber": "text",
          "payerName": "text",
          "payerAddress": "text",
          "payerEmail": "text",
          "payerId": "text",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "status": "ACTIVE",
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-02-22",
              "receiptType": {},
              "channel": "text",
              "voucherHeader": {},
              "boundary": {},
              "manualReceiptNumber": "text",
              "manualReceiptDate": 1,
              "collectionType": "text",
              "billDescription": "text",
              "expiryDate": 1,
              "displayMessage": "text",
              "cancellationRemarks": "text",
              "billAccountDetails": [
                {
                  "id": "text",
                  "tenantId": "text",
                  "billDetailId": "text",
                  "demandDetailId": "text",
                  "order": 1,
                  "amount": 1,
                  "adjustedAmount": 1,
                  "taxHeadCode": "text",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  },
                  "purpose": "ARREAR",
                  "additionalDetails": {}
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }
}

Payment info validated sucessfully.

search

post

/payments/{moduleName}/_search

Path parameters

moduleNamestringrequired

moduleName

Query parameters

billIdsstring[]

businessServicesstring[]

consumerCodesstring[]

fromDateinteger · int64

idsstring[]

instrumentStatusstring[]

isCountRequestboolean

limitinteger · int32

mobileNumberstring

offsetinteger · int32

payerIdsstring[]

paymentModesstring[]

receiptNumbersstring[]

statusstring[]

tenantIdstring

tenantIdsstring[]

toDateinteger · int64

transactionNumberstring

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

curl -L \
  --request POST \
  --url '//payments/{moduleName}/_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

200

{}

OK

workflow

post

/payments/{moduleName}/_workflow

Path parameters

moduleNamestringrequired

moduleName

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/{moduleName}/_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"}}'

200

201

401

403

404

200

{}

OK

update

post

/preexistpayments/_update

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//preexistpayments/_update'

200

201

401

403

404

200

No body

OK

create

post

/remittances/_create

Body

RequestInfoobjectrequired

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.

RemittanceRemittance[]required

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//remittances/_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"}]}]}},"Remittance":[{"auditDetails":{},"referenceDate":1,"referenceNumber":"text","tenantId":"text","remittanceDetails":[{"chartOfAccount":"text"}],"remittanceInstruments":[{"instrument":"text"}],"remittanceReceipts":[{}]}]}'

200

201

401

403

404

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Remittance": [
    {
      "auditDetails": {},
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceDate": 1,
      "referenceNumber": "text",
      "remarks": "text",
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "instrument": "text"
        }
      ],
      "remittanceReceipts": [
        {}
      ]
    }
  ]
}

OK

search

post

/remittances/_search

Query parameters

bankaccountstring

fromDateinteger · int64

functionstring

fundstring

idsstring[]

limitinteger · int32

offsetinteger · int32

pageSizeinteger · int32

reasonForDelaystring

referenceNumbersstring[]

remarksstring

sortBystring

sortOrderstring

statusstring

tenantIdstringrequired

toDateinteger · int64

voucherHeaderstring

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

curl -L \
  --request POST \
  --url '//remittances/_search?tenantId=text' \
  --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

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Remittance": [
    {
      "auditDetails": {},
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceDate": 1,
      "referenceNumber": "text",
      "remarks": "text",
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "instrument": "text"
        }
      ],
      "remittanceReceipts": [
        {}
      ]
    }
  ]
}

OK

update

post

/remittances/_update

Body

RequestInfoobjectrequired

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.

RemittanceRemittance[]required

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//remittances/_update' \
  --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"}]}]}},"Remittance":[{"auditDetails":{},"referenceDate":1,"referenceNumber":"text","tenantId":"text","remittanceDetails":[{"chartOfAccount":"text"}],"remittanceInstruments":[{"instrument":"text"}],"remittanceReceipts":[{}]}]}'

200

201

401

403

404

200

{}

OK