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

# Create card

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

Creates a virtual card for an approved team member, with the funding plan, budget, spending limits and usage hours you choose. It returns `201` with the card when it's ready (or with `status: pending` while it's still being set up), or `202` if your business uses approvals and the request is waiting for an approver. Send an `Idempotency-Key` header so retries never create duplicate cards, and see [Issue cards to your team](/guides/issue-cards-to-your-team) for the full flow. To limit the card to certain transaction categories, set them with [Update card usage restriction](/api-reference/cards/update-card-usage-restriction) after you create the card. See [Cards](/concepts/cards).

If your business uses approvals, this returns `202` with `status: "pendingApproval"` instead of a card. See [How do I set up approval workflows for my team?](https://support.reap.global/hc/en-us/articles/13939633575567-How-do-I-set-up-approval-workflows-for-my-team) in the Help Center.


## OpenAPI

````yaml POST /2026-07-13/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-07-13/...`).


    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-07-13'
  contact: {}
servers:
  - url: https://api.global.direct.reap.global
security: []
tags: []
paths:
  /2026-07-13/cards:
    post:
      tags:
        - Cards
      summary: Create card
      description: >-
        Required API-key scope: `cards:write`.


        Creates a virtual card for an approved team member, with the funding
        plan, budget, spending limits and usage hours you choose. It returns
        `201` with the card when it's ready (or with `status: pending` while
        it's still being set up), or `202` if your business uses approvals and
        the request is waiting for an approver. Send an `Idempotency-Key` header
        so retries never create duplicate cards, and see [Issue cards to your
        team](/guides/issue-cards-to-your-team) for the full flow. To limit the
        card to certain transaction categories, set them with [Update card usage
        restriction](/api-reference/cards/update-card-usage-restriction) after
        you create the card. See [Cards](/concepts/cards).
      operationId: createCard
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            A unique value you choose for each new card, for example
            `new-card-{userId}`. Sending the same key again with the same body
            returns the original result instead of creating a second card;
            reusing it with a different body returns `IDEMPOTENCY_KEY_REUSED`.
            If the first request failed with a timeout or an unexpected error on
            our side, the card may exist, so the same key returns
            `IDEMPOTENCY_KEY_OUTCOME_UNKNOWN` instead of trying again. An empty
            card list does not prove that no card was created: a new card may
            not be listed straight away, and a request waiting for approval is
            not listed until it is approved. Before you retry with a new key,
            check pending approvals in the dashboard, list your cards again
            after a few minutes, and contact support with the `requestId` if you
            still cannot tell. Errors that mean no card was created, such as
            `CARD_CREATION_BUSY` and `CARD_CREATION_UNAVAILABLE`, release the
            key, so you can retry with the same key.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCard'
      responses:
        '201':
          description: >-
            Card created. You usually get the full card back; if it's still
            being set up, you get `{ id, status: pending }` instead, and can
            fetch the URL in the `Location` header until the card is ready.
          headers:
            Location:
              description: >-
                The URL of the new card on this API version. Call it to fetch
                the card, for example while its status is `pending`.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Card'
                  - $ref: '#/components/schemas/CardCreatedPending'
              examples:
                created:
                  summary: Card created
                  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: '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'
        '202':
          description: >-
            Your business uses approvals, so the card request is waiting for an
            approver in the Business Account dashboard. No card exists yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardApprovalPending'
              examples:
                pendingApproval:
                  summary: Card creation awaiting approval
                  value:
                    approvalRequestId: approval_01JZ2Q8A6B4C3D2E1F0G9H8J7K
                    status: pendingApproval
        '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.
        '409':
          description: '`IDEMPOTENCY_KEY_IN_FLIGHT`, `IDEMPOTENCY_KEY_OUTCOME_UNKNOWN`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IDEMPOTENCY_KEY_IN_FLIGHT:
                  summary: IDEMPOTENCY_KEY_IN_FLIGHT
                  value:
                    statusCode: 409
                    type: INVALID_REQUEST_ERROR
                    code: IDEMPOTENCY_KEY_IN_FLIGHT
                    message: >-
                      A request with this Idempotency-Key is still being
                      processed. Retry shortly.
                IDEMPOTENCY_KEY_OUTCOME_UNKNOWN:
                  summary: IDEMPOTENCY_KEY_OUTCOME_UNKNOWN
                  value:
                    statusCode: 409
                    type: INVALID_REQUEST_ERROR
                    code: IDEMPOTENCY_KEY_OUTCOME_UNKNOWN
                    message: >-
                      The first request with this Idempotency-Key may have
                      completed. Check its outcome before you retry with a new
                      Idempotency-Key.
        '422':
          description: >-
            `CARD_CREATION_REQUIRES_DEPOSIT`, `CARDHOLDER_NOT_FOUND`,
            `CARD_CATEGORY_NOT_FOUND`, `IDEMPOTENCY_KEY_REUSED`,
            `CURRENCY_MISMATCH`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CARD_CREATION_REQUIRES_DEPOSIT:
                  summary: CARD_CREATION_REQUIRES_DEPOSIT
                  value:
                    statusCode: 422
                    type: INVALID_REQUEST_ERROR
                    code: CARD_CREATION_REQUIRES_DEPOSIT
                    message: Deposit funds before creating a card.
                CARDHOLDER_NOT_FOUND:
                  summary: CARDHOLDER_NOT_FOUND
                  value:
                    statusCode: 422
                    type: INVALID_REQUEST_ERROR
                    code: CARDHOLDER_NOT_FOUND
                    message: No team member matches the provided cardholder id.
                CARD_CATEGORY_NOT_FOUND:
                  summary: CARD_CATEGORY_NOT_FOUND
                  value:
                    statusCode: 422
                    type: INVALID_REQUEST_ERROR
                    code: CARD_CATEGORY_NOT_FOUND
                    message: No card category matches the provided category id.
                IDEMPOTENCY_KEY_REUSED:
                  summary: IDEMPOTENCY_KEY_REUSED
                  value:
                    statusCode: 422
                    type: INVALID_REQUEST_ERROR
                    code: IDEMPOTENCY_KEY_REUSED
                    message: >-
                      This Idempotency-Key was already used with a different
                      request body.
                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: '`CARD_LIMIT_EXCEEDED`, `CARD_CREATION_BUSY`'
          headers:
            Retry-After:
              description: >-
                Sent with `CARD_CREATION_BUSY`: the number of seconds to wait
                before retrying.
              schema:
                type: integer
          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.
                CARD_LIMIT_EXCEEDED:
                  summary: CARD_LIMIT_EXCEEDED
                  value:
                    statusCode: 429
                    type: RATE_LIMIT_ERROR
                    code: CARD_LIMIT_EXCEEDED
                    message: >-
                      Your account has reached the maximum number of cards.
                      Contact support to request more.
                CARD_CREATION_BUSY:
                  summary: CARD_CREATION_BUSY
                  value:
                    statusCode: 429
                    type: RATE_LIMIT_ERROR
                    code: CARD_CREATION_BUSY
                    message: >-
                      Another card is being created for this business. Retry
                      after a few seconds.
        '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.
        '503':
          description: '`CARD_CREATION_UNAVAILABLE`, `IDEMPOTENCY_UNAVAILABLE`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CARD_CREATION_UNAVAILABLE:
                  summary: CARD_CREATION_UNAVAILABLE
                  value:
                    statusCode: 503
                    type: API_ERROR
                    code: CARD_CREATION_UNAVAILABLE
                    message: >-
                      Card creation temporarily unavailable. Please retry
                      shortly.
                IDEMPOTENCY_UNAVAILABLE:
                  summary: IDEMPOTENCY_UNAVAILABLE
                  value:
                    statusCode: 503
                    type: API_ERROR
                    code: IDEMPOTENCY_UNAVAILABLE
                    message: >-
                      The idempotent request outcome could not be safely
                      determined.
      security:
        - apiKey: []
components:
  schemas:
    CreateCard:
      type: object
      properties:
        type:
          type: string
          enum:
            - virtual
          description: >-
            The kind of card to create. Only `virtual` cards can be created
            through the API.
        title:
          type: string
          maxLength: 255
          pattern: \S
          description: >-
            A nickname for the card, up to 255 characters, shown in the
            dashboard and returned by the API. Say who or what the card is for,
            for example `Ada – Marketing tools`.
        cardholderId:
          type: string
          description: >-
            The `userId` of the team member who will hold the card, from [List
            team members](/api-reference/team-members/list-team-members). The
            team member must have `inviteStatus` `approved`, or the request
            fails with `CARDHOLDER_NOT_FOUND`.
        planType:
          type: string
          enum:
            - subscription
            - topUp
          description: >-
            How the card is funded: `subscription` (the default) draws on your
            shared credit within the card's limits, and `topUp` gives the card
            its own fixed budget, set in `spendCap`.
        category:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          description: >-
            The ID of the card category, from [List card
            categories](/api-reference/cards/list-card-categories), or the
            request fails with `CARD_CATEGORY_NOT_FOUND`. It labels what the
            card is for and doesn't limit where it can be used.
        isRevolving:
          type: boolean
          description: >-
            Whether the card draws from your business's shared revolving budget.
            Leave it out or set it to `false` for top-up cards.
        expiresAt:
          description: >-
            The date you want the card to expire (`YYYY-MM-DD`). Leave it out to
            use the standard expiry date.
          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])))$
        spendCap:
          type: object
          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
          description: >-
            The fixed budget for a top-up card, for example `500.00` USD. It's
            required when `planType` is `topUp`, and the card declines card
            transactions once it's used up.
        spendControl:
          type: object
          properties:
            transaction:
              type: object
              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
              description: The most a single card transaction can be.
            daily:
              type: object
              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
              description: The most the card can spend in one day.
            weekly:
              type: object
              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
              description: The most the card can spend in one week.
            monthly:
              type: object
              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
              description: The most the card can spend in one month.
            yearly:
              type: object
              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
              description: The most the card can spend in one year.
            allTime:
              type: object
              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
              description: The most the card can spend over its whole life.
          description: >-
            Spending limits to put on the card: per card transaction, or per
            day, week, month, year or lifetime. Set only the ones you need. 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.
        restriction:
          type: object
          properties:
            time:
              description: >-
                The window of hours each day when the card can be used, in UTC.
                Null or left out means the card can be used at any time.
              type:
                - object
                - 'null'
              properties:
                start:
                  type: string
                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                  description: >-
                    When the window opens each day, in UTC (`HH:mm`, from
                    `00:00` to `23:59`), for example `09:00`.
                end:
                  type: string
                  pattern: ^([01]\d|2[0-3]):[0-5]\d$
                  description: >-
                    When the window closes each day, in UTC (`HH:mm`, from
                    `00:00` to `23:59`), for example `18:00`. It must differ
                    from `start`. An `end` earlier than `start` makes the window
                    run past midnight, so `22:00` to `06:00` allows use
                    overnight.
              required:
                - start
                - end
          description: >-
            The hours of the day when the card can be used, in UTC. Leave it out
            to allow use at any time.
        message:
          description: >-
            An optional note saved with the card request, up to 255 characters,
            for example to explain the request to an approver.
          type:
            - string
            - 'null'
          maxLength: 255
      required:
        - type
        - title
        - cardholderId
        - category
    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
    CardCreatedPending:
      type: object
      properties:
        id:
          type: string
          description: >-
            The new card's ID. Save it, then call [Retrieve a
            card](/api-reference/cards/retrieve-a-card) or the `Location` URL
            until the card is ready.
        status:
          type: string
          enum:
            - pending
          description: >-
            Always `pending`: the card has been created, but its details aren't
            available yet.
      required:
        - id
        - status
    CardApprovalPending:
      type: object
      properties:
        approvalRequestId:
          type: string
          description: >-
            The ID of the approval request. Once an approver accepts it in the
            dashboard, the card appears in [List
            cards](/api-reference/cards/list-cards).
        status:
          type: string
          enum:
            - pendingApproval
          description: >-
            Always `pendingApproval`: the card hasn't been created yet and is
            waiting for an approver.
      required:
        - approvalRequestId
        - status
    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.