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

# Fund a sandbox wallet from the testnet faucet

> Sends testnet RD from Dakota's sandbox float wallet to the wallet on
Base Sepolia. The transfer is a real on-chain send, so the balance
arrives through the same deposit ingestion a customer's own deposit
takes; only the trigger is synthetic.

Accepted immediately. Poll `GET /sandbox/simulations/{simulation_id}`
for the terminal state; the simulation completes once the deposit
webhook is ingested.

The faucet draws on a shared float, so calls are metered per wallet
per day, per client per day, and against a floor the float must still
hold after the transfer. Each refusal carries a distinct problem type
so a client can tell a limit that clears on its own from one that
needs an operator.

Available in sandbox mode only.




## OpenAPI

````yaml /openapi.yaml post /sandbox/wallets/{wallet_id}/faucet
openapi: 3.0.3
info:
  title: Dakota Platform API
  version: 1.0.0
  description: >-
    Combined API specification for Dakota Platform services:

    - Issuance API: Asset minting and burning operations

    - Onboarding API: Know Your Business/Customer verification

    - On/Off Ramp API: Managing on-ramp and off-ramp accounts

    - Recipients API: Managing destinations for KYB'd entities

    - Transactions API: Viewing transaction history across platform operations


    ## Authentication and API Headers


    All API endpoints require the following headers:


    - `X-Idempotency-Key`: Required for all POST endpoints to ensure request
    idempotency

    - `x-api-key`: Required for authentication across all endpoints


    Note: On /applications endpoints you need a token for authentication instead
    of a x-api-key

    - `x-application-token`: Required for authentication on public /applications
    endpoints (alternative to `x-api-key` where documented)



    ## Rate Limits


    Requests are rate limited per API key. Every response includes the following
    headers:


    | Header | Description |

    | --- | --- |

    | `X-RateLimit-Limit` | Maximum requests allowed in the current one-minute
    window. |

    | `X-RateLimit-Remaining` | Requests remaining in the current window. |

    | `X-RateLimit-Reset` | Absolute Unix timestamp (seconds since epoch) when
    the current rate-limit window resets. |


    When a request is throttled (`429`), responses also include `Retry-After`
    with seconds to wait before retrying.
servers:
  - url: https://api.platform.dakota.xyz
    description: Production environment
  - url: https://api.platform.sandbox.dakota.xyz
    description: Sandbox — safe for testing with simulated data
security:
  - ApiKeyAuth: []
