---
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
  - `reference` string, required — The unique reference code that was in the payment instructions
  - `currencyCode` string, required — Currency code for the funds to be sent
  - `currencyAmount` integer, required — The amount to send in the smallest unit of the currency (eg. cents)

## 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)
  - `senderUmaAddress` string, required — UMA address of the payment sender
  - `receiverUmaAddress` string, required — UMA address of the payment recipient
  - `userId` string, required — System ID of the user (sender for outgoing, recipient for incoming)
  - `platformUserId` string, required — Platform-specific ID of the user (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
  - `description` string — Optional memo or description for the payment
  - `counterpartyInformation` object — Additional information about the counterparty, if available
  - `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. "SAT" for satoshis, "USDC" for USDCoin, 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. "SAT" for satoshis, "USDC" for USDCoin, 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
    - `reference` string, required — Unique reference code that must be included with the payment to properly credit it
    - `instructionsNotes` string — Additional human-readable instructions for making the payment
    - `bankAccountInfo` union, required
      - PaymentClabeAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
      - PaymentUsAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `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
        - `accountHolderName` string — Name of the account holder
      - PaymentPixAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `bankName` string — Name of the bank
        - `accountHolderName` string — Name of the account holder
      - PaymentIbanAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string — SWIFT/BIC code (8 or 11 characters)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
      - PaymentFboAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `paymentUrl` string, uri, required — The url to make request to in order to confirm payment
        - `paymentMethod` 'POST' | 'GET', required — The HTTP method to use for confirming the payment
      - PaymentUpiAccountInfo
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `vpa` string, required — Virtual Payment Address for UPI payments
        - `accountHolderName` string — Name of the account holder
  - `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).
    - `umaaasMultiplier` number, double, required — The underlying multiplier from the sending currency to mSATS, including variable fees.
    - `umaaasFixedFee` integer, required — The fixed fee charged by the UMAaaS product to execute the quote in the smallest unit of the sending currency (eg. cents).
    - `umaaasVariableFeeRate` number, double, required — The variable fee rate charged by the UMAaaS product to execute the quote as a percentage of the sending currency amount.
    - `umaaasVariableFeeAmount` number, required — The variable fee amount charged by the UMAaaS product to execute the quote in the smallest unit of the sending currency (eg. cents). This is the sending amount times umaaasVariableFeeRate.
  - `failureReason` 'QUOTE_EXPIRED' | 'QUOTE_EXECUTION_FAILED' | 'LIGHTNING_PAYMENT_FAILED' | 'FUNDING_AMOUNT_MISMATCH' | 'COUNTERPARTY_POST_TX_FAILED' | 'TIMEOUT' | 'MANUAL_REFUND' — 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.
  - `counterpartyDeliveryStatus` 'PENDING' | 'COMPLETED' | 'FAILED' — The status of the delivery of the payment from the counterparty to the end recipient. This will only be present if the transaction has passed the `COMPLETED` status.

## Other responses

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

---

[API](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/uma-as-a-service-umaaas-api/revisions/2e2b5ba6d69b/schema)