SETSimple Easy Transactions
SET DocsAPI reference and complianceUpdated 2026-11-09
Browse: SET API (Platforms)

SET API (Platforms) · Sandbox

Run a sandbox scenario

POST/v1/sandbox/scenarios

Key scope: write · Staging only · Success: 201

Staging only. One call puts an object into an outcome your integration must handle before going live: a rejected KYB, an RFI, a deposit reviewed then refunded, a returned Cash-Out payment, a returned or undeliverable payout, a microdeposit, or a wallet that needs initiation. Every answer and event is labelled “Sandbox: simulated” (simulated: true).

Body

name stringrequired
kyb_rejected, rfi_raised, deposit_in_review_then_refunded, cash_out_payment_returned, payout_returned, payout_undeliverable, microdeposit or wallet_initiation_required.
object stringrequired
The id it acts on: a customer, a virtual account or simulated deposit (sim_dep_…), a Cash-Out Address or simulated payment (sim_drain_…), a payout, or a wallet.
clear boolean
Ends kyb_rejected, rfi_raised, microdeposit or wallet_initiation_required.
reasons string[]
kyb_rejected: up to five rejection reasons. Never real personal data.
amount decimal string
Deposit and Cash-Out scenarios: at least "1.00".
amounts string[]
microdeposit: one or two amounts from "0.01" to "0.99".

Notes

  • kyb_rejected: the customer reads rejected with rejectionReasons, and creates for it answer 409 verification_incomplete.
  • rfi_raised: rfi.created for a stand-in RFI (sim_rfi_…) listed by GET /v1/customers/{id}/rfis; answering it with POST /v1/rfis/{id}/responses closes it (answers are not kept).
  • wallet_initiation_required: GET /v1/wallets/{id} reads initiationRequired: true, and payouts and withdrawals from it answer 409 initiation_required.
  • In production the route answers 404. See Sandbox scenarios.

Errors

  • 400 body_invalid
  • 400 scenario_unknown
  • 400 object_invalid
  • 400 clear_invalid
  • 400 clear_unsupported
  • 400 reasons_invalid
  • 400 amount_invalid
  • 400 amounts_invalid
  • 404 customer_unknown
  • 404 virtual_account_unknown
  • 404 deposit_unknown
  • 404 cash_out_address_unknown
  • 404 cash_out_payment_unknown
  • 404 payout_unknown
  • 404 wallet_unknown
  • 409 scenario_active
  • 409 scenario_not_active
  • 409 nothing_to_simulate
  • 409 virtual_account_inactive
  • 401 api_key_required
  • 401 api_key_invalid
  • 401 api_key_wrong_mode
  • 403 scope_missing
  • 429 rate_limited

All codes: Errors.