GET
List events
ENDPOINT/v1/events
Returns the durable event log for the program, newest first. Filter
by event_types and with_content. Use this log to catch up when a
webhook delivery was delayed or missed. This operation is
program-scoped.
Authentication & Headers
| Header | Type | Requirement | Description |
|---|---|---|---|
| Authorization | string | REQUIRED | API key passed as an HTTP Bearer token: Bearer rk_live_... |
| X-Program-ID | UUID | PROGRAM-SCOPED | Program boundary UUID that scopes the issuing card, wallet, or transfer. |
Query Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| event_types | array | OPTIONAL | Return only events whose `type` is in this list. Repeat the parameter
to filter on several types. Omit to return every type.
|
| with_content | boolean | OPTIONAL | When true (the default), each listed event includes `payload`. When
false, list items omit `payload` so pages stay small while you scan
the log. Retrieve and webhook deliveries always include `payload`.
|
| page | integer | OPTIONAL | 1-based page index. Default 1. Values below 1 are treated as 1.
|
| page_size | integer | OPTIONAL | Number of objects to return in the page. Minimum 1, maximum 100, default
10. Also accepted as `page-size`. Values below 1 fall back to the default;
values above 100 are capped at 100.
|
| order_by | string | OPTIONAL | Field to sort by. When omitted, the endpoint uses its default order.
Also accepted as `order-by`. Valid fields are endpoint-specific
(`created_at`, `updated_at`, …).
|
| ascending | boolean | OPTIONAL | Sort direction. Default true (ascending). Pass `false` for descending.
Invalid values are ignored and the default is used.
|
Response Codes & Schemas
200A page of events.
application/json{
"data": [
{
"id": "0c5e8024-6f91-4353-e72b-30412f5d6807",
"object": "event",
"type": "card.created",
"payload": {
"id": "0c4e8f16-2a7b-4d93-b5e1-8f3a6c9d0142",
"object": "card",
"wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
"wallet_entity_id": "2e9c4b71-8a5d-4f03-b6e2-1c7d9a0f3e58",
"program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
"card_art_id": "8f2b1c40-0c1a-4b7e-9a3d-6d5f2e1a7b90",
"state": "OPEN",
"form_factor": "VIRTUAL",
"last_four": "4242",
"exp_month": 8,
"exp_year": 2029,
"network": "VISA",
"spend_limit": {
"amount": 250000,
"currency": "USD"
},
"memo": "Primary virtual",
"shipping": null,
"replacement_for_card_id": null,
"digital_wallet_tokens": 1,
"created_at": "2026-08-12T10:30:00Z",
"updated_at": "2026-08-12T10:30:00Z"
},
"created_at": "2026-08-12T10:30:00Z",
"updated_at": "2026-08-12T10:30:00Z"
},
{
"id": "6e1a4c80-2b5d-4f19-a3e7-9c0d8b1f2463",
"object": "event",
"type": "wallet.created",
"payload": {
"id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
"object": "wallet",
"kind": "CUSTOMER",
"status": "ACTIVE",
"state_reason": null,
"wallet_entity_id": "2e9c4b71-8a5d-4f03-b6e2-1c7d9a0f3e58",
"program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
"application_id": "6a0d5e28-1f4b-4c79-a3d6-8e2b9c7f0154",
"financial_account_ids": [
"9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14"
],
"credit_limit": {
"amount": 500000,
"currency": "USD"
},
"available_credit": {
"amount": 375000,
"currency": "USD"
},
"current_balance": {
"amount": 125000,
"currency": "USD"
},
"delinquency": {
"state": "CURRENT",
"days_past_due": 0,
"amount_past_due": {
"amount": 0,
"currency": "USD"
}
},
"statement_summary": {
"last_statement_date": "2026-08-15",
"last_statement_balance": {
"amount": 125000,
"currency": "USD"
},
"next_statement_date": "2026-09-15",
"payment_due_date": "2026-09-10",
"minimum_payment_due": {
"amount": 3500,
"currency": "USD"
}
},
"created_at": "2026-08-12T10:15:00Z",
"updated_at": "2026-08-27T15:04:05Z"
},
"created_at": "2026-08-12T10:15:00Z",
"updated_at": "2026-08-12T10:15:00Z"
}
],
"total_count": 12
}400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "invalid order by: foo. Valid options are: [created_at updated_at]",
"param": "order_by",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/invalid_request"
}
}401Unauthorized: missing, malformed, or unknown API key.
application/json{
"error": {
"type": "authentication_error",
"code": "authentication_error",
"message": "A valid API key is required.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/authentication_error"
}
}403Forbidden: the API key is denied by RBAC, or it cannot access this
program. A resource that exists on another program or organization
returns `404 not_found`, not `403`.
application/json{
"error": {
"type": "permission_error",
"code": "permission_denied",
"message": "The API key cannot access this program.",
"param": "X-Program-ID",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/permission_denied"
}
}404Not Found: unknown id, or the resource is not visible to this API key.
application/json{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "No card found for the given id.",
"param": "card_id",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/not_found"
}
}429Too Many Requests: the API key exceeded its rate limit.
application/json{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/rate_limited"
}
}500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/internal_error"
}
}