> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clinkbill.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 支付方式列表

> Lists the payment methods of the token's customer.

不会返回 PAN 或 CVV。添加卡片请使用[绑定银行卡](https://docs.clinkbill.com/cn/api-reference/agent-portal/bind_card.md)。如果要在一次流程中完成绑卡和购买授权，请在[创建指令](https://docs.clinkbill.com/cn/api-reference/agent-portal/create_instruction.md)中省略 `payment_instrument_id`。删除卡片请使用[删除支付方式](https://docs.clinkbill.com/cn/api-reference/agent-portal/delete_payment_method.md)。


## OpenAPI

````yaml GET /agent/platform/payment-methods
openapi: 3.1.0
info:
  title: Clink Agent Portal API
  description: >-
    Agent Portal APIs let an Agent platform read and manage one user's Clink
    account with a portal user token: payment methods, orders, refunds, purchase
    instructions, payment credentials, payment results, and settings.
  version: 1.0.0
servers:
  - url: https://uat-api.clinkbill.com
    description: Sandbox
security:
  - PortalToken: []
paths:
  /agent/platform/payment-methods:
    get:
      summary: List payment methods
      description: Lists the payment methods of the token's customer.
      operationId: listPaymentMethods
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    description: '`200` on success.'
                    example: 200
                  msg:
                    type: string
                    description: Result message.
                    example: Success
                  data:
                    $ref: '#/components/schemas/PaymentMethodList'
              example:
                code: 200
                msg: Success
                data:
                  payment_methods:
                    - payment_instrument_id: pi_...
                      payment_method_type: CARD
                      payment_instrument_type: VIRTUAL_CARD
                      card_scheme: VISA
                      card_last_four: '4242'
                      expiry_month: '12'
                      expiry_year: '2030'
                      issuer_bank: Example Bank
                      is_default: true
                      status: ACTIVE
        '401':
          description: Missing, expired, or invalid portal token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Wrong token audience, missing scope, or a platform client token used
            instead of a portal token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PaymentMethodList:
      type: object
      properties:
        payment_methods:
          type: array
          description: The customer's payment methods.
          items:
            $ref: '#/components/schemas/PaymentMethod'
    ErrorResponse:
      type: object
      description: Business errors use the standard envelope without `data`.
      properties:
        code:
          type: integer
          description: >-
            Numeric business error code. Judge an error by the HTTP status
            together with `code`, not by a string error code.
        msg:
          type: string
          description: Human-readable description.
    PaymentMethod:
      type: object
      properties:
        payment_instrument_id:
          type: string
          description: >-
            Payment method ID. Use it to create an instruction with an existing
            card, or to delete the payment method.
          example: pi_...
        payment_method_type:
          type: string
          description: Payment method type, for example `CARD`.
          example: CARD
        payment_instrument_type:
          type: string
          description: Payment instrument type, for example `VIRTUAL_CARD`.
          example: VIRTUAL_CARD
        card_scheme:
          type: string
          description: Card scheme, for example `VISA`.
          example: VISA
        card_last_four:
          type: string
          description: Last four digits of the card.
          example: '4242'
        expiry_month:
          type: string
          description: Card expiry month.
          example: '12'
        expiry_year:
          type: string
          description: Card expiry year.
          example: '2030'
        issuer_bank:
          type: string
          description: Issuing bank.
          example: Example Bank
        is_default:
          type: boolean
          description: >-
            Whether this is the card used by default. The default card can be
            deleted.
          example: true
        status:
          type: string
          description: Payment method status.
          enum:
            - ACTIVE
            - DISABLED
          example: ACTIVE
  securitySchemes:
    PortalToken:
      type: http
      scheme: bearer
      description: >-
        Portal user token from `POST /agent/cwallet/platform/portal/tokens`.
        Reads require `portal:read`; writes require `portal:write`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.