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

# Get all Cards

> List customer virtual cards for your business



## OpenAPI

````yaml api-reference/openapi.json GET /pms/api/external/request/virtual-cards/
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /pms/api/external/request/virtual-cards/:
    get:
      tags:
        - Issuing
      summary: Get all Cards
      description: >-
        List issued virtual cards for the authenticated business (customer and
        business cards). Returns masked_pan only — use Get a Card for full
        card_number and cvv on a single card.
      operationId: externalVirtualCardsList
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: 'Filter: PENDING, ACTIVE, FROZEN, TERMINATED, FAILED'
          schema:
            type: string
            enum:
              - PENDING
              - ACTIVE
              - FROZEN
              - TERMINATED
              - FAILED
      responses:
        '200':
          description: Virtual cards retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualCardListResponse'
              examples:
                success:
                  summary: Issued cards (customer and business)
                  value:
                    status: true
                    message: Virtual cards retrieved successfully
                    data:
                      - id: 7f219a25-d968-4894-9a8b-ba83fa0bf6ec
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 557350******7848
                        status: ACTIVE
                        currency: USD
                        brand: MASTERCARD
                        balance: '3.00'
                        expiry: 08/31
                        created_datetime: '2026-05-24T00:38:02.543669'
                        updated_datetime: '2026-05-24T03:20:19.331923'
                      - id: a0e7ed8b-bbb7-48d2-81e1-d76d98965006
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 227449******4392
                        status: TERMINATED
                        currency: USD
                        brand: VISA
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T21:35:08.115964'
                        updated_datetime: '2026-05-22T21:35:50.942942'
                      - id: aae598cc-99d9-4730-80f5-4044d49bba75
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: business
                        customer_id: null
                        customer_name: null
                        business_name: Nex Panther Technologies
                        card_name: MARKETING CARD
                        masked_pan: 222980******7461
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T20:29:31.615688'
                        updated_datetime: '2026-05-24T02:05:56.229932'
                      - id: 94659981-fcdd-46fc-baf6-ed2defe11497
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: business
                        customer_id: null
                        customer_name: null
                        business_name: Nex Panther Technologies
                        card_name: NEX PANTHER TECHNOLOGIES
                        masked_pan: 556239******1702
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T20:16:55.532341'
                        updated_datetime: '2026-05-24T02:09:20.005748'
                      - id: e52c1e97-4266-4673-ba17-2f5c581a471a
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 271479******0667
                        status: TERMINATED
                        currency: USD
                        brand: VISA
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T20:05:58.926686'
                        updated_datetime: '2026-05-22T20:11:53.886907'
                      - id: ef8bfabb-a362-42e2-b881-4264466d1092
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 222216******9786
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T20:04:53.885611'
                        updated_datetime: '2026-05-22T20:05:30.183982'
                      - id: 8d56aa56-0539-4a12-bd07-186754a5c30d
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 222631******9071
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T20:02:12.217529'
                        updated_datetime: '2026-05-22T20:03:54.927384'
                      - id: 1e68abb2-ffea-4325-b8cf-ee47ef1181a7
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 559823******2749
                        status: TERMINATED
                        currency: USD
                        brand: VISA
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T19:59:03.393789'
                        updated_datetime: '2026-05-22T19:59:55.652210'
                      - id: 821e3321-818d-44aa-8816-b8078d83651c
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 257392******6469
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T19:36:16.031791'
                        updated_datetime: '2026-05-22T19:55:15.561682'
                      - id: 8b248314-1303-4cfe-abf5-db9353da4cc7
                        business_id: 8f926b04-e63a-4449-b346-ea922b69e20e
                        kind: customer
                        customer_id: 5e6bda15-1090-4cfe-bc1d-861990947bbc
                        customer_name: MUSA GANIYU
                        business_name: null
                        card_name: Ganiyu Musa
                        masked_pan: 229160******5625
                        status: TERMINATED
                        currency: USD
                        brand: MASTERCARD
                        balance: '0.00'
                        expiry: 08/31
                        created_datetime: '2026-05-22T19:10:25.288651'
                        updated_datetime: '2026-05-22T19:35:48.059145'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  summary: Invalid credentials
                  value:
                    error: 401
                    message: Unauthorized. Please check your API key.
        '403':
          description: Forbidden request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    VirtualCardListResponse:
      type: object
      properties:
        status:
          type: boolean
          description: Indicates whether the request succeeded
        message:
          type: string
          description: Human-readable result message
        data:
          type: array
          description: List of issued cards
          items:
            $ref: '#/components/schemas/IssuedCard'
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
    IssuedCard:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: PayVessel card ID
        business_id:
          type: string
          format: uuid
          description: Owning business
        kind:
          type: string
          description: customer card
        customer_id:
          type: string
          format: uuid
          description: Linked customer ID
        customer_name:
          type: string
          description: Customer display name
        card_name:
          type: string
          description: Name on card
        masked_pan:
          type: string
          description: Masked PAN (empty while PENDING)
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - FROZEN
            - TERMINATED
            - FAILED
          description: Card lifecycle status
        currency:
          type: string
          description: USD
        brand:
          type: string
          description: VISA or MASTERCARD
        balance:
          type: string
          description: Issuer-synced balance in USD
        expiry:
          type: string
          description: Card expiry (MM/YY)
        card_number:
          type: string
          description: Full PAN (GET card only, when ACTIVE/FROZEN)
        cvv:
          type: string
          description: CVV (GET card only, when ACTIVE/FROZEN)
        created_datetime:
          type: string
          format: date-time
        updated_datetime:
          type: string
          format: date-time

````