GET
List tokenizations
ENDPOINT/v1/tokenizations
Returns network tokens in the program, newest first. Filter by card, issuing wallet, lifecycle status, and digital wallet. Token objects include last_four and DPAN last four, never PAN or CVV. 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. |
Query Parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
| card_id | string(uuid) | OPTIONAL | Return only tokenizations that belong to this card.
|
| wallet_id | string(uuid) | OPTIONAL | Return only tokenizations whose card belongs to this issuing wallet.
|
| status | string | OPTIONAL | Return only tokenizations in this lifecycle status.
Allowed: ACTIVEPAUSEDDEACTIVATEDPENDING_ACTIVATIONPENDING_2FAINACTIVE |
| wallet | string | OPTIONAL | Return only tokenizations for this digital wallet.
Allowed: APPLE_PAYGOOGLE_PAYSAMSUNG_PAY |
| 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 tokenizations.
application/json{
"data": [
{
"id": "3a8c1e40-6b2d-4f15-9c7a-2e5d0b8f1734",
"object": "tokenization",
"card_id": "0c4e8f16-2a7b-4d93-b5e1-8f3a6c9d0142",
"wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
"network": "VISA",
"token_requestor_name": "APPLE_PAY",
"status": "ACTIVE",
"device": {
"device_id": "device_iphone_14_jane",
"device_name": "Jane's iPhone",
"device_type": "MOBILE_PHONE"
},
"last_four": "9012",
"dpan": {
"last_four": "5510"
},
"digital_card_art_id": "5e7a3c19-8d4f-4b02-9a6e-1c8d0f5b3728",
"events": [
{
"type": "TOKEN_CREATED",
"channel": null,
"result": null,
"created_at": "2026-08-12T11:00:00Z"
},
{
"type": "DECISION",
"channel": null,
"result": "APPROVED",
"created_at": "2026-08-12T11:00:01Z"
},
{
"type": "ACTIVATED",
"channel": null,
"result": null,
"created_at": "2026-08-12T11:00:05Z"
}
],
"created_at": "2026-08-12T11:00:00Z",
"updated_at": "2026-08-18T09:12:00Z"
}
],
"total_count": 1
}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"
}
}