# List card products

> Retrieve the card products and related configuration available to the merchant.

```yaml
openapi: 3.1.0
info:
  title: List card products
  version: 1.0.0
  description: Retrieve the card products and related configuration available to
    the merchant.
paths:
  /api/v1/merchant/cardProduct/list:
    post:
      summary: List card products
      description: Retrieve the card products and related configuration available to
        the merchant.
      parameters:
        - name: ApiKey
          in: header
          required: true
          description: Issuing API key request header assigned by Onerway.
          schema:
            type: string
            description: Issuing API key request header assigned by Onerway.
      responses:
        "200":
          description: Card products returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Business response code. `20000` means success.
                  respMsg:
                    type: string
                    description: Response message.
                  data:
                    type:
                      - array
                      - "null"
                    description: Card products available to the merchant.
                    items:
                      type: object
                      properties:
                        productId:
                          type: integer
                          description: Card product ID.
                        productName:
                          type: string
                          description: Card product name.
                        cardBin:
                          type: string
                          description: Card BIN.
                        cardScheme:
                          type: string
                          description: Card scheme.
                        issueCurrency:
                          type: string
                          description: Card issuing currency.
                        issueRegionCode:
                          type: string
                          description: Card issuing region code.
                        cardholderConfig:
                          type:
                            - object
                            - "null"
                          properties:
                            maxCardCount:
                              type: integer
                              description: Maximum number of cards allowed for one cardholder.
                            requiredFields:
                              type: array
                              description: Cardholder fields required to use this product.
                              items:
                                type: string
                              x-onerway-value:
                                empty: true
                                when:
                                  en: Returned as an empty array when no additional cardholder field is required.
                                  zh: 无需额外持卡人字段时返回空数组。
                          description: Cardholder configuration for the product.
                          x-onerway-value:
                            nullable: true
                            when:
                              en: Returned as `null` when no cardholder configuration applies.
                              zh: 无持卡人配置时返回 `null`。
                        cardRechargeConfig:
                          type:
                            - object
                            - "null"
                          properties:
                            rechargeMinQuota:
                              type: number
                              description: Minimum recharge amount.
                            rechargeMaxQuota:
                              type: number
                              description: Maximum recharge amount.
                          description: Card recharge configuration for the product.
                          x-onerway-value:
                            nullable: true
                            when:
                              en: Returned as `null` when no recharge configuration applies.
                              zh: 无充值配置时返回 `null`。
                        feeViews:
                          type:
                            - array
                            - "null"
                          description: Fee information displayed for the product.
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: Fee item name.
                              value:
                                type: string
                                description: Formatted fee item value.
                          x-onerway-value:
                            nullable: true
                            empty: true
                            when:
                              en: Returned as `null` or an empty array when no fee information is available.
                              zh: 无费用信息时返回 `null` 或空数组。
                    x-onerway-value:
                      nullable: true
                      empty: true
                      when:
                        en: Returned as `null` when the query fails, or as an empty array when no card
                          product is available.
                        zh: 查询失败时返回 `null`；无可用卡产品时返回空数组。
              examples:
                success:
                  summary: Card products returned
                  value:
                    respCode: "20000"
                    respMsg: success
                    data:
                      - productId: 20001
                        productName: Example Virtual Card
                        cardBin: "411111"
                        cardScheme: VISA
                        issueCurrency: USD
                        issueRegionCode: US
                        cardholderConfig:
                          maxCardCount: 5
                          requiredFields:
                            - firstName
                            - lastName
                        cardRechargeConfig:
                          rechargeMinQuota: 10
                          rechargeMaxQuota: 10000
                        feeViews:
                          - name: setupFee
                            value: 10.00 USD
```
