Skip to main content

Sandbox APIs

The Sandbox APIs section is reserved for Public Test and demo-only helper surfaces that should stay visually separate from the core public business API families. The current sandbox capabilities are:

Sandbox Lightning execution profile

  • it stores platform-scoped execution-profile defaults
  • it affects newly created quotes after corridor confirmation
  • it feeds POST /quotes indirectly rather than returning quote outputs
  • it is not a second quote endpoint
  • it is not a Lightning node, channel, liquidity, or routing-management API

Sandbox incoming payment simulation

  • it is Public Test and demo-only
  • it creates synthetic incoming-payment review cases for Step 4
  • it feeds the existing transaction review flow rather than creating a second transaction system
  • it is not the real incoming-payment ingestion surface
  • it is not a second transaction API family
  • it supports three frozen review scenarios with explicit decision models
Use POST /sandbox/incoming-payments/simulate to create one reviewable Step 4 case, then continue on the existing transaction review surfaces:
  • GET /transactions to see reviewable cases in the queue/inventory flow
  • GET /transactions/{transactionId} to inspect the selected case and its Step 4 review metadata
  • POST /transactions/{transactionId}/approve when the existing review lane allows approval
  • POST /transactions/{transactionId}/reject to complete the negative path on the existing review lane
The three frozen Step 4 scenarios remain:
  • sanctions_hit Reject only. The runtime blocks approve for this scenario.
  • sender_kyc_not_approved Reject only. The runtime blocks approve for this scenario.
  • counterparty_info_incomplete Manual review required. Demo operators use the existing transaction detail and local Step 4 workflow to complete manual review before approving.
The manual-review scenario uses this frozen missing field set:
  • senderFullLegalName
  • senderCountryCode
  • senderDateOfBirthOrRegistrationId
  • purposeOfPayment
That keeps the Sandbox APIs section visually separate from the core business flows while still making the Step 4 demo operator workflow discoverable in the docs site.