GET
List funding events
ENDPOINT/v1/funding-events
Returns collections from program funding financial accounts that cover network settlement, newest first. Filter by status, network, and financial account. Each event includes settled gross, fees, net, and status. 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 |
|---|---|---|---|
| status | string | OPTIONAL | Return only funding events in this lifecycle status.
Allowed: PENDINGIN_TRANSITSETTLEDFAILED |
| network | string | OPTIONAL | Return only funding events for this card network.
Allowed: VISAMASTERCARD |
| financial_account_id | string(uuid) | OPTIONAL | Return only funding events that debit this program funding financial account.
|
| 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 funding events.
application/json{
"data": [
{
"id": "9a3e6c14-2b8d-4f51-a7e0-5c1d8f4b3062",
"object": "funding_event",
"financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056",
"network": "VISA",
"report_date": "2026-08-26",
"settled_gross": {
"amount": 10000000,
"currency": "USD"
},
"fees": {
"amount": 10000,
"currency": "USD"
},
"net": {
"amount": 9990000,
"currency": "USD"
},
"status": "SETTLED",
"created_at": "2026-08-27T05:10:00Z",
"updated_at": "2026-08-27T05:15:00Z"
}
],
"total_count": 1
}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"
}
}