Confirm Invoice (Optional)
base_url: https://firseinvoicedemo.etranzactng.com
Description: This endpoint fetched the details of an invoice using the IRN as the unique identifier. During invoice exchange/transmission it can also be used to find out the status of the transmission and delivery status of the invoice.
- Sample Request
- Sample Response
Request Parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
| irn | string | A unique tracking number assigned to each Yes invoice. | Yes |
Response Parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
| status | integer | HTTP status code | Yes |
| message | string | Description of http status code | Yes |
| data | object | A nested data object containing the primary details or payload of the response. | Yes |
| issue_date | date | The issued date of the invoice | Yes |
| due_date | date | The due date of the invoice | Yes |
| sync_date | date | The sync date of the invoice | Yes |
| payment_status | integer | Invoice payment status. Where: 0 = REJECTED 1 = PENDING 2=PAID | Yes |
| transmitted | Boolean | The transmission status | Yes |
| delivered | Boolean | The delivery status | 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
- Sample Response
Request Parameters
GET {base_url}app/invoice/confirm/INV285-47AT78FN-20250417
curl `{base_url}app/invoice/confirm/INV285-47AT78FN-20250417`
-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"
'
Sample Success Response
GET {base_url}app/invoice/confirm/INV285-47AT78FN-20250417
{
"status": 200,
"message": "Invoice confirmed successfully",
"data": {
"transmitted": true,
"delivered": true,
"issue_date": "2025-03-24",
"due_date": "2025-03-30",
"sync_date": "2025-04-02",
"payment_status": "PENDING"
},
"execTime": 1.234568,
"error": ""
}