Sandbox

Sandbox endpoints are available only to sandbox workspace API keys. They let you create deterministic test balances and move existing sandbox pay-ins or payouts to terminal states without moving real funds.

Prerequisites

1. Create a sandbox workspace in Swipelux at https://swipelux.app.
2. Issue an API key from that workspace. Sandbox keys are marked with sbx.
3. Use normal API endpoints to create the customer, wallet, pay-in, or payout before calling simulation endpoints.

Send the sandbox key in the same X-API-Key header used by production requests:

X-API-Key: sk.sbx.xxxxx

Live keys receive 403 on /v1/sandbox/* endpoints.

Test Balances

Use POST /v1/sandbox/topup to credit a custodial sandbox wallet with test funds. The response is a completed wallet_to_wallet transfer record. The returned explorer-style URLs are for testing only and are not proof of a real transaction.

{
  "wallet": "wal_xxxxxxxxxxxxxxxxxx",
  "amount": "1000.00",
  "currency": "USDC"
}

Top-ups complete synchronously with state: "completed". The target wallet must belong to a sandbox customer.

Simulate Pay-in Settlement

Use POST /v1/sandbox/payins/simulate after creating a sandbox pay-in through the normal pay-in flow.

{
  "payin": "tr_xxxxxxxxxxxxxxxxxx",
  "status": "completed",
  "amount": "100.00"
}

status can be completed or failed. Completed simulations credit the sandbox wallet and emit the same pay-in and transfer webhook families as a real settlement. Failed simulations emit the normal failure webhook family. amount is optional; when omitted, the original pay-in amount is used.

The customer-scoped alias is also available:

POST /v1/customers/{customer_id}/simulate-transactions

{
  "type": "PAYIN",
  "payin_id": "tr_xxxxxxxxxxxxxxxxxx",
  "simulate_status": "COMPLETED",
  "amount": "100.00"
}

Simulate Payout Settlement

Use POST /v1/sandbox/payouts/simulate after creating a sandbox payout through the normal payout flow.

{
  "payout": "tr_xxxxxxxxxxxxxxxxxx",
  "status": "completed"
}

status can be completed or failed. The endpoint emits the same payout and transfer webhook families that production payouts use while keeping the activity inside the sandbox workspace.

API Reference