Skip to main content
GET
List cardholders

Overview

Returns a paginated list of cardholders for your business, scoped to the API key’s environment (LIVE or SANDBOX). Supports filtering by status and free-text search.

Query Parameters

Example

Success Response (200)

Call GET /cardholders/{id} for the full profile including address, date of birth, nationality, and metadata.

Iterating All Pages

Node.js — iterate all pages

Error Codes

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
status
enum<string>
Available options:
ACTIVE,
SUSPENDED,
TERMINATED
programId
string
Maximum string length: 100

Response

Cardholders retrieved

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Cardholders retrieved"

data
object[]
pagination
object
meta
object