GET

List settlement details

ENDPOINT/v1/reports/settlement/details

Returns per-institution, per-program net settlement totals, newest first. Filter by report date, card network, and settlement institution. Each row breaks out gross settled volume, interchange, fees, disputes, other adjustments, and net. 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
report_date	string(date)	OPTIONAL	Return only rows whose settlement business date equals this calendar day.
network	string	OPTIONAL	Return only rows for this card network. Allowed:`VISAMASTERCARD`
settlement_institution_id	string(uuid)	OPTIONAL	Return only rows for this settlement institution.
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 settlement detail rows.

application/json

{
  "data": [
    {
      "id": "6c1e4a82-9f3b-4d17-a8c5-2e0d7b6f4519",
      "object": "settlement_detail",
      "report_date": "2026-08-26",
      "network": "VISA",
      "settlement_institution_id": "1f6b8d20-4e9c-4a73-b2d5-8c0a7e3f1954",
      "program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "amounts": {
        "gross_settled": {
          "amount": 10000000,
          "currency": "USD"
        },
        "interchange": {
          "amount": 150000,
          "currency": "USD"
        },
        "fees": {
          "amount": 10000,
          "currency": "USD"
        },
        "disputes": {
          "amount": 5000,
          "currency": "USD"
        },
        "other": {
          "amount": 0,
          "currency": "USD"
        },
        "net": {
          "amount": 10135000,
          "currency": "USD"
        }
      },
      "created_at": "2026-08-27T05:05:00Z",
      "updated_at": "2026-08-27T05:05: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"
  }
}