GET

List capabilities

ENDPOINT/v1/capabilities

Returns the platform capability catalogue: every service that can be enabled on a product, grouped by category. Not program-scoped; the catalogue is the same for every program. Use the ids with POST /v1/programs/{program_id}/products/{product_id}/capabilities.

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
category	string	OPTIONAL	Return only capabilities in this category. Allowed:`PAYINPAYOUTVAULTINGINSTRUMENTCHECKOUTLENDINGCURRENCYNETWORK`
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

200List capabilities.

application/json

{
  "data": [
    {
      "id": "cap-payin-ach",
      "object": "capability",
      "category": "PAYIN",
      "name": "ACH payin",
      "description": "Receive funds into a financial account by ACH."
    },
    {
      "id": "cap-payout-ach",
      "object": "capability",
      "category": "PAYOUT",
      "name": "ACH payout",
      "description": "Send funds from a financial account by ACH."
    },
    {
      "id": "cap-payout-rtp",
      "object": "capability",
      "category": "PAYOUT",
      "name": "RTP payout",
      "description": "Send funds from a financial account over the RTP network."
    },
    {
      "id": "cap-vault-credit",
      "object": "capability",
      "category": "VAULTING",
      "name": "Credit account",
      "description": "Hold a credit receivable that backs card spend."
    },
    {
      "id": "cap-inst-virtual-card",
      "object": "capability",
      "category": "INSTRUMENT",
      "name": "Virtual card",
      "description": "Issue virtual cards on the product."
    },
    {
      "id": "cap-inst-physical-card",
      "object": "capability",
      "category": "INSTRUMENT",
      "name": "Physical card",
      "description": "Issue and ship physical cards on the product."
    },
    {
      "id": "cap-net-visa",
      "object": "capability",
      "category": "NETWORK",
      "name": "Visa",
      "description": "Issue and settle on the Visa network."
    }
  ],
  "total_count": 7
}

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