{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/event-deliveries","version":"1.0.0","description":"Webhook delivery status for a page of credit events"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/event-deliveries":{"get":{"tags":["credit"],"summary":"Webhook delivery status for a page of credit events","description":"Takes the same parameters as `GET /credit/events` and returns, for each event on that page, whether it reached the partner's webhook endpoints: delivered, pending (sent once its transaction commits), retrying, failed, not_subscribed, or not_pushed (a polling program).","operationId":"list_credit_event_deliveries","parameters":[{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Events after this sequence number, as on the feed.","title":"After"},"description":"Events after this sequence number, as on the feed."},{"name":"event_types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated event types to include.","title":"Event Types"},"description":"Comma-separated event types to include."},{"name":"credit_line_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id"}},{"name":"program_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"}},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"asc (default) pages forward with `after`; desc returns the latest events newest first and pages older with `before`.","default":"asc","title":"Order"},"description":"asc (default) pages forward with `after`; desc returns the latest events newest first and pages older with `before`."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"With order=desc: events below this sequence number.","title":"Before"},"description":"With order=desc: events below this sequence number."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditEventDeliveryStatusPage_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_credit_event_deliveries_api_v1_credit_event_deliveries_get"}}},"components":{"schemas":{"CreditEventDeliveryStatusPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CreditEventDeliverySummary"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Cursor"},"has_next":{"type":"boolean","title":"Has Next","default":false},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["limit"],"title":"CreditEventDeliveryStatusPage","description":"Delivery status for the same page of events ``GET /credit/events``\nreturns for the same parameters."},"CreditEventDeliverySummary":{"properties":{"event_id":{"type":"string","title":"Event Id"},"sequence_no":{"type":"integer","title":"Sequence No"},"event_type":{"type":"string","title":"Event Type"},"status":{"type":"string","enum":["delivered","pending","retrying","failed","not_subscribed","not_pushed"],"title":"Status","description":"`delivered`: every endpoint it went to answered 2xx (on the first attempt, a retry, or a redelivery). `pending`: the first attempt has not been made yet, or is being made; it goes out about a second after the event's transaction commits. `retrying`: an endpoint has not answered 2xx yet and a retry is queued or being sent. `failed`: an endpoint gave up — redeliver it. `not_subscribed`: the program pushes, but no active endpoint subscribes to this event. `not_pushed`: nothing was attempted (a polling program)."},"endpoint_count":{"type":"integer","title":"Endpoint Count","description":"Endpoints a delivery was made to.","default":0},"last_attempt_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Attempt At"},"last_response_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Response Code"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"next_retry_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Retry At","description":"The earliest queued retry, while one is queued."},"redeliverable":{"items":{"$ref":"#/components/schemas/RedeliverableDelivery"},"type":"array","title":"Redeliverable","description":"The latest failed delivery per endpoint that gave up."}},"type":"object","required":["event_id","sequence_no","event_type","status"],"title":"CreditEventDeliverySummary","description":"How one credit event's push went, across every endpoint it went to."},"RedeliverableDelivery":{"properties":{"endpoint_id":{"type":"string","title":"Endpoint Id"},"delivery_id":{"type":"string","title":"Delivery Id"}},"type":"object","required":["endpoint_id","delivery_id"],"title":"RedeliverableDelivery","description":"A failed delivery to one endpoint, ready to re-send with\n``POST /webhooks/o2c/{endpoint_id}/deliveries/{delivery_id}/redeliver``."},"SuccessEnvelope_CreditEventDeliveryStatusPage_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/CreditEventDeliveryStatusPage"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditEventDeliveryStatusPage]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}