Obtain JWT tokens to authenticate all other requests.
ConnectPSP API (2.2.0)
ConnectPSP is a PIX payment gateway designed for high-throughput platforms such as digital wallets, betting companies, and fintechs.
This API allows you to:
- 💸 Receive payments via PIX (Cash-In) — standard QR Code or OpenFinance
- 🏦 Send payments via PIX key or bank account data (Cash-Out)
- 📊 Manage your wallet — check consolidated balances and rebalance between transactional and proprietary accounts
- 🪝 Receive real-time events via Webhooks as transactions progress
All endpoints (except POST /auth/token) require two headers:
| Header | Description |
|---|---|
Authorization | Bearer <jwt_token> — obtained from POST /auth/token |
ApplicationToken | Fixed GUID token that identifies your integration |
For financial operations (Cash-Out, Rebalance), an additional header is required:
| Header | Description |
|---|---|
DigitalSignature | HMAC-SHA256 hash of your JWT + CryptoToken. See Authentication Guide |
X-Idempotency-Key is optional on POST /cash-in and POST /cash-out, and recommended (a UUID v4 per operation). With it, a network retry returns the original response instead of creating a second transaction. Without it, the request is processed normally and externalReference still blocks duplicates with 409 DUPLICATED_EXTERNAL_REFERENCE. See the Authentication Guide for the full rules.
| Phase | What to confirm first |
|---|---|
| Setup | Credentials, environment, headers, and webhook readiness in Initial Setup |
| Authentication | JWT generation and DigitalSignature rules in the Authentication Guide |
| Transactions | Your first Cash-In or Cash-Out flow with idempotency and webhook validation |
Request
Returns Cash-Out transactions created within a period, oldest first by default. Pass order=desc for newest first.
Send nextCursor from the previous response to fetch the next page. When the response comes back without nextCursor, you have reached the end of the period.
To walk backwards, send previousCursor in the very same cursor parameter. It is absent on the first page, so its absence is how you know you are at the start.
Keep from, to, limit and order identical across every page — only cursor changes. Both directions return the page in the order you asked for.
ℹ️ There is no
totalfield. Counting the whole window would require a full scan, which is exactly what cursor pagination avoids.
Each item carries the same fields as GET /cash-out/{id}, with the same status, failure and reason values.
Start of the period, inclusive. Accepts a plain date (YYYY-MM-DD) or a full ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss).
Times without an explicit offset are read as America/Sao_Paulo (UTC-3). A plain date becomes 00:00:00.000 of that day in that timezone.
The period filters on when the transaction was created, not when it was paid.
End of the period, inclusive. Same format rules as from. A plain date becomes 23:59:59.999 of that day in America/Sao_Paulo.
Maximum number of items per page. Defaults to 50, maximum 1000.
Opaque cursor pointing at another page. Copy nextCursor (to go forward) or previousCursor (to go back) from the previous response verbatim. Do not build or parse it yourself, its format may change — a cursor already knows which way it goes.
Keep from, to, limit and order identical across every page of the same walk.
Sort direction by date. asc (default) returns the oldest first, desc the newest first.
⚠️
ordercannot change mid-walk. The direction is baked into the cursor. Sending a differentorderalongside acursorreturns422 LIST_ORDER_MISMATCH, because the next page would otherwise walk backwards — repeating rows you already had and skipping rows you never got. To change direction, start a new walk withoutcursor.
- Staging Environment (Testing)https://api.homologacao.connectpsp.com/cash-out
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl "https://api.homologacao.connectpsp.com/cash-out?from=2026-08-01&to=2026-08-01&limit=50" \
-H "Authorization: Bearer <token>" \
-H "ApplicationToken: <app-token>"A page of Cash-Out transactions.
BACEN/SPI settlement proof.
COMPLETED: starts withEREFUNDED: starts withD(the devolution); the payment E2E is inoriginalEndToEndIdCANCELLED: absent when the transfer never reached the PIX network
PROCESSING— being executed at the financial institutionPENDING— held on the ConnectPSP side (approval, analysis or reconciliation)COMPLETED— paid to the payeeCANCELLED— the money never left your account; seefailureREFUNDED— the money left and came back to your account; seereason
Why the Cash-Out was cancelled. Present only when status is CANCELLED. The full table of codes, messages and whether to retry is in GET /cash-out/{id}.
Machine-readable failure code. Key your handling on this. New codes may be added — treat an unknown code as PROCESSING_ERROR.
Why a completed Cash-Out came back. Present only when status is REFUNDED.
PAYEE_REQUESTED— the payee asked their bank to return the transferFRAUD— returned because of fraud, including a MED (Special Return Mechanism) claimOPERATIONAL_ERROR— returned because of an operational error at a bankREVERSED_BY_INSTITUTION— reversed by the financial institutionOTHER— any other reason
CPF or CNPJ of the payee (numbers only).
COMPLETED/REFUNDED— the ConnectPSP account that settled the Cash-Out.CANCELLED— the ConnectPSP account the Cash-Out would have been paid from. Present only when a bank had already been assigned; no money left your account.PROCESSING/PENDING— absent.
When the Cash-Out was requested. Always present.
When the payment was completed. Present on COMPLETED, and kept on REFUNDED.
Opaque cursor for the next page. Absent when there are no more pages.
{ "items": [ { … } ], "nextCursor": "MTM4OTU1MTIwMDAwMDAwMDB8YXxufElWS1BSTU9DRFk" }
Request
Aggregated Cash-Out figures for a period: totals per status, and the same figures broken down by settlement bank.
The keys are the Cash-Out status values returned by GET /cash-out/{id}, the listing and the webhooks, in lowercase.
| Key | Status | Meaning |
|---|---|---|
processing | PROCESSING | Being executed at the financial institution |
pending | PENDING | Held on the ConnectPSP side (approval, analysis or reconciliation) |
completed | COMPLETED | Settled |
cancelled | CANCELLED | The money never left your account |
refunded | REFUNDED | Settled, then returned to your account |
A bucket only appears when it has at least one transaction.
settlement counts and sums completed transactions only.
Start of the period, inclusive. Accepts a plain date (YYYY-MM-DD) or a full ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss).
Times without an explicit offset are read as America/Sao_Paulo (UTC-3). A plain date becomes 00:00:00.000 of that day in that timezone.
The period filters on when the transaction was created, not when it was paid.
- Staging Environment (Testing)https://api.homologacao.connectpsp.com/cash-out/summary
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl "https://api.homologacao.connectpsp.com/cash-out/summary?from=2026-08-01&to=2026-08-01" \
-H "Authorization: Bearer <token>" \
-H "ApplicationToken: <app-token>"Aggregated figures for the period.
Start of the period, echoed back in America/Sao_Paulo.
Status key → {count, amount}. Only statuses with at least one transaction appear.
Cash-In keys: pending, paid, refunded. Cash-Out keys: the Cash-Out statuses in lowercase — processing, pending, completed, cancelled, refunded.
Breakdown by settlement bank, paid transactions only (paid on Cash-In, completed on Cash-Out), ordered by amount descending.
{ "from": "2026-08-01T00:00:00-03:00", "to": "2026-08-01T23:59:59-03:00", "currency": "BRL", "totals": { "completed": { … }, "processing": { … }, "pending": { … }, "cancelled": { … } }, "settlement": [ { … }, { … } ] }
Request
Returns the current status and details of a Cash-Out transaction, including settlement proof from BACEN/SPI when available.
The body is the same object delivered in the data of the CASHOUT_* webhooks.
The {id} parameter accepts any of the identifiers below. When a value matches more than one transaction, the result is deterministic: the first level in this order wins, and within the same level the most recent transaction wins.
| Order | Identifier |
|---|---|
| 1 | internalCode (e.g. IVKPRMOCDY) |
| 2 | transactionId (UUID) |
| 3 | endToEndId of the payment (starts with E) |
| 4 | endToEndId of the refund (starts with D) |
| 5 | externalReference (your own reference) |
Prefer internalCode: it is the only identifier that can never collide with another level.
status | Meaning | Extra fields |
|---|---|---|
PROCESSING | Being executed at the financial institution | — |
PENDING | Held on the ConnectPSP side (approval, analysis or reconciliation) | — |
COMPLETED | Paid to the payee | completedAt |
CANCELLED | The money never left your account | failure, cancelledAt |
REFUNDED | The money left and came back to your account | reason, refundedAt |
COMPLETED, CANCELLED and REFUNDED are final, except that a COMPLETED Cash-Out can later become REFUNDED when the payee's bank returns it.
failure is present only when status is CANCELLED. failure.message is fixed per code.
failure.code | failure.message | When it happens | Retry? |
|---|---|---|---|
PROVIDER_UNAVAILABLE | The withdrawal could not be completed due to a temporary instability. The amount remains available in your account. | Temporary instability at ConnectPSP or at the settlement partner | Yes |
PIX_KEY_NOT_FOUND | The provided PIX key did not resolve to a valid account. | The PIX key is not registered in the PIX directory (DICT) | No — ask the payee for another key |
PIX_KEY_INVALID | The provided PIX key has an invalid format. | The key does not match the format of its pixKeyType | No — fix the key |
PAYEE_DOCUMENT_MISMATCH | The PIX key or account does not belong to the informed payee document. | The owner of the key or account is not payee.document | No |
PAYEE_ACCOUNT_INVALID | The destination account data is invalid. | Bank account data (ISPB, branch, account, type) does not identify an account | No — fix the account data |
PAYEE_ACCOUNT_UNAVAILABLE | The destination account is blocked, closed or cannot receive this transfer. | The destination account is blocked, closed or does not accept this transfer | No |
PAYEE_BANK_UNAVAILABLE | The receiving institution did not respond in time. The amount remains available in your account. | The payee's bank did not answer in time | Yes |
PAYEE_BANK_REJECTED | The receiving institution rejected the transfer. | The payee's bank refused the transfer | Only after checking with the payee |
FRAUD_SUSPECTED | The transfer was blocked by a security restriction on the payee. | A security or anti-fraud restriction on the payee | No |
INSUFFICIENT_FUNDS | Insufficient balance to complete the withdrawal. | Your transactional balance did not cover the amount | Yes, after funding the account (see POST /account/rebalance) |
AMOUNT_ABOVE_MAXIMUM | The amount exceeds the maximum allowed for this transfer. | Above the maximum per transfer | Only with a lower amount |
DAILY_LIMIT_EXCEEDED | The daily withdrawal limit has been reached. | Your daily withdrawal limit was reached | Yes, on the next day |
PERIOD_LIMIT_EXCEEDED | The withdrawal limit for the current period has been reached. | The limit for the current period (daytime or nighttime) was reached | Yes, in the next period |
PAYEE_LIMIT_EXCEEDED | The withdrawal limit for this payee has been reached. | The limit per payee was reached | Yes, when the payee's limit resets |
PAYEE_NOT_ALLOWED | Transfers to this payee are not allowed. | The payee, or the payee's institution, is not allowed to receive | No |
DUPLICATED_TRANSFER | A duplicated transfer was detected and rejected. | The same transfer was already sent | No — check the original Cash-Out first |
APPROVAL_REJECTED | The withdrawal was rejected during approval. | Rejected during manual approval | Only with a new approval |
PROCESSING_ERROR | The withdrawal could not be completed. The amount remains available in your account. | Any other failure | Yes — contact support if it repeats |
A retry is always a new POST /cash-out with a new externalReference: the cancelled one keeps its reference. New codes may be added over time — treat a code you do not know as PROCESSING_ERROR.
reason is present only when status is REFUNDED.
reason | Meaning |
|---|---|
PAYEE_REQUESTED | The payee asked their bank to return the transfer |
FRAUD | Returned because of fraud, including a MED (Special Return Mechanism) claim |
OPERATIONAL_ERROR | Returned because of an operational error at a bank |
REVERSED_BY_INSTITUTION | Reversed by the financial institution |
OTHER | Any other reason |
- Staging Environment (Testing)https://api.homologacao.connectpsp.com/cash-out/{id}
- cURL
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl https://api.homologacao.connectpsp.com/cash-out/IVKPRMOCDY \
-H "Authorization: Bearer <token>" \
-H "ApplicationToken: <app-token>"Cash-Out details returned.
BACEN/SPI settlement proof.
COMPLETED: starts withEREFUNDED: starts withD(the devolution); the payment E2E is inoriginalEndToEndIdCANCELLED: absent when the transfer never reached the PIX network
PROCESSING— being executed at the financial institutionPENDING— held on the ConnectPSP side (approval, analysis or reconciliation)COMPLETED— paid to the payeeCANCELLED— the money never left your account; seefailureREFUNDED— the money left and came back to your account; seereason
Why the Cash-Out was cancelled. Present only when status is CANCELLED. The full table of codes, messages and whether to retry is in GET /cash-out/{id}.
Machine-readable failure code. Key your handling on this. New codes may be added — treat an unknown code as PROCESSING_ERROR.
Why a completed Cash-Out came back. Present only when status is REFUNDED.
PAYEE_REQUESTED— the payee asked their bank to return the transferFRAUD— returned because of fraud, including a MED (Special Return Mechanism) claimOPERATIONAL_ERROR— returned because of an operational error at a bankREVERSED_BY_INSTITUTION— reversed by the financial institutionOTHER— any other reason
PIX— payment via PIX key. ProvidepixKeyTypeandpixKey.BANK_ACCOUNT— payment via bank account data. ProvidebankAccount.
Type of PIX key. Required when type is PIX. Responses and webhooks always return one of these same five values: CPF, CNPJ, EMAIL, PHONE or EVP (random key).
The PIX key value. Required when type is PIX.
Banking details returned after settlement. May be null before settlement.
COMPLETED/REFUNDED— the ConnectPSP account that settled the Cash-Out.CANCELLED— the ConnectPSP account the Cash-Out would have been paid from. Present only when a bank had already been assigned; no money left your account.PROCESSING/PENDING— absent.
When the Cash-Out was requested. Always present.
When the payment was completed. Present on COMPLETED, and kept on REFUNDED.
- completed
- cancelled
- cancelled_insufficient_funds
- refunded
{ "transactionId": "dd30446e-6cc5-4664-bf3f-6b7f5e55a1a9", "internalCode": "IVKPRMOCDY", "externalReference": "withdraw_xyz789", "endToEndId": "E00416968202603101827cemeFscF6AG", "status": "COMPLETED", "amount": 500, "payee": { "name": "Maria Silva", "document": "12345678909", "destination": { … }, "bankData": { … } }, "settlement": { "ispb": "87654321", "bank": "SETTLEMENT PARTNER B", "branch": "0001", "account": "654987" }, "requestedAt": "2026-03-10T14:00:00-03:00", "completedAt": "2026-03-10T14:02:30-03:00" }
PIX Health tells you whether PIX is working for you right now, and who is at fault when it is not.
A statistical engine compares every 5-minute window of your PIX traffic with what is normal for that weekday and time over the last four weeks, and attributes any clear deviation to the platform, to a settlement partner, to a payer bank or to your own operation — always scoped to what you actually use.
Three endpoints, all read-only and all safe to poll once a minute:
| Endpoint | Use it for |
|---|---|
GET /health/pix | The picture of the moment: status per block plus the incidents open right now |
GET /health/pix/incidents | History of confirmed incidents, paginated |
GET /health/pix/incidents/{id} | One incident with the evidence behind the verdict |
None of them require DigitalSignature or X-Idempotency-Key — only Authorization and ApplicationToken.
Confirmed incidents are also pushed as webhooks (PIX_INCIDENT_DETECTED / UPDATED / RESOLVED), so you do not have to poll to be warned; see the Webhooks guide.