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

# List cards

> Cards belonging to your business. Each item carries its balance, holder, and operation history.

## Error codes

| Status | `code` | Cause |
| - | - | - |
| `400` | `validation_failed` | An unknown parameter, or a page size above 100. |
| `401` | `INVALID_API_KEY` | The key is missing, invalid, inactive, expired, from the other environment, or blocked by its IP allowlist. |
| `404` | `card_not_found` | No such card for this business. |
| `429` | `api_key_rate_limit_exceeded` | The per-minute limit for this key was exceeded. |


## OpenAPI

````yaml /openapi.json get /v1/cards
openapi: 3.1.0
info:
  title: Sakawave Business API
  version: 1.0.0-draft
  summary: >-
    Accounts, transfers, FX quotes, and transaction reconciliation for Sakawave
    businesses.
  description: >-
    Generated from the public NestJS controllers and their Zod request schemas.
    Public URLs and policy statements remain draft until the Phase 1 contract
    checklist is approved.
  contact:
    name: Sakawave API Support
    email: api-support@sakawave.example
servers:
  - url: https://sandbox-api.sakawave.example
    description: Sandbox (default)
  - url: https://api.sakawave.example
    description: Live
security:
  - bearerAuth: []
tags:
  - name: Bill payments
    description: Browse the biller catalog, validate a customer, and pay a bill.
  - name: Cards
    description: Issue, fund, and control USD virtual and disposable cards.
  - name: eSIM
    description: >-
      Sell mobile data abroad: browse the catalog, buy an eSIM, and manage it
      once installed.
  - name: Currencies and countries
    description: >-
      Reference data: what may be held, what may be sent where, and which
      jurisdictions are served.
  - name: Customers
    description: Create and manage customers of your business.
  - name: Accounts
    description: >-
      Open business and customer accounts, and issue the destinations that fund
      them.
  - name: Transfer destinations
    description: Resolve temporary destinations and saved recipients.
  - name: FX quotes
    description: Create and retrieve time-limited cross-currency quotes.
  - name: Transfers
    description: Preview, create, and monitor transfers.
  - name: Transactions
    description: Read ledger entries for reconciliation.
