Sign in

v1

latestOpenAPI 3.0.02026-07-247150151.6 KB
Simulate

Simulate Authorization

Simulate a card transaction

post/simulate/authorization

Request body

card_idstring required
amountstring required

Transaction amount as a decimal string using two digits of precision, e.g., "10.00".

transaction_datetimestring

Date and time of transaction YYYY-MM-DD HH:MM

currencystring required

ISO currency of simulated transaction

merchant_namestring required

merchant name to be returned in transaction

merchant_citystring required

merchant city to be returned in transaction

merchant_statestring required

merchant state to be returned in transaction

merchant_zip_codestring required

merchant zip code be returned in transaction zip code in 5-digit (12345)

mccstring required

merchant category code to be returned in transaction mcc code in 4-digit (1234)

midstring required

merchant identifier to be return in the transaction in X-digit (xxxx)

Response

Example response

transaction_idstring required
customer_idstring required
card_idstring required
raw_statement_descriptorstring required
account_idstring required
bond_brand_idstring required
payment_railstring required
amountstring required
amount_in_centsstring required
currency_codestring required
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:exchange_rate","oasType":"schema","type":"unknown"}
transaction_typestring required
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:cardholder_presence_indicator","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:original_transaction_id","oasType":"schema","type":"unknown"}
merchant_namestring required
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:merchant_id","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:merchant_address","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:merchant_country","oasType":"schema","type":"unknown"}
merchant_citystring required
merchant_statestring required
merchant_zip_codestring required
mccstring required
settled_datestring required
new_balancestring required
prior_balancestring required
transaction_timestring required
date_createdstring required
date_updatedstring required
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:fee","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:rewards_rate","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:rewards","oasType":"schema","type":"unknown"}
transaction_statestring required
origin_timestampstring required
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:transaction_response_code","oasType":"schema","type":"unknown"}
{"stackTrail":"components:responses:simulate-response:content:application/json:schema:properties:acquiring_institution_identification_code","oasType":"schema","type":"unknown"}

Example response

{
  "transaction_id": "3fd4356b-a64b-4d2f-8699-cbb2b76e1d52",
  "customer_id": "08ebf96f-d3e2-4a50-8a52-d5677c3c9825",
  "card_id": "7c216d02-e5ca-4d88-b8da-90b912a34081",
  "raw_statement_descriptor": "Amazon.com Amzn.com/billWAUSA USA",
  "account_id": "4b9cecad-8081-49aa-ab71-d273d64fb50e",
  "bond_brand_id": "91b8a931-c86d-462b-9db5-eded20b26bd9",
  "payment_rail": "card",
  "amount": "-4.99",
  "amount_in_cents": "-499",
  "currency_code": "USD",
  "transaction_type": "POS Purchase",
  "merchant_name": "Amazon.Com Amzn.Com/Billwausa Usa",
  "mcc": "Online Shopping",
  "settled_date": "2021-07-20 22:29:00",
  "new_balance": "298.01",
  "prior_balance": "303",
  "transaction_time": "2021-07-20 22:29:00",
  "date_created": "2021-07-20 22:29:00",
  "date_updated": "2021-07-20 22:29:00",
  "transaction_state": "pending",
  "origin_timestamp": "2021-07-20 22:29:00"
}