Update Invoice (Optional)

base_url: https://firseinvoice.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

Request Parameters

Parameter	Type	Description	Required?
payment_status	string	Invoice payment status. Where: 0 = REJECTED 1 = PENDING 2=PAID	Yes
reference	string	Payment reference or 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

Request Parameters

POST {base_url}/api/v1/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",
    "reference": "Paid in full after 3 days of issue"
   }
'

Sample Response

Sample Success Response

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

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