v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Card Transaction Simulations

Simulate clearing or refund

Simulate an authorization.clearing type transaction by including the original_transaction_token and amount in your request. To simulate a refund type transaction, set the is_refund field to true.

post/cards/transaction_simulations/clearing

Request body

amountinteger required

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

force_postboolean

is_refundboolean

midstring

original_transaction_idstring uuid required

When you simulated a clearing the synchronous response would have included a transaction.token. That value should be used here.

Example request

{
  "amount": 80,
  "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"
  },
  "force_post": false,
  "is_refund": false,
  "mid": "mid",
  "network_fees": [
    {
      "amount": 123,
      "credit_debit": "C",
      "type": "ISSUER_FEE"
    },
    {
      "amount": 123,
      "credit_debit": "C",
      "type": "ISSUER_FEE"
    }
  ],
  "original_transaction_id": "original_transaction_id"
}

Response

Success

SimulationResponseModel required