No momento, esta página não está disponível em português
Point-of-sale icon

Activate scanning a single barcode using Terminal API

Create a scanning session to scan a single barcode.

On Android payment terminals S1E Barcode, S1E2L, S1F2L, and S1U2 you can use Terminal API requests to:

  • Activate the scan button on the terminal so that your staff can scan a single item.
  • Cancel scanning to deactivate the barcode scanner and the scan button.
  • Specify how much time you want to allow for scanning.

You don't need to set up the scanning button in the Customer Area to use this method.

You can also start a batch scan session to scan multiple barcodes at once.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Requirement Description
Integration type A Terminal API integration with payment terminals.
Hardware Android terminal models S1E Barcode, S1E2L, S1F2L, or S1U2 that have a barcode scanner.
Setup steps Before you begin:
  • You need to implement a way to process the scanned content in your POS app.
  • Implement a button in your POS app UI to trigger the scan.

How it works

  1. Your staff scans an item.
  2. A successful scan deactivates the barcode scanning button, and you receive the barcode content in the admin request response.
  3. With the logic that you have created, you pass the content from the response to your POS app.

Activate the barcode scanner for a single scan

To activate the barcode scanner for a single scan, you only need to send a request.

  1. Create a JSON object with the following data elements:

    Parameter Required Description
    Session -white_check_mark- An object with:
    • Id: your unique reference of the scanning session.
    • Type: Once activates the barcode scanner.
    Operation -white_check_mark- An object with:
    • Type: ScanBarcode.
    • TimeoutMs: how long the barcode scanner stays on, in milliseconds (from 0 to 30000).

  2. Encode the JSON object to Base64.

  3. Make a POST request to a Terminal API endpoint, specifying:

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- Admin
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
    • AdminRequest: the request body. This must include:
      • ServiceIdentification: the Base64-encoded JSON object.

    The terminal operator can now scan a barcode.

  4. In the response, note:

    • If successful, the following fields are returned:
      • Response.Result: Success
      • AdditionalResponse: contains the Base64-encoded barcode content.
    • If unsuccessful, the following fields are returned:
      • Response.Result: Failure
      • ErrorCondition: Cancel, Aborted, UnavailableService, or NotFound
      • AdditionalResponse: contains the reason for failure as a Base64-encoded string. Decoding the string results in a message of the following format: { "message": "Admin ScanBarcode request canceled due to Timeout" }.

    The format of the AdditionalResponse can be a Base64-encoded or URL-encoded. To always receive the AdditionalResponse in one of those formats, contact our Support Team.

  5. If Response.Result is Success, decode the Base64-encoded string in the AdditionalResponse.
    Note that this contains:

    • Barcode.Data: the content of the scanned barcode.
    • Barcode.Symbology: the format of the scanned barcode. If the symbology is not recognized, the response returns UNKNOWN.

    For more information on the Terminal API request structure, see the Terminal API fundamentals.

  6. You process the content from the response in your POS app with the logic that you have implemented.

If you want to turn off the barcode scanner before the timeout, you need to send a request to cancel the scanning session.

Cancel scanning session

If you want to cancel the activation of the terminal's barcode scanner before the specified timeout, you need to send an AdminRequest with the Session.Type End.

  1. Create a JSON object with the following data elements:

    Parameter Required Description
    ServiceIdentification.Session -white_check_mark- An object with:
    • Id: the unique reference of the session.
    • Type: End cancels the scanning session.

  2. Encode the JSON object to Base64.

  3. Make a POST request to a Terminal API endpoint, specifying:

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Service
      MessageCategory -white_check_mark- Admin
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
    • AdminRequest: the request body. This must include:
      • ServiceIdentification: the Base64-encoded JSON object.

  4. If the cancel request succeeds, in the AdminResponse note:

    • Response.Result: Success
    • AdditionalResponse: contains the Base64-encoded message. Decoding the string results in a message of the following format: { "message": "Admin ScanBarcode request was successfully canceled" }

    The format of the AdditionalResponse can be a Base64-encoded or URL-encoded. To always receive the AdditionalResponse in one of those formats, contact our Support Team.

See also