Managing Firmware Updates

There are primarily 2 ways to facilitate firmware updates to the Braintree card readers.

Why are Firmware Updates Important?

As we release new functionality, improve performance, enhance user experience as well as fix bugs, these changes get pushed to the card readers through firmware updates. In order for this to work the card reader must be powered on and connected to the internet. It is always recommended to test these new versions in the sandbox environment before pushing to production. Click the link below to see our latest App Version Release Notes:

Firmware Version Release Notes

1) How to install an update to the Reader using the admin menu on the reader:

The passcode referenced below is for Sandbox only. There is a different passcode for production which you can get from the PayPal support team at [e-mail]

First, open the device settings screen by going to the PayPal branded screensaver and then simultaneously press 2 + 8 to display the settings screen. Before displaying the settings screen the device will prompt for a passcode. Enter 123456 followed by when prompted.

Towards the bottom of the screen, you'll see the currently installed version number. If there's an update available to install, you'll see a button that says Install Update. After pressing the install button, the device will proceed to download and install the update. As part of the update the device will restart. Once the device returns to the PayPal branded screensaver it is ready for use.

2) How to install an update to the Reader using the GraphQL API:

GraphQL Mutation

mutation RequestFirmwareUpdateFromInStoreReaderInput ($input: RequestFirmwareUpdateFromInStoreReaderInput!) {
    requestFirmwareUpdateFromInStoreReader(input: $input) {
        clientMutationId
        inStoreContext {
            id
            status
            reader {
                id
                name                
                status
                softwareVersion
            }
        }
    }
}

GraphQL Variables

{
	"input": {
		"readerId": "your reader ID here"
    }
}

Sample API Response

{
    "data": {
        "requestFirmwareUpdateFromInStoreReader": {
            "clientMutationId": null,
            "inStoreContext": {
                "id": "aW5zdG9yZWNvbnRleHRfIkjfgiey79622VmNGZkNTQ2NTI5ZTc3NTUyMGEyNWZhNDJlI1ZFUklGT05FLTgwNS0wMTctNDU0I3VzLXdlc3QtMg",
                "status": "COMPLETE",
                "reader": {
                    "id": "aW5zdG9yZX769ccl8jY3B3c2Y0Mmh3OWo1OWhjbiNWRVJJRk9ORS04MDUtMDE3LTQ1NA",
                    "name": "POS Terminal #5",
                    "status": "ONLINE",
                    "softwareVersion": "3.2.1"
                }
            }
        }
    },
    "extensions": {
        "requestId": "1f003122-112d-48f8-a6f5-8f2b58039016"
    }
}