Cardholder List
curl --request POST \
--url https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-From: <x-forwarded-from>' \
--data '
{
"cardholderId": 123,
"areaCode": "<string>",
"mobile": "<string>",
"email": "<string>",
"merchantOrderNo": "<string>",
"pageNum": 1,
"pageSize": 10,
"cardholderType": "<string>",
"cardholderStatus": "<string>",
"searchTerm": "<string>"
}
'import requests
url = "https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list"
payload = {
"cardholderId": 123,
"areaCode": "<string>",
"mobile": "<string>",
"email": "<string>",
"merchantOrderNo": "<string>",
"pageNum": 1,
"pageSize": 10,
"cardholderType": "<string>",
"cardholderStatus": "<string>",
"searchTerm": "<string>"
}
headers = {
"X-Forwarded-From": "<x-forwarded-from>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Forwarded-From': '<x-forwarded-from>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cardholderId: 123,
areaCode: '<string>',
mobile: '<string>',
email: '<string>',
merchantOrderNo: '<string>',
pageNum: 1,
pageSize: 10,
cardholderType: '<string>',
cardholderStatus: '<string>',
searchTerm: '<string>'
})
};
fetch('https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list', 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://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cardholderId' => 123,
'areaCode' => '<string>',
'mobile' => '<string>',
'email' => '<string>',
'merchantOrderNo' => '<string>',
'pageNum' => 1,
'pageSize' => 10,
'cardholderType' => '<string>',
'cardholderStatus' => '<string>',
'searchTerm' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Forwarded-From: <x-forwarded-from>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list"
payload := strings.NewReader("{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Forwarded-From", "<x-forwarded-from>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list")
.header("X-Forwarded-From", "<x-forwarded-from>")
.header("Content-Type", "application/json")
.body("{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Forwarded-From"] = '<x-forwarded-from>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 200,
"msg": "Success",
"data": {
"total": 150,
"pageNum": 1,
"pageSize": 10,
"records": [
{
"cardholderId": "ch-12345678",
"accountId": "wsb-12345678",
"cardholderReference": "REF123456",
"personalInfo": {
"firstName": "John",
"lastName": "Doe",
"middleName": "William",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"gender": "MALE",
"nationality": "US",
"email": "john.doe@example.com",
"phoneNumber": "+1234567890",
"mobileNumber": "+1234567890"
},
"residentialAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
},
"mailingAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
},
"employmentInfo": {
"employerName": "Tech Corp",
"occupationCode": "001",
"occupationTitle": "Software Engineer",
"industry": "TECHNOLOGY",
"employmentStatus": "FULL_TIME",
"employmentStartDate": "2020-01-01T00:00:00.000Z",
"monthlyIncome": 5000,
"annualIncome": 60000,
"incomeCurrency": "USD",
"employerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
}
},
"kycDocuments": [
{
"documentType": "PASSPORT",
"documentNumber": "AB123456789",
"documentExpiryDate": "2030-01-15T00:00:00.000Z",
"documentIssueDate": "2020-01-15T00:00:00.000Z",
"documentIssuingCountry": "US",
"documentFrontImageUrl": "https://example.com/doc-front.jpg",
"documentBackImageUrl": "https://example.com/doc-back.jpg",
"selfieImageUrl": "https://example.com/selfie.jpg",
"verificationStatus": "PENDING"
}
],
"cardholderType": "B2B",
"riskLevel": "LOW",
"kycLevel": "STANDARD",
"sourceOfFunds": "SALARY",
"purposeOfAccount": "PERSONAL_USE",
"politicallyExposedPerson": false,
"sanctionsScreeningRequired": true,
"cardholderStatus": "ACTIVE",
"kycStatus": "VERIFIED",
"verificationTime": 1640995200000,
"createTime": 1640995200000,
"updateTime": 1640995200000,
"numberOfCards": 2,
"activeCards": 2
}
]
}
}Cardholders
Cardholder List
Query cardholders with pagination and filters
POST
/
api
/
v2.1
/
fincard
/
virtual
/
card
/
holder
/
list
Cardholder List
curl --request POST \
--url https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-From: <x-forwarded-from>' \
--data '
{
"cardholderId": 123,
"areaCode": "<string>",
"mobile": "<string>",
"email": "<string>",
"merchantOrderNo": "<string>",
"pageNum": 1,
"pageSize": 10,
"cardholderType": "<string>",
"cardholderStatus": "<string>",
"searchTerm": "<string>"
}
'import requests
url = "https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list"
payload = {
"cardholderId": 123,
"areaCode": "<string>",
"mobile": "<string>",
"email": "<string>",
"merchantOrderNo": "<string>",
"pageNum": 1,
"pageSize": 10,
"cardholderType": "<string>",
"cardholderStatus": "<string>",
"searchTerm": "<string>"
}
headers = {
"X-Forwarded-From": "<x-forwarded-from>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Forwarded-From': '<x-forwarded-from>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cardholderId: 123,
areaCode: '<string>',
mobile: '<string>',
email: '<string>',
merchantOrderNo: '<string>',
pageNum: 1,
pageSize: 10,
cardholderType: '<string>',
cardholderStatus: '<string>',
searchTerm: '<string>'
})
};
fetch('https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list', 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://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cardholderId' => 123,
'areaCode' => '<string>',
'mobile' => '<string>',
'email' => '<string>',
'merchantOrderNo' => '<string>',
'pageNum' => 1,
'pageSize' => 10,
'cardholderType' => '<string>',
'cardholderStatus' => '<string>',
'searchTerm' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Forwarded-From: <x-forwarded-from>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list"
payload := strings.NewReader("{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Forwarded-From", "<x-forwarded-from>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list")
.header("X-Forwarded-From", "<x-forwarded-from>")
.header("Content-Type", "application/json")
.body("{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/holder/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Forwarded-From"] = '<x-forwarded-from>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardholderId\": 123,\n \"areaCode\": \"<string>\",\n \"mobile\": \"<string>\",\n \"email\": \"<string>\",\n \"merchantOrderNo\": \"<string>\",\n \"pageNum\": 1,\n \"pageSize\": 10,\n \"cardholderType\": \"<string>\",\n \"cardholderStatus\": \"<string>\",\n \"searchTerm\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 200,
"msg": "Success",
"data": {
"total": 150,
"pageNum": 1,
"pageSize": 10,
"records": [
{
"cardholderId": "ch-12345678",
"accountId": "wsb-12345678",
"cardholderReference": "REF123456",
"personalInfo": {
"firstName": "John",
"lastName": "Doe",
"middleName": "William",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"gender": "MALE",
"nationality": "US",
"email": "john.doe@example.com",
"phoneNumber": "+1234567890",
"mobileNumber": "+1234567890"
},
"residentialAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
},
"mailingAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
},
"employmentInfo": {
"employerName": "Tech Corp",
"occupationCode": "001",
"occupationTitle": "Software Engineer",
"industry": "TECHNOLOGY",
"employmentStatus": "FULL_TIME",
"employmentStartDate": "2020-01-01T00:00:00.000Z",
"monthlyIncome": 5000,
"annualIncome": 60000,
"incomeCurrency": "USD",
"employerAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"addressType": "RESIDENTIAL",
"isPrimary": true
}
},
"kycDocuments": [
{
"documentType": "PASSPORT",
"documentNumber": "AB123456789",
"documentExpiryDate": "2030-01-15T00:00:00.000Z",
"documentIssueDate": "2020-01-15T00:00:00.000Z",
"documentIssuingCountry": "US",
"documentFrontImageUrl": "https://example.com/doc-front.jpg",
"documentBackImageUrl": "https://example.com/doc-back.jpg",
"selfieImageUrl": "https://example.com/selfie.jpg",
"verificationStatus": "PENDING"
}
],
"cardholderType": "B2B",
"riskLevel": "LOW",
"kycLevel": "STANDARD",
"sourceOfFunds": "SALARY",
"purposeOfAccount": "PERSONAL_USE",
"politicallyExposedPerson": false,
"sanctionsScreeningRequired": true,
"cardholderStatus": "ACTIVE",
"kycStatus": "VERIFIED",
"verificationTime": 1640995200000,
"createTime": 1640995200000,
"updateTime": 1640995200000,
"numberOfCards": 2,
"activeCards": 2
}
]
}
}Headers
User agent
Forwarded for
Client application identifier
Example:
"client-app"
Tenant ID
Device ID
Platform
Body
application/json
Cardholder list request
Cardholder list request
Cardholder ID (optional filter)
Mobile area code (optional, must be passed with mobile)
Mobile phone number (optional)
Email (optional)
Client transaction reference (optional)
Current page. Default is 1
Page size. Maximum 100, default 10
Cardholder type filter (optional)
Cardholder status filter (optional)
Search term (optional)
⌘I