Structure

GetTransactionHistoryRequest

Request to retrieve transaction history with rich filtering options

Declaration

struct GetTransactionHistoryRequest

Topics

Initializers

init(storeId: String?, tid: String?, mid: String?, status: String?, statuses: [String]?, type: String?, types: [String]?, eventId: String?, search: String?, cardNumber: String?, minAmount: Int?, maxAmount: Int?, startDate: Date?, endDate: Date?, limit: Int, offset: Int, sortBy: String, sortOrder: String)

Transaction history request with default values.

Instance Properties

var cardNumber: String?

Filter by partial card number

var endDate: Date?

End date (unix timestamp in ms)

var eventId: String?

Identifier used to trace or correlate a specific event or transaction request

var limit: Int

Number of records to return (1-1000)

var locationId: String?

Filter by store ID

var maxAmount: Int?

Maximum transaction amount

var minAmount: Int?

Minimum transaction amount

var offset: Int

Number of records to skip

var search: String?

Search term for transaction ID, card number, etc.

var sortBy: String

Field to sort by (default: “created_at”)

var sortOrder: String

Sort order - “asc” or “desc” (default: “desc”)

var startDate: Date?

Start date (unix timestamp in ms)

var statuses: [String]?

Filter by multiple transaction statuses

var types: [String]?

Filter by multiple transaction types

Instance Methods

func toDictionary() -> [String : Any?]

Type Methods

static func excludingCancelled() -> GetTransactionHistoryRequest

Filter to exclude cancelled/canceled transactions (optional - not used by default)

static func failedOnly() -> GetTransactionHistoryRequest

Filter for failed transactions only

static func pendingOnly() -> GetTransactionHistoryRequest

Filter for pending transactions only

static func successfulOnly() -> GetTransactionHistoryRequest

Filter for successful transactions only

static func withStatuses([KoardTransaction.Status]) -> GetTransactionHistoryRequest

Helper to filter by transaction statuses using the Status enum

static func withTypes([PaymentType]) -> GetTransactionHistoryRequest

Helper to filter by transaction types using the PaymentType enum