Collection

Collection APIs

APIs to collection revenue

create

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_create HTTP/1.1
Host: bankAccountServiceMapping
Content-Type: application/json
Accept: */*
Content-Length: 506

{
  "BankAccountServiceMapping": [
    {
      "bank": "text",
      "bankAccount": "text",
      "bankBranch": "text",
      "businessDetails": "text",
      "tenantId": "text"
    }
  ],
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

{}

search

post

Query parameters

bankAccountanyOptional

businessDetailsanyOptional

tenantIdanyOptional

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_search HTTP/1.1
Host: bankAccountServiceMapping
Accept: */*

No content

Searches the Payment based on search criteria

post

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

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

pageSizeinteger · max: 100Optional

Number of records returned.

Default: 20

pageNumberintegerOptional

Page number

Default: 1

sortstring[] · min: 1 · max: 3Optional

Receipt results will be sorted by receiptnumber ascending by default.

Default: ["+receiptNumber"]

idsstring[]Optional

Payment Ids.

consumerCodesstring[]Optional

Consumer Code .

receiptNumbersstring[]Optional

List of receipt numbers.

fromDateinteger · int64Optional

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

toDateinteger · int64Optional

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

statusstring[]Optional

Search based on the status of the Payment.

instrumentStatusstring[]Optional

Search based on the status of the instrument.

paymentModesstring[]Optional

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

payerIdsstring[]Optional

The ids of the payer

transactionNumberstring · max: 64Optional

Unique tansaction number for multiple receipts created in one transaction.

mobileNumberstring · max: 64Optional

Unique tansaction number for multiple receipts created in one transaction.

billIdsstring[]Optional

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

Body

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.

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: 1024Optional

Device ID from which the API is called

keystring · max: 256Optional

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: 256Optional

UserId of the user calling

authTokenstringOptional

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

correlationIdstringRead-onlyOptional

Responses

200

Successful response

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /_search?tenantId=text HTTP/1.1
Host: payments
Content-Type: */*
Accept: */*
Content-Length: 360

{
  "apiId": "text",
  "ver": "text",
  "ts": 1,
  "action": "text",
  "did": "text",
  "key": "text",
  "msgId": "text",
  "requesterId": "text",
  "authToken": "text",
  "userInfo": {
    "tenantId": "text",
    "id": 1,
    "userName": "text",
    "mobile": "text",
    "email": "text",
    "primaryrole": [
      {
        "name": "text",
        "description": "text"
      }
    ],
    "additionalroles": [
      {
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "description": "text"
          }
        ]
      }
    ]
  }
}

[
  {
    "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,
      "paymentMode": "CASH",
      "instrumentDate": 1,
      "instrumentNumber": "text",
      "instrumentStatus": "APPROVED",
      "ifscCode": "text",
      "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",
            "status": "ACTIVE",
            "reasonForCancellation": "text",
            "isCancelled": true,
            "additionalDetails": {},
            "collectionModesNotAllowed": [
              "text"
            ],
            "partPaymentAllowed": true,
            "isAdvanceAllowed": true,
            "minimumAmountToBePaid": 1,
            "businessService": "text",
            "totalAmount": 1,
            "consumerCode": "text",
            "billNumber": "text",
            "billDate": 1,
            "billDetails": [
              {
                "id": "text",
                "tenantId": "text",
                "demandId": "text",
                "billId": "text",
                "amount": 1,
                "amountPaid": 1,
                "fromPeriod": 1,
                "toPeriod": 1,
                "receiptDate": "2025-05-30",
                "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",
                    "additionalDetails": {},
                    "purpose": "ARREAR",
                    "auditDetails": {
                      "createdBy": "text",
                      "lastModifiedBy": "text",
                      "createdTime": 1,
                      "lastModifiedTime": 1
                    }
                  }
                ]
              }
            ]
          },
          "additionalDetails": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "paidBy": "text",
      "mobileNumber": "text",
      "payerName": "text",
      "payerAddress": "text",
      "payerEmail": "text",
      "payerId": "text",
      "paymentStatus": "NEW",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  }
]

plainSearch

post

Query parameters

billIdsstring[]Optional

businessServicesstring[]Optional

consumerCodesstring[]Optional

fromDateinteger · int64Optional

idsstring[]Optional

instrumentStatusstring[]Optional

isCountRequestbooleanOptional

limitinteger · int32Optional

mobileNumberstringOptional

offsetinteger · int32Optional

payerIdsstring[]Optional

paymentModesstring[]Optional

receiptNumbersstring[]Optional

statusstring[]Optional

tenantIdstringOptional

tenantIdsstring[]Optional

toDateinteger · int64Optional

transactionNumberstringOptional

Body

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_plainsearch HTTP/1.1
Host: payments
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

