Zamok Kiosk API
    Preparing search index...

    Variable actionsConst

    actions: {
        authorize: PayloadAC<"oauth/AUTHORIZE", AuthorizationCode>;
        authorizeFailure: PayloadAC<"oauth/AUTHORIZE_FAILURE", OAuthError>;
        authorizeSuccess: PayloadAC<
            "oauth/AUTHORIZE_SUCCESS",
            { authorization_code: string },
        >;
        createCardTransaction: PayloadAC<"CREATE_CARD_TRANSACTION", PaymentRequest>;
        deleteCardReader: PayloadAC<"DELETE_CARD_READER", string>;
        getCardReaderByRequestId: PayloadAC<
            "GET_CARD_READER_BY_REQUEST_ID",
            string,
        >;
        getCardReaders: PayloadAC<"GET_CARD_READERS", void>;
        getPaymentByRequestId: PayloadAC<"GET_PAYMENT_BY_REQUEST_ID", string>;
        getPaymentByTransactionId: PayloadAC<
            "GET_PAYMENT_BY_TRANSACTION_ID",
            string,
        >;
        getToken: PayloadAC<"oauth/GET_TOKEN", TokenRequest>;
        getTokenFailure: PayloadAC<"oauth/GET_TOKEN_FAILURE", OAuthError>;
        getTokenSuccess: PayloadAC<"oauth/GET_TOKEN_SUCCESS", TokenResponse>;
        inviteUser: PayloadAC<"accounts/INVITE_USER", InviteUserRequest>;
        inviteUserFailure: PayloadAC<
            "accounts/INVITE_USER_FAILURE",
            BadRequestError,
        >;
        inviteUserSuccess: PayloadAC<
            "accounts/INVITE_USER_SUCCESS",
            InviteUserResponse,
        >;
        loadCardReaderByRequestIdResponse: PayloadAC<
            "LOAD_CARD_READER_BY_REQUEST_ID_RESPONSE",
            AsyncCardReader,
        >;
        loadCardReadersResponse: PayloadAC<
            "LOAD_CARD_READERS_RESPONSE",
            CardReader[],
        >;
        loadCreateCardTransaction: PayloadAC<
            "LOAD_CREATE_CARD_TRANSACTION",
            AsyncPayment,
        >;
        loadDeleteCardReaderResponse: PayloadAC<
            "LOAD_DELETE_CARD_READER_RESPONSE",
            void,
        >;
        loadPayAsyncResponse: PayloadAC<
            "LOAD_PAY_ASYNC_RESPONSE",
            AsyncPaymentResponse,
        >;
        loadPaymentByRequestIdResponse: PayloadAC<
            "LOAD_PAYMENT_BY_REQUEST_ID_RESPONSE",
            AsyncPayment,
        >;
        loadPaymentByTransactionIdResponse: PayloadAC<
            "LOAD_PAYMENT_BY_TRANSACTION_ID_RESPONSE",
            PosPayment,
        >;
        loadPreviewPaymentResponse: PayloadAC<
            "LOAD_PREVIEW_PAYMENT_RESPONSE",
            PaymentPreviewResponse,
        >;
        loadRefundResponse: PayloadAC<"LOAD_REFUND_RESPONSE", PosRefundResponse>;
        loadRegisterCardReaderResponse: PayloadAC<
            "LOAD_REGISTER_CARD_READER_RESPONSE",
            AsyncCardReaderResponse,
        >;
        loadSimulateCardSwipeResponse: PayloadAC<
            "LOAD_SIMULATE_CARD_SWIPE_RESPONSE",
            void,
        >;
        payAsync: PayloadAC<"PAY_ASYNC", PaymentRequest>;
        previewPayment: PayloadAC<"PREVIEW_PAYMENT", PaymentPreviewRequest>;
        refund: PayloadAC<"REFUND", RefundParams>;
        registerCardReader: PayloadAC<"REGISTER_CARD_READER", CardReaderRequest>;
        resetPassword: PayloadAC<"accounts/RESET_PASSWORD", PasswordResetRequest>;
        resetPasswordFailure: PayloadAC<
            "accounts/RESET_PASSWORD_FAILURE",
            BadRequestError,
        >;
        resetPasswordSuccess: EmptyAC<"accounts/RESET_PASSWORD_SUCCESS">;
        simulateCardSwipe: PayloadAC<
            "SIMULATE_CARD_SWIPE",
            SimulateCardSwipeParams,
        >;
    } = ...

    Type Declaration

    • authorize: PayloadAC<"oauth/AUTHORIZE", AuthorizationCode>
    • authorizeFailure: PayloadAC<"oauth/AUTHORIZE_FAILURE", OAuthError>
    • authorizeSuccess: PayloadAC<"oauth/AUTHORIZE_SUCCESS", { authorization_code: string }>
    • createCardTransaction: PayloadAC<"CREATE_CARD_TRANSACTION", PaymentRequest>

      CREATE CARD TRANSACTION

    • deleteCardReader: PayloadAC<"DELETE_CARD_READER", string>

      GET: /devices Input: void Output: CardReader[]

    • getCardReaderByRequestId: PayloadAC<"GET_CARD_READER_BY_REQUEST_ID", string>

      GET: /async/devices/{requestId} Input: requestId Output: AsyncCardReader

    • getCardReaders: PayloadAC<"GET_CARD_READERS", void>

      GET: /devices Input: void Output: CardReader[]

    • getPaymentByRequestId: PayloadAC<"GET_PAYMENT_BY_REQUEST_ID", string>

      GET: /async/payments/{requestId} Input: requestId: string Output: AsyncPayment

    • getPaymentByTransactionId: PayloadAC<"GET_PAYMENT_BY_TRANSACTION_ID", string>

      GET: /transactions/{transactionId}/payment Input: transactionId: string Output: PosPayment

    • getToken: PayloadAC<"oauth/GET_TOKEN", TokenRequest>
    • getTokenFailure: PayloadAC<"oauth/GET_TOKEN_FAILURE", OAuthError>
    • getTokenSuccess: PayloadAC<"oauth/GET_TOKEN_SUCCESS", TokenResponse>
    • inviteUser: PayloadAC<"accounts/INVITE_USER", InviteUserRequest>
    • inviteUserFailure: PayloadAC<"accounts/INVITE_USER_FAILURE", BadRequestError>
    • inviteUserSuccess: PayloadAC<"accounts/INVITE_USER_SUCCESS", InviteUserResponse>
    • loadCardReaderByRequestIdResponse: PayloadAC<"LOAD_CARD_READER_BY_REQUEST_ID_RESPONSE", AsyncCardReader>
    • loadCardReadersResponse: PayloadAC<"LOAD_CARD_READERS_RESPONSE", CardReader[]>
    • loadCreateCardTransaction: PayloadAC<"LOAD_CREATE_CARD_TRANSACTION", AsyncPayment>
    • loadDeleteCardReaderResponse: PayloadAC<"LOAD_DELETE_CARD_READER_RESPONSE", void>
    • loadPayAsyncResponse: PayloadAC<"LOAD_PAY_ASYNC_RESPONSE", AsyncPaymentResponse>
    • loadPaymentByRequestIdResponse: PayloadAC<"LOAD_PAYMENT_BY_REQUEST_ID_RESPONSE", AsyncPayment>
    • loadPaymentByTransactionIdResponse: PayloadAC<"LOAD_PAYMENT_BY_TRANSACTION_ID_RESPONSE", PosPayment>
    • loadPreviewPaymentResponse: PayloadAC<"LOAD_PREVIEW_PAYMENT_RESPONSE", PaymentPreviewResponse>
    • loadRefundResponse: PayloadAC<"LOAD_REFUND_RESPONSE", PosRefundResponse>
    • loadRegisterCardReaderResponse: PayloadAC<"LOAD_REGISTER_CARD_READER_RESPONSE", AsyncCardReaderResponse>
    • loadSimulateCardSwipeResponse: PayloadAC<"LOAD_SIMULATE_CARD_SWIPE_RESPONSE", void>
    • payAsync: PayloadAC<"PAY_ASYNC", PaymentRequest>

      POST: /async/pay Input: PaymentRequest Output: AsyncPaymentResponse

    • previewPayment: PayloadAC<"PREVIEW_PAYMENT", PaymentPreviewRequest>

      POST: /preview/pay Input: PaymentPreviewRequest Output: PaymentPreviewResponse

    • refund: PayloadAC<"REFUND", RefundParams>

      POST: /transactions/{transactionId}/refunds Input: PosRefundRequest Output: PosRefundResponse

    • registerCardReader: PayloadAC<"REGISTER_CARD_READER", CardReaderRequest>

      POST: /async/devices Input: CardReaderRequest Output: AsyncCardReaderResponse

    • resetPassword: PayloadAC<"accounts/RESET_PASSWORD", PasswordResetRequest>
    • resetPasswordFailure: PayloadAC<"accounts/RESET_PASSWORD_FAILURE", BadRequestError>
    • resetPasswordSuccess: EmptyAC<"accounts/RESET_PASSWORD_SUCCESS">
    • simulateCardSwipe: PayloadAC<"SIMULATE_CARD_SWIPE", SimulateCardSwipeParams>

      POST: /devices/{deviceId}/swipe Input: deviceId: string, SimulatedCardSwipe Output: boolean

    Settings

    Member Visibility