v1

latestOpenAPI 3.0.02026-08-04620256.0 KB
Simulate

Simulate authorisation refund transaction

post/simulate/{transactionID}/refund

Path parameters

transactionIDstring required

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

billAmountnumber float

The amount to be billed to the cardholder. You can simulate either a full reversal or a partial reversal:

Full reversal: Leave this field empty to process a full reversal.

Partial reversal: Set this field to a positive value to indicate a partial reversal.

The reversal amount is calculated as: transactionAmount - billAmount.

transactionAmountnumber float

The amount of the transaction being authorized.

unrelatedboolean

when set to true, simulate a refund that is unrelated to a previous clearing transaction.

acquirerCountrystring nullable

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

Response

Successfully simulated an refund transaction

lifecycleEventIDstring required

A unique identifier for the lifecycle event.

idstring required

A unique identifier for the transaction.