Simulation
Simulate card authorization
Simulate a card authorization for a sandbox card. The cardholder is always billed in USD; when merchant_currency
is not USD, provide cardholder_fx_rate.
When neither realtime_decision nor network_standin is set, Column sends a real-time authorization decision request
to your endpoint subscribed to decision.issuing.card_transaction, and declines if none is configured. Set
realtime_decision to supply the decision without calling your endpoint, or network_standin to simulate the card
network deciding on your behalf. To attach 3DS authentication details, pass an authenticated three_ds_attempt_id
for the same card.
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.
network_decision_reason
stringOptionalThe reason for the network's decline decision. Only applicable when
network_standin is declined. Determines the network response code
on the transaction. Defaults to generic_decline if not specified.
network_standin
enumOptionalSimulates a scenario where the card network makes the authorization decision
on behalf of the issuer (e.g., due to issuer timeout). When set, the resulting
transaction will have decision_source set to card_network.
approved— the network approves the transaction.declined— the network declines the transaction.
realtime_decision
enumOptionalSpecifies the issuer's real-time authorization decision to inject if the transaction
reaches the real-time decisioning step. Mutually exclusive with network_standin.
approve— the issuer approves the transaction.decline— the issuer declines the transaction (seerealtime_decision_reason).partially_approve— the issuer partially approves the transaction
(requires realtime_partially_approved_amount).
When neither realtime_decision nor network_standin is provided, the simulator
attempts a real real-time authorization decision webhook to the platform's configured
decision.issuing.card_transaction destination (declining if no destination is configured).
realtime_decision_reason
stringOptionalThe reason for the issuer's real-time decline decision. Only applicable when
realtime_decision is decline. Defaults to generic_decline if not specified.
realtime_funding_account_id
stringOptionalThe bank account to just-in-time fund the authorization from, as a platform's real-time authorization
decision would name in funding_account_id. Only applicable when realtime_decision is approve or
partially_approve, and only on debit card programs with jit_funding_enabled.
realtime_partially_approved_amount
numberOptionalThe amount to partially approve, expressed in the smallest currency unit.
Required when realtime_decision is partially_approve, and must be less than the
requested cardholder_amount.
three_ds_attempt_id
stringOptionalOptional 3DS attempt ID to link to this authorization. The 3DS attempt must be in
authenticated status and belong to the same card. When provided, the authorization
will include authentication details with liability shift.