{
  "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,
    "paymentMode": "CASH",
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-05-30",
              "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",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Records the payment in the system

post

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

Body

Payment Request with Request Info.

Responses

201

Payment created sucessfully.

*/*

400

Invalid input.

post

HTTPcURLJavaScriptPython

POST /_create HTTP/1.1
Host: payments
Content-Type: */*
Accept: */*
Content-Length: 2327

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 1,
    "totalAmountPaid": 1,
    "transactionNumber": "text",
    "transactionDate": 1,
    "paymentMode": "CASH",
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-05-30",
              "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",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

{
  "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,
    "paymentMode": "CASH",
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-05-30",
              "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",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Validates the PaymentRequest

post

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

Body

Payment Request with Request Info.

Responses

201

Payment info validated sucessfully.

*/*

400

Invalid input.

post

HTTPcURLJavaScriptPython

POST /_validate HTTP/1.1
Host: payments
Content-Type: */*
Accept: */*
Content-Length: 2327

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 1,
    "totalAmountPaid": 1,
    "transactionNumber": "text",
    "transactionDate": 1,
    "paymentMode": "CASH",
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-05-30",
              "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",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

{
  "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,
    "paymentMode": "CASH",
    "instrumentDate": 1,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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",
          "status": "ACTIVE",
          "reasonForCancellation": "text",
          "isCancelled": true,
          "additionalDetails": {},
          "collectionModesNotAllowed": [
            "text"
          ],
          "partPaymentAllowed": true,
          "isAdvanceAllowed": true,
          "minimumAmountToBePaid": 1,
          "businessService": "text",
          "totalAmount": 1,
          "consumerCode": "text",
          "billNumber": "text",
          "billDate": 1,
          "billDetails": [
            {
              "id": "text",
              "tenantId": "text",
              "demandId": "text",
              "billId": "text",
              "amount": 1,
              "amountPaid": 1,
              "fromPeriod": 1,
              "toPeriod": 1,
              "receiptDate": "2025-05-30",
              "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",
                  "additionalDetails": {},
                  "purpose": "ARREAR",
                  "auditDetails": {
                    "createdBy": "text",
                    "lastModifiedBy": "text",
                    "createdTime": 1,
                    "lastModifiedTime": 1
                  }
                }
              ]
            }
          ]
        },
        "additionalDetails": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

search

post

Path parameters

moduleNamestringRequired

moduleName

Query parameters

billIdsstring[]Optional

businessServicesstring[]Optional

consumerCodesstring[]Optional

fromDateinteger · int64Optional

idsstring[]Optional

instrumentStatusstring[]Optional

isCountRequestbooleanOptional

limitinteger · int32Optional

mobileNumberstringOptional

offsetinteger · int32Optional

payerIdsstring[]Optional

paymentModesstring[]Optional

receiptNumbersstring[]Optional

statusstring[]Optional

tenantIdstringOptional

tenantIdsstring[]Optional

toDateinteger · int64Optional

transactionNumberstringOptional

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /{moduleName}/_search HTTP/1.1
Host: payments
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

{}

workflow

post

Path parameters

moduleNamestringRequired

moduleName

Body

Payment Workflow Request with Request Info.

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /{moduleName}/_workflow HTTP/1.1
Host: payments
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  },
  "Payment": {
    "paymentId": "text",
    "action": "CANCEL",
    "tenantId": "text",
    "reason": "text",
    "additionalDetails": 1
  }
}

{}

update

post

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_update HTTP/1.1
Host: preexistpayments
Accept: */*

No content

create

post

Body

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_create HTTP/1.1
Host: remittances
Content-Type: application/json
Accept: */*
Content-Length: 1035

{
  "Remittance": [
    {
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceDate": 1,
      "referenceNumber": "text",
      "remarks": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text",
          "creditAmount": 1,
          "debitAmount": 1,
          "id": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "id": "text",
          "instrument": "text",
          "reconciled": true,
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceReceipts": [
        {
          "id": "text",
          "receipt": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text"
    }
  ],
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

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

search

post

Query parameters

bankaccountstringOptional

fromDateinteger · int64Optional

functionstringOptional

fundstringOptional

idsstring[]Optional

limitinteger · int32Optional

offsetinteger · int32Optional

pageSizeinteger · int32Optional

reasonForDelaystringOptional

referenceNumbersstring[]Optional

remarksstringOptional

sortBystringOptional

sortOrderstringOptional

statusstringOptional

tenantIdstringRequired

toDateinteger · int64Optional

voucherHeaderstringOptional

Body

Responses

200

OK

*/*

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_search?tenantId=text HTTP/1.1
Host: remittances
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

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

update

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /_update HTTP/1.1
Host: remittances
Content-Type: application/json
Accept: */*
Content-Length: 1035

{
  "Remittance": [
    {
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "bankaccount": "text",
      "function": "text",
      "fund": "text",
      "id": "text",
      "reasonForDelay": "text",
      "referenceDate": 1,
      "referenceNumber": "text",
      "remarks": "text",
      "remittanceDetails": [
        {
          "chartOfAccount": "text",
          "creditAmount": 1,
          "debitAmount": 1,
          "id": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceInstruments": [
        {
          "id": "text",
          "instrument": "text",
          "reconciled": true,
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "remittanceReceipts": [
        {
          "id": "text",
          "receipt": "text",
          "remittance": "text",
          "tenantId": "text"
        }
      ],
      "status": "text",
      "tenantId": "text",
      "voucherHeader": "text"
    }
  ],
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ]
        }
      ]
    }
  }
}

{}