Zamok Kiosk API
    Preparing search index...

    Function transactionReducer

    • Stores the active ZamokPaymentTransaction, or null when none exists.

      Parameters

      • state: null | ZamokPaymentTransaction = null
      • action:
            | CommonAction
            | PayloadAction<
                "START_TRANSACTION",
                {
                    customerAckId?: string;
                    externalID?: string;
                    paymentMethodAckId?: string;
                    total: number;
                },
            >
            | PayloadAction<"CANCEL_TRANSACTION", { reason: CancelReason }>
            | EmptyAction<"COMPLETE_TRANSACTION">
            | PayloadAction<"MONEY_CHANGED_HANDS", AccountingEvent>
            | PayloadAction<"USER_SELECTED_PAYMENT_METHOD", (PaymentMethod | null)>
            | PayloadAction<"REFUND_OWED", { amount: number }>
            | PayloadAction<"REFUND_ISSUED", { amount: number }>
            | EmptyAction<"CLEAR_TRANSACTION">
            | PayloadAction<"SUBMIT_PAYMENT_FOR_PROCESSING", PaymentProcessingRequest>
            | PayloadAction<"PAYMENT_PROCESSING_SUCCEEDED", PaymentProcessingResult>
            | PayloadAction<"PAYMENT_PROCESSING_FAILED", { error: string }>
            | EmptyAction<"CLEAR_PAYMENT_PROCESSING">
            | PayloadAction<
                "SET_TRANSACTION_PAYMENT_METHOD_ACK_ID",
                { paymentMethodAckId: string },
            >
            | PayloadAction<"SET_TRANSACTION_EXTERNAL_ID", { externalId: string }>
            | PayloadAction<
                "SET_TRANSACTION_CUSTOMER_ACK_ID",
                { customerAckId: string },
            >
            | PayloadAction<
                "SET_TRANSACTION_RECONCILIATION_DATA",
                { integrationLogId?: string; reconciliationFields: ReconciliationField[] },
            >

      Returns null | ZamokPaymentTransaction

      State contains saleAmount, amountPaid, amountOwed, history, paymentMethodsUsed, transactionID, optional provider/customer IDs, optional reconciliation data, status, optional cancel reason, and optional payment date.

      startTransaction initializes state; monetary, completion/cancellation, processing-success, ID setter, and reconciliation actions update it. sessionReset clears it. clearTransaction only clears a non-pending transaction. Invalid duplicate starts, payment/completion/refund amounts, and cancellation states throw errors rather than changing state.

    Settings

    Member Visibility