var readerEvents: AsyncStream<PaymentCardReader.Event>
Stream of payment card reader events from Apple’s ProximityReader framework
Class
KoardMerchantSDK
Declaration
class KoardMerchantSDKTopics
Instance Properties
Instance Methods
func auth(transactionId: String, amount: Int, breakdown: PaymentBreakdown?, eventId: String?) async throws -> TransactionResponse
Authorize an incremental amount on an existing transaction
func capture(transactionId: String, amount: Int?, breakdown: PaymentBreakdown?, eventId: String?) async throws -> TransactionResponse
Captures a previously authorized transaction.
func confirm(transaction: String, confirm: Bool) async throws -> KoardTransaction
Confirms or cancels a transaction after the reader interaction.
func createFallbackLink(amount: Int, breakdown: PaymentBreakdown?) async throws -> FallbackResponse
Generates a fallback payment link in case Tap to Pay fails.
func deinitializeCardReader()
Deinitializes the active card reader session and releases associated resources.
func getActiveLocationID() -> String?
Retrieves the currently selected active location ID for the merchant.
func getMerchantAccount() async throws -> AccountBase
Retrieves the currently authenticated merchant’s account details.
func getToken() async throws -> PaymentCardReader.Token
Refreshes the card reader token used for Tap to Pay functionality.
func initialize(options: KoardOptions, apiKey: String)
Initializes the Koard SDK with configuration options and API key.
func isAccountLinked() async throws -> Bool
Checks whether a merchant account is currently linked in the SDK.
func linkAccount() throws
Links the merchant account to Apple’s payment processing system.
func locations(request: GetLocationsRequest) async throws -> [Location]
Retrieves the list of available merchant locations associated with the current account.
func login(code: String, pin: String) async throws
Login with a merchant code and PIN to authenticate with the Koard API.
func logout()
Logs out the current merchant session and clears all associated credentials.
func preauth(amount: Int, breakdown: PaymentBreakdown?, currency: CurrencyCode, eventId: String?) async throws -> TransactionResponse
Performs a pre-authorization for a specified amount.
func prepare() async throws
Prepares the card reader for accepting payments.
func presentTutorial(from: UIViewController) throws
Presents the Tap to Pay tutorial to the user.
func refund(transactionID: String, amount: Int?, eventId: String?) async throws -> TransactionResponse
Issues a refund for a previously captured transaction.
func refund(transactionId: String, amount: Int?, eventId: String?) async throws -> TransactionResponse
Issues a refund for a previously captured transaction.
func reverse(transactionId: String, amount: Int?, eventId: String?) async throws -> TransactionResponse
Reverses a previously authorized transaction before it is captured.
func sale(amount: Int, breakdown: PaymentBreakdown?, currency: CurrencyCode, eventId: String?, type: PaymentType) async throws -> TransactionResponse
Processes a payment using the specified amount and currency.
func searchTransactions(String) async throws -> TransactionHistoryResponse
Searches transactions using a general search term.
func searchTransactionsAdvanced(searchTerm: String?, startDate: Date?, endDate: Date?, statuses: [String]?, types: [String]?, cardNumber: String?, minAmount: Int?, maxAmount: Int?, eventId: String?, limit: Int, offset: Int, sortBy: String, sortOrder: String) async throws -> TransactionHistoryResponse
Performs an advanced search of transactions using multiple filters.
func sendReceipts(transactionId: String, email: String?, phoneNumber: String?) async throws -> SendReceiptsResponse
Sends a digital receipt for a transaction via email or SMS.
func setActiveLocationID(String)
Sets the active merchant location ID to be used for future transactions.
func transactionHistory(request: GetTransactionHistoryRequest) async throws -> TransactionHistoryResponse
Retrieves the full transaction history for the current merchant.
func transactionsByCardNumber(String) async throws -> TransactionHistoryResponse
Retrieves transactions filtered by a full or partial card number.
func transactionsByDateRange(startDate: Date, endDate: Date) async throws -> TransactionHistoryResponse
Retrieves transactions within a specific date range.
func transactionsByStatus(String) async throws -> TransactionHistoryResponse
Retrieves all transactions matching a specific status.
func transactionsByStatusAndTypeStrings(statuses: [String], types: [String]) async throws -> TransactionHistoryResponse
Retrieves transactions by matching multiple status and type strings.
func transactionsByStatuses([String]) async throws -> TransactionHistoryResponse
Retrieves transactions that match any of the provided statuses.
func transactionsByStatusesAndTypes(statuses: [KoardTransaction.Status], types: [PaymentType]) async throws -> TransactionHistoryResponse
Retrieves transactions matching one or more statuses and payment types.
func transactionsByType(PaymentType) async throws -> TransactionHistoryResponse
Retrieves transactions filtered by a specific
PaymentType.func transactionsByTypeString(String) async throws -> TransactionHistoryResponse
Retrieves transactions filtered by a specific payment type string.
func transactionsByTypeStrings([String]) async throws -> TransactionHistoryResponse
Retrieves transactions that match any of the provided type strings.
func transactionsByTypes([PaymentType]) async throws -> TransactionHistoryResponse
Retrieves transactions matching one or more payment types.