Simulate transaction or payment (v2)

post

https://api.sandbox.com/v2/simulations

Creates an enhanced v2 transaction simulation that calculates and previews all costs, exchange rates, and requirements before executing a transaction. The v2 version provides more detailed breakdowns including itemized fees (network fees, service fees, FX fees), step-by-step multi-currency conversion paths for complex transactions, compliance requirements based on amount and destination, and improved exchange rate accuracy. Simulations are valid for 24 hours and should be used to show users exact costs before they confirm a transaction. Use v2 for better transparency and accuracy, especially for cross-border or multi-hop currency conversions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to simulate a payment transaction including amount conversion, fees, and payment rail selection for both funding and payout.

beneficiaryId

string

from

object

Represents a monetary amount with currency code and value.

object

Represents a monetary amount with currency code and value.

funding

string

enum

payout

string

enum

recipientId

string

achSameDay

boolean

When true, requests same-day ACH settlement instead of the default 1–2 business day settlement. Only applicable when the payment rail is ACH. When set on the simulation, this value automatically carries over to the transaction without needing to re-specify it in the TransactionRequest.

customFees

object

Optional integrator-defined fees applied on the currency-conversion (FX) leg of the operation. Supply your own spread under the INTEGRATOR_SPREAD key (the INTEGRATOR alias is also accepted); this spread is added on top of Caliza's spread and becomes your revenue on the conversion. Values are in basis points (BPS), where 100 BPS = 1%, and must be >= 0. Passing 0 or omitting the field disables your spread, in which case integratorRate equals calizaRate in the response. Only the FX leg is affected; same-currency flows are unaffected. The resulting rate tiers are returned under conversionDetails (marketExchangeRate, calizaRate, integratorRate) and each margin appears as a spreadFees[] item (type: CALIZA for Caliza's revenue and type: INTEGRATOR_SPREAD for yours).

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK