Zamok Kiosk API
    Preparing search index...
    • Parameters

      • state: {
            payitCredit: {
                apiReady: boolean;
                authorize: { authorization_code: string };
                createCardTransaction: null | AsyncPayment;
                deleteCardReader: null | boolean;
                getCardReaderByRequestId: null | AsyncCardReader;
                getCardReaders: null | CardReader[];
                getPaymentByRequestId: null | AsyncPayment;
                getToken: null | TokenResponse;
                inviteUser: null | InviteUserResponse;
                payAsync: null | AsyncPaymentResponse;
                previewPayment: null | PaymentPreviewResponse;
                refund: null | PosRefundResponse;
                registerCardReader: null | AsyncCardReaderResponse;
                resetPassword: null | void;
                simulateCardSwipe: null | boolean;
            };
        }

      Returns {
          apiReady: boolean;
          authorize: { authorization_code: string };
          createCardTransaction: null | AsyncPayment;
          deleteCardReader: null | boolean;
          getCardReaderByRequestId: null | AsyncCardReader;
          getCardReaders: null | CardReader[];
          getPaymentByRequestId: null | AsyncPayment;
          getToken: null | TokenResponse;
          inviteUser: null | InviteUserResponse;
          payAsync: null | AsyncPaymentResponse;
          previewPayment: null | PaymentPreviewResponse;
          refund: null | PosRefundResponse;
          registerCardReader: null | AsyncCardReaderResponse;
          resetPassword: null | void;
          simulateCardSwipe: null | boolean;
      }

      • apiReady: boolean

        ======================= API Ready State

      • authorize: { authorization_code: string }
      • createCardTransaction: null | AsyncPayment

        CREATE CARD TRANSACTION

      • deleteCardReader: null | boolean
      • getCardReaderByRequestId: null | AsyncCardReader
      • getCardReaders: null | CardReader[]
      • getPaymentByRequestId: null | AsyncPayment

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

      • getToken: null | TokenResponse
      • inviteUser: null | InviteUserResponse
      • payAsync: null | AsyncPaymentResponse

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

      • previewPayment: null | PaymentPreviewResponse

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

      • refund: null | PosRefundResponse

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

      • registerCardReader: null | AsyncCardReaderResponse
      • resetPassword: null | void
      • simulateCardSwipe: null | boolean