Simulation
Simulate full financial transaction
Simulate a full financial transaction for a sandbox card. Full financial transactions capture funds immediately without a prior authorization hold, as with transit taps, low-value purchases, and offline transactions. Simulated full financial transactions don't call your real-time authorization endpoint, but card status, authorization policy, and balance checks still apply and can decline them.
The cardholder is always billed in USD; when merchant_currency is not USD, provide cardholder_fx_rate.
Path Parameters
card_id
stringRequiredUnique identifier for the card.
Body Parameters
cardholder_amount
numberRequiredTransaction amount in the merchant's currency, expressed in the smallest currency unit.
For example, 1000 represents 10.00 EUR. When merchant_currency is not USD,
this amount is multiplied by cardholder_fx_rate to derive the USD billing amount.
Must not exceed 999999999999.
cardholder_fx_rate
stringOptionalForeign exchange rate to convert from merchant currency to USD (cardholder billing currency),
as a decimal string. Required when merchant_currency is not USD.
For example, if merchant_currency is EUR and cardholder_fx_rate is "1.10",
a 10.00 EUR transaction will result in an 11.00 USD cardholder charge.
merchant_category_code
stringOptionalOptional merchant category code (ISO 18245 MCC) to put on the simulated message (Field 18), for
example 5812 (restaurants) or 6011 (ATM). Defaults to 5999. Use it to exercise real-time
decisioning rules that depend on the merchant category.
merchant_city
stringOptionalOptional card acceptor city to put on the simulated message (Field 43, positions 26-38).
Defaults to CITY NAME. At most 13 characters.
merchant_country_code
stringOptionalOptional card acceptor country, ISO 3166-1 alpha-2, to put on the simulated message (Field 43,
positions 39-40). Defaults to US. Use it to exercise country-based decisioning rules.
merchant_currency
stringRequiredMerchant's currency code in ISO 4217 format.
merchant_name
stringOptionalOptional card acceptor name to put on the simulated message (Field 43, positions 1-25).
Defaults to ACQUIRER NAME. At most 25 characters.