{"title":"Create a flow","category":"default","creationDate":1672059480,"content":"

You can create a flow that spans multiple requests, including input, display, and payment requests. To do so, you send an admin request to start a session. The terminal shows the waiting screen after every input, display, and payment request until you end the session. This solves the issue that customers may think something is wrong if they provide input and then do not see anything happening on the terminal. The waiting screen is shown for a set amount of time, or until the next request is sent to the terminal.<\/p>\n

This is useful for payment flows where someone needs to interact with a terminal, like Pay at Table<\/a>. It shows that the POS system is not unresponsive, it is just busy doing something that takes a bit of time.<\/p>\n

How it works<\/h2>\n

You need to send two separate admin requests to mark the start and the end of a session. All requests in between belong to a single session.<\/p>\n

To include multiple requests in one session:<\/p>\n

    \n
  1. \n

    Before you send the first request, send an admin request to start the session<\/a>.<\/p>\n<\/li>\n

  2. \n

    Send multiple requests, including input, display, and payment requests<\/a>.
    \nWhen you send an input request, after the user provides input on the terminal, the waiting screen shows for the set amount of time. With display and payment requests, after showing your data on the screen, the waiting screen shows. If you send another request before the waiting screen expires, the waiting screen disappears.<\/p>\n

    \"WaitingScreen\"<\/p>\n<\/li>\n

  3. \n

    After the last request, send an admin request to end the session<\/a>.<\/p>\n<\/li>\n<\/ol>\n

    Step 1: Start the session<\/h2>\n
      \n
    1. \n

      Create a JSON object with the following data elements:<\/p>\n\n\n\n\n\n\n
      Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
      Session<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nAn object with:
      • ID<\/code>: the unique reference of the session.<\/li>
      • Type<\/code>: set the value to Begin<\/strong><\/span> to start the session.<\/li><\/ul><\/td>\n<\/tr>\n
      Operation<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nAn object with: