Skip to main content
GET
/
cardholders
List cardholders
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/cardholders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Cardholders retrieved",
  "data": [
    {
      "cardholderId": "chl_01HXYZ1234ABCDEF5678",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@example.com",
      "phone": "+12025551234",
      "status": "ACTIVE",
      "kycStatus": "APPROVED",
      "externalId": "usr_123456",
      "totalCards": 2,
      "createdAt": "2026-05-01T09:00:00Z"
    }
  ],
  "pagination": {
    "total": 47,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-22T15:00:00Z"
  }
}

​
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

ParameterTypeDefaultDescription
limitinteger20Results per page (max 100)
offsetinteger0Number of records to skip
statusstring—Filter by ACTIVE, SUSPENDED, or TERMINATED
programIdstring—Filter to a specific program
searchstring—Search name, email, or externalId (max 100 chars)

​
Example

curl -G https://api.fyatu.com/api/v3.20/cardholders \
  -H "Authorization: Bearer $FYATU_API_KEY" \
  -d limit=20 \
  -d offset=0 \
  -d status=ACTIVE

​
Success Response (200)

{
  "success": true,
  "status": 200,
  "message": "Cardholders retrieved",
  "data": [
    {
      "cardholderId": "chl_01HXYZ1234ABCDEF5678",
      "programId":    "prg_01HXYZ9876ABCDEF0000",
      "firstName":    "John",
      "lastName":     "Smith",
      "email":        "john.smith@example.com",
      "phone":        "+12025551234",
      "status":       "ACTIVE",
      "kycStatus":    "APPROVED",
      "kycVerifiedAt": "2026-05-01T09:05:00Z",
      "totalCards":   2,
      "totalSpendCents": 125000,
      "suspendedAt":  null,
      "createdAt":    "2026-05-01T09:00:00Z",
      "updatedAt":    "2026-05-01T09:05:00Z"
    }
  ],
  "pagination": {
    "total":   47,
    "limit":   20,
    "offset":  0,
    "hasMore": true
  },
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-22T10:00:00Z"
  }
}
Call GET /cardholders/{id} for the full profile including address, date of birth, nationality, and metadata.

​
Iterating All Pages

Node.js — iterate all pages
async function* listAllCardholders(apiKey) {
  let offset = 0;
  const limit = 100;

  while (true) {
    const resp = await fetch(
      `https://api.fyatu.com/api/v3.20/cardholders?limit=${limit}&offset=${offset}`,
      { headers: { 'Authorization': `Bearer ${apiKey}` } }
    );
    const body = await resp.json();
    yield* body.data;

    if (!body.pagination.hasMore) break;
    offset += limit;
  }
}

for await (const ch of listAllCardholders(process.env.FYATU_API_KEY)) {
  console.log(ch.cardholderId, ch.kycStatus);
}

​
Error Codes

CodeHTTPCause
VALIDATION_ERROR422Invalid status value or search exceeds 100 characters
INSUFFICIENT_SCOPE403Key lacks cardholders:read scope
INTERNAL_ERROR500Server error

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
​
search
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