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)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Response

Payment created sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

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

paymentId*string

id of the payment on which to take action .

action*enum

the action to be taken on the payment

CANCELDISHONOURREMIT

tenantId*string

tenantId of the payment

reasonstring

reason for taking the action.

additionalDetailsinteger

Any additional fields can be captured here as a map

Response

Payment status updated sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

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)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Response

Payment info validated sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

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

paymentId*string

id of the payment on which to take action .

action*enum

the action to be taken on the payment

CANCELDISHONOURREMIT

tenantId*string

tenantId of the payment

reasonstring

reason for taking the action.

additionalDetailsinteger

Any additional fields can be captured here as a map

Response

Payment status updated sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

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)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Response

Payment created sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

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)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Response

Payment info validated sucessfully.

Body

PaymentPayment (object)

tenantId*string (varchar)

Unique id of tenant.

idstring (varchar)

Unique id of tenant.

totalDuenumber

Total amount due.

totalAmountPaid*number (double)

Unique id of tenant.

transactionNumberstring (varchar)

Transaction number of the payment

transactionDatenumber (int64)

The date of payment in epoch

paymentMode*enum

Mode of payment used.

CASHCHEQUEDDONLINECARD

instrumentDatenumber (int64)

The instrument date

instrumentNumberstring (varchar)

The number of the instrument like dd number,cheque number etc.

instrumentStatusenum

The status of the instrument

APPROVEDAPPROVALPENDINGTOBESUBMITTEDREMITTEDREJECTEDCANCELLEDDISHONOURED

ifscCodestring (varchar)

IFSC code of the bank to which payment is made

additionalDetailsobject

Any additional fields can be captured here as a map

paymentDetails*array of PaymentDetail (object)

Payment details of each bill

idstring

id of the payment detail

tenantIdstring

tenantId of the payment detail

totalDuenumber (double)

The total amount to be paid for the bill corresponding to the payment detail

totalAmountPaid*number (double)

The amount that is being paid

manualReceiptNumberstring

Receipt number entered manually for legacy data.

receiptNumberstring

The receipt number generated for the payment against the bill

receiptTypestring

The receipt type generated for the payment against the bill

receiptDateinteger

The epoch receipt date generated for the payment against the bill

businessServicestring

The code of the businessService to which the bill belongs

billId*string

The id of the bill for which the payment is made

billBill (object)

paidBystring

Name of the Person who is making payment.

mobileNumberstring (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

statusenum

status of the bill.

ACTIVECANCELLEDPAIDEXPIRED

reasonForCancellationstring (varchar)

The reason for cancellation of bill

isCancelledboolean (varchar)

Boolean indicating if the bill is cancelled

additionalDetailsobject

Additional fields can be captured here

collectionModesNotAllowedarray of string

The list of collection modes that are not allowed

itemsstring

partPaymentAllowedboolean

Boolean flag indicating if partial payment is allowed to be collected

isAdvanceAllowedboolean

Flag indicating if advance can be collected

minimumAmountToBePaidnumber (double)

The minumun amount that can be paid against the bill

businessServicestring (varchar)

The businessService of the entity for which the bill is generated

totalAmountnumber (double)

The total amount to be paid for the bill

consumerCodestring (varchar)

The consumer code for which bill is generated

billNumberstring (varchar)

The bill number generated by system

billDatenumber (int64)

The date on which bill is generated

billDetailsarray of BillDetail (object)

idstring

uuid of the billDetail.

tenantIdstring

tenantId of the billDetail.

demandIdstring

The id of the corresponding demand .

billIdstring

The id of the parent bill.

amountnumber (double)

Amount to be paid for the bill detail.

amountPaidnumber (double)

Amount paid by the citizen.

fromPeriodnumber (int64)

start date of the taxperiod

toPeriodnumber (int64)

end date of the taxperiod

receiptDatestring (date)

Receipt Date.

receiptTypeany

Type of Receipt.

channelstring

To be used by third party applications, to send the channel name.

voucherHeaderany

Voucher header need to refer from Finanicals.

boundaryany

Boundary need to refer from Core services.

manualReceiptNumberstring

Manual Receipt Number for legacy reciepts.

manualReceiptDatenumber

Manual Receipt date for legacy reciepts.

collectionTypestring

collectionType of the payment.

billDescriptionstring

Description of the bill.

expiryDatenumber (int64)

Expiry date in epoch

displayMessagestring

cancellationRemarksstring

Remarks related to cancellation of payment

billAccountDetailsarray of BillAccountDetail (object)

idstring

uuid of the billAccountDetail.

tenantIdstring

tenantId of the billAccountDetail.

billDetailIdstring

uuid of the parent billDetail.

demandDetailIdstring

uuid of the demand for which the parent billDetail is created.

orderinteger

Priority of the account detail.

amountnumber (double)

Amount to be paid for the bill account detail

adjustedAmountnumber (double)

The amount paid against the bill account detail

taxHeadCodestring

The taxHeadCode of the bill account detail

additionalDetailsobject

Additional fields can be captured in this object as map

purposeenum

purpose of the bill account detail.

ARREARCURRENTADVANCEEXEMPTIONARREAR_LATEPAYMENT_CHARGESCURRENT_LATEPAYMENT_CHARGESCHEQUE_BOUNCE_PENALTYREBATEOTHERS

additionalDetailsinteger

Any additional fields can be captured here as a map

paidBy*string (varchar)

The person who is paying the bill

mobileNumber*string (varchar)

The mobileNumber of person who is paying

payerNamestring (varchar)

The owner of the bill

payerAddressstring (varchar)

The address of the owner of the bill

payerEmailstring (varchar)

The email id of the owner of the bill

payerIdstring (varchar)

The system user id of the owner of the bill

paymentStatusenum

Unique id of tenant.

NEWDEPOSITEDCANCELLEDDISHONOUREDRECONCILED

Request

Response

const response = await fetch('/payments/_workflow', {
    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-07",
              "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/_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-07",
              "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/_validate', {
    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-07",
              "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"
  }
}