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

# Get a spending pool

> Retrieve a spending pool with what its agents have spent and may still spend in the current period.



## OpenAPI

````yaml /openapi.yaml get /spending-pools/{spendingPoolId}
openapi: 3.1.0
info:
  title: Grid API
  description: >
    API for managing global payments on the open Money Grid. Built by
    Lightspark. See the full documentation at https://docs.lightspark.com/.
  version: '2025-10-13'
  contact:
    name: Lightspark Support
    email: support@lightspark.com
  license:
    name: Proprietary
    url: https://lightspark.com/terms
servers:
  - url: https://api.lightspark.com/grid/2025-10-13
    description: Production server
security:
  - BasicAuth: []
  - AgentAuth: []
tags:
  - name: Platform Configuration
    description: >-
      Platform configuration endpoints for managing global settings. You can
      also configure these settings in the Grid dashboard.
  - name: Customers
    description: >-
      Customer management endpoints for creating and updating customer
      information
  - name: Contact Verification
    description: >-
      Endpoints for verifying a customer's email and phone via one-time codes.
      Required only for customers whose payment provider mandates contact
      verification (e.g. EU customers); other providers return 409.
  - name: Strong Customer Authentication
    description: >-
      Endpoints for authorizing money-movement operations that require Strong
      Customer Authentication. Relevant only for customers in a region where SCA
      is required (e.g. EU); customers outside SCA-regulated regions never see
      an SCA challenge and these endpoints return 409.
  - name: KYC/KYB Verifications
    description: >-
      Endpoints for Know Your Customer (KYC) and Know Your Business (KYB)
      verification, including managing beneficial owners and triggering
      verification for customers.
  - name: Documents
    description: >-
      Endpoints for uploading and managing verification documents for customers
      and beneficial owners. Supports KYC and KYB document requirements.
  - name: Internal Accounts
    description: >-
      Internal account management endpoints for creating and managing internal
      accounts
  - name: Periodic Statements
    description: >
      Build, deliver, and evidence a Regulation E periodic statement for a
      customer's internal account. A statement period is a calendar month in US
      Central time (`America/Chicago`).


      A statement is issued for each customer's own USD internal account and
      covers their whole balance. Money received through a rule-based account
      appears on its owner's statement; rule-based, bulk settlement and
      platform-owned accounts have no statement of their own.


      **1. The statement — `GET
      /internal-accounts/{id}/balance-changes?startDate=&endDate=`**


      One row per change to the balance, in the order the money moved, with the
      opening and closing balances for the window in the same response. Page
      until `hasMore` is false, then assert this identity across every page
      before you render anything:


      ```

      openingBalance + Σ(data[].amount) == closingBalance

      ```


      If it does not hold, do not send the statement; contact support instead.
      `startDate` and `endDate` bound a half-open window `[startDate, endDate)`:
      for a monthly statement, pass the first instant of the month and the first
      instant of the following month, both in US Central time (for August 2026,
      `2026-08-01T00:00:00-05:00` and `2026-09-01T00:00:00-05:00`). Grid records
      a statement as fetched only for a window that is exactly one such month.


      **2. The receipt — `POST /internal-accounts/{id}/confirm-statement`**


      Once a month, after you have pulled and issued a period's statement, send
      a receipt with the `statementMonth` it covers. Grid stores it as the
      delivery record for that account and period. Sending it again is harmless:
      the first receipt's time is kept.


      **Timing**


      A window whose card settlement has not closed is refused with `409
      NOT_YET_AVAILABLE` rather than answered with figures that could still
      change; retry once it has settled.
  - name: External Accounts
    description: >-
      External account management endpoints for creating and managing external
      bank accounts
  - name: Same-Currency Transfers
    description: >-
      Deprecated endpoints for transferring funds between internal and external
      accounts with the same currency. Use the quote endpoints under
      Cross-Currency Transfers instead, which now serve same-currency transfers
      as well.
  - name: Cross-Currency Transfers
    description: >-
      Endpoints for creating and confirming quotes for transfers, both
      same-currency and cross-currency
  - name: Transactions
    description: Endpoints for retrieving transaction information
  - name: Webhooks
    description: Webhook endpoints and configuration for receiving notifications
  - name: Invitations
    description: Endpoints for creating, claiming and managing UMA invitations
  - name: Sandbox
    description: Endpoints to trigger test cases in sandbox
  - name: API Tokens
    description: Endpoints to programmatically manage API tokens
  - name: Exchange Rates
    description: >-
      Endpoints for retrieving cached foreign exchange rates. Rates are cached
      for approximately 5 minutes and include platform-specific fees.
  - name: Discoveries
    description: >-
      Endpoints for discovering available payment rails, banks, and providers
      for a given country and currency corridor.
  - name: Embedded Wallet Auth
    description: >-
      Endpoints for registering and verifying end-user authentication
      credentials (email OTP, OAuth, passkey) used to sign Embedded Wallet
      actions.
  - name: Agent Management
    description: >-
      Endpoints for creating and managing agents (experimental), called by the
      partner's backend using platform credentials. Covers the full agent
      lifecycle: creation, policy configuration, pausing, deletion, the device
      code installation flow, and approving or rejecting transactions initiated
      by agents.
  - name: Agent Operations
    description: >-
      Experimental endpoints called by the agent itself using its own
      credentials (obtained via device code redemption). Scoped to the agent's
      associated customer — all requests automatically operate on behalf of that
      customer and are subject to the agent's policy. When an action requires
      approval, the resulting transaction enters a pending state and must be
      approved by the platform via `POST /transactions/{transactionId}/approve`.
  - name: Cards
    description: >-
      Card management endpoints. Issue debit cards against an internal account,
      freeze / unfreeze, close, manage a card's funding source, and list card
      transactions.
  - name: Stablecoins
    description: >-
      Stablecoin issuance endpoints. Link provider accounts, register
      provider-created stablecoins, create direct mint/burn issuer operations,
      and track operation status.
  - name: Embedded Care
    description: |
      A support chat between the cardholder and Lightspark's care agent, driven
      from the partner's own app. The platform calls with its ordinary Grid
      credential, but the person typing is the cardholder rather than the
      caller, so reaching that cardholder's account takes a second proof: an
      SMS code they send into the chat, after which the partner carries a
      session token in the `X-Ls-Care-Session` header.

      **The surface is two routes, and verification happens inside the
      conversation.**

      1. **Open the chat.** `POST /care/chats/{chatId}/messages` with an empty
         `message`, addressed to the cardholder as `Customer:<uuid>`. Returns
         the chat's id and the agent's opening line in `reply`, which is what
         a chat window renders before anybody has typed. Sends no SMS, needs
         no `Idempotency-Key` and consumes none, and is safe to call again: a
         widget that reloaded gets the same chat back, this time without a
         `reply`.
      2. **Send the cardholder's first message.** The same route with their
         text and an `Idempotency-Key` header. One turn runs synchronously and
         the agent's answer comes back in `reply`. On a chat that cannot yet
         reach the account this call also texts the cardholder a code, and the
         agent's `reply` asks for it.
      3. **The cardholder sends the code as an ordinary message.** When it is
         correct, the response to that turn carries `sessionToken` and
         `expiresAt`. Send that token as the `X-Ls-Care-Session` header on
         every message from then on. A code that does not match is answered in
         `reply`, and the cardholder can simply send it again.
      4. **Close the chat** with `DELETE /care/chats/{chatId}` when the
         cardholder is done. Every response also carries `chatEnded`, and the
         agent can end the chat itself: when `chatEnded` is true, the closing
         line is in `reply` and the chat takes no further messages, so stop
         sending to it. An opening addressed to that `CareChat:<id>` answers
         `409 CARE_CHAT_ENDED`; address the cardholder as `Customer:<uuid>`
         to open a new chat.

      **Render `redactedCustomerMessage` if present, then `reply` if
      present.** That one rule covers an opening, a resume and a turn.

      **A cardholder whose code never arrived asks the agent for another
      one.** The agent sends a new code to the number on file and says so in
      its `reply`. There is no separate route for it.

      **The verification fields are optional hints.** `verificationRequired`
      and `codeLength` let an app show a dedicated one-time-code input of the
      right length, marked as a one-time code so iOS and Android offer to fill
      it from the SMS. A partner can ignore them, since the agent asks for the
      code in its reply and says where it went, and the app still sends the
      code as an ordinary message.

      Step 1 is optional. A message addressed to a `Customer:` id opens that
      cardholder's chat if they have none, so a partner whose cardholder has
      just typed something spends one call rather than two.

      A cardholder who has not verified yet is never a `401`, because the
      first message from every new cardholder is unverified and a `401` there
      would be indistinguishable from a bad credential. On these endpoints a
      `401` means the platform's Grid credential is wrong, the session token
      presented is malformed, or a replay lacks the session token its original
      request required.

      **Verification expires, and a lost session is recoverable in the
      chat.** A chat reaches the cardholder's account only while its
      verification is newer than the session lifetime, fifteen minutes in the
      default deployment, which is also how long a session token lives. Past
      that window a message gets a fresh code, and the agent asks the
      cardholder to send it back inside the conversation, which hands the
      partner the next session token. A new message sent with no
      `X-Ls-Care-Session` header, or with a token past its expiry, on a chat
      whose verification is still current is treated the same way: the
      verification is cancelled before the turn runs, a new code is sent, and
      the agent asks for it. So a client that lost its token, or held one too
      long, simply keeps sending messages. Only a token that is malformed, or
      that was minted for another platform, chat or cardholder, is refused.

      Two things an integration has to get right:

      - **Render `redactedCustomerMessage`, never your own copy of what was
        typed.** Grid masks card numbers and other sensitive digit strings in
        it. A UI that renders its own copy of the input instead puts a card
        number the cardholder pasted back on their screen unmasked, and into
        your logs.
      - **The session token is returned once and is never re-readable.** No
        endpoint hands it back, it cannot be revoked, and it is short-lived by
        design. Hold it for the life of the cardholder's session. It arrives
        on the message response to the turn in which the cardholder sent their
        code, and on no other. Losing it costs the cardholder a new code, never
        access to the chat.

      Some things are absent by construction, so no integration can come to
      depend on them: nothing returns a transcript or an earlier turn's reply
      (retrying under the original `Idempotency-Key` is how an answer that was
      produced but not delivered is recovered; a replay requires the same
      session token its original request required and never carries a
      `sessionToken`, so a lost token is recovered by sending the cardholder's
      next message as a new message, which verifies them again), nothing sets
      a verification state, and nothing changes the number a code is sent to.

      Errors from these endpoints carry `code` and `reason` only (see the
      `CareError` schema), unlike the `Error4xx` schemas used elsewhere in this
      specification.
paths:
  /spending-pools/{spendingPoolId}:
    parameters:
      - name: spendingPoolId
        in: path
        description: System-generated unique spending pool identifier
        required: true
        schema:
          type: string
    get:
      tags:
        - Agent Management
      summary: Get a spending pool
      description: >-
        Retrieve a spending pool with what its agents have spent and may still
        spend in the current period.
      operationId: getSpendingPool
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpendingPool'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: >-
            Forbidden - Agents API or spending pools are not enabled for the
            platform
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Spending pool not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal service error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
      security:
        - BasicAuth: []
components:
  schemas:
    SpendingPool:
      title: Spending Pool
      type: object
      description: >-
        A spending limit shared by the agents assigned to it, on their
        customer's balance. A pool holds no money and no money moves between
        pools: it only limits what its agents may spend, in addition to each
        agent's own policy. Limits of different pools may add up to more than
        the balance. Each agent belongs to at most one pool.
      required:
        - id
        - customerId
        - name
        - currency
        - limitType
        - limitAmount
        - allowedPaymentTypes
        - requiresAdminApproval
        - isArchived
        - usage
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: System-generated unique identifier for the pool.
          example: SpendingPool:019542f5-b3e7-1d02-0000-000000000007
        customerId:
          type: string
          description: The customer whose agents spend under the pool.
          example: Customer:019542f5-b3e7-1d02-0000-000000000001
        name:
          type: string
          description: Human-readable name for the pool.
          example: Marketing
        currency:
          type: string
          description: >-
            ISO 4217 currency code all of the pool's amounts are in. Only agents
            whose policy is in the same currency may be assigned to it.
            Immutable.
          example: USD
        limitType:
          $ref: '#/components/schemas/SpendingPoolLimitType'
        period:
          $ref: '#/components/schemas/SpendingPoolPeriod'
          description: The period a `RECURRING` pool resets on. Absent for `TOTAL`.
        limitAmount:
          type: integer
          format: int64
          minimum: 1
          description: >-
            The most the pool's agents may spend together: per `period` for a
            `RECURRING` pool, in total for a `TOTAL` one.
          example: 500000
        perTransactionLimit:
          type: integer
          format: int64
          minimum: 1
          description: The most a single payment may be. Absent for no cap.
          example: 50000
        dailyLimit:
          type: integer
          format: int64
          minimum: 1
          description: >-
            The most the pool's agents may spend together per UTC day. Absent
            for no cap.
          example: 100000
        monthlyLimit:
          type: integer
          format: int64
          minimum: 1
          description: >-
            The most the pool's agents may spend together per UTC calendar
            month. Absent for no cap.
          example: 400000
        allowedPaymentTypes:
          type: array
          description: >-
            The kinds of payment the pool's agents may make. Any other is
            refused with `policyDenialReason` `POOL_PAYMENT_TYPE_NOT_ALLOWED`.
          items:
            $ref: '#/components/schemas/SpendingPoolPaymentType'
          uniqueItems: true
          example:
            - CARDS
            - CRYPTO_SENDS
        requiresAdminApproval:
          type: boolean
          description: >-
            Whether the platform requires an administrator to approve the pool's
            agents' payments that need approval. Grid stores it for the platform
            and does not act on it.
          example: false
        isArchived:
          type: boolean
          description: >-
            Whether the pool was archived. An archived pool takes no agents and
            cannot be changed.
          example: false
        usage:
          $ref: '#/components/schemas/SpendingPoolUsage'
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp.
          example: '2026-11-02T17:32:28Z'
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp.
          example: '2026-11-02T17:32:28Z'
    Error401:
      type: object
      required:
        - reason
        - code
      properties:
        code:
          type: string
          description: >
            | Error Code | Description |

            |------------|-------------|

            | UNAUTHORIZED | Issue with API credentials |

            | INVALID_SIGNATURE | Signature header is invalid |

            | WALLET_SIGNATURE_MISSING | The `Grid-Wallet-Signature` header is
            required for this Embedded Wallet action but was not supplied |

            | WALLET_SIGNATURE_MALFORMED | The `Grid-Wallet-Signature` header
            could not be parsed (bad encoding, structure, or fields) |

            | WALLET_SIGNATURE_BODY_MISMATCH | The `Grid-Wallet-Signature` was
            computed over a different request body than the one received |

            | WALLET_SIGNATURE_INVALID | The `Grid-Wallet-Signature` failed
            cryptographic verification against the registered credential |

            | REQUEST_ID_MISSING | The `Request-Id` header is required on the
            signed retry but was not supplied (paired with
            `Grid-Wallet-Signature`) |
          enum:
            - UNAUTHORIZED
            - INVALID_SIGNATURE
            - WALLET_SIGNATURE_MISSING
            - WALLET_SIGNATURE_MALFORMED
            - WALLET_SIGNATURE_BODY_MISMATCH
            - WALLET_SIGNATURE_INVALID
            - REQUEST_ID_MISSING
        reason:
          type: string
          description: Error message
        details:
          type: object
          description: Additional error details
          additionalProperties: true
    Error403:
      type: object
      required:
        - reason
        - code
      properties:
        code:
          type: string
          description: >
            | Error Code | Description |

            |------------|-------------|

            | FORBIDDEN | Insufficient permissions. `details.refusalReason`
            names the cause when Grid knows it |

            | USER_NOT_READY | Customer exists but is not ready for operation |

            | COUNTERPARTY_NOT_ALLOWED | Counterparty has not been enabled for
            your account |

            | VELOCITY_LIMIT_EXCEEDED | Counterparty has exceeded velocity
            limits |

            | END_USER_TERMS_NOT_ACCEPTED | Customer has not accepted the End
            User Terms |

            | CUSTOMER_NOT_VERIFIED | The customer is not verified and cannot
            perform this action |

            | SANCTION_BLOCKED | Blocked by sanction screening |

            | DESTINATION_NOT_ALLOWED | The agent may not pay this destination |

            | CORRIDOR_UNDER_MAINTENANCE | Payments to this corridor are paused
            for maintenance. |
          enum:
            - FORBIDDEN
            - USER_NOT_READY
            - COUNTERPARTY_NOT_ALLOWED
            - VELOCITY_LIMIT_EXCEEDED
            - END_USER_TERMS_NOT_ACCEPTED
            - CUSTOMER_NOT_VERIFIED
            - SANCTION_BLOCKED
            - DESTINATION_NOT_ALLOWED
            - CORRIDOR_UNDER_MAINTENANCE
        reason:
          type: string
          description: Error message
        details:
          type: object
          description: >-
            Additional error details. Shape varies by `code`. A `FORBIDDEN`
            refusal with a known cause carries `refusalReason`, plus the fields
            that reason names.
          properties:
            refusalReason:
              $ref: '#/components/schemas/RefusalReason'
            permission:
              type: string
              description: >-
                The `AgentPermission` the agent's policy lacks. Present with
                refusal reason `AGENT_PERMISSION_REQUIRED`. Grid may add
                permissions, so accept a value not yet listed there.
              example: ISSUE_CARDS
            policyDenialReason:
              $ref: '#/components/schemas/AgentPolicyDenialReason'
              description: >-
                The policy rule that denied the quote or purchase card. Present
                with refusal reason `AGENT_POLICY_DENIED` or
                `AGENT_PURCHASE_CARD_POLICY_DENIED`.
          additionalProperties: true
    Error404:
      type: object
      required:
        - reason
        - code
      properties:
        code:
          type: string
          description: >
            | Error Code | Description |

            |------------|-------------|

            | TRANSACTION_NOT_FOUND | Transaction not found |

            | INVITATION_NOT_FOUND | Invitation not found |

            | USER_NOT_FOUND | Customer not found |

            | QUOTE_NOT_FOUND | Quote not found |

            | LOOKUP_REQUEST_NOT_FOUND | Lookup request not found |

            | TOKEN_NOT_FOUND | Token not found |

            | BULK_UPLOAD_JOB_NOT_FOUND | Bulk upload job not found |

            | REFERENCE_NOT_FOUND | Reference not found |

            | UMA_NOT_FOUND | The UMA address is well-formed but no receiver
            exists at the counterparty VASP |

            | STABLECOIN_PROVIDER_ACCOUNT_NOT_FOUND | Stablecoin provider
            account link not found |

            | ACCOUNT_NOT_FOUND | Account not found |

            | AUTH_METHOD_NOT_FOUND | Authentication credential not found |

            | CUSTOMER_NOT_FOUND | Customer not found |

            | DOCUMENT_HOLDER_NOT_FOUND | Document holder not found |

            | NOT_FOUND | The requested resource was not found |

            | PAYMENT_URL_NOT_FOUND | Payment URL not found |

            | PLATFORM_NOT_FOUND | Platform not found |

            | REQUEST_NOT_FOUND | Pending request not found |

            | SESSION_NOT_FOUND | Session not found |

            | STABLECOIN_EXTERNAL_ACCOUNT_NOT_FOUND | Stablecoin external
            account not found |

            | STABLECOIN_NOT_FOUND | Stablecoin not found |

            | STABLECOIN_OPERATION_NOT_FOUND | Stablecoin operation not found |

            | VERIFICATION_NOT_FOUND | Verification not found |

            | PAYMENT_DOCUMENT_NOT_FOUND | Payment document not found |
          enum:
            - TRANSACTION_NOT_FOUND
            - INVITATION_NOT_FOUND
            - USER_NOT_FOUND
            - QUOTE_NOT_FOUND
            - LOOKUP_REQUEST_NOT_FOUND
            - TOKEN_NOT_FOUND
            - BULK_UPLOAD_JOB_NOT_FOUND
            - REFERENCE_NOT_FOUND
            - UMA_NOT_FOUND
            - STABLECOIN_PROVIDER_ACCOUNT_NOT_FOUND
            - ACCOUNT_NOT_FOUND
            - AUTH_METHOD_NOT_FOUND
            - CUSTOMER_NOT_FOUND
            - DOCUMENT_HOLDER_NOT_FOUND
            - NOT_FOUND
            - PAYMENT_URL_NOT_FOUND
            - PLATFORM_NOT_FOUND
            - REQUEST_NOT_FOUND
            - SESSION_NOT_FOUND
            - STABLECOIN_EXTERNAL_ACCOUNT_NOT_FOUND
            - STABLECOIN_NOT_FOUND
            - STABLECOIN_OPERATION_NOT_FOUND
            - VERIFICATION_NOT_FOUND
            - PAYMENT_DOCUMENT_NOT_FOUND
        reason:
          type: string
          description: Error message
        details:
          type: object
          description: Additional error details
          additionalProperties: true
    Error500:
      type: object
      required:
        - reason
        - code
      properties:
        code:
          type: string
          description: |
            | Error Code | Description |
            |------------|-------------|
            | GRID_SWITCH_ERROR | Grid switch error |
            | INTERNAL_ERROR | Internal server or UMA error |
          enum:
            - GRID_SWITCH_ERROR
            - INTERNAL_ERROR
        reason:
          type: string
          description: Error message
        details:
          type: object
          description: Additional error details
          additionalProperties: true
    SpendingPoolLimitType:
      type: string
      enum:
        - RECURRING
        - TOTAL
      description: >
        How a spending pool's `limitAmount` applies.


        | Value | Description |

        |-------|-------------|

        | `RECURRING` | Resets at the start of each `period` (UTC calendar week
        starting Monday, or calendar month) |

        | `TOTAL` | A running total that never resets; raise `limitAmount` to
        allow more |
      example: RECURRING
    SpendingPoolPeriod:
      type: string
      enum:
        - MONTH
        - WEEK
      description: >-
        The UTC calendar period a `RECURRING` pool's limit resets on: a calendar
        month, or a week starting Monday 00:00 UTC.
      example: MONTH
    SpendingPoolPaymentType:
      type: string
      enum:
        - CARDS
        - CRYPTO_SENDS
        - BANK_PAYOUTS
      description: >
        A kind of agent payment a spending pool may allow.


        | Value | Description |

        |-------|-------------|

        | `CARDS` | Authorizations on the agents' cards |

        | `CRYPTO_SENDS` | Sends to crypto destinations, Spark and Lightning
        included |

        | `BANK_PAYOUTS` | Payouts to bank accounts |
      example: CARDS
    SpendingPoolUsage:
      type: object
      description: >-
        What the pool's agents have spent, counting payments still in flight, as
        of the request. Amounts are in the smallest unit of the pool's
        `currency`.
      required:
        - spent
        - remaining
        - dailySpent
        - monthlySpent
      properties:
        periodStart:
          type: string
          format: date
          description: >-
            The first day (UTC) of the current period of a `RECURRING` pool.
            Absent for a `TOTAL` pool.
          example: '2026-11-01'
        periodEnd:
          type: string
          format: date
          description: >-
            The first day (UTC) of the next period of a `RECURRING` pool, when
            its spending resets. Absent for a `TOTAL` pool.
          example: '2026-12-01'
        spent:
          type: integer
          format: int64
          description: >-
            Spent against `limitAmount`: in the current period for a `RECURRING`
            pool, ever for a `TOTAL` one.
          example: 125000
        remaining:
          type: integer
          format: int64
          description: >-
            What the pool's agents may still spend now: the least room left
            under `limitAmount`, `dailyLimit` and `monthlyLimit`, and never
            below zero. A single payment is also held to `perTransactionLimit`,
            and to each agent's own policy.
          example: 375000
        dailySpent:
          type: integer
          format: int64
          description: Spent today (UTC).
          example: 2500
        monthlySpent:
          type: integer
          format: int64
          description: Spent in the current UTC calendar month.
          example: 125000
    RefusalReason:
      type: string
      description: >
        Why Grid refused the request, as `details.refusalReason`. Several
        refusals

        share one `code`, and `reason` is a message that may be reworded, so
        branch

        on this value rather than on `reason`. Treat it as an open set, not a
        fixed

        list: Grid may add values, and an unknown one is a refusal without a
        known

        cause.


        | Refusal reason | Status | Description |

        |----------------|--------|-------------|

        | `AGENT_API_DISABLED` | 403 | The agent API is not enabled for the
        platform |

        | `AGENT_CUSTOMER_INACTIVE` | 403 | The agent's customer is not active |

        | `AGENT_INACTIVE` | 403 | The agent is paused or deleted |

        | `AGENT_NO_DELEGATED_KEY` | 403 | The agent holds no active delegated
        key for the source wallet |

        | `AGENT_PERMISSION_REQUIRED` | 403 | The agent's policy lacks a
        permission this call needs. `details.permission` names it |

        | `AGENT_ACCOUNT_NOT_ALLOWED` | 403 | The agent's policy does not allow
        the source account or funding source |

        | `AGENT_DEPOSIT_ACCOUNT_NOT_ALLOWED` | 403 | The agent's policy does
        not allow deposits to this account |

        | `AGENT_POLICY_DENIED` | 403 | The agent's policy denied executing the
        quote. `details.policyDenialReason` says which rule |

        | `AGENT_QUOTE_HELD` | 403 | The quote cannot be sent and is held for
        manual follow-up |

        | `AGENT_CARDS_DISABLED` | 403 | Agent cards are not enabled for the
        platform |

        | `AGENT_CARDS_CUSTOMER_NOT_VERIFIED` | 403 | Agent cards need a
        verified individual customer |

        | `AGENT_CARD_HANDOVER_DISABLED` | 403 | Handing an agent's card over to
        its customer is not enabled for the platform |

        | `AGENT_PURCHASE_CARDS_DISABLED` | 403 | Agent purchase cards are not
        enabled for the platform |

        | `AGENT_RECURRING_PURCHASE_CARDS_DISABLED` | 403 | Agent recurring
        purchase cards are not enabled for the platform |

        | `AGENT_PURCHASE_CARD_POLICY_DENIED` | 403 | The agent's policy denied
        the purchase card. `details.policyDenialReason` says which rule |

        | `CARDS_DISABLED` | 403 | Cards are not enabled for the platform |

        | `CARDHOLDER_INFO_MISSING` | 400 | The cardholder record lacks fields a
        card needs. `details.missingFields` lists them; supply them through the
        customers API |

        | `CARDHOLDER_BANK_ACCOUNT_NOT_OPEN` | 400 | The cardholder's USD bank
        account is not open yet, so no card can be issued until it is |

        | `CARDHOLDER_HOLDS_CARD` | 409 | The cardholder already holds a card
        and the platform allows one per cardholder. Close it before issuing
        another |

        | `INVOICE_SUB_SAT_AMOUNT` | 400 | The Lightning invoice's amount is not
        a whole number of satoshis |

        | `INVOICE_FUNDS_DEPOSIT` | 400 | The Lightning invoice was issued by
        Lightspark to fund a deposit and cannot be paid with a send |

        | `INVOICE_FUNDS_OWN_DEPOSIT` | 400 | The Lightning invoice funds a
        deposit of the sender's own. Quote a transfer between the customer's
        accounts instead |
      example: AGENT_POLICY_DENIED
    AgentPolicyDenialReason:
      type: string
      description: >
        Which agent policy rule denied executing a quote or issuing a purchase
        card.

        Sent as `details.policyDenialReason` with refusal reason

        `AGENT_POLICY_DENIED` or `AGENT_PURCHASE_CARD_POLICY_DENIED`. Treat it
        as an

        open set, not a fixed list: Grid may add values.


        | Reason | Description |

        |--------|-------------|

        | `INVALID_AMOUNT` | The amount is not one the policy can evaluate |

        | `AGENT_PAUSED` | The agent is paused |

        | `PERMISSION_MISSING` | The policy lacks `EXECUTE_QUOTES` |

        | `ACCOUNT_NOT_ALLOWED` | The policy does not allow the source account |

        | `PER_TRANSACTION_LIMIT_EXCEEDED` | The amount exceeds the
        per-transaction limit |

        | `DAILY_LIMIT_EXCEEDED` | The amount would exceed the daily spending
        limit |

        | `MONTHLY_LIMIT_EXCEEDED` | The amount would exceed the monthly
        spending limit |

        | `DAILY_TRANSACTION_LIMIT_EXCEEDED` | The agent has made its daily
        number of transactions |

        | `POOL_LIMIT_EXCEEDED` | The amount would exceed a limit of the agent's
        spending pool |

        | `POOL_PAYMENT_TYPE_NOT_ALLOWED` | The agent's spending pool does not
        allow this kind of payment |
      example: DAILY_LIMIT_EXCEEDED
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        API token authentication using format `<api token id>:<api client
        secret>`
    AgentAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token authentication for agent-scoped endpoints. The token is the
        `accessToken` returned when redeeming a device code via `POST
        /agents/device-codes/redeem`. Agent credentials are user-scoped: all
        requests are automatically bound to the agent's associated customer and
        subject to the agent's policy.

````

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