Refund a Payment

A referenced refund uses the original payment’s reference so the refund is directly linked to the initial sale, ensuring accurate reconciliation and audit tracking.

If you don't have, or don't want to use, the original payment's reference, use an Unreferenced Refund instead, but be aware that it can fail more often, so use it only as a last resort.

Prerequisites

• You must have initialized the SDK and obtained a valid TeyaCommonTransactionsApi instance. See Getting Started.
• Store the gatewayPaymentId from a successful payment state. See Make Payment.

Make a referenced refund

Call refundPayment on your TeyaCommonTransactionsApi instance, passing the original gatewayPaymentId, the amount to refund, and the currency.

import Foundation
import TeyaUnifiedEposSDK

let amountToRefund: Int32 = 100 // minor units (e.g., cents)
let currency = "GBP"          // ISO 4217

let refundSubscription = teyaPosLinkSDK.transactionsApi.refundPayment(
    paymentId: originalSuccessfulPaymentId, 
    amount: amountToRefund,
    currency: currency
)

Listen for refund result

Subscribe to the refund result using TeyaRefundResultListener. You’ll receive a single callback once the refund completes (either successful or failed).

Create a small Swift wrapper for convenience:

private class RefundResultListener: TeyaRefundResultListener {
    private let onResult: (TeyaRefundResultDetails) -> Void

    init(onResult: @escaping (TeyaRefundResultDetails) -> Void) {
        self.onResult = onResult
    }

    func onRefundResult(refundResult: TeyaRefundResultDetails) {
        onResult(refundResult)
    }
}

Subscribe to the refund result:

refundSubscription.subscribe(listener_: RefundResultListener { refundResult in
    // Inspect refundResult and update your UI
    print("Refund result: \(refundResult)")
})

TeyaRefundResultDetails contains a refund id (if successful), a debugErrorMessage (optionally) and the result which can be: