Retrieves the payment events (lifecycle milestones) for a specific bill
Use this endpoint to see the payment history of a bill: when it was submitted for payment,
cleared, rejected, etc. Returns events in chronological order.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| billId | Unique numeric identifier of the bill | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
BillPaymentEventResponseV202504
| Property | Description | Type |
|---|---|---|
| createdDate | The date and time of the bill payment event | string (date-time) |
| paymentEventId | The identifier of the payment event | integer (int32) |
| paymentEventType | The payment type of the event. For example, paymentGroup.approved, payment.open, payment.returned | string |
| webhookPayload | An object representing the JSON received by the web hook | object |
Example Response
[
{ "createdDate": "2026-06-29", "paymentEventId": 1, "paymentEventType": "string", "webhookPayload": {}
}
]