---
title: "Simulate payment send to test receiving a payment"
method: POST
path: "/sandbox/receive"
tags: ["Sandbox"]
---

# Simulate payment send to test receiving a payment

`POST /sandbox/receive`

Simulate sending payment from an sandbox uma address to a platform user to test payment receive.
This endpoint is only for the sandbox environment and will fail for production platforms/keys.

## Request body

- object
  - `senderUmaAddress` string, required — UMA address of the sender from the sandbox
  - `receiverUmaAddress` string — UMA address of the receiver (optional if userId is provided)
  - `userId` string — System ID of the receiver (optional if receiverUmaAddress is provided)
  - `receivingCurrencyCode` string, required — The currency code for the receiving amount
  - `receivingCurrencyAmount` integer, required — The amount to be received in the smallest unit of the currency (eg. cents)

## Response `200`

Payment triggered successfully

- IncomingTransaction
  - `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
  - `receivedAmount` 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
  - `reconciliationInstructions` ReconciliationInstructions
    - `reference` string, required — Unique reference code that must be included with the payment to match it with the correct incoming transaction
  - `rateDetails` IncomingRateDetails — Details about the rate and fees for an incoming transaction.
    - `umaaasMultiplier` number, double, required — The underlying multiplier from the mSATS to the receiving currency, including variable fees.
    - `umaaasFixedFee` integer, required — The fixed fee charged by the UMAaaS product to execute the quote in the smallest unit of the receiving 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 receiving currency amount.
    - `umaaasVariableFeeAmount` number, required — The variable fee amount charged by the UMAaaS product to execute the quote in the smallest unit of the receiving currency (eg. cents). This is the receiving amount times umaaasVariableFeeRate.
  - `failureReason` 'LNURLP_FAILED' | 'PAY_REQUEST_FAILED' | 'PAYMENT_APPROVAL_WEBHOOK_ERROR' | 'PAYMENT_APPROVAL_TIMED_OUT' | 'OFFRAMP_FAILED' | 'MISSING_MANDATORY_PAYEE_DATA' | 'QUOTE_EXPIRED' | 'QUOTE_EXECUTION_FAILED' — Reason for failure of an incoming 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` — Sender or receiver 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)