The documentation for AQPago's API services was developed to assist you in integrating your application with our banking services. This material is structured in strategic steps, according to the customer journey, from initial setup to advanced operations. Our goal is to ensure that your experience is secure, efficient, and fully compliant with financial regulations.
Follow the steps below to get started:
-
Registration and Credentialing
This is the initial step to access AQPago’s API services. Here, clients register using their CPF or CNPJ, submit the required documentation, and go through an onboarding process to verify their identity. If you wish to integrate with the API, you must request a unique API Key from the commercial team, which will be linked to the registered document (CPF/CNPJ) for authentication. -
API Endpoints
We offer two environments for you to integrate your application:- Sandbox: used for testing and validating the API services before going live.
- Production: the environment where the system is used by end users.
-
REST API
Our API was developed following REST design principles, using HTTP verbs and status codes. All requests and responses are processed in JSON format. Visit the Simulation Cards page to see which cards can be used for simulated transactions. -
Authentication and Authorization
Once authenticated, the client will receive a new Token that must be used for all future requests. All requests require prior Authentication for enhanced security. Without authentication, the client will not be able to access the API services.
Ready to get started?
To begin, start with the Registration and Credentialing topic, and then continue to Authentication and Authorization, or explore our Postman Collection with practical examples.
In case of any doubts, our support team is available to assist you at any stage of the integration process with our API.
Follow the steps above and refer to the explanations and code examples in our complete documentation.