Fleet management

    Group and manage a fleet of readers by physical location.

    If your Terminal deployment uses many readers across multiple physical locations, keeping track of them all can get overwhelming. Locations help you manage readers and their activity by associating them with a physical operating site.

    Use the Terminal Locations object to group readers, view their connectivity status, and customize their settings by physical location. This can be especially helpful for marketplaces with many connected accounts.

    Creating a location Server-side Dashboard

    To create a new location, use the create location request.

    curl https://api.stripe.com/v1/terminal/locations \ -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \ -d display_name="HQ" \ -d "address[line1]"="123 Main St" \ -d "address[city]"="San Francisco" \ -d "address[state]"="CA" \ -d "address[country]"="US" \ -d "address[postal_code]"="94103"

    You can also create locations from the Stripe Dashboard, under Locations.

    Whenever you register a reader (manually for the Verifone P400, or automatically when you connect to a BBPOS Chipper 2X BT for the first time), you have the option to specify a location to group the reader. If you do not provide a location, the reader will be ungrouped on your account.

    Creating Connection Tokens Server-side

    When creating a ConnectionToken for the Terminal SDK, you may provide a location parameter to control access to readers. If you provide a location, the ConnectionToken is only usable with readers assigned to that location. If you do not provide a location, the ConnectionToken is usable with all readers.

    curl https://api.stripe.com/v1/terminal/connection_tokens \ -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \ -d location="{LOCATION_ID}"

    Registering a reader to a location

    Verifone P400 Server-sideDashboard

    Register Verifone P400 readers to a location for better onsite discoverability. When discovering readers, your app can provide a location parameter to only show readers in that location.

    When registering a Verifone P400 through the Stripe API, you can assign the reader to a location in the same step. Just specify the location ID (viewable in the Dashboard) in your API request. If you do not provide a location, the reader will be ungrouped on your account.

    curl https://api.stripe.com/v1/terminal/readers \ -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \ -d registration_code="{READER_REGISTRATION_CODE}" \ -d location="{LOCATION_ID}" \ -d label="Alice's Reader"

    You can also register readers in the Dashboard, under Locations.

    BBPOS Chipper 2X BT Dashboard

    The BBPOS Chipper 2X BT is automatically registered when you connect to the reader for the first time. Because it uses Bluetooth for connection, the reader only appears in discovery when it is nearby.

    Currently, you can’t assign a BBPOS Chipper 2X BT to a location.

    Filtering discovered readers

    Verifone P400 Client-side

    Your application uses the SDK’s discoverReaders method to look for readers it can connect to. When discovering a Verifone P400, you can discover the intended reader more easily by filtering results by location.

    With the code below, only readers in a given location are returned to your app’s callback. You can find the location’s ID in the Dashboard, under Locations.

    terminal.discoverReaders({ location: "{LOCATION_ID"}).then(function(discoverResult) { // ... });
    async () => { const discoverResult = await terminal.discoverReaders({ location: "{LOCATION_ID}"}); // ... }

    BBPOS Chipper 2X BT

    Because your app uses Bluetooth discovery to find a BBPOS Chipper 2X BT, it can only search for nearby readers. There’s no need to filter by location.

    Setting a custom splash screen Dashboard

    A splash screen is the default screen displayed when your Verifone P400 is ready to accept payments.

    Set a custom splash screen for all of your Verifone P400 readers:

    1. From the Terminal section of your Dashboard, click on your default location.
    2. In the location details, click Customize.
    3. Upload the image you’d like displayed on your readers.

    You can also customize the splash screen for each location, so that all readers registered to a site share the same branding. For Connect users, custom splash screens enable you to create different checkout experiences to reflect the various merchants connected to your platform.

    Was this page helpful?

    Thank you for helping improve Stripe's documentation. If you need help or have any questions, please consider contacting support.

    On this page