GET

Retrieve funding event details

ENDPOINT/v1/funding-events/{funding_event_id}/details

Returns the funding event together with settlement_breakdown, the per-cycle amounts collected from the program funding financial account by network. Totals match settled_gross, fees, net, and status on the parent event. 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.

Path Parameters

Parameter	Type	Requirement	Description
funding_event_id	string	REQUIRED	Unique identifier of the funding event.

Response Codes & Schemas

200The funding event with settlement breakdown.

application/json

{
  "id": "9a3e6c14-2b8d-4f51-a7e0-5c1d8f4b3062",
  "object": "funding_event_details",
  "financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056",
  "network": "VISA",
  "report_date": "2026-08-26",
  "settlement_breakdown": [
    {
      "network": "VISA",
      "report_date": "2026-08-26",
      "cycle": "001",
      "gross_settled": {
        "amount": 10000000,
        "currency": "USD"
      },
      "fees": {
        "amount": 10000,
        "currency": "USD"
      },
      "net": {
        "amount": 9990000,
        "currency": "USD"
      }
    }
  ],
  "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"
}

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"
  }
}