POST
Enable a capability on a product
ENDPOINT/v1/programs/{program_id}/products/{product_id}/capabilities
Enables a capability from the catalogue on this product within the given
jurisdictions, optionally with a reserve requirement. Enabling a
money-movement capability with a reserve requirement expects a
RESERVE financial account on the program wallet with reserve_for
equal to capability_id. Send Idempotency-Key so retries return the
original result.
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. |
| Content-Type | string | REQUIRED | Must be application/json. |
| Idempotency-Key | string | OPTIONAL | Unique UUID to prevent duplicate execution of financial creations or mutations. |
Path Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| program_id | string | REQUIRED | Unique identifier of the program. |
| product_id | string | REQUIRED | Unique identifier of the product. |
Request Body Schema
application/jsoncapability_idstring
REQUIREDCapability to enable.
jurisdictionsarray
REQUIREDJurisdiction ids the capability operates in.
reserve_requirement_bpsintegernull
optionalReserve requirement in basis points of volume. Omit for none.
enabledboolean
optionalSet false to enable in a paused state.
Response Codes & Schemas
201The enabled product capability.
application/json{
"id": "5a8c2e71-3d94-4f06-b1e7-9c0d4a6f2b58",
"object": "product_capability",
"product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
"capability_id": "cap-payin-ach",
"category": "PAYIN",
"jurisdictions": [
"US"
],
"reserve_requirement_bps": 250,
"enabled": true,
"created_at": "2026-08-10T14:25:00Z",
"updated_at": "2026-08-10T14:25: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"
}
}409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json{
"error": {
"type": "conflict_error",
"code": "conflict",
"message": "The card cannot be reissued from its current state.",
"param": null,
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/conflict"
}
}422Unprocessable Entity: the document is valid JSON but violates a business rule.
application/json{
"error": {
"type": "invalid_request_error",
"code": "insufficient_funds",
"message": "The source financial account does not have enough available balance.",
"param": "amount",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
}
}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"
}
}