Update Invoice Status
Push a payment status update for an existing IRN.
Endpoint
POST /api/v1/nrs/update/{irn}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
irn | string | Invoice 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
| Code | Description |
|---|---|
| 200 | Status update completed |
| 400 | Validation or upstream request error |
| 422 | Validation error |
| 500 | Local 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
irnmust reference an existing invoice.payment_statusshould 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.