increase-test
POST/simulations/card_authorizations

Sandbox: Create a Card Authorization

Simulates a purchase authorization on a Card. Depending on the balance available to the card and the amount submitted, the authorization activity will result in a Pending Transaction of type card_authorization or a Declined Transaction of type card_decline. You can pass either a Card id or a Digital Wallet Token id to simulate the two different ways purchases can be made. The response will contain either a pending_transaction or a declined_transaction; the other attribute will be null. If the authorization is declined, the reason is available on the Declined Transaction at source.card_decline.reason.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

17 body fields
amountintegerrequired
The authorization amount in cents.
authenticated_card_payment_idstringoptional
The identifier of a Card Payment with a `card_authentication` if you want to simulate an authenticated authorization.
card_idstringoptional
The identifier of the Card to be authorized.
decline_reasonstringoptional
Forces a card decline with a specific reason. No real time decision will be sent.
Allowed:account_closedcard_not_activecard_canceledphysical_card_not_activeentity_not_activegroup_lockedinsufficient_fundscvv2_mismatchpin_mismatchcard_expiration_mismatchtransaction_not_allowedbreaches_limit
digital_wallet_token_idstringoptional
The identifier of the Digital Wallet Token to be authorized.
event_subscription_idstringoptional
The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.
merchant_acceptor_idstringoptional
The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
merchant_category_codestringoptional
The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
merchant_citystringoptional
The city the merchant resides in.
merchant_countrystringoptional
The country the merchant resides in.
merchant_descriptorstringoptional
The merchant descriptor of the merchant the card is transacting with.
merchant_statestringoptional
The state the merchant resides in.
network_detailsobjectoptional
Fields specific to a given card network.
network_risk_scoreintegeroptional
The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.
physical_card_idstringoptional
The identifier of the Physical Card to be authorized.
processing_categoryobjectoptional
Fields specific to a specific type of authorization, such as Automatic Fuel Dispensers, Refund Authorizations, or Cash Disbursements.
terminal_idstringoptional
The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.

3 status codes
200Inbound Card Authorization Simulation Result
declined_transactionobjectrequired
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
pending_transactionobjectrequired
If the authorization attempt succeeds, this will contain the resulting Pending Transaction object. The Pending Transaction's `source` will be of `category: card_authorization`.
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_card_authorization_simulation_result`.
Allowed:inbound_card_authorization_simulation_result
4XXError
5XXError