Here you find all steps for the QrCode Generation and status check.
The first step in the integration process is ensuring secure authentication of the partner with the Treeal API. This step guarantees that only authorized users have access to the resources and features offered by the platform, maintaining the security of data and transactions.
Invoice Creation
Once authentication is complete, the Treeal partner is ready to create Pix invoices via the API provided by Treeal. Through this interface, the partner can quickly and easily generate invoices by specifying essential details such as the invoice amount and the recipient’s Pix key.
Payment
After creating the Pix invoice, the Treeal partner sends the invoice to their customer, who can complete the payment using their preferred method, whether through a banking app, digital wallet, or other Pix-compatible payment method.
Notification
Once the payment is made, Treeal will notify the partner via a callback URL, also known as a Webhook. This notification informs the partner of the transaction’s status, allowing for immediate responses and real-time transaction status updates.
Transaction Query
To provide a comprehensive view of the operations, the Treeal partner can query specific details of Pix transactions via the Treeal API. This query provides detailed information on created invoices, received payments, and other relevant data for the partner.
Before Getting Started, Ensure You Have:
The service credentials (clientId, clientSecret, pixKey), which can be obtained through the Treeal Finance portal.
The certificate for MTLS connection, sent as a compressed file by the Treeal integration team along with the documentation. Extract the contents of this file to a directory of your choice.
Postman or a similar tool installed and configured to use MTLS.