paths:
  /v1/cards:
    get:
      tags:
        - Cards
      summary: List cards
      description: >-
        Cards belonging to your business. Each item carries its balance, holder,
        and operation history.
      operationId: listCards
      parameters:
        - name: page
          in: query
          required: false
          description: One-based page number.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Records per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: status
          in: query
          required: false
          description: Filter by card status.
          schema:
            type: string
            enum:
              - creating
              - active
              - frozen
              - funding_failed
              - terminating
              - used
              - terminated
              - failed
              - fraud
        - name: type
          in: query
          required: false
          description: Filter by card type.
          schema:
            type: string
            enum:
              - virtual
              - disposable
      responses:
        '200':
          description: Successful response.
          headers:
            X-Request-ID:
              description: >-
                The request identifier assigned by Sakawave. Include it in
                support requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardPage'
              example:
                items:
                  - id: 01K2Z3AB4S5T6V7W8XYZABCDEF
                    label: Ada travel card
                    type: virtual
                    brand: mastercard
                    currency: USD
                    status: active
                    maskedPan: •••• •••• •••• 4242
                    expiryMonth: 8
                    expiryYear: 2028
                    holder:
                      type: customer
                      id: 01K2Z3AB4C5D6E7F8G9HJKMNPQ
                      name: Ada Okafor
                    balance: '5000'
                    balanceFormatted: '50.00'
                    spendingControls:
                      transactionAmountLimit: '2000'
                      dailyAmountLimit: '5000'
                      dailyTransactionCount: 10
                    operations:
                      - id: 01K2Z3AB4R5S6T7V8WXYZABCDE
                        cardId: 01K2Z3AB4S5T6V7W8XYZABCDEF
                        type: issuance
                        status: completed
                        sourceCurrency: NGN
                        destinationCurrency: USD
                        sourceAmount: '8000000'
                        destinationAmount: '5000'
                        failureCode: null
                        failureReason: null
                        completedAt: '2026-08-14T09:12:00.000Z'
                        createdAt: '2026-08-14T09:11:40.000Z'
                        updatedAt: '2026-08-14T09:12:00.000Z'
                    createdAt: '2026-08-14T09:11:40.000Z'
                    updatedAt: '2026-08-14T09:12:00.000Z'
                pagination:
                  page: 1
                  pageSize: 20
                  total: 1
                  pageCount: 1
                  hasNext: false
                  hasPrevious: false
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    CardPage:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CardResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - items
        - pagination
    CardResponse:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/Ulid'
        label:
          type: string
          maxLength: 80
          description: Your own name for the card.
        type:
          type: string
          enum:
            - virtual
            - disposable
        brand:
          type: string
          enum:
            - mastercard
        currency:
          type: string
          enum:
            - USD
          description: Cards are USD only.
        status:
          type: string
          enum:
            - creating
            - active
            - frozen
            - funding_failed
            - terminating
            - used
            - terminated
            - failed
            - fraud
        maskedPan:
          type: string
          description: >-
            The masked number. The full PAN is only available from the
            credentials endpoint.
        expiryMonth:
          type: integer
          minimum: 1
          maximum: 12
        expiryYear:
          type: integer
        holder:
          type: object
          additionalProperties: false
          properties:
            type:
              type: string
              enum:
                - customer
                - user
            id:
              anyOf:
                - $ref: '#/components/schemas/Ulid'
                - type: 'null'
            name:
              type: string
          required:
            - type
            - id
            - name
        balance:
          $ref: '#/components/schemas/MinorUnits'
        balanceFormatted:
          type: string
          description: The same figure rendered for display. Never use it in a calculation.
        spendingControls:
          anyOf:
            - $ref: '#/components/schemas/CardSpendingControls'
            - type: 'null'
        operations:
          type: array
          items:
            $ref: '#/components/schemas/CardOperationResponse'
          description: >-
            Issuance, funding, withdrawal, and termination operations for this
            card. Empty on a list response.
        createdAt:
          $ref: '#/components/schemas/IsoTimestamp'
        updatedAt:
          $ref: '#/components/schemas/IsoTimestamp'
      required:
        - id
        - label
        - type
        - brand
        - currency
        - status
        - maskedPan
        - expiryMonth
        - expiryYear
        - holder
        - balance
        - balanceFormatted
        - spendingControls
        - operations
        - createdAt
        - updatedAt
    Pagination:
      type: object
      additionalProperties: false
      properties:
        page:
          type: integer
          minimum: 1
        pageSize:
          type: integer
          minimum: 1
          maximum: 100
        total:
          type: integer
          minimum: 0
        pageCount:
          type: integer
          minimum: 0
        hasNext:
          type: boolean
        hasPrevious:
          type: boolean
      required:
        - page
        - pageSize
        - total
        - pageCount
        - hasNext
        - hasPrevious
    RequestError:
      anyOf:
        - $ref: '#/components/schemas/ValidationError'
        - $ref: '#/components/schemas/Error'
      description: >-
        Either a field-level validation failure carrying an errors array, or a
        rule the request broke, identified by code.
    Error:
      type: object
      additionalProperties: true
      properties:
        statusCode:
          type: integer
        message:
          type: string
          description: >-
            A sentence suitable for a log or a support conversation, not for a
            user interface.
        code:
          type: string
          description: >-
            The stable machine-readable reason. Branch on this, never on the
            message.
      required:
        - message
        - code
      description: >-
        An error body. Individual errors may add context fields alongside these
        three.
    RateLimitError:
      type: object
      additionalProperties: false
      properties:
        statusCode:
          const: 429
        message:
          type: string
        code:
          const: api_key_rate_limit_exceeded
        retryAfterSeconds:
          type: integer
          minimum: 1
      required:
        - statusCode
        - message
        - code
        - retryAfterSeconds
    Ulid:
      type: string
      minLength: 26
      maxLength: 26
      pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
      example: 01K2Z3AB4C5D6E7F8G9HJKMNPQ
      description: A 26-character ULID.
    MinorUnits:
      type: string
      pattern: ^-?\d+$
      example: '2500000'
      description: >-
        An integer number of the asset’s smallest unit. Use this value for
        arithmetic.
    CardSpendingControls:
      type: object
      additionalProperties: false
      properties:
        transactionAmountLimit:
          $ref: '#/components/schemas/PositiveMinorUnits'
        dailyAmountLimit:
          $ref: '#/components/schemas/PositiveMinorUnits'
        dailyTransactionCount:
          type: integer
          minimum: 1
          maximum: 10000
      description: Per-card limits, in USD minor units. Not available on a disposable card.
    CardOperationResponse:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/Ulid'
        cardId:
          $ref: '#/components/schemas/Ulid'
        type:
          type: string
          enum:
            - issuance
            - funding
            - withdrawal
            - termination
        status:
          type: string
          enum:
            - created
            - submitting
            - pending
            - completed
            - failed
        sourceCurrency:
          $ref: '#/components/schemas/AssetCode'
        destinationCurrency:
          $ref: '#/components/schemas/AssetCode'
        sourceAmount:
          $ref: '#/components/schemas/MinorUnits'
        destinationAmount:
          $ref: '#/components/schemas/MinorUnits'
        failureCode:
          anyOf:
            - type: string
            - type: 'null'
        failureReason:
          anyOf:
            - type: string
            - type: 'null'
        completedAt:
          anyOf:
            - $ref: '#/components/schemas/IsoTimestamp'
            - type: 'null'
        createdAt:
          $ref: '#/components/schemas/IsoTimestamp'
        updatedAt:
          $ref: '#/components/schemas/IsoTimestamp'
      required:
        - id
        - cardId
        - type
        - status
        - sourceCurrency
        - destinationCurrency
        - sourceAmount
        - destinationAmount
        - failureCode
        - failureReason
        - completedAt
        - createdAt
        - updatedAt
    IsoTimestamp:
      type: string
      format: date-time
      example: '2026-08-14T09:00:00.000Z'
    ValidationError:
      type: object
      additionalProperties: false
      properties:
        statusCode:
          const: 400
        message:
          type: string
          description: The single failure, or a count when more than one field failed.
        code:
          const: validation_failed
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationFailure'
      required:
        - statusCode
        - message
        - code
        - errors
    PositiveMinorUnits:
      type: string
      pattern: ^[1-9]\d*$
      example: '2500000'
      description: A positive integer number of minor units.
    AssetCode:
      type: string
      enum:
        - NGN
        - USD
        - GBP
        - EUR
        - GHS
        - ZAR
        - UGX
        - CAD
        - MXN
        - AED
        - BTC
        - ETH
        - USDT
        - USDC
    ValidationFailure:
      type: object
      additionalProperties: false
      properties:
        message:
          type: string
        field:
          type: string
        code:
          type: string
        path:
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
      required:
        - message
        - field
        - code
        - path
  responses:
    ValidationError:
      description: >-
        The request was rejected before it was acted on. Field failures list
        every failing field.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            statusCode: 400
            message: Must be a valid identifier.
            code: validation_failed
            errors:
              - message: Must be a valid identifier.
                field: accountId
                code: custom
                path:
                  - accountId
    AuthenticationError:
      description: >-
        The API key is missing, invalid, inactive, expired, for another
        environment, or blocked by its IP allowlist.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            code: INVALID_API_KEY
            message: Invalid or inactive API credentials.
    RateLimitError:
      description: The API key rate limit was exceeded.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
          example:
            statusCode: 429
            message: Too many API requests. Try again later.
            code: api_key_rate_limit_exceeded
            retryAfterSeconds: 17
    ServerError:
      description: An unexpected server error occurred.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 500
            code: internal_server_error
            message: An unexpected error occurred.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sakawave API key
      description: >-
        A secret API key, sent as `Authorization: Bearer sk_test_…` in sandbox
        or `Bearer sk_live_…` in live.

````

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