跳至主要内容

查詢卡片列表

查詢已認證用戶的虛擬卡與實體卡,一次返回全部符合條件的卡片。默認僅返回非終態卡及處理中的卡片。

提示

僅返回屬於已認證用戶本人的卡片

請求體可以省略或設為 {},不接受分頁參數。

HTTP 請求​

POST/v5/card/list

請求參數​

參數是否必需類型說明
includeFinalCardsfalseboolean是否包含已註銷及已失效的卡片。true: 包含終態卡;省略、false 或 null: 使用默認篩選條件

響應參數​

參數類型說明
retCodeinteger業務返回碼。0: 成功;非零: 失敗
retMsgstring返回消息
resultobject查詢結果,失敗時為 null
> pageNointeger當前頁碼,固定為 1
> pageSizeinteger本次返回的卡片數量
> totalPageinteger總頁數,固定為 1
> totalCountinteger符合條件的卡片總數
> dataarray卡片列表,無符合條件的卡片時為空數組
>> cardIdstring卡片 ID
>> cardProductCodeinteger卡產品代碼,與 productId 共同標識產品
>> productIdinteger卡產品 ID
>> cardHolderNamestring卡面持卡人姓名
>> cardTypeinteger卡片類型。1: 虛擬卡, 2: 實體卡
>> maskedCardNumberstring掩碼卡號
>> pan6string卡號前綴,通常為前 6 位
>> pan4string卡號後綴,通常為後 4 位
>> cardExpireDatestring卡片有效期,格式為 MM/yy
>> cardCurrencystring卡片幣種代碼
>> statusinteger卡主狀態。0: 未定義, 1: 未激活, 2: 已激活, 3: 已凍結, 4: 已封禁, 5: 已註銷, 6: 已失效, 7: 已創建
>> subStatusinteger卡子狀態碼。例如:200: 已激活, 300: 常規凍結, 501: 用戶註銷, 601: 過期失效
>> countryAlpha3string國家 Alpha-3 代碼,例如 AUS
>> cardActivateTimeinteger卡片激活時間(Unix 毫秒時間戳)
>> createTimeinteger卡片創建時間(Unix 毫秒時間戳)
>> allowOnlineTransactionboolean是否允許線上交易
>> allowAtmWithdrawalboolean是否允許 ATM 取款
>> supportedCurrencyListarray支持的幣種代碼列表,列表元素可以為 null
>> shippingInfoobject實體卡配送信息,虛擬卡為 null
>>> delvProviderstring配送服務商
>>> trackingNostring追蹤單號
>>> shipmentTimeinteger發貨時間(Unix 毫秒時間戳)
>>> shippingStatusstring配送狀態
>>> shippingStatusDetailstring配送詳細狀態
>>> trackingUrlstring追蹤鏈接
>>> allowToChangeAddressboolean是否允許修改配送地址
>>> deliverReminderCodestring配送提醒代碼
>> isGooglePayAvailableboolean產品是否支持 Google Pay,配置缺失時為 false
>> isApplePayAvailableboolean產品是否支持 Apple Pay,配置缺失時為 false
retExtInfoobject擴展信息,默認為 {}
timeinteger響應時間(Unix 毫秒時間戳)

卡片詳情字段可以為 null,但 isGooglePayAvailable 和 isApplePayAvailable 始終返回布爾值。配送字段可以為 null,不返回配送地址。部分實體卡無配送記錄時,仍返回字段為空的對象。

錯誤碼​

retCoderetMsg說明
913100000SYSTEM ERROR請求參數綁定失敗或系統異常

全局異常響應可以缺少 retExtInfo 和 time。


請求示例​

POST /v5/card/list HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672211918471
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
"includeFinalCards": true
}

響應示例​

{
"retCode": 0,
"retMsg": "OK",
"result": {
"pageNo": 1,
"pageSize": 1,
"totalPage": 1,
"totalCount": 1,
"data": [
{
"cardId": "180585395564494848",
"cardProductCode": 1,
"productId": 4,
"cardHolderName": "TEST HOLDER",
"cardType": 1,
"maskedCardNumber": "539900******5497",
"pan6": "539900",
"pan4": "5497",
"cardExpireDate": "12/29",
"cardCurrency": "USD",
"status": 2,
"subStatus": 200,
"countryAlpha3": "AUS",
"cardActivateTime": 1672211918471,
"createTime": 1672211918471,
"allowOnlineTransaction": true,
"allowAtmWithdrawal": true,
"supportedCurrencyList": ["USD"],
"shippingInfo": null,
"isGooglePayAvailable": false,
"isApplePayAvailable": false
}
]
},
"retExtInfo": {},
"time": 1672211918471
}