---
title: "Simulate sending funds"
method: POST
path: "/sandbox/send"
tags: ["Sandbox"]
---

# Simulate sending funds

`POST /sandbox/send`

Simulate sending funds to the bank account as instructed in the quote.
This endpoint is only for the sandbox environment and will fail for production platforms/keys.

## Request body

- object
  - `quoteId` string, required — The unique identifier of the quote
  - `currencyCode` string, required — Currency code for the funds to be sent
  - `currencyAmount` integer — The amount to send in the smallest unit of the currency (eg. cents). If not provided, the amount will be derived from the quote.

## Response `200`

Funds received successfully

- OutgoingTransaction
  - `id` string, required — Unique identifier for the transaction
  - `status` 'CREATED' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'REFUNDED' | 'EXPIRED', required — Status of a payment transaction
  - `type` 'INCOMING' | 'OUTGOING', required — Type of transaction (incoming payment or outgoing payment)
  - `destination` union, required
    - AccountDestination — Destination account details
      - `destinationType` 'ACCOUNT', required — Destination type identifier
      - `accountId` string, required — Destination account identifier
      - `currency` string, required — Currency code for the destination account
    - UmaAddressDestination — UMA address destination details
      - `destinationType` 'UMA_ADDRESS', required — Destination type identifier
      - `umaAddress` string, required — UMA address of the recipient
      - `currency` string — Currency code for the destination
  - `customerId` string, required — System ID of the customer (sender for outgoing, recipient for incoming)
  - `platformCustomerId` string, required — Platform-specific ID of the customer (sender for outgoing, recipient for incoming)
  - `settledAt` string, date-time — When the payment was or will be settled
  - `createdAt` string, date-time — When the transaction was created
  - `updatedAt` string, date-time — When the transaction was last updated
  - `description` string — Optional memo or description for the payment
  - `counterpartyInformation` object — Additional information about the counterparty, if available and relevant to the transaction and platform. Only applicable for transactions to/from UMA addresses.
  - `source` union, required
    - AccountSource — Source account details
      - `sourceType` 'ACCOUNT', required — Source type identifier
      - `accountId` string, required — Source account identifier
      - `currency` string, required — Currency code for the source account
    - UmaAddressSource — UMA address source details
      - `sourceType` 'UMA_ADDRESS', required — Source type identifier
      - `umaAddress` string, required — UMA address of the sender
      - `currency` string — Currency code for the source
  - `sentAmount` CurrencyAmount, required
    - `amount` integer, required — Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)
    - `currency` Currency, required
      - `code` string — Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)
      - `name` string — Full name of the currency
      - `symbol` string — Symbol of the currency
      - `decimals` integer — Number of decimal places for the currency
  - `receivedAmount` CurrencyAmount
    - `amount` integer, required — Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)
    - `currency` Currency, required
      - `code` string — Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)
      - `name` string — Full name of the currency
      - `symbol` string — Symbol of the currency
      - `decimals` integer — Number of decimal places for the currency
  - `exchangeRate` number — Number of sending currency units per receiving currency unit.
  - `fees` integer — The fees associated with the quote in the smallest unit of the sending currency (eg. cents).
  - `quoteId` string — The ID of the quote that was used to trigger this payment
  - `originalTransactionId` string — ID of the original transaction that this transaction is retrying, if applicable
  - `paymentInstructions` PaymentInstructions[], required — Payment instructions for executing the payment.
    - `instructionsNotes` string — Additional human-readable instructions for making the payment
    - `isPlatformAccount` boolean — Indicates whether the account is a platform account or a customer account.
    - `accountOrWalletInfo` union, required
      - ClabeAccountInfo
        - `accountType` 'CLABE', required
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
      - UsAccountInfo
        - `accountType` 'US_ACCOUNT', required
        - `accountNumber` string, required — US bank account number
        - `routingNumber` string, required — ACH routing number (9 digits)
        - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
        - `bankName` string — Name of the bank
      - PixAccountInfo
        - `accountType` 'PIX', required
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `taxId` string, required — Tax ID of the account holder
      - IbanAccountInfo
        - `accountType` 'IBAN', required
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string, required — SWIFT/BIC code (8 or 11 characters)
      - UpiAccountInfo
        - `accountType` 'UPI', required
        - `vpa` string, required — Virtual Payment Address for UPI payments
      - SparkWalletInfo
        - `accountType` 'SPARK_WALLET', required
        - `address` string, required — Spark wallet address
      - object
        - `accountType` 'LIGHTNING', required
        - `invoice` string, required — Invoice for the payment
      - SolanaWalletInfo
        - `accountType` 'SOLANA_WALLET', required
        - `address` string, required — Solana wallet address
      - TronWalletInfo
        - `accountType` 'TRON_WALLET', required
        - `address` string, required — Tron wallet address
      - PolygonWalletInfo
        - `accountType` 'POLYGON_WALLET', required
        - `address` string, required — Polygon eth wallet address
      - BaseWalletInfo
        - `accountType` 'BASE_WALLET', required
        - `address` string, required — Base eth wallet address
  - `refund` Refund
    - `reference` string, required — The unique reference code of the refund
    - `initiatedAt` string, date-time, required — When the refund was initiated
    - `settledAt` string, date-time — When the refund was or will be settled
  - `rateDetails` OutgoingRateDetails — Details about the rate and fees for an outgoing transaction or quote.
    - `counterpartyMultiplier` number, double, required — The underlying multiplier from mSATs to the receiving currency as returned by the counterparty institution.
    - `counterpartyFixedFee` integer, required — The fixed fee charged by the counterparty institution to execute the quote in the smallest unit of the receiving currency (eg. cents).
    - `gridApiMultiplier` number, double, required — The underlying multiplier from the sending currency to mSATS, including variable fees.
    - `gridApiFixedFee` integer, required — The fixed fee charged by the Grid product to execute the quote in the smallest unit of the sending currency (eg. cents).
    - `gridApiVariableFeeRate` number, double, required — The variable fee rate charged by the Grid product to execute the quote as a percentage of the sending currency amount.
    - `gridApiVariableFeeAmount` number, required — The variable fee amount charged by the Grid product to execute the quote in the smallest unit of the sending currency (eg. cents). This is the sending amount times gridApiVariableFeeRate.
  - `failureReason` 'QUOTE_EXPIRED' | 'QUOTE_EXECUTION_FAILED' | 'LIGHTNING_PAYMENT_FAILED' | 'FUNDING_AMOUNT_MISMATCH' | 'COUNTERPARTY_POST_TX_FAILED' | 'TIMEOUT' — Reason for failure of an outgoing transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, this field is omitted.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden - request was made with a production platform token
- `404` — Quote not found
- `500` — Internal service error

## Changes

- **2026-01-28** `f3b295b6fbcc` — 2 info
  - removed `FBO` discriminator mapping keys from the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo` response property for the response status `200`
  - removed `#/components/schemas/PaymentFboAccountInfo` from the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo` response property `oneOf` list for the response status `200`
- **2026-01-28** `d1490309094a` — 1 info
  - removed `subschema #1` from the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #5: FBO Account]/` response property `allOf` list for the response status `200`
- **2026-01-28** `60af1189794c` — 1 breaking, 1 info
  - the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the required property `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/accountType` to the response with the `200` status
- **2026-01-24** `36c697116132` — 1 breaking, 1 info
  - the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #8: Lightning Invoice]/` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - removed `#/components/schemas/PaymentAccountOrWalletInfo` from the `allOf[subschema #2]/paymentInstructions/items/accountOrWalletInfo/oneOf[subschema #8: Lightning Invoice]/` response property `allOf` list for the response status `200`

[Change history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/sandbox/send/post.md)

---

[API](https://skmtc.dev/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.dev/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/revisions/f3b295b6fbcc/schema)