v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Invoice update

post/{base URL}

Path parameters

base URL'tsp/pg/portal/pay/paymentInvoiceService' required

Request body

merchantId string required

Merchant account ID. SIze-12

aggregatorIdstring

Aggregator account ID. Required if request is initiated from aggregator. SIze-12

userIDstring

Unique Identifier of the user. If sent it should be the same as sent in the original request. SIze-24

invoiceNostring required

Unique Ref/Invoice number for the payment request. Should be the same as sent in original request. SIze-32

invoiceStatusstring required

C – Close/Cancel P – Paid O – Open ERP system can send update to either close/cancel an invoice. If the invoice is paid by any other channel then the same can be updated by using status as Paid.

Close – Can be used only when the invoice is fully open (not fully or partly paid). For updating the dueDate/additionalFee send invoiceStatus as O. This status cannot be used to reopen a Paid/Closed/Cancelled /Refunded invoice.

SIze-1

descstring

Description / remarks. SIze-48

dueDatestring

Due Date. DD/MM/YYYY Can be changed only before the dueDate. SIze-10

additionalFeenumber

Additional fee that need to be charged. Can be used to charge penalty/late fees

secureHashstring required

Hash value. SIze-64

Response

responseCodestring required

Response code indicating success/failure 0000 – Success, Any other value failure Size- 4

respDescriptionstring required

Description of failure. Ignore for success response. Size- 45

merchantIdstring

Merchant account ID. Echo of request field

aggregagtorIdstring

Aggregator account ID. Echo of request field

invoiceNostring

Merchant Txn ref Number. Echo of request field

userIDstring

Echo of request field

txnIDstring

The unique ref number generated by the PG. Size- 24

secureHashstring required

Hash value. Size- 64