Skip to main content
This request initiates the refund process by referencing the unique identifiers of the original, captured transaction. The API confirms the original transaction exists, calculates the amount available for refund, and instructs the payment processor to disburse the funds back to the cardholder.
Only for Settled TransactionsA Refund Request can only be performed on transactions that have been captured (Settled).

Request

The Refund request uses the same endpoint as the initial /close-transaction request. The API determines it’s a settlement based on the RequestType value within the BasicInfo object. See the example below:
Note that the RequestType is set to the value corresponding to a Full Refund (4) or Partial Refund (5). The Amount specifies the refund amount (which can be less than the original capture amount for a partial refund).

Request Parameters

The following table highlights the critical fields used to define a Refund request:

Response

A successful validation returns a 200 OK status and a body containing the validated merchant details:

Response Parameters

The table below describes the parameters of the response: