Prerequisites¶
This documentation is based on the current minimum version of the Pix API.
Warning
To access the new features of the Pix API, it is recommended to migrate from the old SDK to the new one. See the migration guide here.
IDE¶
Android Studio¶
We recommend using Android Studio
Physical terminal¶
Keys (Development/Production)¶
To start development, you need a physical terminal with valid development or production keys. The keys used must be DEV, if the objective is to develop applications. The keys used must be PROD, if the objective is to capture transactions with existing applications. The keys must be purchased from the terminal manufacturers.
See which terminals are approved
Warning
Currently it is not possible to use pix integration on Android emulators or SmartPhones. This solution was developed for POS (Point Of Service) terminals.
PayStore Portal¶
Registrations (Facilitator, Establishment, Terminal)¶
It is necessary to access the PayStore Portal development environment for this first contact and register required to boot the terminal for the first time. In this process, contact the support team.
PayStore APKs required¶
Installation Sequence¶
PayStore applications must be installed on the terminal. Installation must be done in the following order:
| Applications | Description |
|---|---|
| 1. payments | Payment transactions. |
| 2. App Pix | Pix app. |
| 3. platform | Manage terminal. |
| 4. acquirer | Integration with acquirers. |
| 5. client | Store PayStore. |
Warning
To ensure proper functioning, it is essential that the version of the installed Pix application is greater than or equal to the minimum version 1.2.0.0.
For more information about PayStore applications, see Apks PayStore
Info
With ADB properly installed and configured on your machine, open the prompt within the directory with the files, and execute the command as per the order above:
adb install -r [file]
If you prefer, use the program PayDroid
Initialize the terminal¶
PayStore Initialization¶
Warning
To continue, it is important that, at this point, your terminal is already initialized with PayStore. If you have any questions about this procedure, please contact the support team
Documentation tour¶
Read the documentation¶
Before actually starting, it is important to know what tools are available for development. Therefore, you must understand the architecture, the applications involved and how they communicate. See the API References and explore the full power of this integration.
Example Applications¶
Pix Demo Android App¶
To facilitate your integration, we created a project demo developed on Android and already integrated with the Pix app. Explore this project to see the integration in action.
Start Integration¶
Congratulations!¶
If you've made it this far, it's because you already have all the information necessary to start developing your application integrated with our pix solution. If you have any questions, please contact the support team.