{"title":"Bluetooth beacons","category":"default","creationDate":1556285460,"content":"

Our Bluetooth terminals use the iBeacon protocol<\/a> to advertise their presence to other nearby Bluetooth devices, such as a mobile POS app. You can use the advertised data to make sure that the POS app discovers the closest terminal and uses its unique identifiers to correctly route Terminal API requests.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n\n\n\n\n\n\n\n<\/tr>\n<\/tbody>\n<\/table>\n

Advertised values and integration types<\/h2>\n

The terminal advertises values using the iBeacon protocol<\/a> so your mobile POS app can recognize the closest terminal. You define the following values when you set up beacons in your Customer Area<\/a>:<\/p>\n

Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nA Terminal API integration<\/a> with payment terminals.<\/td>\n<\/tr>\n
Limitations<\/strong><\/td>\nThe beacon functionality is not supported for Android terminals and unattended non-Android terminals.<\/td>\n<\/tr>\n
\n\n\n\n\n\n
<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
Major<\/strong><\/td>\n${SERIALH}<\/td>\n<\/tr>\n
Minor<\/strong><\/td>\n${SERIALL}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

To learn how to decode the advertised data, see Get the serial number<\/a>.<\/p>\n<\/li>\n

  • \n

    Encode the IP address<\/strong> of the terminal if you are using local communications<\/a>. Here, the placeholder also depends on your network interface. For example, if you are using the first Ethernet interface, set Major<\/strong> to ${IPH:ETH0}<\/strong><\/span>, and Minor<\/strong> to ${IPL:ETH0}<\/strong><\/span>.<\/p>\n\n\n\n\n\n\n
    <\/th>\n<\/th>\n<\/th>\n<\/th>\n<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
    Major<\/strong><\/td>\n${IPH:ETH0}<\/td>\n${IPH:ETH1}<\/td>\n${IPH:WLAN0}<\/td>\n${IPH:WLAN1}<\/td>\n${IPH:GPRS0}<\/td>\n<\/tr>\n
    Minor<\/strong><\/td>\n${IPL:ETH0}<\/td>\n${IPL:ETH1}<\/td>\n${IPL:WLAN0}<\/td>\n${IPL:WLAN1}<\/td>\n${IPL:GPRS0}<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    To learn how to decode the advertised data, see Get the IP address<\/a>.<\/p>\n<\/li>\n<\/ul>\n

    Use beacons with cloud communications<\/h2>\n

    With cloud communications<\/a>, a Terminal API request is routed to the correct terminal based on the unique terminal ID, the POIID<\/code>, which you pass in the request.<\/p>\n

    \n

    POIID<\/code> = [Terminal model] - [Serial number]<\/em>, for example P400Plus-324688179<\/strong>.<\/p>\n<\/div><\/div>\n

    After you have set up beacons in your Customer Area<\/a>, route your Terminal API requests as follows:<\/p>\n

      \n
    1. Get the serial number from the Major and Minor<\/a>. You can use our placeholders<\/a> to have the terminal advertise its serial number, encoded into the Major and Minor.<\/li>\n
    2. Get the full POIID<\/code>:\n
        \n
      1. Make a POST \n \/connectedTerminals<\/code>\n<\/a> request to find the terminals under a company account, merchant account, or store.
        \nThe response lists the POIIDs.<\/li>\n
      2. In the response, look up the POIID<\/code> by searching for the serial number you retrieved in Step 1.<\/li>\n<\/ol><\/li>\n
      3. Send your Terminal API request using the correct POIID<\/code> retrieved in Step 2.<\/li>\n<\/ol>\n

        Get the serial number<\/h3>\n

        If you set Major<\/strong> to ${SERIALH}<\/strong><\/span> and Minor<\/strong> to ${SERIALL}<\/strong><\/span>, the terminal advertises its serial number, encoded in the Major and Minor. For example, the serial number 324688179 is advertised as:<\/p>\n