Sign in

v1

latestOpenAPI 3.0.02026-08-04620256.0 KB
Simulate

Simulate authorisation transaction

post/simulate/authorisation

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

cardIDstring required

The unique identifier of the card to be used for simulating the transaction.

billAmountnumber float required

The total amount charged to the cardholder, in the card’s currency. This amount includes the transaction amount plus any applicable fees.

transactionAmountnumber float

The original amount of the transaction in the merchant’s currency, representing the base value of the purchase before fees are added.

Note: If not specified, this defaults to the same value as billAmount.

transactionCurrencystring nullable

The ISO 4217 currency code for the transaction. Defaults to the card’s currency if not specified.

transactionIDstring

The identifier for the transaction. It is required If you simulate incremental authorizations.

simulateIncorrectCVVboolean

When set to true, simulates an incorrect CVV scenario.

simulateIncorrectPINboolean

When set to true, simulates an incorrect PIN scenario.

simulateIncorrectExpiryDateboolean

When set to true, simulates an incorrect expiration date scenario.

simulateTimeoutboolean

When set to true, simulates a transaction timeout in the sandbox, causing the transaction to be declined and emitting a declined-transaction webhook.

simulateFraudboolean

When set to true, triggers the fraud alert simulation flow (FRAUD_DETECTION webhook + timeout handling).

merchantNamestring

Override merchant name in the FRAUD_DETECTION webhook. Defaults to "Simulated Merchant".

merchantLocationstring

Override merchant location in the FRAUD_DETECTION webhook. Defaults to "SG".

mccstring

The 4-digit Merchant Category Code (MCC). This parameter is not applicable to incremental authorizations. Default is 5732.

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 transaction

lifecycleEventIDstring required

A unique identifier for the lifecycle event.

idstring required

A unique identifier for the transaction.