Update Invoice

post

https://sandbox.api.phicommerce.com/pg/portal/pay/paymentInvoiceService

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API can be used to update the invoice that is created in Phicommerce system, you can also use this API to mark the invoice paid if invoice is paid outside of PhiCommerce system order

📘
To update the parameter of the invoice , you need to set the invoice status as 'O'. You can update the below parameter

Parameter to update
dueDate
additionalFee
desc

Parameter to update
dueDate
additionalFee
desc

❗️
1.For change of amount, merchant should close the old invoice and raise a new one.
2.This invoice cannot be updated if invoice is Paid/Closed/Cancelled/Refunded invoice.

📘
For details on Invoice Update please click on below link
Invoice Update

Body Params

merchantId

string

required

Defaults to I_00001

MerchantID used to do transaction, use default

aggregatorId

string

use this parameter if you want to integrate as aggregator,If aggregator is attached to your MID then Passing this value is mandatory, Please change MID to I_00002 if you have aggregator attached and use Aggregator ID as A_00001 in request

userID

string

Unique Identifier of the user, If sent it should be same as sent in original
request

invoiceNo

string

required

Invoice number for the merchant for the payment request

invoiceStatus

string

required

If the invoice is paid by any other channel then the same can be updated by using status as Paid.
For updating the dueDate/additionalFeesend invoiceStatus as O,This status cannot
be used to reopen a Paid/Closed/Cancelled /Refunded invoice.
You can Pass "P" to mark Paid and O to change/update parameter

desc

string

Invoice Description- You can update this in case Invoice Status id Passed as "O"

dueDate

string

The status has to be open at PayPhi Server for the request to succeed. You can update this in case Invoice Status id Passed as "O". Can be changed only before the dueDate.

additionalFee

string

Additional fee that need to be charged, Can be used to charge penalty/late fees ,You can update this in case Invoice Status id Passed as "O"

secureHash

string

required

Click to generate the Hash, Hash will be calculated and copied , This is used to authenticate the request coming into Phicommerce PG

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Update Invoice

What’s Next

What’s Next

200

What’s Next

What’s Next