---
title: "Simulate authorisation clearing transaction"
method: POST
path: "/simulate/{transactionID}/clearing"
tags: ["Simulate"]
---

# Simulate authorisation clearing transaction

`POST /simulate/{transactionID}/clearing`

## Path parameters

- `transactionID` string, required

## Headers

- `Accept-Version` string, required — Specifies the API version to use for this request.

## Request body

- object
  - `transactionAmount` number, float — The amount for the transaction. If not provided, it defaults to the **billAmount**.
  - `transactionCurrency` string, nullable — The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) (e.g., 840 for USD). If not provided, it defaults to the card currency.
  - `simulateOfflineTxn` boolean — Indicates whether to simulate an offline transaction. Possible values: **true**: Simulates a transaction type that clears directly without a previously authorized amount (offline transaction). **false**: Simulates a transaction type that clears a previously authorized transaction. **Note**: When set to true, the transactionID in the path parameter can be any value.
  - `billAmount` union
    - number, float — Required when **simulateOfflineTxn** is true.
    - number, float — If **simulateOfflineTxn** is **false**, this parameter can be left empty.
  - `cardID` union
    - string — Required when **simulateOfflineTxn** is true.
    - string — If **simulateOfflineTxn** is false, this parameter can be left empty.
  - `acquirerCountry` string, nullable — The country of the acquirer. This parameter is not applicable to incremental authorizations. Default is **HKG**.

## Response `201`

Successfully simulated an authorisation clearing transaction

- object
  - `lifecycleEventID` string, required — A unique identifier for the lifecycle event.
  - `id` string, required — A unique identifier for the transaction.

## Other responses

- `400` — Bad request
- `404` — Not found

---

[API](https://skmtc.net/reap-global/apis/reap-api.md) · [All operations](https://skmtc.net/reap-global/apis/reap-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reap-global/reap-api/versions/525072733e02/schema)