tags:
  - name: Agentic Payments
    x-beta: true
    description: >-
      Beta — agent-driven payments: provision agents, draft and approve spending
      mandates, accept reviewed instructions, and manage scheduled payments.


      **Prerequisites:** Customer onboarded; signer groups attached for
      recognition.

      **Related:** Wallets, Signer Groups, Transactions
  - name: Mandates
    x-beta: true
    description: >-
      Beta — spending mandates: signed, signer-bound authorizations governing
      what may be spent, approved or cancelled by a second recognized signer (§8
      — the dual-control rule that every mandate mutation must be signed by a
      recognized signer OTHER than the bound one). Independent of agents and
      scheduled payments.


      **Prerequisites:** Signer groups attached for recognition.

      **Related:** Signer Groups, Transactions
  - name: Insights
    x-beta: true
    description: >-
      Beta — read-only insight: a deterministic report over a customer's agentic
      activity (funding balances, upcoming obligations, failures, mandate
      headroom and expiry), or — via `GET /insights` — over the whole client's
      book, with portfolio KPIs, daily series and a per-customer roll-up. Never
      moves money, never creates or changes anything.


      **Prerequisites:** Customer onboarded; insight is computed from the
      customer's scheduled payments, mandates, and wallets.

      **Related:** Agentic Payments, Mandates
  - name: Customers
    description: >-
      Manage customer entities representing businesses and organizations
      onboarded to Dakota.


      **Prerequisites:** Complete KYB via Onboarding endpoints before initiating
      money movement.

      **Related:** Onboarding, Recipients, Transactions, Accounts, Wallets
  - name: Wallets
    description: >-
      Manage wallets, balances, and wallet-to-signer-group relationships for
      custody and movement controls.


      **Prerequisites:** Customer must exist. Configure signer groups before
      policy-enforced workflows.

      **Related:** Signer Groups, Policies, Transactions, Customers
  - name: Transactions
    description: >-
      Create, cancel, and retrieve transaction records across account and wallet
      flows.


      **Prerequisites:** Accounts or destinations must be configured based on
      flow type.

      **Related:** Accounts, Recipients, Policies, Events
  - name: Recipients
    description: >-
      Manage recipient entities and destination rails used by customers for
      payouts and transfers.


      **Prerequisites:** Customer must be onboarded and active.

      **Related:** Customers, Transactions, Accounts, Onboarding
  - name: Accounts
    description: >-
      Manage account resources used for onramp, offramp, and swap operations.


      **Prerequisites:** Customer must be created and network/asset constraints
      must be known.

      **Related:** Customers, Transactions, Auto Transactions, Info
  - name: Auto Transactions
    description: >-
      Manage automated transaction configurations and execution history for
      account automation workflows.


      **Prerequisites:** Source account must exist and be configured for
      automation.

      **Related:** Accounts, Transactions, Events
  - name: Onboarding
    description: >-
      Manage KYB/KYC onboarding lifecycle, application documents, attestations,
      and verification steps.


      **Prerequisites:** Customer context and required entity/application
      metadata.

      **Related:** Customers, Exceptions, Recipients, Transactions
  - name: Policies
    description: >-
      Define and manage policy objects and rules used for transaction governance
      and risk controls.


      **Prerequisites:** Wallet and signer group resources should be configured
      for enforcement scenarios.

      **Related:** Wallets, Signer Groups, Transactions
  - name: Signer Groups
    description: >-
      Manage signer groups and signer assignments for multi-party authorization
      models.


      **Prerequisites:** Wallets should exist before linking signer groups.

      **Related:** Wallets, Policies, Transactions
  - name: Authentication
    description: >-
      Manage API authentication credentials and key lifecycle for platform
      access.


      **Prerequisites:** Client organization must be provisioned.

      **Related:** Users, Info
  - name: Users
    description: >-
      Manage client users, roles, and identity metadata for platform access
      control.


      **Prerequisites:** Auth credentials and client context must be
      established.

      **Related:** Authentication
  - name: Webhooks
    description: >-
      Manage outbound webhook targets and delivery configuration for event
      notifications.


      **Prerequisites:** Subscriber endpoint must be reachable and secured.

      **Related:** Events, Authentication
  - name: Payouts
    description: >-
      Manage where Dakota sends your accrued developer-fee payouts.


      **Prerequisites:** Auth credentials and client context must be
      established.

      **Related:** Events
  - name: RD Marketing Fee
    description: >-
      Everything behind your RD marketing fee: read what a month came to,
      declare the wallets you hold outside Dakota so the RD in them counts, and
      say where the fee should be sent.


      **Prerequisites:** Client must be in the RD marketing-fee programme. A
      month is readable once it has closed.

      **Related:** Wallets, Events
  - name: Self Serve
    description: >-
      Buy and track prepaid credits, and read the tiers and pricing they are
      sold at.


      **Prerequisites:** Auth credentials and client context must be
      established.

      **Related:** Billing
  - name: Events
    description: >-
      Retrieve event records emitted by platform operations for audit and
      troubleshooting.


      **Prerequisites:** Requesting client must have access to referenced
      resources.

      **Related:** Webhooks, Transactions, Onboarding
  - name: Info
    description: >-
      Read platform capability metadata, such as supported rails, networks, and
      assets.

      These operations are served under `/capabilities/*` - `GET
      /capabilities/countries`

      and `GET /capabilities/networks`. The tag name does not appear in the
      request paths.


      **Prerequisites:** Valid authentication headers.

      **Related:** Accounts, Transactions
  - name: Sandbox
    description: >-
      Trigger sandbox-only simulation endpoints for safe end-to-end integration
      testing with synthetic data. The sandbox host
      (`https://api.platform.sandbox.dakota.xyz`) also accepts a family of
      `X-Sandbox-*` request headers on most write endpoints (`Customers`,
      `Accounts`, `Transactions`, simulate endpoints) that let integrators drive
      deterministic failure modes — pick a preset via `X-Sandbox-Scenario`, or
      compose a custom one with
      `X-Sandbox-Error-Step`/`X-Sandbox-Error-Status`/`X-Sandbox-Error-Message`.
      `X-Sandbox-Instant-Completion` collapses async flows to a single
      synchronous step, and `X-Sandbox-Skip-Auto-Approval` keeps newly created
      KYB applications in `pending` for manual-review testing. All `X-Sandbox-*`
      headers are ignored in production.


      **Prerequisites:** Sandbox environment and test customer data.

      **Related:** Customers, Accounts, Transactions, Onboarding
  - name: Legal
    description: |-
      The legal documents customers accept — terms of service, privacy policy,
      e-sign notice, and partner agreements.

      Dakota publishes these here, and this is the authoritative source: the
      hosted onboarding flow, the dakota.xyz website, and your own integration
      all read the same revisions. Present the current revision to your customer
      before capturing their acceptance so the record reflects the text they
      actually saw.
paths:
  /sandbox/wallets/{wallet_id}/faucet:
    parameters:
      - name: wallet_id
        in: path
        required: true
        description: Wallet to fund.
        schema:
          $ref: '#/components/schemas/KSUID'
    post:
      tags:
        - Sandbox
      summary: Fund a sandbox wallet from the testnet faucet
      description: |
        Sends testnet RD from Dakota's sandbox float wallet to the wallet on
        Base Sepolia. The transfer is a real on-chain send, so the balance
        arrives through the same deposit ingestion a customer's own deposit
        takes; only the trigger is synthetic.

        Accepted immediately. Poll `GET /sandbox/simulations/{simulation_id}`
        for the terminal state; the simulation completes once the deposit
        webhook is ingested.

        The faucet draws on a shared float, so calls are metered per wallet
        per day, per client per day, and against a floor the float must still
        hold after the transfer. Each refusal carries a distinct problem type
        so a client can tell a limit that clears on its own from one that
        needs an operator.

        Available in sandbox mode only.
      operationId: faucetWallet
      parameters:
        - $ref: '#/components/parameters/IdempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxFaucetRequest'
            example:
              asset: RD
              amount: '2.00'
      responses:
        '202':
          description: Faucet transfer accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxFaucetResponse'
              example:
                simulation_id: sim_faucet_01J8ZQ4T7K2M9X
                wallet_id: 1NFHrqBHb3cTfLVkFSGmHZqdDPi
                asset: RD
                amount: '2.00'
                status: accepted
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://docs.dakota.xyz/api-reference/errors#invalid-request
                title: Invalid Request
                status: 400
                detail: amount must be a positive decimal
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '403':
          description: Not available outside sandbox mode
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://docs.dakota.xyz/api-reference/errors#forbidden
                title: Forbidden
                status: 403
                detail: Endpoint only available in sandbox mode
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '404':
          description: Wallet not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://docs.dakota.xyz/api-reference/errors#not-found
                title: Wallet Not Found
                status: 404
                detail: Wallet 1NFHrqBHb3cTfLVkFSGmHZqdDPi was not found
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '409':
          description: |
            The idempotency key cannot serve this request. The key was
            already used with different parameters, or on another sandbox
            simulation, or an earlier request with this key failed. A failed
            request is not replayed, and a key belongs to one simulation:
            retry with a new idempotency key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                different_parameters:
                  summary: >-
                    Key already used with different parameters, or on another
                    simulation
                  value:
                    type: https://docs.dakota.xyz/api-reference/errors#conflict
                    title: Simulation Conflict
                    status: 409
                    detail: >-
                      idempotency key already used with different parameters or
                      on another sandbox simulation
                    instance: >-
                      https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                    request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
                previous_request_failed:
                  summary: An earlier request with this key failed
                  value:
                    type: https://docs.dakota.xyz/api-reference/errors#conflict
                    title: Simulation Conflict
                    status: 409
                    detail: >-
                      a previous request with this idempotency key failed; retry
                      with a new idempotency key
                    instance: >-
                      https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                    request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '422':
          description: |
            Amount over the sandbox cap, a wallet the faucet asset cannot reach,
            or a client that is not provisioned at the provider yet.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://docs.dakota.xyz/api-reference/errors#sandbox-amount-cap-exceeded
                title: Sandbox Amount Cap Exceeded
                status: 422
                detail: >-
                  amount 25 exceeds sandbox cap of 2; reduce the amount and
                  retry
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '429':
          description: |
            A faucet limit refused the call. The problem `type` says which one:
            `#sandbox-faucet-wallet-daily-limit` and
            `#sandbox-faucet-client-daily-limit` clear on their own within 24
            hours; `#sandbox-faucet-float-floor` means the shared float is low
            and needs an operator to replenish it.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: >-
                  https://docs.dakota.xyz/api-reference/errors#sandbox-faucet-wallet-daily-limit
                title: Sandbox Faucet Wallet Daily Limit
                status: 429
                detail: >-
                  This wallet has used its faucet allowance for the day. Retry
                  within 24 hours.
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '500':
          description: Platform failed to process the request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://docs.dakota.xyz/api-reference/errors#internal-error
                title: Internal Server Error
                status: 500
                detail: An unexpected error occurred.
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
        '502':
          description: Provider gRPC call failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: https://docs.dakota.xyz/api-reference/errors#provider-error
                title: Provider Error
                status: 502
                detail: provider sandbox service returned an error
                instance: >-
                  https://api.platform.dakota.xyz/sandbox/wallets/1NFHrqBHb3cTfLVkFSGmHZqdDPi/faucet
                request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6
      externalDocs:
        description: Read full guide in docs
        url: https://docs.dakota.xyz/api-reference/sandbox/fund-a-wallet
