Skip to main content

Update Invoice Status

Push a payment status update for an existing IRN.

Endpoint

POST /api/v1/nrs/update/{irn}

Path Parameters

ParameterTypeDescription
irnstringInvoice Reference Number to update.

Request Body

{
"payment_status": "PAID"
}

Response

{
"endpoint": "string",
"status_code": 0,
"ok": true,
"timestamp": "string",
"attempts": 1,
"retried": false,
"request_payload": {
"additionalProp1": {}
},
"response_body": "string"
}

Status Codes

CodeDescription
200Status update completed
400Validation or upstream request error
422Validation error
500Local proxy failure

Validation Error Example

{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string",
"input": "string",
"ctx": {}
}
]
}

Server Error Example

{
"endpoint": "string",
"status_code": 0,
"ok": false,
"error": "string"
}

Notes

  • irn must reference an existing invoice.
  • payment_status should contain a valid invoice payment state.
  • The update request is forwarded upstream to eTranzact.
  • Validation errors are returned if the IRN or status is invalid.