Sandbox

Simulate a fixed-route source deposit

Changed on

Sandbox-only: triggers the fixed-route sweep without on-chain funds or provider webhooks. Works for fiat (vba_) and crypto (inw_) source routes. Does not use account fund-in -- Infinite wallets cannot be credited that way. When the sweep target is a treasury Infinite wallet and the destination is a mintable sandbox token (USDT or USAT on Ethereum), this also mints that token to the vault so GET treasury and withdrawals see a real testnet balance. When the sweep target is a fiat balance account, this credits that balance immediately and emits balance.credited. A reused reference with the same amount returns the existing sweep and leaves its recorded rail and remitter unchanged. An unfinished sweep resumes from that deposit, not the later rail. Use a new reference per rail. On a fiat pay-in that lists sourceRails, rail is ACH, WIRE, or SWIFT. Omit it to book the stored rail (ACH when the route accepts ACH and wire). Wire, ACH, and SWIFT deposits populate source.originator with a sandbox remitter unless you pass originator or the route has allowedSenderBanks. The ACH remitter is the originator name and routing number only.

post/v1/sandbox/fixed-routes/{id}/simulate-deposit

Request

Path parameters

idstring required

Fixed route source account id (vba_ for fiat, inw_ for crypto deposit wallets)

Headers

X-API-Keystring

API key

Request body

amountstring required

Deposit amount in major units (e.g. "1000.00" for USD, "100.5" for USDT)

currencystring

Deposit currency; defaults to the route source currency when omitted

referencestring

Idempotency reference for the simulated deposit. A reused reference returns the existing sweep. Its rail and remitter stay as first recorded, and an unfinished sweep resumes from that deposit rather than the later rail. Use a new reference to simulate a different inbound rail.

rail'ACH' | 'WIRE' | 'SWIFT'

Inbound rail for a fiat pay-in that lists sourceRails. ACH, WIRE, or SWIFT. Omit to book the route's stored rail (ACH when the route accepts ACH and wire). Domestic wire is WIRE. Ignored when the route has no sourceRails.

Example request

{
  "amount": "1000.00",
  "currency": "USD",
  "reference": "sandbox_test_deposit_1",
  "rail": "WIRE",
  "senderBank": {
    "bankName": "JPMorgan Chase",
    "routingNumber": "021000021",
    "swiftBic": "CHASUS33"
  },
  "originator": {
    "name": "Sandbox Originator LLC",
    "bankName": "Sandbox Test Bank",
    "routingNumber": "021000021",
    "accountNumber": "000123456789",
    "swiftBic": "CHASUS33",
    "bankCountry": "US",
    "paymentReference": "INV-2025-001"
  }
}

Response

Fixed route sweep simulated successfully

accountIdstring required

Fixed route source account ID

transferIdstring required

Sweep transfer created or replayed for this simulation

sweepReferenceIdstring required

Sweep idempotency key used for this simulation

Example response

{
  "accountId": "acc_123",
  "transferId": "tfr_123",
  "sweepReferenceId": "sandbox_sim_550e8400-e29b-41d4-a716-446655440000"
}

Changes