Use the guides when you already know the flow you want to integrate and need operational detail, security rules, or implementation decisions.
| Step | Read this when you need to | Guide |
|---|---|---|
| 1 | Authenticate requests and understand DigitalSignature | Authentication |
| 2 | Receive asynchronous events safely and idempotently | Webhooks |
| 3 | Map failures to retries, alerts, and operator actions | Error Handling |
| If you are trying to... | Start here |
|---|---|
| Send your first authenticated request | Authentication |
| Validate webhook delivery before production | Webhooks |
| Handle rejected requests or business-rule failures | Error Handling |
| Domain | Description |
|---|---|
| Cash-In | Generate PIX QR Codes and OpenFinance payment intents. Receive confirmation webhooks when payments land. |
| Cash-Out | Send PIX payments to any Brazilian bank account or PIX key. |
| Account | View consolidated wallet balances across all banking partners and manage transactional vs. proprietary account rebalance. |
| Webhooks | Asynchronous events sent by ConnectPSP when transactions evolve. |
Cash-Out requests return 202 Accepted immediately. Final settlement happens asynchronously through the PIX network (SPI/BACEN), so webhook handling is part of the happy path, not an optional extra.
ConnectPSP manages two accounts per banking partner:
- Transactional — mirrors your users' total exposure (wallets + in-flight operations)
- Proprietary — your operational capital/buffer
Use POST /account/rebalance to keep transactional funds aligned with actual user exposure.
Every PIX transaction settled by BACEN receives a unique E2E ID:
- Starts with
E→ original payment settled - Starts with
D→ devolution/refund of a previous payment
- Start from Initial Setup if you are still preparing the integration baseline.
- Use the Quickstart section when you want a guided first transaction.
- Open the API Reference when you need exact request and response contracts.