List cardholders
curl --request GET \
--url https://api.fyatu.com/api/v3.20/cardholders \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3.20/cardholders"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3.20/cardholders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fyatu.com/api/v3.20/cardholders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fyatu.com/api/v3.20/cardholders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fyatu.com/api/v3.20/cardholders")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3.20/cardholders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}Cardholders
List Cardholders
Retrieve a paginated list of cardholders for your business. GET /cardholders. Requires cardholders:read scope.
GET
/
cardholders
List cardholders
curl --request GET \
--url https://api.fyatu.com/api/v3.20/cardholders \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3.20/cardholders"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fyatu.com/api/v3.20/cardholders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fyatu.com/api/v3.20/cardholders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fyatu.com/api/v3.20/cardholders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fyatu.com/api/v3.20/cardholders")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3.20/cardholders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 20 | Results per page (max 100) |
offset | integer | 0 | Number of records to skip |
status | string | — | Filter by ACTIVE, SUSPENDED, or TERMINATED |
programId | string | — | Filter to a specific program |
search | string | — | 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
const params = new URLSearchParams({ limit: '20', offset: '0', status: 'ACTIVE' });
const resp = await fetch(
`https://api.fyatu.com/api/v3.20/cardholders?${params}`,
{ headers: { 'Authorization': `Bearer ${process.env.FYATU_API_KEY}` } }
);
const body = await resp.json();
console.log(`${body.pagination.total} cardholders, showing ${body.data.length}`);
import os, requests
resp = requests.get(
'https://api.fyatu.com/api/v3.20/cardholders',
headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'},
params={'limit': 20, 'offset': 0, 'status': 'ACTIVE'}
)
body = resp.json()
print(body['pagination']['total'], 'total cardholders')
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
| Code | HTTP | Cause |
|---|---|---|
VALIDATION_ERROR | 422 | Invalid status value or search exceeds 100 characters |
INSUFFICIENT_SCOPE | 403 | Key lacks cardholders:read scope |
INTERNAL_ERROR | 500 | Server error |
Authorizations
API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.
Query Parameters
Required range:
1 <= x <= 100Required range:
x >= 0Available options:
ACTIVE, SUSPENDED, TERMINATED Maximum string length:
100⌘I

