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

# Retrieve a payment method's card design

> Returns the card design printed on this payment method.

The design belongs to the card, not the customer: a customer with several
cards can have a different design on each, so read it per payment method.
Enumerate a customer's cards with
`GET /v2/customers/{customer_id}/payment_methods` and call this for the one
you care about.

A card may have no design resolved yet — some programs assign a default
asynchronously. That is a normal state, not an error: the response is `200`
with `selected: false` and no `card_design`.

Only `CARD` payment methods carry a design. A loan or bank account returns
`200` with `selected: false`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v2/payment_methods/{payment_method_id}/card_design
openapi: 3.1.0
info:
  title: Public Imprint API
  version: '2.0'
servers:
  - url: https://dev.sbx.imprint.co
    description: Imprint public api sandbox
security:
  - basicAuth: []
  - bearerAuth: []
paths:
  /v2/payment_methods/{payment_method_id}/card_design:
    get:
      tags:
        - Payment Methods
      summary: Retrieve a payment method's card design
      description: >
        Returns the card design printed on this payment method.


        The design belongs to the card, not the customer: a customer with
        several

        cards can have a different design on each, so read it per payment
        method.

        Enumerate a customer's cards with

        `GET /v2/customers/{customer_id}/payment_methods` and call this for the
        one

        you care about.


        A card may have no design resolved yet — some programs assign a default

        asynchronously. That is a normal state, not an error: the response is
        `200`

        with `selected: false` and no `card_design`.


        Only `CARD` payment methods carry a design. A loan or bank account
        returns

        `200` with `selected: false`.
      operationId: getPaymentMethodCardDesign
      parameters:
        - $ref: '#/components/parameters/paymentMethodIdParam'
          name: payment_method_id
      responses:
        '200':
          description: The payment method's card design, if any
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodCardDesignResponse'
        '404':
          description: Payment method not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodNotFoundError'
components:
  parameters:
    paymentMethodIdParam:
      name: payment_method_id
      in: path
      required: true
      description: The unique identifier of the payment method
      schema:
        type: string
        example: 9ED4FE47-8E9C-48E9-BBEF-094DF1789012
  schemas:
    PaymentMethodCardDesignResponse:
      type: object
      required:
        - selected
      properties:
        selected:
          type: boolean
          description: >
            Whether a card design is resolved for this payment method. When
            `false`,

            `card_design` is omitted.
        card_design:
          $ref: '#/components/schemas/CardDesign'
    PaymentMethodNotFoundError:
      type: object
      required:
        - type
        - message
      properties:
        type:
          type: string
          description: The category of error being returned
          example: PAYMENT_METHOD_NOT_FOUND_ERROR
        message:
          type: string
          description: A message describing the cause of the error.
          example: 'Payment method not found for provided ID: pymd_123'
        param:
          type: string
          description: The param causing the error
          example: payment_method_id
    CardDesign:
      type: object
      required:
        - id
        - name
        - access_min_rank
        - type
        - status
      properties:
        id:
          $ref: '#/components/schemas/CardDesignID'
        name:
          type: string
          description: Human-readable name of the card design
          example: Midnight Black
        access_min_rank:
          type: integer
          format: int64
          description: >
            Minimum loyalty tier rank a customer must hold to select this
            design. `0`

            means available to everyone. A design with a rank above the
            customer's own

            tier is returned but cannot be selected by them.
          example: 0
        loyalty_tier_name:
          type: string
          description: >
            Name of the loyalty tier corresponding to `access_min_rank`.
            Currently always

            omitted; use `access_min_rank` to determine gating.
          example: GOLD
        categories:
          type: object
          additionalProperties:
            type: string
          description: Partner-defined key/value labels for grouping designs
        image_orientation:
          $ref: '#/components/schemas/CardDesignOrientation'
        type:
          $ref: '#/components/schemas/CardDesignType'
        status:
          $ref: '#/components/schemas/CardDesignStatus'
        light_asset_url_path:
          type: string
          description: >
            Absolute URL of the card design artwork for light mode. Artwork is
            served

            from `https://assets.imprint.co` or `https://app.imprint.co`
            depending on

            where it was uploaded.
          example: >-
            https://assets.imprint.co/brand-assets/card-designs/light/midnight-black.svg
        dark_asset_url_path:
          type: string
          description: >
            Absolute URL of the card design artwork for dark mode. Artwork is
            served

            from `https://assets.imprint.co` or `https://app.imprint.co`
            depending on

            where it was uploaded.
          example: >-
            https://assets.imprint.co/brand-assets/card-designs/dark/midnight-black.svg
        virtual_digital_card_art_id:
          type: string
          description: Processor-side art identifier for the virtual card
        physical_digital_card_art_id:
          type: string
          description: Processor-side art identifier for the physical card
    CardDesignID:
      type: string
      description: Imprint ID for the graphic design printed on the card
      example: 3b9c1f3e-52a0-44c1-b131-a7ab0099a214
    CardDesignOrientation:
      type: string
      description: Orientation of the card design artwork
      enum:
        - UNSPECIFIED
        - VERTICAL
        - HORIZONTAL
      example: VERTICAL
    CardDesignType:
      type: string
      description: >
        Whether this is the program's default design or one of its selectable
        alternates.
      enum:
        - UNSPECIFIED
        - DEFAULT
        - REGULAR
      example: REGULAR
    CardDesignStatus:
      type: string
      description: |
        Availability of the design. Only `ACTIVE` designs can be selected.
      enum:
        - UNSPECIFIED
        - ACTIVE
        - INACTIVE
        - DELETED
      example: ACTIVE
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic HTTP authentication. Allowed headers-- Authorization: Basic
        <base64(api_key_id:api_key_secret)>
    bearerAuth:
      bearerFormat: auth-scheme
      description: >-
        Bearer HTTP authentication. Allowed headers-- Authorization: Bearer
        <api_key>
      scheme: bearer
      type: http

````