Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
About Stripe payments
Upgrade your integration
Payments analytics
Online payments
OverviewFind your use caseManaged Payments
Use Payment Links
Build a checkout page
Build an advanced integration
Build an in-app integration
Payment Methods
Add payment methods
Manage payment methods
Faster checkout with Link
Payment interfaces
Payment Links
Checkout
Web Elements
In-app Elements
Payment scenarios
Handle multiple currencies
Custom payment flows
Flexible acquiring
Orchestration
In-person payments
Terminal
    Overview
    Accept in-person payments
    Integration design
    Select your reader
    Design an integration
    Quickstart
    Example applications
    Testing
    Terminal setup
    Set up your integration
    Connect to a reader
    Accepting a payment
    Collect card payments
    Additional payment methods
    Accept offline payments
    Mail order and telephone order payments
    Regional considerations
    During checkout
    Collect tips
    Collect and save payment details for future use
    Flexible authorisations
    After checkout
    Refund transactions
    Provide receipts
    Customize checkout
    Cart display
    Collect on-screen inputs
    Collect swiped data
    Collect tapped data for NFC instruments
    Apps on devices
    Manage readers
    Order, return, replace readers
    Register readers
    Manage locations and zones
    Configure readers
      Splash screen
      Offline mode
      Reboot time
      Tipping
      Wi-Fi
    Monitor Readers
    Encryption
    References
    API references
    Mobile readers
    Smart readers
    SDK migration guide
    Deployment checklist
    Stripe Terminal reader product sheets
Beyond payments
Incorporate your company
Crypto
Financial Connections
Climate
HomePaymentsTerminalConfigure readers

Configure readers with a custom splash screen

Customize the default splash screen for your readers.

A splash screen is the default screen that displays when your reader is ready to accept payments. You can set a custom splash screen for these readers in one of two ways:

  • In the Dashboard
  • Using the Configuration API

Public preview

To set the custom splash screen for the BBPOS WisePad 3 device type in the Dashboard, you need to access this preview feature. To request access, contact Stripe support.

You can configure an account default splash screen, which applies to all readers in your fleet. You can also configure a custom splash screen for individual locations, which overrides the splash screen configured at the account level. Locations without a custom splash screen inherit the account default splash screen.

Use the Configuration API to specify settings and set a custom splash screen for your Stripe Reader 700, BBPOS WisePOS E, or Verifone P400.

  1. Upload a file.
  2. Create or update a Configuration object.

Upload a file

Use the File Upload API to upload an image to display on your readers. JPG and PNG images must be less than 2 MB. GIF images must be less than 4 MB. Each reader has a specific display resolution and you must crop your JPG or PNG image to fit those dimensions. GIF images scale automatically.

Caution

GIF files under 4 MB might still fail to upload. If this occurs, reduce the file size further by manually deleting frames. Try reducing the GIF’s frame count by 50% until the upload succeeds.

ReaderResolution (W x H)Accepts GIF
Stripe S7001080 x 1920
BBPOS WisePOS E720 x 1280
Verifone P400320 x 480–
Command Line
curl
curl https://files.stripe.com/v1/files \ -u
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:
\ -F "file"="@/path/to/a/file.jpg" \ -F "purpose"="terminal_reader_splashscreen"

Create or update a Configuration object

Use a Configuration object to set the custom splash screen for your specified device type. The supported device types are stripe_s700, bbpos_wisepos_e, and verifone_p400.

Note

Stripe automatically provisions an account default configuration for you. You can optionally create a Configuration object for another configuration, or you can continue to the next step to apply the default configuration settings to the entire account.

To create a Configuration object, use the create configuration request:

Command Line
cURL
curl https://api.stripe.com/v1/terminal/configurations \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d "stripe_s700[splashscreen]"=file_1KjBJdE7XUJuZdf0F6GgO9uY

To update a Configuration object, use the update configuration request:

Command Line
cURL
curl https://api.stripe.com/v1/terminal/configurations/tmc_EjHtMwLT8HmATT \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d "bbpos_wisepos_e[splashscreen]"=file_1KjBJdE7XUJuZdf0F6GgO9uY
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access programme.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc