GET

List prime rates

ENDPOINT/v1/credit-products/{credit_product_id}/prime-rates

Returns prime index rates for the credit product, newest effective_date first. The rate in force on a calendar day is the entry with the latest effective_date on or before that day. Rate values are decimal strings of basis points, never JSON numbers. 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
credit_product_id	string	REQUIRED	Unique identifier of the credit product. Same value as the Product `id` whose credit terms these operations configure.

Query Parameters

Parameter	Type	Requirement	Description
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 prime rates for the credit product.

application/json

{
  "data": [
    {
      "id": "2b6e4d18-9c7a-4f31-a8e5-1d3c6b9f0247",
      "object": "prime_rate",
      "credit_product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
      "effective_date": "2026-07-01",
      "rate": "850.0000",
      "created_at": "2026-06-15T18:00:00Z",
      "updated_at": "2026-06-15T18:00:00Z"
    },
    {
      "id": "9a3c7e41-0d8f-4b26-c5a1-6e2d9f4b1580",
      "object": "prime_rate",
      "credit_product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
      "effective_date": "2026-01-01",
      "rate": "775.0000",
      "created_at": "2025-12-15T18:00:00Z",
      "updated_at": "2025-12-15T18:00:00Z"
    }
  ],
  "total_count": 2
}

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