ROOKDocs
GET

List network programs

ENDPOINT/v1/network-programs

Returns the network programs of the program, newest first. A network program is the program's registration with one card network (Visa or Mastercard) and supplies BIN ranges, settlement currency, and network-assigned registration identifiers. A program that issues on more than one network has one network program per network. Filter by network to find the registration a product should reference.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.

Query Parameters

ParameterTypeRequirementDescription
networkstringOPTIONAL
Return only the network program registered with this card network.
Allowed:VISAMASTERCARD
pageintegerOPTIONAL
1-based page index. Default 1. Values below 1 are treated as 1.
page_sizeintegerOPTIONAL
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_bystringOPTIONAL
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`, …).
ascendingbooleanOPTIONAL
Sort direction. Default true (ascending). Pass `false` for descending. Invalid values are ignored and the default is used.

Response Codes & Schemas

200A page of network programs.
application/json
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "network_program",
      "program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Rook Consumer Credit Visa",
      "network": "VISA",
      "bin_ranges": [
        {
          "start": "424242",
          "end": "424242"
        },
        {
          "start": "41111100",
          "end": "41111199"
        }
      ],
      "settlement_currency": "USD",
      "program_registration_ids": {
        "ica": "99999",
        "bid": "10054321",
        "member_id": "554433"
      },
      "created_at": "2026-08-01T12:00:00Z",
      "updated_at": "2026-08-27T15:04:05Z"
    },
    {
      "id": "4c9a1e30-77b2-4f16-9d21-0b8c5a3e7f11",
      "object": "network_program",
      "program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Rook Commercial Mastercard",
      "network": "MASTERCARD",
      "bin_ranges": [
        {
          "start": "545454",
          "end": "545454"
        }
      ],
      "settlement_currency": "USD",
      "program_registration_ids": {
        "ica": "88888",
        "member_id": "112233"
      },
      "created_at": "2026-07-01T08:00:00Z",
      "updated_at": "2026-08-15T11:45: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"
  }
}