Skip to main content
POST
/
api
/
v2.1
/
fincard
/
virtual
/
card
/
list
Card List
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/fincard/virtual/card/list \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --data '
{
  "cardId": "<string>",
  "status": "<string>",
  "cardTypeId": 123,
  "cardholderId": 123,
  "startTime": 123,
  "endTime": 123,
  "pageNum": 1,
  "pageSize": 10
}
'
{
  "success": true,
  "code": 123,
  "msg": "<string>",
  "data": {
    "total": 123,
    "records": [
      {
        "cardId": "card-12345678",
        "cardToken": "tok_12345678",
        "maskedCardNumber": "**** **** **** 4242",
        "expiryDate": "12/25",
        "cardStatus": "ACTIVE",
        "cardType": "VIRTUAL",
        "brand": "VISA",
        "currency": "USD",
        "accountId": "wsb-12345678",
        "cardholderId": "ch-12345678",
        "cardName": "My Virtual Card",
        "availableBalance": 1000,
        "currentBalance": 1000,
        "blockedAmount": 0,
        "spendingLimit": 5000,
        "dailyLimit": 1000,
        "monthlyLimit": 10000,
        "dailySpent": 100,
        "monthlySpent": 500,
        "createTime": 1640995200000,
        "updateTime": 1640995200000,
        "activateTime": 1640995200000,
        "expireTime": 1767225600000,
        "settings": {
          "enableOnline": true,
          "enableInternational": true,
          "enableContactless": true,
          "enableAtm": true,
          "allowedMcc": [
            "5411",
            "5812"
          ],
          "blockedMcc": [
            "7995"
          ],
          "pinFreeAmount": 100,
          "autoLoad": false,
          "autoLoadAmount": 1000,
          "autoLoadThreshold": 100
        },
        "limits": {
          "spendingLimit": 5000,
          "dailyLimit": 1000,
          "monthlyLimit": 10000,
          "perTransactionLimit": 2500,
          "atmDailyLimit": 500,
          "atmPerTransactionLimit": 300
        },
        "features": [
          "CHIP",
          "NFC",
          "3DS"
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.finhub.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
User-Agent
string

User agent

​
X-Forwarded-For
string

Forwarded for

​
X-Forwarded-From
string
required

Client application identifier

Example:

"client-app"

​
X-Tenant-ID
string

Tenant ID

​
deviceId
string

Device ID

​
platform
string

Platform

Body

application/json

Card list request

Card list request

​
cardId
string

Card ID (optional filter)

​
status
string

Card status filter: pending, un_activated, Normal, Freeze, Freezing, UnFreezing, canceling, cancel, fail

​
cardTypeId
integer<int64>

Card type ID (optional filter)

​
cardholderId
integer<int64>

Cardholder ID (optional filter)

​
startTime
integer<int64>

Start time - card create time (milliseconds)

​
endTime
integer<int64>

End time - card create time (milliseconds)

​
pageNum
integer<int32>
default:1

Current page. Default is 1

​
pageSize
integer<int32>
default:10

Page size. Default 10, maximum 100

Response

Successful response

Card list response

​
success
boolean

Success flag

​
code
integer<int32>

Response code

​
msg
string

Response message

​
data
object

Card list data