> ## Documentation Index > Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Card > 查询你此前签发的某张卡片的详细信息。响应中不返回卡片的敏感信息。 ## OpenAPI ````yaml /zh/card-issuance/v1.6/issuing.yaml get /v1/issuing/cards/{id} openapi: 3.0.2 info: title: Issuing API version: 0.0.1 x-source-en-commit: fdf4a2b x-source-en-path: card-issuance/v1.6/issuing.yaml description: > UQPAY Issuing API 让你签发虚拟卡、管理持卡人，并监控卡交易。 ## 功能概览 - 创建并管理虚拟卡（签发、激活、冻结、注销） - 通过 KYC 完成持卡人入驻与验证 - 设置消费限额与卡控制 - 为卡余额充值与提现 - 查询卡交易与账户余额 - 在发卡账户之间转账 - 生成并下载报表 ## 身份认证 所有请求都需要携带有效的鉴权 Token，Token 通过 [Access Token](/zh/account-center/v1.6/api-reference/access-token) 接口获取。请在 `x-auth-token` 请求头中携带该 Token。 ## 幂等性 POST 请求支持 `x-idempotency-key` 请求头，可安全重试而不会创建重复资源。 contact: name: UQPAY Support Team url: https://www.uqpay.com/support email: support@uqpay.com license: name: Proprietary url: https://www.uqpay.com/legal/api-terms termsOfService: https://www.uqpay.com/legal/terms x-api-id: uqpay-issuing-api-v1.6.0 x-categories: - Card Issuing - Transaction Processing x-features: - Virtual Card Issuance - Real-time Processing - Webhook Notifications - Comprehensive Reporting - Transaction Monitoring servers: - url: https://api-sandbox.uqpaytech.com/api description: 沙盒环境基础 URL。 - url: https://api.uqpay.com/api description: 生产环境基础 URL。 security: [] tags: - name: Card Lifecycle description: 创建卡片并管理其完整生命周期——签发、查询、更新、激活、绑定与变更状态。 - name: Card Secure Data description: 通过 PCI 合规接口或令牌化 iframe 访问敏感卡数据（PAN、CVV）。是否可用取决于你的 PCI 状态，而非卡产品。 - name: Card Funding description: 为预付类卡片充值或提取其卡内储值余额。 - name: Card PIN description: 设置并管理卡片 PIN 码。`reset-pin` 用于实体卡，`manage-card-pin` 用于虚拟卡。 - name: Card Add-ons description: >- 产品专属的卡功能。每个操作仅适用于特定卡产品——参见 [卡产品](/zh/card-issuance/v1.6/guide/card-products)。 - name: Card Arts description: >- 管理发卡账户可用的视觉设计（卡面）。可设置账户级默认卡面，或在签发/更新卡片时传入 `card_art_id` 以按卡覆盖。仅 Personal Visa 支持。 - name: Cardholders description: 你可以创建持卡人。持卡人是你企业的授权代表，可被签发卡片。 - name: Transactions description: 这些接口用于查询在你用户卡片上发生的交易信息。 - name: Products description: 通过这组接口，你可以为客户创建卡订单。 - name: Balances description: 各币种的可用金额与待处理金额会进一步按资金来源类型细分。你可以查询它，查看发卡账户当前的余额。 - name: Transfers description: 在发卡账户之间转账。 - name: Reports description: 生成并下载发卡报表。 - name: Simulator description: 在沙盒环境中模拟卡交易。 paths: /v1/issuing/cards/{id}: get: tags: - Card Lifecycle summary: Retrieve Card description: 查询你此前签发的某张卡片的详细信息。响应中不返回卡片的敏感信息。 operationId: retrieve-card parameters: - $ref: '#/components/parameters/IdPath' - $ref: '#/components/parameters/XOnBehalfOf' responses: '200': description: 成功获取卡片。 headers: x-response-id: $ref: '#/components/headers/XResponseId' content: application/json: schema: $ref: '#/components/schemas/RetrieveCardResponse' title: RetrieveCardResponse security: - XAuthToken: [] components: parameters: IdPath: name: id description: 资源的全局唯一标识符（UUID v4）。 in: path required: true schema: type: string format: uuid example: 71fdb0fe-9682-457a-9361-e8868694f12f XOnBehalfOf: in: header name: x-on-behalf-of schema: type: string required: false description: > 指定代表哪个子账户发起请求。应设置为 `account_id`，该值可通过 [List Connected Accounts](/zh/account-center/v1.6/api-reference/list-connected-accounts) 接口获取。若省略或为空，则请求以主账户身份执行。 更多信息参见 [关联账户](/zh/account-center/v1.6/guide/connected-accounts)。 example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be headers: XResponseId: description: 响应的全局唯一标识符（UUID v4）。在联系 UQPAY 支持团队时有助于定位某次请求。 schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde schemas: RetrieveCardResponse: type: object required: - card_id - card_bin - mode_type - card_scheme - card_number - form_factor - card_limit - available_balance - cardholder - card_status - no_pin_payment_amount properties: card_id: $ref: '#/components/schemas/CardId' card_bin: $ref: '#/components/schemas/CardBin' card_scheme: $ref: '#/components/schemas/CardScheme' card_currency: $ref: '#/components/schemas/CardCurrency' card_number: $ref: '#/components/schemas/CardNumber' form_factor: $ref: '#/components/schemas/FormFactor' mode_type: $ref: '#/components/schemas/ModeType' card_product_id: $ref: '#/components/schemas/CardProductId' card_limit: $ref: '#/components/schemas/CardLimit' available_balance: type: string example: 2000.05 description: 可用余额，币种参见 `card_currency`。 cardholder: $ref: '#/components/schemas/CardholderListResponse' spending_controls: $ref: '#/components/schemas/SpendingControls' no_pin_payment_amount: $ref: '#/components/schemas/NoPINPaymentAmountInResponse' risk_controls: $ref: '#/components/schemas/RiskControls' network_protection: $ref: '#/components/schemas/NetworkProtection' metadata: $ref: '#/components/schemas/Metadata' card_status: $ref: '#/components/schemas/CardStatus' update_reason: $ref: '#/components/schemas/UpdateReason' consumed_amount: $ref: '#/components/schemas/ConsumedAmount' CardId: type: string example: c0cef051-29c5-4796-b86a-cd5b684bfad7 description: 卡片的唯一标识符。 CardBin: type: string example: '40963608' description: 卡号前缀（BIN）。 CardScheme: type: string example: VISA description: 卡组织。 CardCurrency: type: string example: USD description: 卡币种。 enum: - SGD - USD - XUSD CardNumber: type: string example: '************5668' description: 脱敏卡号 FormFactor: type: string example: VIRTUAL description: 卡片形态——`VIRTUAL` 或 `PHYSICAL`，目前仅支持虚拟卡。 enum: - VIRTUAL - PHYSICAL ModeType: type: string example: SHARE enum: - SHARE - SINGLE description: | 模式类型枚举 - SINGLE 或 SHARE。 * `SINGLE` - 单卡仅支持预付模式。 * `SHARE` - 共享卡可支持借记模式，即关联借记产品和账户。 CardProductId: type: string description: 卡产品的唯一标识符。 example: 3bd1656b-e691-4aab-a76a-3ead39e7a6f6 format: uuid CardLimit: type: number example: 2100.02 minimum: 0 description: > 分配给该卡片的总信用额度，币种参见 `card_currency`。这**不是累计余额**，而是类似信用卡的固定信用额度。 ##### 各卡产品的字段行为： - **Business Mastercard** 和 **Personal Visa**：创建卡片时 `card_limit` 为**必填**，且必须**大于或等于 0.01**。 - **Business Visa**：`card_limit` 为**可选**。 - 若省略，系统默认 `card_limit` 为 0。 - 若提供，取值必须**大于或等于 0**，最多两位小数。**不允许负值。** 完整能力矩阵参见 [卡产品](/zh/card-issuance/v1.6/guide/card-products)。 CardholderListResponse: type: object properties: cardholder_id: $ref: '#/components/schemas/CardholderId' email: $ref: '#/components/schemas/CardholderEmail' number_of_cards: $ref: '#/components/schemas/CardholderNumberOfCards' first_name: description: 该持卡人的名字。激活卡片前必填。此字段不能包含任何数字、特殊字符（句点、逗号、连字符、空格和撇号除外）或非拉丁字母。 type: string example: Emily last_name: description: 该持卡人的姓氏。激活卡片前必填。此字段不能包含任何数字、特殊字符（句点、逗号、连字符、空格和撇号除外）或非拉丁字母。 type: string example: Toy create_time: description: 对象的创建时间。 type: string example: '2024-05-09 15:52:23' cardholder_status: $ref: '#/components/schemas/CardholderStatus' date_of_birth: $ref: '#/components/schemas/CardholderDateOfBirth' country_code: $ref: '#/components/schemas/CountryCode' phone_number: $ref: '#/components/schemas/CardholderPhoneNumber' gender: $ref: '#/components/schemas/Gender' nationality: $ref: '#/components/schemas/Nationality' residential_address: $ref: '#/components/schemas/ResidentialAddress' review_status: $ref: '#/components/schemas/ReviewStatus' idv_status: type: string description: | IDV 验证状态。在适用时返回。 * `PENDING` - IDV 待处理。 * `PASSED` - IDV 通过。 * `FAILED` - IDV 失败。 enum: - PENDING - PASSED - FAILED idv_verification_url: type: string description: IDV 验证 URL。在适用时返回。 example: https://idv.sumsub.com/verify/abc123 idv_url_expires_at: type: string description: IDV 验证 URL 的过期时间，RFC 3339 格式。 example: '2026-04-10T10:00:00+08:00' SpendingControls: type: array description: 控制该卡片消费的规则。 items: type: object required: - amount - interval properties: amount: type: number description: 每个周期允许消费的最大金额，必须大于或等于零。 example: 100.03 minimum: 0 interval: type: string example: PER_TRANSACTION enum: - PER_TRANSACTION description: | 应用该金额的周期（或事件）。 此字段为必填，且必须是以下之一： * `PER_TRANSACTION` - 不能超过最大授权金额 NoPINPaymentAmountInResponse: type: string example: 2000USD description: >- 无需 PIN 验证即可进行卡交易的允许金额，包含币种单位（如 `2000USD`）。此响应字段应与对应的请求参数区分开，后者指定的金额不含币种单位。 RiskControls: type: object description: | 用户自定义的风控设置。 支持的配置取决于卡产品。能力矩阵参见 [卡产品](/zh/card-issuance/v1.6/guide/card-products)。 properties: enable_3ds: $ref: '#/components/schemas/Enable3ds' allow_3ds_transactions: $ref: '#/components/schemas/Allow3dsTransactions' allowed_mcc: $ref: '#/components/schemas/AllowedMcc' blocked_mcc: $ref: '#/components/schemas/BlockedMcc' NetworkProtection: type: object description: 嵌入在卡片响应对象中的 ASAF Network Protection 状态。仅 Visa 卡片返回。 properties: enabled: type: boolean example: true description: 该卡片当前是否启用了 Network Protection。 card_scheme: type: string nullable: true example: VISA action_code: $ref: '#/components/schemas/NetworkProtectionActionCode' definition: type: string nullable: true example: Lost card, pickup description: '`action_code` 的可读描述。' status: $ref: '#/components/schemas/NetworkProtectionStatus' submitted_time: type: string format: date-time nullable: true example: '2026-05-14T09:00:00Z' description: 最近一次注册或移除请求提交的时间。 Metadata: additionalProperties: maxLength: 3200 type: string example: key1: value1 key2: value2 description: 任意键值对象。最大长度 = 3200 字节。必须是有效的 JSON 数据。 type: object CardStatus: type: string description: > 卡片状态枚举。更多信息参见卡生命周期与状态指南。 - `PENDING`：创建卡片的请求已收到，正在审核中。 - `ACTIVE`：创建卡片的请求成功，卡片可以使用。 - `FROZEN`：所有进入的授权请求都将被拒绝。卡片可以重新激活以接受新的授权。 - `BLOCKED`：因可疑活动，卡片被 UQPAY 锁定。 - `PRE_CANCEL`：卡片已被安排注销，处于等待期，期间所有进入的授权请求都将被拒绝。等待期结束后转为 `CANCELLED`。 - `CANCELLED`：卡片无法再从此状态重新激活，所有进入的授权请求都将被永久拒绝。 - `LOST`：卡片已向 UQPAY 报失。 - `STOLEN`：卡片已向 UQPAY 报被盗。 - `FAILED`：使用 [创建卡片](/zh/card-issuance/v1.6/api-reference/create-card) 创建卡片的请求失败。 example: ACTIVE enum: - PENDING - ACTIVE - FROZEN - BLOCKED - PRE_CANCEL - CANCELLED - LOST - STOLEN - FAILED UpdateReason: type: string description: 更新卡片状态的原因。 maxLength: 100 minLength: 0 ConsumedAmount: type: string description: 反映卡限额中已使用的累计金额。 example: '51.00' CardholderId: type: string description: 持卡人的唯一标识符。 example: 7c4ff2cd-1bf6-4aaa-bf16-266771425011 format: uuid CardholderEmail: type: string description: 持卡人的电子邮箱地址。 example: demo@example.com CardholderNumberOfCards: type: integer description: 与持卡人关联的卡片总数，包含所有状态。 example: 1 CardholderStatus: description: 持卡人的状态。 type: string default: SUCCESS enum: - FAILED - PENDING - SUCCESS - INCOMPLETE CardholderDateOfBirth: description: 持卡人的出生日期，格式为 `yyyy-mm-dd`。 type: string example: '1990-01-01' CountryCode: type: string description: >- 两位国家代码 [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)。 maxLength: 2 example: SG CardholderPhoneNumber: description: > 持卡人的电话号码。 长度校验详情参见 [电话号码校验规则](/zh/card-issuance/v1.6/guide/phone-number-validation-rules-for-cardholder)。 type: string example: '86683306' Gender: type: string description: | 持卡人的性别。 * `MALE` - 男。 * `FEMALE` - 女。 enum: - MALE - FEMALE example: MALE Nationality: type: string description: 持卡人的国籍，采用 ISO 3166-1 alpha-2 格式。STANDARD 和 ENHANCED KYC 等级必填。 minLength: 2 maxLength: 2 example: SG ResidentialAddress: type: object description: > 持卡人的居住地址。 所有字段只接受字母（A-Z、a-z）、数字（0-9）、空格，以及以下标点：`, . ' / # ( ) - &`。包含其他任何字符的请求都会被拒绝——请修正后重新提交。为空的可选字段不做校验。 required: - country - city - line1 properties: country: $ref: '#/components/schemas/Country' state: type: string description: 州/县/省/地区。 maxLength: 128 example: Singapore city: type: string description: 城市/区/郊区/镇/村。 maxLength: 128 example: Singapore district: type: string description: 城市内的区或子区域。 maxLength: 128 example: Buona Vista line1: type: string description: 地址行 1（如街道、邮政信箱或公司名称）。 maxLength: 255 example: 9 N Buona Vista Dr line2: type: string description: 地址行 2（如公寓、套房、单元或楼宇）。 maxLength: 255 example: THE METROPOLIS line_en: type: string description: 英文地址。 maxLength: 255 example: 9 N Buona Vista Dr, THE METROPOLIS postal_code: type: string description: 邮编或邮政编码。如果你打算签发 Enhanced 卡，此字段长度必须为 4-10 个字符。 maxLength: 16 example: '138666' ReviewStatus: type: string description: 持卡人的审核状态。 enum: - SUCCESS - FAILED - PENDING example: SUCCESS Enable3ds: type: string description: > 控制是否为该卡片注册 [3D Secure](https://en.wikipedia.org/wiki/3-D_Secure)。 - `Y` —— 注册 3DS。交易时的验证行为随后由 `allow_3ds_transactions` 决定。 - `N` —— 不注册 3DS。线上交易完全跳过 3DS 验证。 仅 **Business Visa** 和 **Personal Visa** 支持；Business Mastercard 上忽略此字段。参见 [卡产品](/zh/card-issuance/v1.6/guide/card-products)。 仅当卡片上显式设置时才返回。未设置时，卡片遵循账户级 3DS 配置。 仅当卡片处于 `PENDING` 或 `ACTIVE` 状态时可修改。 enum: - 'Y' - 'N' example: 'Y' Allow3dsTransactions: type: string description: > 决定当交易触发 3DS 时，是否允许 [3D Secure](https://en.wikipedia.org/wiki/3-D_Secure) 验证流程。 - **创建卡片时：** 未提供则默认为 `Y`。 - **更新卡片时：** 无默认值。未提供则保持现有值不变。 仅 **Business Visa** 支持。参见 [卡产品](/zh/card-issuance/v1.6/guide/card-products)。 > **注意：** 此字段仅在 `enable_3ds` 为 `Y` 时生效。若 `enable_3ds` 为 `N`，卡片完全跳过 3DS，此字段不起作用。 > **重要：** 当设为 `N` 时，你的卡片使用无摩擦 3DS 验证机制——交易无需输入 OTP 即可完成，并被视为已通过持卡人验证。因此，此类交易无法基于欺诈或未授权使用发起争议。为增强安全性，建议保持设为 `Y`。 - `Y`：可能需要 OTP 验证。 - `N`：不需要 OTP。 enum: - 'Y' - 'N' example: 'Y' AllowedMcc: type: array items: type: string description: | 指定允许交易的商户类别代码（MCC）白名单。 所有不在此列表中的 MCC 下的交易都将被拒绝。 **注意：** 每张卡只能配置 `allowed_mcc` 或 `blocked_mcc` 之一。若两者都未提供，交易将遵循默认风控逻辑。 example: null BlockedMcc: type: array items: type: string description: | 指定限制交易的商户类别代码（MCC）黑名单。 这些 MCC 下的交易将被拒绝，其他所有交易则按 UQPAY 标准风控评估流程处理。 **注意：** 每张卡只能配置 `allowed_mcc` 或 `blocked_mcc` 之一。若两者都未提供，交易将遵循默认风控逻辑。 example: - '5999' - '6011' NetworkProtectionActionCode: type: string description: | ASAF 操作码，表示卡片被注册到 Network Protection 的原因。 - `04` —— 收卡 - `41` —— 卡片挂失，收卡 - `43` —— 卡片被盗，收卡 - `46` —— 账户已关闭 - `54` —— 卡片已过期 enum: - '04' - '41' - '43' - '46' - '54' example: '41' NetworkProtectionStatus: type: string description: ASAF Network Protection 注册的生命周期状态。 enum: - NOT_ENROLLED - ENROLL_PENDING - ENROLL_FAILED - ENROLLED - REMOVAL_PENDING example: ENROLL_PENDING Country: type: string description: >- 两位国家代码 [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)。 maxLength: 2 example: SG securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: 由 UQPay 提供的登录 API Token。 ````