{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","ApiLink","img"]},"type":"markdown"},"seo":{"title":"Device Reader SDK Integration Prerequisites | Finix Documentation","description":"Set up your PAX developer account, API credentials, and Device resource before integrating the Finix Android SDK for PAX Device Readers.","siteUrl":"https://docs.finix.com/","llmstxt":{"hide":false,"sections":[{"title":"Getting Started","includeFiles":["guides/getting-started/**/*.md"],"excludeFiles":[]},{"title":"Online Payments","includeFiles":["guides/online-payments/**/*.md"],"excludeFiles":["guides/online-payments/payment-features/fsa-hsa-non-healthcare-mcc.md"]},{"title":"In-Person Payments","includeFiles":["guides/in-person-payments/**/*.md"],"excludeFiles":[]},{"title":"Subscriptions","includeFiles":["guides/subscriptions/**/*.md"],"excludeFiles":[]},{"title":"After the Payment","includeFiles":["guides/after-the-payment/**/*.md"],"excludeFiles":[]},{"title":"Managing Operations","includeFiles":["guides/managing-operations/**/*.md"],"excludeFiles":[]},{"title":"Platform Payments","includeFiles":["guides/platform-payments/**/*.md"],"excludeFiles":[]},{"title":"Payouts","includeFiles":["guides/payouts/**/*.md"],"excludeFiles":[]},{"title":"Low-Code / No-Code","includeFiles":["low-code-no-code/**/*.md"],"excludeFiles":[]},{"title":"Developers","includeFiles":["additional-resources/developers/**/*.md"],"excludeFiles":[]},{"title":"Plugins","includeFiles":["additional-resources/plugins/**/*.md"],"excludeFiles":[]},{"title":"Industry Considerations","includeFiles":["guides/industry-considerations/**/*.md"],"excludeFiles":[]},{"title":"Regional Considerations","includeFiles":["guides/regional-considerations/**/*.md"],"excludeFiles":[]},{"title":"Release Notes","includeFiles":["release-notes/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"device-reader-sdk-integration-prerequisites","__idx":0},"children":["Device Reader SDK Integration Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before integrating the Finix Android SDK for PAX Device Readers, complete the following one-time setup. These steps register your PAX developer account, establish your API credentials, and create your Device resource in Finix."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You are registered as a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://developer.pax.us/"},"children":["developer"]}," with PAX."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-choose-the-credential-type","__idx":2},"children":["1. Choose the credential type"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK supports either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_PARTNER"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_MERCHANT"]}," credentials. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_MERCHANT"]}," credentials to scope your app to a single Merchant. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_PARTNER"]}," credentials if your app processes payments across multiple devices or Merchants."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_PARTNER"]}," credentials are required for ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":["Split Transactions"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-role_merchant-credentials","__idx":3},"children":["Creating ROLE_MERCHANT credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a ",{"$$mdtype":"Tag","name":"ApiLink","attributes":{"href":"/api/users"},"children":["User"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role: ROLE_MERCHANT"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -i -X POST \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \\\n  https://finix.sandbox-payments-api.com/users \\\n  -H 'Content-Type: application/json' \\\n  -H 'Finix-Version: 2022-02-01' \\\n  -d '{\n    \"role\": \"ROLE_MERCHANT\",\n    \"identity_id\": \"ID6YeRojM2ppNkPt4mP8ExNH\"\n  }'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the credentials across multiple devices as long as the devices are associated with the same Merchant."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-role_partner-credentials","__idx":4},"children":["Creating ROLE_PARTNER credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLE_PARTNER"]}," credentials:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://live.payments-dashboard.com/Login"},"children":["Finix Dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the environment for which you would like to create the API credentials (Sandbox or Live)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the bottom left-hand corner, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developer"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["From the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," tab, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create API Key"]},"."]}]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/developer-api-keys-create.734cc8d9fcbceaa6500a394d7b7a350bb854b952c502fe5cb57d74ee9792b476.08ff7529.png","alt":"Create API Key","withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-creating-a-device","__idx":5},"children":["2. Creating a Device"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating a Device resource can be done either via the Finix Dashboard or via API. The steps below use the API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a ",{"$$mdtype":"Tag","name":"ApiLink","attributes":{"href":"/api/devices"},"children":["Device"]}," under the ",{"$$mdtype":"Tag","name":"ApiLink","attributes":{"href":"/api/merchants"},"children":["Merchant"]}," provisioned to process in-person payments. Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model"]}," of the payment terminal you will be using to process cards. Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integration_mode"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SDK"]}," to designate that this Device uses the Finix Android SDK for PAX Device Readers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more details about the payment terminals available, see our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/in-person-payments/select-your-device"},"children":["available devices"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","data-title":"Request","header":{"title":"Request","controls":{"copy":{}}},"source":"curl -i -X POST \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \\\n  https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"description\": \"Cashier Three\",\n    \"model\": \"PAX_A800\",\n    \"name\": \"PAX_A800 Finix Android SDK for PAX Device Readers\",\n    \"integration_mode\": \"SDK\",\n    \"serial_number\": \"19046260947\"\n  }'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Response","header":{"title":"Response","controls":{"copy":{}}},"source":"{\n  \"id\": \"DVxcL2fiBdt9frYCKAbZikZK\",\n  \"created_at\": \"2025-05-21T19:01:32.000581Z\",\n  \"updated_at\": \"2025-05-21T19:01:32.000581Z\",\n  \"configuration_details\": null,\n  \"description\": \"Cashier Three\",\n  \"enabled\": false,\n  \"idle_message\": null,\n  \"integration_mode\": \"SDK\",\n  \"merchant\": \"MU7noQ1wdgdAeAfymw2rfBMq\",\n  \"model\": \"PAX_A800\",\n  \"name\": \"PAX_A800 Finix Android SDK for PAX Device Readers\",\n  \"serial_number\": \"19046260947\",\n  \"tags\": {},\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/devices/DVxcL2fiBdt9frYCKAbZikZK\"\n    },\n    \"merchant\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/authorizations\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Device Reader SDK Integration Prerequisites","id":"device-reader-sdk-integration-prerequisites","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"1. Choose the credential type","id":"1-choose-the-credential-type","depth":2},{"value":"Creating ROLE_MERCHANT credentials","id":"creating-role_merchant-credentials","depth":3},{"value":"Creating ROLE_PARTNER credentials","id":"creating-role_partner-credentials","depth":3},{"value":"2. Creating a Device","id":"2-creating-a-device","depth":2}],"frontmatter":{"seo":{"title":"Device Reader SDK Integration Prerequisites | Finix Documentation","description":"Set up your PAX developer account, API credentials, and Device resource before integrating the Finix Android SDK for PAX Device Readers."},"keywords":{"includes":["integration prerequisites","device reader sdk","pax developer account","api credentials","role_merchant","role_partner","create device"],"excludes":["mobile integration","standalone"]}},"lastModified":"2026-09-15T22:17:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/in-person-payments/deploy-apps-terminals/integration-prerequisites","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}