Skip to main content
Approve Payment Refund

Authorizations

Authorization
string
header
required

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

Body

application/json
IsRefundedExternally
boolean

Indicates whether the refund was processed by an external system.

RefundDocumentUrl
string | null

The URL to the document associated with the refund, if available.

TransactionId
integer<int64>

The unique identifier of the transaction for which the refund is being approved.

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 approval was successfully processed, and the response contains the result of the approval.

Result
string | null

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

Status
string | null

The current status of the refund request.