crate::web::openapi::simulations

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

Changed on

Request

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, ETH, SOL
  • Fiat currencies: USD, MXN
networkstring required

Public network identifier for bank, blockchain and internal transactions.

Allowed values:

  • Bank: US_ACH, US_FEDWIRE, US_RTP, US_FEDNOW, SWIFT, CUBIX, SPEI, PIX_TRANSFER, LOCAL_BANK_TRANSFER, CHATS, FPS, SEPA, FASTER_PAYMENT, UAEFTS, UPI, EREBOR_RAIL
  • Blockchain: ETHEREUM, POLYGON, ARBITRUM, AVALANCHE, BASE, BNBCHAIN, SOLANA, TRON, ONE_MONEY, BITCOIN
  • Internal: INTERNAL

Availability depends on the asset and customer account configuration.

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' | 'MICRO_DEPOSIT' | 'MICRO_DEPOSIT_REVERSED' 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"
}

Changes

    • warning

      added the new MICRO_DEPOSIT enum value to the response property for the response status

    • warning

      added the new MICRO_DEPOSIT_REVERSED enum value to the response property for the response status

    • info

      api tag crate::web::openapi::simulations added

    • info

      api tag Simulations removed