GuidesAPI Reference
Guides
API Reference

Simulate transaction or payment

Creates a simulation to preview and calculate all costs associated with a transaction before executing it. The simulation returns estimated total costs, itemized fees, exchange rates (if currency conversion is involved), expected settlement time, and any compliance requirements. Simulations are typically valid for 24 hours, after which exchange rates may change and a new simulation should be created. Always create a simulation before executing a transaction to show users accurate costs and get a simulation ID required for transaction creation. For more detailed breakdowns, consider using the v2 simulation endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
from
object
required

Represents a monetary amount with currency code and value.

string
enum
to
object

Represents a monetary amount with currency code and value.

string
string
enum
Allowed:
boolean
string
enum
string
string
enum
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
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json