Collection

Records the payment in the system

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

POST/payments/_create

Body

Creates payment for list of bill

PaymentPayment (object)

Response

Payment created sucessfully.

Body

PaymentPayment (object)

Request

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

Response

{
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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,
          "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-16",
              "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",
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW"
  }
}

Performs workflow actions on the payment

The API can perform the following operations:

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

POST/payments/_workflow

Body

The workflow request

PaymentPaymentWorkflow (object)

Workflow object for payment

Response

Payment status updated sucessfully.

Body

PaymentPayment (object)

Request

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

Response

{
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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,
          "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-16",
              "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",
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW"
  }
}

Validates the PaymentRequest

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

Bill is present and is in valid state
Amount paid is positive integer
Zero amount payment is allowed only if bill amount is zero
Payment mode is allowed
Partial Payment is allowed based on the businessService
Advance payment is allowed based on the businessService

POST/payments/_validate

Body

The request to be validated

PaymentPayment (object)

Response

Payment info validated sucessfully.

Body

PaymentPayment (object)

Request

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

Response

{
  "Payment": {
    "tenantId": "text",
    "id": "text",
    "totalDue": 0,
    "totalAmountPaid": 0,
    "transactionNumber": "text",
    "transactionDate": 0,
    "paymentMode": "CASH",
    "instrumentDate": 0,
    "instrumentNumber": "text",
    "instrumentStatus": "APPROVED",
    "ifscCode": "text",
    "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,
          "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-16",
              "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",
                  "purpose": "ARREAR"
                }
              ]
            }
          ]
        }
      }
    ],
    "paidBy": "text",
    "mobileNumber": "text",
    "payerName": "text",
    "payerAddress": "text",
    "payerEmail": "text",
    "payerId": "text",
    "paymentStatus": "NEW"
  }
}

PreviousFile Store NextDSS Ingest

Last updated 9 months ago

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

{ "Payment": { "tenantId": "text", "id": "text", "totalDue": 0, "totalAmountPaid": 0, "transactionNumber": "text", "transactionDate": 0, "paymentMode": "CASH", "instrumentDate": 0, "instrumentNumber": "text", "instrumentStatus": "APPROVED", "ifscCode": "text", "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, "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-16", "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", "purpose": "ARREAR" } ] } ] } } ], "paidBy": "text", "mobileNumber": "text", "payerName": "text", "payerAddress": "text", "payerEmail": "text", "payerId": "text", "paymentStatus": "NEW" } }

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

Validates the PaymentRequest

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

Bill is present and is in valid state
Amount paid is positive integer
Zero amount payment is allowed only if bill amount is zero
Payment mode is allowed
Partial Payment is allowed based on the businessService
Advance payment is allowed based on the businessService

POST/payments/_validate

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