Simulate

Simulate authorisation refund transaction

post/simulate/{transactionID}/refund

Request

Base URL
https://sandbox.api.caas.reap.global
Auth
API key in header x-reap-api-key
TypeScript
https://skmtc.dev/reap-global/apis/reap-api/docs/simulate/:transactionID/refund/post.ts
A function with typed inputs. Its response is checked against the schema.

transactionIDstring required

Accept-Versionstring required

Specifies the API version to use for this request.

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.

Successfully simulated an refund transaction

lifecycleEventIDstring required

A unique identifier for the lifecycle event.

idstring required

A unique identifier for the transaction.

No recorded changes to this operation across all 2 revisions of this API.