components:
  schemas:
    KSUID:
      type: string
      title: KSUID
      description: >-
        KSUID is a 27-character globally unique ID that combines a timestamp
        with a random component. Used for all entity identifiers in the Dakota
        platform.
      pattern: ^[0-9A-Za-z]{27}$
      minLength: 27
      maxLength: 27
      example: 1NFHrqBHb3cTfLVkFSGmHZqdDPi
    SandboxFaucetRequest:
      type: object
      description: A request to fund a sandbox wallet from the testnet float.
      required:
        - amount
      properties:
        asset:
          type: string
          default: RD
          description: |
            Asset to fund. Only `RD` is served today; the field exists so a
            second asset can be added once a float exists for it.
          enum:
            - RD
          example: RD
        amount:
          type: string
          description: |
            Amount in decimal token units. Capped by the sandbox
            per-transaction limit.
          example: '2.00'
    SandboxFaucetResponse:
      type: object
      description: An accepted faucet transfer.
      required:
        - simulation_id
        - wallet_id
        - asset
        - amount
        - status
      properties:
        simulation_id:
          type: string
          description: |
            Simulation identifier. Resolve it with
            `GET /sandbox/simulations/{simulation_id}`.
        wallet_id:
          $ref: '#/components/schemas/KSUID'
        asset:
          type: string
          description: Asset that was sent.
          example: RD
        amount:
          type: string
          description: Amount that was sent, in decimal token units.
          example: '2.00'
        tx_hash:
          type: string
          description: |
            Reserved for the on-chain transaction hash. The faucet answers
            before the transfer has one, so the accepted response does not
            carry it. Do not depend on this field; poll
            `GET /sandbox/simulations/{simulation_id}` for the outcome.
        status:
          $ref: '#/components/schemas/SimulationState'
    ProblemDetails:
      type: object
      required:
        - type
        - title
        - status
      description: |
        Error response following RFC 9457 Problem Details.
        Public API error responses use this format.
      example:
        type: https://docs.dakota.xyz/api-reference/errors#not-found
        title: Customer Not Found
        status: 404
        detail: Customer cst_2abc123 was not found in your organization.
        instance: https://api.platform.dakota.xyz/customers/cst_2abc123
        request_id: req_7f3a8b2c
      properties:
        type:
          type: string
          format: uri
          description: |
            URI reference identifying the problem type.
            Resolves to human-readable documentation.
          example: https://docs.dakota.xyz/api-reference/errors#not-found
        title:
          type: string
          description: >-
            Short, human-readable summary of the problem type. Stable across
            occurrences.
          example: Customer Not Found
        status:
          type: integer
          description: HTTP status code for this occurrence.
          example: 404
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
          example: Customer cst_2abc123 was not found in your organization.
        instance:
          type: string
          format: uri
          description: The request path that triggered this error.
          example: https://api.platform.dakota.xyz/customers/cst_2abc123
        request_id:
          type: string
          description: Unique request identifier. Include when contacting support.
          example: req_7f3a8b2c
        errors:
          type: array
          description: Field-level validation errors (present for validation failures).
          items:
            $ref: '#/components/schemas/ValidationError'
        resolution_url:
          type: string
          format: uri
          description: |
            A link the customer can follow to CLEAR this error, present only on
            problems with a concrete self-service remedy.

            Today this is returned by
            `#terms-not-accepted`, where it points at the hosted flow in which
            the outstanding agreement can be signed. The link is token-gated and
            usable as-is — send the customer to it directly rather than parsing
            it out of `detail`.
          example: >-
            https://onboarding.dakota.xyz/applications/2abc123?token=tok_7f3a8b2c
        user_message:
          type: string
          description: |
            A plain-language rendition of `detail` written for the end
            customer, present when one exists for this error. `detail` names
            request fields and actions so a machine caller (such as a payment
            agent drafting proposals) can self-correct; `user_message` says the
            same thing without API vocabulary. Clients that relay errors into a
            human surface (chat, email, UI) should show `user_message` when
            present and fall back to `detail`.
          example: >-
            ACH payments pay out USD, so a USDC payout isn't possible on this
            rail. Change the payout currency to USD and try again.
    SimulationState:
      type: string
      enum:
        - accepted
      description: State of a sandbox simulation after submission.
    ValidationError:
      type: object
      required:
        - field
        - message
      properties:
        field:
          type: string
          description: Field path using dot notation for nested fields.
          example: bank_account.routing_number
        message:
          type: string
          description: Human-readable description of the field error.
          example: Routing number must be exactly 9 digits
        code:
          type: string
          description: Machine-readable error code for this field.
          example: invalid_format
  parameters:
    IdempotencyKeyHeader:
      name: x-idempotency-key
      in: header
      required: true
      description: >-
        Unique key to ensure request idempotency. If the same key is used within
        a certain time window, the original response will be returned instead of
        executing the request again.
      schema:
        type: string
        format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````