Update Invoice (Optional)

base_url: https://firseinvoicedemo.etranzactng.com

Description: This endpoint updates an invoice using the invoice reference number as the unique identifier.

NB: It is only called when an invoice status changes.

Sample Request (PAID / REJECTED)

Request Parameters

Parameter	Type	Description	Required?
payment_status	string	Invoice payment status. Acceptable values: PAID or REJECTED	Yes

Sample Request (PARTIAL)

Request Parameters

Parameter	Type	Description	Required?
payment_status	string	Invoice payment status. Acceptable value: PARTIAL	Yes
amount	double	Amount that is to be partially paid	Yes
reference	string	payment reference / note	No

Sample Response

Response Parameters

Parameter	Type	Description	Required?
status	integer	HTTP status code	Yes
message	string	Description of http status code	Yes
execTime	integer	Time taken to process request (for metrics and performance tracking)	Yes
error	integer	Specific errors when request does not return a HTTP status of 200	No

Sample Request (PAID / REJECTED)

Request Parameters

POST {base_url}/api/v3/app/invoice/update/{irn}

curl -X PATCH
  -H "X-API-Key: {{CLIENT_API_KEY}}"
  -H "X-API-Signature: {{HMAC_SHA256_SIGNATURE}}"
  -H "X-API-Timestamp: {{ISO_20022_TIMESTAMP}}"
  -H "Content-Type: application/json"
  -d '{
    "payment_status": "PAID",
   }
'

Sample Request (PARTIAL)

Request Parameters

POST {base_url}/api/v3/app/invoice/update/{irn}

curl -X PATCH
  -H "X-API-Key: {{CLIENT_API_KEY}}"
  -H "X-API-Signature: {{HMAC_SHA256_SIGNATURE}}"
  -H "X-API-Timestamp: {{ISO_20022_TIMESTAMP}}"
  -H "Content-Type: application/json"
  -d '{
    "payment_status": "PARTIAL",
    "amount": "50000" ,
    "reference": "This is an initial payment for total amount of 200,000. Balance is to be paid within a week"
   }
'

Sample Response

Sample Success Response

PATCH {base_url}/api/v3/app/invoice/update/{irn}

{
  "status": 200,
  "message": "Invoice updated successfully",
  "execTime": 1.234568,
  "error": ""
}