> ## Documentation Index
> Fetch the complete documentation index at: https://direct-api.reap.global/llms.txt
> Use this file to discover all available pages before exploring further.

# List cards

> Required API-key scope: `cards:read`.

Returns the cards on your Business Account, with each card's status, cardholder, budget, spending limits and how much it has spent. Use it to show a card list in your own tools, find a card by cardholder, nickname or last four digits, or check which cards are close to their limits. To get a single card, use [Retrieve a card](/api-reference/cards/retrieve-a-card). See [Cards](/concepts/cards).

## Filter and sort cards

Pass one or more public statuses separated by commas, for example `status=active,frozen`.
Status filters match the status returned on each card, including lifecycle flags and expiry rules.

Filter creation or last update time with `createdAt[gte]`, `createdAt[lt]`, `updatedAt[gte]` and `updatedAt[lt]`.
`gte` includes its instant; `lt` excludes it. Either bound can be omitted.
A date such as `2026-10-01` means midnight UTC. Timestamps must include `Z` or a timezone offset.
When encoding an offset in a URL, encode `+` as `%2B`.

For active or frozen cards created during October:

```http
GET /2026-07-13/cards?status=active,frozen&createdAt[gte]=2026-10-01&createdAt[lt]=2026-11-01&sort=createdAt:desc
```

For cards updated since a specific instant:

```http
GET /2026-07-13/cards?updatedAt[gte]=2026-11-04T08:00:00Z&sort=updatedAt:asc
```

All supplied filters combine with AND. A card can match any status in the status list.
Invalid statuses, malformed ranges, invalid dates, and unsupported sorting return `400`.
When both bounds are supplied, `gte` must be strictly before `lt`.

Sort by `id`, `createdAt` or `updatedAt`, optionally followed by `:asc` or `:desc`.
The default direction is ascending. Timestamp sorts use card ID in the same direction to break ties.
Omitting `sort` preserves the existing ordering.
The ordering is deterministic for unchanged data; page/limit pagination does not provide a snapshot when cards change between requests.


## OpenAPI

````yaml /openapi/2026-11-05.json get /2026-11-05/cards
openapi: 3.1.0
info:
  title: Reap Business Account API
  description: >

    # Introduction


    The Reap Business Account API lets you manage cards, spend and Treasury

    funding for your Business Account from your own systems. Every endpoint is

    authenticated with an API key sent in the `x-api-key` header and versioned

    with a date in the URL (`/2026-11-05/...`).


    Guides, concepts and the full setup reference live on the docs site:

    [direct-api.reap.global](https://direct-api.reap.global).



    ## Errors


    All errors share a single JSON envelope:


    ```json

    {
      "statusCode": 400,
      "type": "INVALID_REQUEST_ERROR",
      "code": "SPEND_CAP_TOO_LOW",
      "message": "Spend cap cannot be lower than the amount already spent on this card.",
      "param": "spendCap",
      "requestId": "01H..."
    }

    ```


    - `statusCode`: HTTP status, duplicated in the body.

    - `type`: coarse category, **always present**. Branch on this for
    retry/re-auth decisions.

    - `code`: stable, machine-readable identifier. Present only for
    programmatically-actionable errors.

    - `message`: human-readable explanation, safe to surface to users.

    - `param`: offending field for validation errors (optional).

    - `details`: structured extra context such as validation issues or required
    API-key scopes (optional).

    - `requestId`: correlation id; include it when contacting support
    (optional).


    The specific error codes each endpoint can return are documented on that

    endpoint's responses below.


    ### Error types


    | Type | Description |

    | --- | --- |

    | `INVALID_REQUEST_ERROR` | The request was rejected due to invalid input, a
    missing resource, or a business-rule violation (HTTP 400/404/409/422). |

    | `AUTHENTICATION_ERROR` | Authentication is missing or invalid (HTTP 401).
    |

    | `PERMISSION_ERROR` | The caller is authenticated but not permitted to
    perform the action (HTTP 403). |

    | `RATE_LIMIT_ERROR` | Too many requests; retry after a delay (HTTP 429). |

    | `API_ERROR` | An unexpected error occurred on our side (HTTP 5xx). |

    | `UPSTREAM_ERROR` | An upstream service returned an error (HTTP 502/503). |
  version: '2026-11-05'
  contact: {}
servers:
  - url: https://api.global.direct.reap.global
security: []
tags: []
paths:
  /2026-11-05/cards:
    get:
      tags:
        - Cards
      summary: List cards
      description: >-
        Required API-key scope: `cards:read`.


        Returns the cards on your Business Account, with each card's status,
        cardholder, budget, spending limits and how much it has spent. Use it to
        show a card list in your own tools, find a card by cardholder, nickname
        or last four digits, or check which cards are close to their limits. To
        get a single card, use [Retrieve a
        card](/api-reference/cards/retrieve-a-card). See
        [Cards](/concepts/cards).
      operationId: listCards
      parameters:
        - name: page
          required: false
          in: query
          description: >-
            Which page of results to return, starting at 1 (the default). Use it
            with `meta.totalPages` to go through all results.
          schema:
            default: 1
            description: >-
              Which page of results to return, starting at 1 (the default). Use
              it with `meta.totalPages` to go through all results.
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: limit
          required: false
          in: query
          description: >-
            How many items to return per page. It must be between 1 and 100
            (default 20).
          schema:
            default: 20
            description: >-
              How many items to return per page. It must be between 1 and 100
              (default 20).
            type: integer
            minimum: 1
            maximum: 100
        - name: status
          required: false
          in: query
          description: >-
            Only return cards with these public statuses. Separate multiple
            statuses with commas, for example active,frozen.
          schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - active
                - frozen
                - inactive
                - expiring
                - expired
                - terminated
            example:
              - active
              - frozen
          style: form
          explode: false
        - name: createdAt
          required: false
          in: query
          description: >-
            Filter creation time. For example,
            `createdAt[gte]=2026-10-01&createdAt[lt]=2026-11-01` includes all of
            October in UTC. Either bound can be omitted.
          schema:
            description: >-
              Filter creation time. For example,
              `createdAt[gte]=2026-10-01&createdAt[lt]=2026-11-01` includes all
              of October in UTC. Either bound can be omitted.
            allOf:
              - $ref: '#/components/schemas/CardDateRange'
          style: deepObject
          explode: true
        - name: updatedAt
          required: false
          in: query
          description: >-
            Filter last update time. For example,
            `updatedAt[gte]=2026-11-04T08:00:00Z` includes cards updated at or
            after that instant. Either bound can be omitted.
          schema:
            description: >-
              Filter last update time. For example,
              `updatedAt[gte]=2026-11-04T08:00:00Z` includes cards updated at or
              after that instant. Either bound can be omitted.
            allOf:
              - $ref: '#/components/schemas/CardDateRange'
          style: deepObject
          explode: true
        - name: sort
          required: false
          in: query
          description: >-
            Sort by id, createdAt or updatedAt, optionally followed by :asc or
            :desc. Default direction is asc. Timestamp sorts also order by id in
            the same direction. Omit to preserve the existing order.
          schema:
            description: >-
              Sort by id, createdAt or updatedAt, optionally followed by :asc or
              :desc. Default direction is asc. Timestamp sorts also order by id
              in the same direction. Omit to preserve the existing order.
            example: createdAt:desc
            type: string
            pattern: ^(id|createdAt|updatedAt)(:(asc|desc))?$
        - name: type
          required: false
          in: query
          description: Only return `virtual` or `physical` cards. Leave it out to get both.
          schema:
            type: string
            enum:
              - virtual
              - physical
            description: >-
              Only return `virtual` or `physical` cards. Leave it out to get
              both.
        - name: name
          required: false
          in: query
          description: >-
            Only return cards whose cardholder's name contains this text,
            ignoring upper and lower case. For example, `ada` matches `Ada
            Lovelace`.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Only return cards whose cardholder's name contains this text,
              ignoring upper and lower case. For example, `ada` matches `Ada
              Lovelace`.
        - name: email
          required: false
          in: query
          description: >-
            Only return cards whose cardholder's email contains this text,
            ignoring case. For example, `@marketing.acme.com` returns everyone
            on that domain.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Only return cards whose cardholder's email contains this text,
              ignoring case. For example, `@marketing.acme.com` returns everyone
              on that domain.
        - name: title
          required: false
          in: query
          description: >-
            Only return cards whose nickname contains this text, ignoring case.
            This works well with a naming convention, for example `CMP-` for all
            campaign cards.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Only return cards whose nickname contains this text, ignoring
              case. This works well with a naming convention, for example `CMP-`
              for all campaign cards.
        - name: last4
          required: false
          in: query
          description: >-
            Only return cards ending in these four digits. Useful when a team
            member reads out the last digits of their card.
          schema:
            type: string
            minLength: 4
            maxLength: 4
            description: >-
              Only return cards ending in these four digits. Useful when a team
              member reads out the last digits of their card.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardList'
              examples:
                cards:
                  summary: Cards
                  value:
                    items:
                      - id: 3db05d6f-97a9-4c06-a578-087b14b4f859
                        type: virtual
                        status: active
                        title: Travel card
                        last4: '4242'
                        expiresAt: '2028-08-31'
                        isRevolving: false
                        planType: topUp
                        category: Travel
                        cardholder:
                          userId: user_01JZ2Q1J4Y8P7M6N5K3H2G1F0E
                          name: Ada Lovelace
                          email: ada@example.com
                        spendCap:
                          amount: '5000.00'
                          currency: USD
                        spentAmount:
                          amount: '0.00'
                          currency: USD
                        spendControl:
                          limits:
                            transaction:
                              amount: '1000.00'
                              currency: USD
                            monthly:
                              amount: '5000.00'
                              currency: USD
                          spent:
                            monthly:
                              amount: '0.00'
                              currency: USD
                          atm:
                            dailyWithdrawal:
                              amount: '500.00'
                              currency: USD
                            dailyFrequency: 3
                        restriction:
                          time:
                            start: '09:00'
                            end: '18:00'
                          category:
                            allow: true
                            values:
                              - flights
                        createdAt: '2026-07-13T08:00:00.000Z'
                        updatedAt: '2026-07-13T08:00:00.000Z'
                    meta:
                      totalItems: 1
                      itemCount: 1
                      itemsPerPage: 20
                      totalPages: 1
                      currentPage: 1
        '400':
          description: '`BAD_REQUEST`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                BAD_REQUEST:
                  summary: BAD_REQUEST
                  value:
                    statusCode: 400
                    type: INVALID_REQUEST_ERROR
                    message: Bad request.
        '401':
          description: '`UNAUTHORIZED`, `AUTH_CREDENTIAL_MISSING`, `API_KEY_INVALID`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED:
                  summary: UNAUTHORIZED
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    message: Authentication required.
                AUTH_CREDENTIAL_MISSING:
                  summary: AUTH_CREDENTIAL_MISSING
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    code: AUTH_CREDENTIAL_MISSING
                    message: Authentication is required.
                API_KEY_INVALID:
                  summary: API_KEY_INVALID
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    code: API_KEY_INVALID
                    message: API key is invalid.
        '403':
          description: >-
            `FORBIDDEN`, `API_KEY_IP_NOT_ALLOWED`,
            `AUTH_INSUFFICIENT_PERMISSIONS`, `AUTH_METHOD_NOT_ALLOWED`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                FORBIDDEN:
                  summary: FORBIDDEN
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    message: You do not have permission to perform this action.
                API_KEY_IP_NOT_ALLOWED:
                  summary: API_KEY_IP_NOT_ALLOWED
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: API_KEY_IP_NOT_ALLOWED
                    message: Request IP is not allowed for this API key.
                AUTH_INSUFFICIENT_PERMISSIONS:
                  summary: AUTH_INSUFFICIENT_PERMISSIONS
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: AUTH_INSUFFICIENT_PERMISSIONS
                    message: Insufficient permissions.
                    details:
                      requiredScopes:
                        - <required-scope>
                AUTH_METHOD_NOT_ALLOWED:
                  summary: AUTH_METHOD_NOT_ALLOWED
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: AUTH_METHOD_NOT_ALLOWED
                    message: >-
                      This endpoint does not accept the credential type
                      provided.
        '429':
          description: '`API_KEY_RATE_LIMITED`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_RATE_LIMITED:
                  summary: API_KEY_RATE_LIMITED
                  value:
                    statusCode: 429
                    type: RATE_LIMIT_ERROR
                    code: API_KEY_RATE_LIMITED
                    message: API key rate limit exceeded.
        '500':
          description: '`INTERNAL_ERROR`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    statusCode: 500
                    type: API_ERROR
                    message: An unexpected error occurred.
        '504':
          description: '`UPSTREAM_TIMEOUT`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UPSTREAM_TIMEOUT:
                  summary: UPSTREAM_TIMEOUT
                  value:
                    statusCode: 504
                    type: UPSTREAM_ERROR
                    code: UPSTREAM_TIMEOUT
                    message: >-
                      An upstream service did not respond in time. If this
                      request changes data, it may still have been applied, so
                      fetch the resource before you retry.
      security:
        - apiKey: []
components:
  schemas:
    CardDateRange:
      type: object
      properties:
        gte:
          anyOf:
            - type: string
              format: date
              example: '2026-10-01'
            - type: string
              format: date-time
              example: '2026-10-01T08:00:00Z'
          description: >-
            Inclusive lower bound. For example, `2026-10-01` (midnight UTC) or
            `2026-10-01T08:00:00Z`. Timestamps must include Z or a timezone
            offset.
          example: '2026-10-01'
        lt:
          anyOf:
            - type: string
              format: date
              example: '2026-11-01'
            - type: string
              format: date-time
              example: '2026-11-01T08:00:00Z'
          description: >-
            Exclusive upper bound. For example, `2026-11-01` excludes November 1
            and later. You can also use a timestamp such as
            `2026-11-01T08:00:00Z`.
          example: '2026-11-01'
      additionalProperties: false
      example:
        gte: '2026-10-01'
        lt: '2026-11-01'
    CardList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: >-
                  The card's unique ID. Use it with [Retrieve a
                  card](/api-reference/cards/retrieve-a-card), [Freeze
                  card](/api-reference/cards/freeze-card) and the other card
                  endpoints.
              type:
                type: string
                enum:
                  - virtual
                  - physical
                description: Whether this is a `virtual` or a `physical` card.
              status:
                type: string
                enum:
                  - pending
                  - active
                  - frozen
                  - inactive
                  - expiring
                  - expired
                  - terminated
                description: >-
                  Where the card is in its lifecycle: `pending` (a physical card
                  not yet activated), `active` (ready to use), `frozen` (paused,
                  can be unfrozen), `inactive` (not usable for another reason,
                  such as a restricted or blocked card), `expiring` (a physical
                  card within 90 days of its expiry date), `expired` or
                  `terminated` (permanently closed).
              title:
                description: >-
                  The card's nickname, set when the card was created or renamed
                  with [Edit card
                  details](/api-reference/cards/edit-card-details).
                type:
                  - string
                  - 'null'
              last4:
                description: >-
                  The last four digits of the card number. To see the full card
                  details, use [Reveal card
                  details](/api-reference/cards/reveal-card-details).
                type:
                  - string
                  - 'null'
              expiresAt:
                description: The date the card expires (`YYYY-MM-DD`).
                type:
                  - string
                  - 'null'
                format: date
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
              isRevolving:
                type: boolean
                description: >-
                  Whether the card draws from your business's shared revolving
                  budget. It's always `false` for top-up cards.
              planType:
                description: >-
                  How the card is funded: `subscription` (draws on shared credit
                  within its limits), `topUp` (has its own fixed budget in
                  `spendCap`) or `physical` (a physical card plan).
                type:
                  - string
                  - 'null'
                enum:
                  - physical
                  - subscription
                  - topUp
                  - null
              category:
                description: >-
                  The display name of the card category chosen when the card was
                  created, for example `Travel`. It describes what the card is
                  for and is different from each card transaction's category. To
                  create a card with this category, pass its `id` from [List
                  card categories](/api-reference/cards/list-card-categories).
                type:
                  - string
                  - 'null'
              cardholder:
                type: object
                properties:
                  userId:
                    description: >-
                      The team member's ID, the same as in [List team
                      members](/api-reference/team-members/list-team-members).
                    type:
                      - string
                      - 'null'
                  name:
                    description: The team member's full name.
                    type:
                      - string
                      - 'null'
                  email:
                    description: The team member's email address.
                    type:
                      - string
                      - 'null'
                required:
                  - userId
                  - name
                  - email
                description: The team member the card belongs to.
              spendCap:
                description: >-
                  The fixed budget set aside for the card; for top-up cards,
                  this is how much the card can spend in total. Change it with
                  [Update spend
                  control](/api-reference/cards/update-spend-control). Null if
                  the card has no fixed budget.
                type:
                  - object
                  - 'null'
                properties:
                  amount:
                    type: string
                    description: >-
                      The amount as a string with two decimals, for example
                      `100.00`.
                  currency:
                    type: string
                    description: The three-letter currency code, for example `USD`.
                required:
                  - amount
                  - currency
              spentAmount:
                type: object
                properties:
                  amount:
                    type: string
                    description: >-
                      The amount as a string with two decimals, for example
                      `100.00`.
                  currency:
                    type: string
                    description: The three-letter currency code, for example `USD`.
                required:
                  - amount
                  - currency
                description: >-
                  How much has been spent on the card since it was created. For
                  top-up cards, compare it with `spendCap` to see how much
                  budget is left.
              spendControl:
                type: object
                properties:
                  limits:
                    type: object
                    properties:
                      transaction:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most a single card transaction can be.
                      daily:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most the card can spend in one day.
                      weekly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most the card can spend in one week.
                      monthly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most the card can spend in one month.
                      yearly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most the card can spend in one year.
                      allTime:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most the card can spend over its whole life.
                    description: >-
                      The spending limits set on the card. Only the limits that
                      have been set are returned.
                  spent:
                    type: object
                    properties:
                      daily:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: Spent so far today.
                      weekly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: Spent so far this week.
                      monthly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: Spent so far this month.
                      yearly:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: Spent so far this year.
                      allTime:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: Spent since the card was created.
                    description: >-
                      How much the card has spent so far in each period that has
                      a limit. Compare it with `limits` to see how much room is
                      left.
                  atm:
                    type: object
                    properties:
                      dailyWithdrawal:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most cash that can be withdrawn in one day.
                      monthlyWithdrawal:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most cash that can be withdrawn in one month.
                      yearlyWithdrawal:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount as a string with two decimals, for
                              example `100.00`.
                          currency:
                            type: string
                            description: The three-letter currency code, for example `USD`.
                        required:
                          - amount
                          - currency
                        description: The most cash that can be withdrawn in one year.
                      dailyFrequency:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: The maximum number of ATM withdrawals per day.
                      monthlyFrequency:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: The maximum number of ATM withdrawals per month.
                      yearlyFrequency:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: The maximum number of ATM withdrawals per year.
                    description: >-
                      Limits on cash withdrawals at ATMs, which apply to
                      physical cards.
                description: >-
                  The card's spending limits, plus how much has been spent in
                  each period so far.
              restriction:
                type: object
                properties:
                  time:
                    description: >-
                      The window of hours each day when the card can be used, in
                      UTC. Null means the card can be used at any time.
                    type:
                      - object
                      - 'null'
                    properties:
                      start:
                        description: >-
                          When the window opens each day, in UTC (`HH:mm`), for
                          example `09:00`.
                        type:
                          - string
                          - 'null'
                      end:
                        description: >-
                          When the window closes each day, in UTC (`HH:mm`), for
                          example `18:00`.
                        type:
                          - string
                          - 'null'
                    required:
                      - start
                      - end
                  category:
                    description: >-
                      The transaction categories the card is limited to. Null
                      means the card has no category restriction.
                    type:
                      - object
                      - 'null'
                    properties:
                      allow:
                        type: boolean
                        description: >-
                          When `true`, the card can only be used in the
                          categories in `values`. When `false`, the card can be
                          used in every category except those in `values`. Cards
                          you set through this API always have `true`.
                      values:
                        type: array
                        items:
                          type: string
                        description: >-
                          The category codes of the restriction, for example
                          `flights`. The codes you can set are
                          `software_and_saas`, `cloud_and_infrastructure`,
                          `advertising_and_marketing`, `conferences_and_events`,
                          `flights`, `lodging_and_hotels`,
                          `rideshare_and_taxis`, `ground_and_other_travel`,
                          `meals_and_entertainment`,
                          `computers_and_electronic_devices`,
                          `office_supplies_and_furniture`, `utilities`,
                          `telecom`, `shipping_and_logistics`,
                          `professional_services`, `legal`,
                          `accounting_and_tax`, `insurance`,
                          `banking_and_financial_fees`,
                          `education_and_training`,
                          `subscriptions_and_memberships`,
                          `general_merchandise`.
                    required:
                      - allow
                      - values
                description: >-
                  Rules on when and in which transaction categories the card can
                  be used. Change them with [Update card usage
                  restriction](/api-reference/cards/update-card-usage-restriction).
              createdAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                description: When the card was created, in UTC.
              updatedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                description: >-
                  When the card's details, limits or status last changed, in
                  UTC.
            required:
              - id
              - type
              - status
              - title
              - last4
              - expiresAt
              - isRevolving
              - planType
              - category
              - cardholder
              - spendCap
              - spentAmount
              - spendControl
              - restriction
              - createdAt
              - updatedAt
          description: The cards on this page, one object per card.
        meta:
          type: object
          properties:
            totalItems:
              type: number
              description: How many items match your filters, across all pages.
            itemCount:
              type: number
              description: How many items are on this page.
            itemsPerPage:
              type: number
              description: The page size you asked for with `limit`.
            totalPages:
              type: number
              description: >-
                How many pages there are in total. Keep requesting the next
                `page` until you reach this number.
            currentPage:
              type: number
              description: The page number you're looking at, starting at 1.
          required:
            - totalItems
            - itemCount
            - itemsPerPage
            - totalPages
            - currentPage
          description: >-
            Pagination details, so you know how many results exist and which
            page you're on.
      required:
        - items
        - meta
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          minimum: 100
          maximum: 599
          description: The HTTP status code, repeated in the body for convenience.
        type:
          type: string
          enum:
            - INVALID_REQUEST_ERROR
            - AUTHENTICATION_ERROR
            - PERMISSION_ERROR
            - RATE_LIMIT_ERROR
            - API_ERROR
            - UPSTREAM_ERROR
          description: >-
            The broad kind of error, for example `RATE_LIMIT_ERROR`. It's always
            present: use it to decide whether to retry, re-authenticate or fix
            the request.
        code:
          description: >-
            A stable, machine-readable error code, for example
            `CARD_CREATION_REQUIRES_DEPOSIT`. It's present when there's a
            specific action you can take, and each endpoint lists the codes it
            can return.
          type: string
        message:
          type: string
          description: >-
            A plain-English explanation of the error that's safe to show to your
            users.
        param:
          description: >-
            The request field that caused a validation error, for example
            `spendCap`.
          type: string
        details:
          description: >-
            Extra structured information, such as the list of validation issues
            or the API-key scopes your key is missing.
        requestId:
          description: >-
            A unique ID for this request. Include it when you contact Reap
            Support so the team can find it.
          type: string
      required:
        - statusCode
        - type
        - message
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Enter your API key

````

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