Sign in

v1

latestOpenAPI 3.0.02026-08-04620256.0 KB
Simulate

Simulate authorisation clearing transaction

post/simulate/{transactionID}/clearing

Path parameters

transactionIDstring required

The unique identifier for the transaction.

This field should be included in the response body after simulating a transaction of type authorization using the POST /simulate/authorization endpoint. If simulating an offline transaction, this field can be left empty.

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

transactionAmountnumber float

The amount for the transaction. If not provided, it defaults to the billAmount.

transactionCurrencystring nullable

The ISO 4217 currency code (e.g., 840 for USD). If not provided, it defaults to the card currency.

simulateOfflineTxnboolean

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.

acquirerCountrystring nullable

The country of the acquirer. This parameter is not applicable to incremental authorizations. Default is HKG.

Example request

{
  "transactionCurrency": "840"
}

Response

Successfully simulated an authorisation clearing transaction

lifecycleEventIDstring required

A unique identifier for the lifecycle event.

idstring required

A unique identifier for the transaction.