跳转到主要内容
GET
List Cards

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设置为 account_id,该值可通过 List Connected Accounts 接口获取。若省略或为空,则请求以主账户身份执行。 更多信息参见 关联账户

查询参数

page_size
integer
默认值:10
必填

每页返回的最大条目数。取值范围为 10 - 100,默认为 10。

必填范围: 10 <= x <= 100
page_number
integer
默认值:1
必填

用于获取下一组条目的页码。取值必须大于 1,默认为 1。

必填范围: x >= 1
card_number
string

完整卡号。

示例:

"4096360811214526"

card_status
enum<string>

按指定卡片状态检索条目。未指定时匹配任意卡片状态。 卡片状态枚举。更多信息参见卡生命周期与状态指南。

  • PENDING:创建卡片的请求已收到,正在审核中。
  • ACTIVE:创建卡片的请求成功,卡片可以使用。
  • FROZEN:所有进入的授权请求都将被拒绝。卡片可以重新激活以接受新的授权。
  • BLOCKED:因可疑活动,卡片被 UQPAY 锁定。
  • PRE_CANCEL:卡片已被安排注销,处于等待期,期间所有进入的授权请求都将被拒绝。等待期结束后转为 CANCELLED
  • CANCELLED:卡片无法再从此状态重新激活,所有进入的授权请求都将被永久拒绝。
  • LOST:卡片已向 UQPAY 报失。
  • STOLEN:卡片已向 UQPAY 报被盗。
  • FAILED:使用 创建卡片 创建卡片的请求失败。
可用选项:
PENDING,
ACTIVE,
FROZEN,
BLOCKED,
PRE_CANCEL,
CANCELLED,
LOST,
STOLEN,
FAILED
示例:

"ACTIVE"

cardholder_id
string<uuid>

持卡人的唯一标识符。

示例:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

响应

200 - application/json

成功获取卡片列表。

total_pages
integer

可用条目的总页数。

示例:

1

total_items
integer

可用条目的总数。

示例:

10

data
object[]