Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Card Transaction Simulations

Simulate financial

A "financial" is a transaction message class that includes ATM transactions, PIN-debit transactions, and balance inquiries.

Simulate a pindebit type transaction by including the card_token and amount in your request.

post/cards/transaction_simulations/financial

Request body

amountinteger required

The amount of the transaction in the smallest whole denomination of the applicable currency (eg. For USD use cents)

card_idstring uuid required
cash_back_amountinteger

Cash back amount in the smallest whole denomination of the applicable currency (eg. For USD use cents)

is_pre_authboolean
midstring required
pinstring

Example request

{
  "card_acceptor": {
    "address": "address",
    "city": "city",
    "country": "country",
    "ecommerce_security_level_indicator": "ecommerce_security_level_indicator",
    "mcc": "mcc",
    "name": "name",
    "partial_approval_capable": false,
    "state": "state",
    "zip": "zip"
  }
}

Response

Success

SimulationResponseModel required