v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB
Sandbox

Simulate inbound transfer on a Deposit Address

Simulate an inbound stablecoin (blockchain) transfer against a Deposit Address, for testing webhook and reconciliation flows. Sandbox / non-production only; returns 404 in production-live. The asset and network are resolved server-side from the Deposit Address (limited to ethereum, base, and solana); the caller supplies only the amount.

post/deposit-addresses/{depositAddressId}/simulate/inbound-transfer

Path parameters

depositAddressIdstring required

Headers

Idempotency-Keystring required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Request body

amountstring required

Wire-safe decimal string for financial float values (USD amounts, percentages).

Response

The request has succeeded.

depositAddressIdstring required

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

asset'usdc' | 'usdt' | 'usat' required

Stablecoin currency code accepted for inbound blockchain transfers.

network'base' | 'ethereum' | 'solana' required

Blockchain network for inbound Deposit Address transfers. Narrowed to the serviceable subset (base, ethereum, solana); there is no Polygon synthesis. Lowercase, matching how DepositAddress.expectedSourceNetwork is cased on the wire.

amountstring required

Wire-safe decimal string for financial float values (USD amounts, percentages).

status'submitted' required

Always "submitted"; sandbox blockchain inbounds settle synchronously.

submittedAtstring date-time required

When the simulated transfer was submitted.

transactionHashstring required

Synthetic on-chain transaction hash for webhook correlation.