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.
- Upload a file.
- 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.
Reader | Resolution (W x H) | Accepts GIF |
---|---|---|
Stripe S700 | 1080 x 1920 | |
BBPOS WisePOS E | 720 x 1280 | |
Verifone P400 | 320 x 480 | – |
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_
, bbpos_
, and verifone_
.
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:
To update a Configuration object, use the update configuration request: