> ## 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.

# Update spend control

> Required API-key scope: `spend_controls:write`.

Changes a card's budget and spending limits. For a top-up card, raise `spendCap` to add funds: it's the new total, not an amount to add, and it can't be lower than what the card has already spent. Sending `limits` replaces all existing limits, `null` removes them, and leaving a field out keeps it unchanged. A terminated card can't be changed and returns `CARD_STATE_CONFLICT`. See [Spend controls](/concepts/spend-controls).



## OpenAPI

````yaml /openapi/2026-11-05.json put /2026-11-05/cards/{cardId}/spend-control
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/{cardId}/spend-control:
    put:
      tags:
        - Cards
      summary: Update spend control
      description: >-
        Required API-key scope: `spend_controls:write`.


        Changes a card's budget and spending limits. For a top-up card, raise
        `spendCap` to add funds: it's the new total, not an amount to add, and
        it can't be lower than what the card has already spent. Sending `limits`
        replaces all existing limits, `null` removes them, and leaving a field
        out keeps it unchanged. A terminated card can't be changed and returns
        `CARD_STATE_CONFLICT`. See [Spend controls](/concepts/spend-controls).
      operationId: updateSpendControl
      parameters:
        - name: cardId
          required: true
          in: path
          description: >-
            The card's ID, as returned by [List
            cards](/api-reference/cards/list-cards) or [Create
            card](/api-reference/cards/create-card).
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSpendControl'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Card'
              examples:
                toppedUpCard:
                  summary: Top-up card with an increased total spend cap
                  value:
                    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: '7500.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'
        '400':
          description: '`SPEND_CAP_TOO_LOW`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                BAD_REQUEST:
                  summary: BAD_REQUEST
                  value:
                    statusCode: 400
                    type: INVALID_REQUEST_ERROR
                    message: Bad request.
                SPEND_CAP_TOO_LOW:
                  summary: SPEND_CAP_TOO_LOW
                  value:
                    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.
        '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.
        '404':
          description: '`NOT_FOUND`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NOT_FOUND:
                  summary: NOT_FOUND
                  value:
                    statusCode: 404
                    type: INVALID_REQUEST_ERROR
                    message: The requested resource was not found.
        '409':
          description: '`CARD_STATE_CONFLICT`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CARD_STATE_CONFLICT:
                  summary: CARD_STATE_CONFLICT
                  value:
                    statusCode: 409
                    type: INVALID_REQUEST_ERROR
                    code: CARD_STATE_CONFLICT
                    message: The requested card state transition is not allowed.
        '422':
          description: '`CURRENCY_MISMATCH`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CURRENCY_MISMATCH:
                  summary: CURRENCY_MISMATCH
                  value:
                    statusCode: 422
                    type: INVALID_REQUEST_ERROR
                    code: CURRENCY_MISMATCH
                    message: The provided currency does not match the card currency.
        '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:
    UpdateSpendControl:
      type: object
      properties:
        isRevolving:
          type: boolean
          description: >-
            Whether the card draws from your business's shared revolving budget.
            It's always `false` for top-up cards.
        spendCap:
          description: >-
            The card's fixed budget as a new total, not an amount to add (to add
            200 to a 500 budget, send `700.00`). It can't be lower than what's
            already been spent, and `null` removes it.
          type:
            - object
            - 'null'
          properties:
            amount:
              type: string
              pattern: ^(?!0+(\.0{1,2})?$)\d{1,15}(\.\d{1,2})?$
              description: >-
                The amount as a string with up to two decimals, for example
                `500.00`. It must be greater than zero.
            currency:
              type: string
              enum:
                - USD
                - HKD
              description: >-
                The currency: `USD` or `HKD`. All amounts on a card must use the
                card's currency.
          required:
            - amount
            - currency
        limits:
          description: >-
            The full set of spending limits for the card. It replaces all
            existing limits, so any period you leave out is removed; send `null`
            to remove every limit, or leave the field out to keep the current
            limits. No limit can be more than a limit for a longer period: for
            example, `daily` can't be more than `monthly`, and `transaction`
            can't be more than any period limit.
          type:
            - object
            - 'null'
          properties:
            transaction:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most a single card transaction can be.
            daily:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most the card can spend in one day.
            weekly:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most the card can spend in one week.
            monthly:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most the card can spend in one month.
            yearly:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most the card can spend in one year.
            allTime:
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^(?!0+(\.0{1,2})?$)\d{1,9}(\.\d{1,2})?$
                  description: >-
                    The amount as a string with up to two decimals, for example
                    `500.00`. It must be greater than zero and no more than
                    `999999999.99`.
                currency:
                  type: string
                  enum:
                    - USD
                    - HKD
                  description: >-
                    The currency: `USD` or `HKD`. All amounts on a card must use
                    the card's currency.
              required:
                - amount
                - currency
              description: The most the card can spend over its whole life.
    Card:
      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
    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.