GET

Retrieve an authorization-rule report

ENDPOINT/v1/authorization-rules/{authorization_rule_id}/report

Returns daily approved and declined counts for the current version and, when present, the draft version. begin and end are UTC calendar days, inclusive. 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
authorization_rule_id	string	REQUIRED	Unique identifier of the authorization rule.

Query Parameters

Parameter	Type	Requirement	Description
begin	string(date)	REQUIRED	First calendar day of the report (inclusive), UTC.
end	string(date)	REQUIRED	Last calendar day of the report (inclusive), UTC. Must be on or after `begin`.

Response Codes & Schemas

200Daily approved and declined counts for the window.

application/json

{
  "object": "authorization_rule_report",
  "authorization_rule_id": "8e4c1a92-2f70-4c45-9b3d-0a1e6f7c8290",
  "begin": "2026-08-01",
  "end": "2026-08-03",
  "days": [
    {
      "date": "2026-08-01",
      "current_version": {
        "approved": 412,
        "declined": 18
      },
      "draft_version": null
    },
    {
      "date": "2026-08-02",
      "current_version": {
        "approved": 388,
        "declined": 22
      },
      "draft_version": {
        "approved": 401,
        "declined": 9
      }
    },
    {
      "date": "2026-08-03",
      "current_version": {
        "approved": 430,
        "declined": 15
      },
      "draft_version": {
        "approved": 441,
        "declined": 4
      }
    }
  ]
}

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