Skip to main content
Request a Payment Refund

Authorizations

Authorization
string
header
required

Enter your Bearer token. It's required to authenticate API requests.

Body

application/json
RefundAmount
number<double> | null

The amount to be refunded to the customer.

RefundEmailList
string | null

A list of email addresses to notify about the refund, separated by commas.

RefundReason
string | null

The reason for requesting the refund.

TransactionId
integer<int64>

The unique identifier of the transaction for which the refund is requested.

SiteId
integer<int32>

The unique identifier of the site where the transaction occurred.

MachineAuTime
string<date-time>

The machine's authorization time associated with the transaction.

Response

200 - application/json

The refund request was successfully processed, and the response contains the result of the request.

Result
string | null

The result of the refund request, indicating success or failure.

Status
string | null

The current status of the refund request.