LIlightsparkdev
Sandbox

Simulate sending funds

Changed on

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.

post/sandbox/send

Request

  • Base URL
    https://api.uma.money/umaaas/2025-05-15
  • URL
    https://api.uma.money/umaaas/2025-05-15/sandbox/send
  • Auth
    HTTP basic

Request body

referencestring required

The unique reference code that was in the payment instructions

currencyCodestring required

Currency code for the funds to be sent

currencyAmountinteger required

The amount to send in the smallest unit of the currency (eg. cents)

Example request

{
  "reference": "UMA-Q12345-REF",
  "currencyCode": "USD",
  "currencyAmount": 1000
}

Response

Funds received successfully

idstring 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)

senderUmaAddressstring required

UMA address of the payment sender

receiverUmaAddressstring required

UMA address of the payment recipient

userIdstring required

System ID of the user (sender for outgoing, recipient for incoming)

platformUserIdstring required

Platform-specific ID of the user (sender for outgoing, recipient for incoming)

settledAtstring date-time

When the payment was or will be settled

createdAtstring date-time

When the transaction was created

descriptionstring

Optional memo or description for the payment

counterpartyInformationobject

Additional information about the counterparty, if available

exchangeRatenumber

Number of sending currency units per receiving currency unit.

feesinteger

The fees associated with the quote in the smallest unit of the sending currency (eg. cents).

quoteIdstring

The ID of the quote that was used to trigger this payment

originalTransactionIdstring

ID of the original transaction that this transaction is retrying, if applicable

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.

Example response

{
  "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
  "senderUmaAddress": "$sender@external.domain",
  "receiverUmaAddress": "$recipient@uma.domain",
  "userId": "User:019542f5-b3e7-1d02-0000-000000000001",
  "platformUserId": "18d3e5f7b4a9c2",
  "settledAt": "2023-08-15T14:30:00Z",
  "createdAt": "2023-08-15T14:25:18Z",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "sentAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "receivedAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "exchangeRate": 1.08,
  "fees": 10,
  "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
  "originalTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000003",
  "paymentInstructions": {
    "reference": "UMA-Q12345-REF",
    "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
    "bankAccountInfo": {
      "clabeNumber": "123456789012345678",
      "bankName": "BBVA Mexico",
      "accountHolderName": "John Doe"
    }
  },
  "refund": {
    "reference": "UMA-Q12345-REFUND",
    "initiatedAt": "2023-08-15T14:30:00Z",
    "settledAt": "2023-08-15T14:30:00Z"
  },
  "rateDetails": {
    "counterpartyMultiplier": 1.08,
    "counterpartyFixedFee": 10,
    "umaaasMultiplier": 0.925,
    "umaaasFixedFee": 10,
    "umaaasVariableFeeRate": 0.003,
    "umaaasVariableFeeAmount": 30
  }
}

Changes

  • aa2c7b1aaf8aRevision changes
    • warning

      added the new CORRIDOR_UNDER_MAINTENANCE enum value to the response property for the response status

  • 53c9091c5ef4Revision changes
    • warning

      added the new SANCTION_BLOCKED enum value to the response property for the response status