List Cardholders
curl --request GET \
--url https://api.fyatu.com/api/v3/cardholders \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3/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/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/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/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/cardholders")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/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 successfully",
"data": {
"cardholders": [
{
"id": "ch_a1b2c3d4e5f6",
"externalId": "EXT-0001",
"firstName": "Alice",
"lastName": "Example",
"email": "alice@example.com",
"phone": "+15550001234",
"status": "ACTIVE",
"kycStatus": "ACCEPTED",
"cardsCount": 1,
"createdAt": "2026-01-10T14:30:00Z"
}
],
"pagination": {
"currentPage": 1,
"itemsPerPage": 20,
"totalItems": 47,
"totalPages": 3
}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-01-17T10:00:00Z"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}Cardholders
List Cardholders
List all cardholders in your Fyatu card program with pagination and KYC status filtering. GET /cardholders.
GET
/
cardholders
List Cardholders
curl --request GET \
--url https://api.fyatu.com/api/v3/cardholders \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fyatu.com/api/v3/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/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/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/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/cardholders")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/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 successfully",
"data": {
"cardholders": [
{
"id": "ch_a1b2c3d4e5f6",
"externalId": "EXT-0001",
"firstName": "Alice",
"lastName": "Example",
"email": "alice@example.com",
"phone": "+15550001234",
"status": "ACTIVE",
"kycStatus": "ACCEPTED",
"cardsCount": 1,
"createdAt": "2026-01-10T14:30:00Z"
}
],
"pagination": {
"currentPage": 1,
"itemsPerPage": 20,
"totalItems": 47,
"totalPages": 3
}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-01-17T10:00:00Z"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}Overview
Retrieve a paginated list of cardholders associated with your application. Use filters to narrow down results by status, KYC status, or search terms.Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Items per page (default: 20, max: 100) |
status | string | Filter by status (ACTIVE, INACTIVE, SUSPENDED) |
kycStatus | string | Filter by KYC status (UNSUBMITTED, PENDING, VERIFIED, REJECTED) |
search | string | Search by name or email (partial match) |
Response
| Field | Type | Description |
|---|---|---|
cardholders | array | List of cardholder objects |
pagination | object | Pagination info |
Cardholder Object (Summary)
| Field | Type | Description |
|---|---|---|
id | string | Unique cardholder identifier |
externalId | string | Your system’s identifier (nullable) |
firstName | string | First name |
lastName | string | Last name |
email | string | Email address |
phone | string | Phone number |
status | string | Cardholder status |
kycStatus | string | KYC verification status |
cardsCount | integer | Number of active cards |
createdAt | string | Creation timestamp |
Example Usage
<?php
// Get active cardholders with verified KYC
$params = http_build_query([
'status' => 'ACTIVE',
'kycStatus' => 'VERIFIED',
'limit' => 50
]);
$response = file_get_contents(
"https://api.fyatu.com/api/v3/cardholders?{$params}",
false,
stream_context_create([
'http' => [
'method' => 'GET',
'header' => 'Authorization: Bearer ' . $accessToken
]
])
);
$result = json_decode($response, true);
foreach ($result['data']['cardholders'] as $ch) {
echo "{$ch['firstName']} {$ch['lastName']} - {$ch['email']} ({$ch['kycStatus']})\n";
}
// Pagination info
$pagination = $result['data']['pagination'];
echo "Page {$pagination['currentPage']} of {$pagination['totalPages']}\n";
// Get active cardholders with verified KYC
const params = new URLSearchParams({
status: 'ACTIVE',
kycStatus: 'VERIFIED',
limit: '50'
});
const response = await fetch(
`https://api.fyatu.com/api/v3/cardholders?${params}`,
{
headers: {
'Authorization': `Bearer ${accessToken}`
}
}
);
const result = await response.json();
for (const ch of result.data.cardholders) {
console.log(`${ch.firstName} ${ch.lastName} - ${ch.email} (${ch.kycStatus})`);
}
// Pagination info
const { currentPage, totalPages } = result.data.pagination;
console.log(`Page ${currentPage} of ${totalPages}`);
Example Response
{
"success": true,
"status": 200,
"message": "Cardholders retrieved successfully",
"data": {
"cardholders": [
{
"id": "ch_a1b2c3d4e5f6",
"externalId": "EXT-0001",
"firstName": "Alice",
"lastName": "Example",
"email": "alice@example.com",
"phone": "+15550001234",
"status": "ACTIVE",
"kycStatus": "VERIFIED",
"cardsCount": 1,
"createdAt": "2026-01-10 14:30:00"
}
],
"pagination": {
"currentPage": 1,
"itemsPerPage": 20,
"totalItems": 47,
"totalPages": 3
}
},
"meta": {
"requestId": "req_a1b2c3d4e5f6",
"timestamp": "2026-01-17T10:00:00+00:00"
}
}
Filtering Tips
By KYC Status
GET /cardholders?kycStatus=VERIFIED
Search by Name or Email
GET /cardholders?search=john
Combine Filters
GET /cardholders?status=ACTIVE&kycStatus=VERIFIED&limit=100
Use the
search parameter to quickly find cardholders by name or email. The search is case-insensitive and matches partial strings.Authorizations
JWT access token obtained from /auth/token
Query Parameters
Page number (default: 1)
Items per page (default: 20, max: 100)
Required range:
x <= 100Filter by cardholder status
Available options:
ACTIVE, INACTIVE, SUSPENDED Filter by KYC verification status
Available options:
UNSUBMITTED, SUBMITTED, ACCEPTED, REJECTED Search by name or email (partial match)
⌘I

