Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB
Simulations

Simulate Deposit

Simulates a deposit transaction for testing purposes. Only available in non-production environments.

Asset & Network Requirements

  • For token assets (USDT, USDC, MXNB), network is required and must be a wallet network (e.g., ETHEREUM).
  • For currency assets (USD), network must be a bank network (US_ACH, US_FEDWIRE, US_RTP, SWIFT, CUBIX, BANK_TRANSFER, PIX_TRANSFER).
  • Amount Limit: Simulation amount must be greater than zero and cannot exceed 1000.

Deposit Status Simulation

Use the simulate_status field to simulate different deposit states:

ValueDescription
FAILEDSimulates a failed deposit

Example: { "asset": "USD", "network": "US_ACH", "amount": "100.00", "simulate_status": "FAILED" }

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

Path parameters

customer_idstring required

Customer ID

Request body

assetstring required
  • Stablecoin assets: USDC, USDT, PYUSD, RLUSD, USDG, USDP, EURC, MXNB, 1USD(1USD/USDC conversion only, deposit/withdrawal not supported)
  • Digital assets: BTC
  • Fiat currencies: USD
networkstring required
amountstring required

Deposit amount

reference_codestring nullable

Optional reference-code/memo/message for the transaction (only used for fiat deposits)

simulate_statusstring nullable

Optional simulation status for sandbox testing. Supported values: "FAILED"

Example request

{
  "asset": "USDC",
  "network": "ETHEREUM",
  "amount": "100.00",
  "reference_code": "Payment reference",
  "simulate_status": "FAILED"
}

Response

simulation_idstring required

Transaction ID

status'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'RETURNED' required
created_atstring required
modified_atstring required

Example response

{
  "simulation_id": "3a8287c7-7e67-11f0-895a-4ac62f6385cc",
  "created_at": "2025-08-21T07:56:57.981Z",
  "modified_at": "2025-08-21T07:56:57.981Z"
}