Skip to content
/
Get Balance

ConnectPSP API (2.0.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

Authentication

All endpoints (except POST /auth/token) require two headers:

HeaderDescription
AuthorizationBearer <jwt_token> — obtained from POST /auth/token
ApplicationTokenFixed GUID token that identifies your integration

For financial operations (Cash-Out, Rebalance), an additional header is required:

HeaderDescription
DigitalSignatureHMAC-SHA256 hash of your JWT + CryptoToken. See Authentication Guide

Idempotency

For POST /cash-in and POST /cash-out, we strongly recommend sending the X-Idempotency-Key header (UUID v4). This guarantees that network retries do not result in duplicate transactions.

Recommended integration order

PhaseWhat to confirm first
SetupCredentials, environment, headers, and webhook readiness in Initial Setup
AuthenticationJWT generation and DigitalSignature rules in the Authentication Guide
TransactionsYour first Cash-In or Cash-Out flow with idempotency and webhook validation
Download OpenAPI description
index.json
index.yaml
Overview
ConnectPSP Support
suporte@connectpsp.com
Languages
Servers
Staging Environment (Testing)
https://api.homologacao.connectpsp.com

Authentication

Obtain JWT tokens to authenticate all other requests.

Operations

Cash-In

Generate and manage inbound PIX payments. Supports standard QR Code and OpenFinance flows.

Operations

Cash-Out

Request and track outbound PIX payments to any Brazilian bank account.

Operations

Account

View consolidated wallet balances across all banking partners (Delbank, Celcoin, StarkBank) and manage rebalancing between transactional and proprietary accounts.

Operations

Get Balance

Request

Returns the consolidated and detailed wallet snapshot across all banking partners (Delbank, Celcoin, StarkBank).

Two account types are tracked per bank:

  • Transactional — funds available to cover Cash-Out requests (mirrors your users' exposure)
  • Proprietary — reserve/buffer account (your operational capital)

ℹ️ Note: Historical balance lookup (?date=) is currently in development. Only the current balance is available.

Security
bearerAuth
Query
datestring(date)

Date for historical balance snapshot (ISO 8601 — YYYY-MM-DD). Currently not available.

Example: date=2026-03-10
Headers
ApplicationTokenstringrequired

Fixed GUID that uniquely identifies your integration. Provided during ConnectPSP onboarding.

Example: {{ApplicationToken}}
curl https://api.homologacao.connectpsp.com/account/balance \
  -H "Authorization: Bearer <token>" \
  -H "ApplicationToken: <app-token>"

Responses

Consolidated balance returned successfully.

Bodyapplication/json
currencystring
Example: "BRL"
referenceDatestring(date)
Example: "2026-03-10"
consolidatedobject
consolidated.​totalBalancenumber(decimal)

Sum of all transactional and proprietary balances.

Example: 1500000
consolidated.​transactionalBalancenumber(decimal)

Total funds available for Cash-Out operations.

Example: 500000
consolidated.​proprietaryBalancenumber(decimal)

Total reserve/buffer capital.

Example: 1000000
banksArray of objects(BankBalance)
banks[].​ispbstring
Example: "13935893"
banks[].​bankstring
Example: "CELCOIN IP S.A."
banks[].​accountsobject
banks[].​accounts.​transactionalobject(AccountDetail)
banks[].​accounts.​proprietaryobject(AccountDetail)
updatedAtstring(date-time)

Timestamp when the balance snapshot was extracted.

Example: "2026-03-10T14:35:00Z"
Response
application/json
{
  "currency": "BRL",
  "referenceDate": "2026-03-10",
  "consolidated": {
    "totalBalance": 1500000,
    "transactionalBalance": 500000,
    "proprietaryBalance": 1000000
  },
  "banks": [
    { … },
    { … },
    { … }
  ],
  "updatedAt": "2026-03-10T14:35:00Z"
}

Rebalance Wallet

Request

Synchronizes your Transactional account to match the total exposure you report.

How it works:

  • If targetAmount is greater than the current transactional balance → funds are pulled from the Proprietary account (Top-up)
  • If targetAmount is less than the current transactional balance → excess funds are swept back to the Proprietary account

The targetAmount represents the total exposure of your platform (sum of all user wallet balances + in-flight bets).

This endpoint requires the DigitalSignature header.

Security
bearerAuth
Headers
ApplicationTokenstringrequired

Fixed GUID that uniquely identifies your integration. Provided during ConnectPSP onboarding.

Example: {{ApplicationToken}}
DigitalSignaturestringrequired

HMAC-SHA256 hash of the JWT token + your CryptoToken. Required for sensitive operations. See the Authentication Guide for the exact computation steps.

Example: {{DigitalSignature}}
Bodyapplication/jsonrequired
targetAmountnumber(decimal)>= 0.01required

The target transactional balance (in BRL) representing your total current user exposure (sum of all user wallet balances + in-flight operations). ConnectPSP will automatically calculate the direction (Top-up or Sweep).

Example: 1000000
curl -X POST https://api.homologacao.connectpsp.com/account/rebalance \
  -H "Authorization: Bearer <token>" \
  -H "ApplicationToken: <app-token>" \
  -H "DigitalSignature: <computed-signature>" \
  -H "Content-Type: application/json" \
  -d '{ "targetAmount": 1000000.00 }'

Responses

Rebalancing completed successfully.

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Rebalancing completed successfully."
Response
application/json
{
  "success": true,
  "message": "Rebalancing completed successfully."
}