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

Simulate clearing or refund

cURL

curl --request POST \
  --url https://api-sandbox.synctera.com/v0/cards/transaction_simulations/clearing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
}
'

201

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Transaction clearing or refund details

amount · integer · required

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

original_transaction_id · string<uuid> · required

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

card_acceptor · object

Show child attributes

Example:

{
  "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 · boolean · default: false

is_refund · boolean · default: false

mid · string

Required string length: 1 - 50

network_fees · object[]

Show child attributes

Response

201

application/json

Success

The response is of type object.