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

# List Cards

> Retrieve a list of all cards associated with the authenticated user.

**Usage Notes:**

Each returned card may include one or more status flags that indicate required user actions or usage limitations:

- `card_images_required`: The cardholder must upload both front and back images before the card can be used for any transactions.
- `withdrawal_confirm_required`: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.
- `payment_confirm_required`: Additional registration or verification is required before new payments can be made with this card.
- `compliance_check_required`: Indicates whether KYC/KYB compliance should be checked before card payments.
- `is_limited`: The user has reached their daily payment limit.
  → Note: No new payments can be made today using card, but withdrawals are still permitted.


If any of the first three flags (`card_images_required`, `withdrawal_confirm_required`, or `payment_confirm_required`) are `true`, the card must be updated before use.<br/>
    → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.



## OpenAPI

````yaml GET /api/platform/card/list/{user_id}
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: http://localhost:8001
  - url: https://api.pw.wintpay.com
  - url: https://test.pw.wintpay.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/card/list/{user_id}:
    get:
      tags:
        - Platform Card
      summary: List Card
      description: >-
        Retrieve a list of all cards associated with the authenticated user.


        **Usage Notes:**


        Each returned card may include one or more status flags that indicate
        required user actions or usage limitations:


        - `card_images_required`: The cardholder must upload both front and back
        images before the card can be used for any transactions.

        - `withdrawal_confirm_required`: A withdrawal setup or confirmation step
        must be completed before withdrawals are allowed.

        - `payment_confirm_required`: Additional registration or verification is
        required before new payments can be made with this card.

        - `compliance_check_required`: Indicates whether KYC/KYB compliance
        should be checked before card payments.

        - `is_limited`: The user has reached their daily payment limit.
          → Note: No new payments can be made today using card, but withdrawals are still permitted.


        If any of the first three flags (`card_images_required`,
        `withdrawal_confirm_required`, or `payment_confirm_required`) are
        `true`, the card must be updated before use.<br/>
            → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.
      operationId: list_user_cards_api_platform_card_list__user_id__get
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique identifier (UUID) of the user whose cards are being
              retrieved.
            title: User Id
          description: >-
            Unique identifier (UUID) of the user whose cards are being
            retrieved.
          example: f47ac10b-****-****-****-0e02b2c3d479
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalListResponse_PlatformCardRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalListResponse_PlatformCardRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
          description: HTTP status code representing the result of the request.
          default: 200
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: Short, human-readable message describing the outcome of the request.
          default: Success
        records:
          anyOf:
            - items:
                $ref: '#/components/schemas/PlatformCardRead'
              type: array
            - type: 'null'
          title: Records
          description: List of result items returned for the current page.
        totalRecords:
          anyOf:
            - type: integer
            - type: 'null'
          title: Totalrecords
          description: >-
            Total number of matching records in the database, useful for
            paginating the full dataset.
          default: 0
        queryGeneratedTime:
          anyOf:
            - type: integer
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            Unix timestamp (in seconds) indicating when this response was
            generated.
          default: 1782303609
      type: object
      title: ExternalListResponse[PlatformCardRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlatformCardRead:
      properties:
        user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: User Id
          description: Unique identifier of the user who owns this card
          example: 134dd73b-e378-4a0b-bbe8-447c8b9e4b1f
        card_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Card Id
          description: Unique identifier of the card
          example: fe0f3346-2f9a-4c5e-b104-0b95c18417fc
        card_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Number
          description: Last 4 digits of the card number, masked for security
          example: '4242'
        card_exp:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Exp
          description: Card expiration in MM/YYYY format
          example: 12/2029
        card_nick_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Nick Name
          description: Custom label assigned by the user to identify this card
          example: Primary Visa
        card_type:
          anyOf:
            - $ref: '#/components/schemas/CardType'
            - type: 'null'
          description: Card classification such as CREDIT or DEBIT
          example: CREDIT
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: First name of the cardholder as entered during registration
          example: John
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Last name of the cardholder as entered during registration
          example: Doe
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: Street address provided for cardholder verification
          example: 123 Main St
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: City associated with the cardholder's billing address
          example: New York
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
          description: State or region tied to the cardholder's billing address
          example: NY
        zip:
          anyOf:
            - type: string
            - type: 'null'
          title: Zip
          description: ZIP or postal code from the cardholder's billing address
          example: '10001'
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country code from the cardholder's billing address (e.g., US)
          example: US
        is_blocked:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Blocked
          description: Indicates whether the card is currently blocked from use
          example: false
        card_image1:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Image1
          description: URL of the front image of the physical card uploaded by the user.
          example: https://cdn.example.com/cards/front_134dd73b.png
        card_image2:
          anyOf:
            - type: string
            - type: 'null'
          title: Card Image2
          description: URL of the back image of the physical card uploaded by the user.
          example: https://cdn.example.com/cards/back_134dd73b.png
        card_images_required:
          type: boolean
          title: Card Images Required
          description: >-
            Indicates that card images are missing or mismatched and need to be
            re-uploaded. See [Update Card](/api-reference/cards/update-card).
          default: false
          example: false
        withdrawal_confirm_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Withdrawal Confirm Required
          description: >-
            Indicates that the user must complete a withdrawal confirmation
            before using this card. See [Update
            Card](/api-reference/cards/update-card).
          example: true
        payment_confirm_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Payment Confirm Required
          description: >-
            Set to true if the user must complete 3D Secure confirmation before
            making payments with this card. See [Update
            Card](/api-reference/cards/update-card).
          example: false
        compliance_check_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Compliance Check Required
          description: >-
            Indicates whether KYC/KYB compliance must be checked for card
            payments. This is false when either AVS or 3DS has passed.
          example: true
        is_limited:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Limited
          description: Indicates whether the user has reached their daily card usage limit
          example: true
      type: object
      title: PlatformCardRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CardType:
      type: string
      enum:
        - MASTERCARD
        - VISA
        - AMEX
        - DISCOVER
        - PW_MASTERCARD
        - PW_GIFT_MASTERCARD
      title: CardType

````