ConnectPSP API (2.2.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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:

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

Idempotency

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.

Recommended integration order

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

Download OpenAPI description

index.json

index.yaml

Overview

ConnectPSP Support

suporte@connectpsp.com

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

Create Cash-In

Request

Generates a PIX payment intent.

Standard PIX flow: Returns a Copia e Cola string and a QR Code image (Base64) that your user can scan to complete the payment.

OpenFinance flow: Include the openFinance object to generate an OpenFinance payment link instead. The user is redirected to their bank's app to authorize the payment.

Once payment is confirmed by the banking network, ConnectPSP will POST a CASHIN_PAID event to your webhookUrl.

externalReference must be unique per client: reusing one returns 409 DUPLICATED_EXTERNAL_REFERENCE. X-Idempotency-Key is optional — see Idempotency.

Security

bearerAuth

Headers

ApplicationTokenstringrequired

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

Example: {{ApplicationToken}}

X-Idempotency-Keystring<= 100 characters

Optional, recommended. A key you generate per operation (a UUID v4 is ideal), up to 100 characters. Accepted on POST /cash-in and POST /cash-out.

Without it, the request is processed normally, with no idempotency. externalReference still blocks duplicates with 409 DUPLICATED_EXTERNAL_REFERENCE.
Same key, same body, within 24 hours: returns the original response, creates nothing, and adds the Idempotent-Replayed: true header.
Same key, different body: 422 IDEMPOTENCY_KEY_REUSED.
Same key while the first request is still running: 409 IDEMPOTENCY_KEY_IN_PROGRESS.
More than 100 characters: 400 IDEMPOTENCY_KEY_INVALID.

Only successful responses are stored. After an error the key is released, and a retry with the same key is processed again.

Example: 550e8400-e29b-41d4-a716-446655440000

Bodyapplication/jsonrequired

amountnumber(decimal)>= 0.01required

Payment amount in BRL (Brazilian Reais). Decimal format (e.g. 150.50).

Example: 150.5

externalReferencestring<= 50 charactersrequired

Your internal order or transaction ID. Must be unique per client: reusing one returns 409 DUPLICATED_EXTERNAL_REFERENCE. Also accepted as {id} on GET /cash-in/{id}.

Example: "order_abc123"

expirationInMinutesinteger[ 1 .. 43200 ]

QR Code validity in minutes. Defaults to 1440 (24h) if omitted.

Example: 60

webhookUrlstring(uri)

URL to receive asynchronous payment events (CASHIN_PAID, CASHIN_REFUNDED).

Example: "https://api.yourdomain.com/webhooks/connectpsp"

payerobject(CashInPayer)required

payer.namestringrequired

Full name of the payer.

Example: "João Silva"

payer.documentstringrequired

CPF (11 digits) or CNPJ (14 digits) — numbers only.

Example: "12345678909"

openFinanceobject(CashInOpenFinance)

When present, triggers the OpenFinance flow instead of a standard QR Code. The response will include a paymentUrl to redirect the user to their bank's authorization screen.

openFinance.redirectUrlstring(uri)required

URL to redirect the user after completing payment in their banking app.

Example: "https://yourdomain.com/payment/success"

includeQrCodeImageboolean

If true, the response includes QR Code as Base64. Defaults to true.

Default true

curl -X POST https://api.homologacao.connectpsp.com/cash-in \
  -H "Authorization: Bearer <token>" \
  -H "ApplicationToken: <app-token>" \
  -H "X-Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 150.50,
    "externalReference": "order_abc123",
    "expirationInMinutes": 60,
    "webhookUrl": "https://api.yourdomain.com/webhooks/connectpsp",
    "payer": {
      "name": "João Silva",
      "document": "12345678909"
    }
  }'

Responses

Cash-In created successfully.

Headers

Idempotent-Replayedstring

true when this response is a replay of an earlier request sent with the same X-Idempotency-Key and the same body. Nothing new was created. Absent on a first execution.

Value"true"

Example: "true"

Bodyapplication/json

transactionIdstring

PIX network TxId (alphanumeric).

Example: "kk6g232xel65a0daee4dd13kk2912714964"

internalCodestring

ConnectPSP short code (7 characters). Use this to poll status.

Example: "US7B1JQ"

externalReferencestring

Your original order reference echoed back.

Example: "order_abc123"

statusstring

Always AWAITING_PAYMENT at creation.

Value"AWAITING_PAYMENT"

Example: "AWAITING_PAYMENT"

amountnumber(decimal)

Example: 150.5

payerobject(CashInResponsePayer)

payer.namestring

Example: "João Silva"

payer.documentstring

Example: "12345678909"

payer.bankDataobject(BankData)

Banking details returned after settlement. May be null before settlement.

payer.bankData.ispbstring

Bank ISPB code (8 digits).

Example: "00000000"

payer.bankData.bankstring

Bank name.

Example: "Banco do Brasil S.A."

payer.bankData.branchstring

Branch number.

Example: "0001"

payer.bankData.accountstring

Account number.

Example: "123456"

pixDataobject(CashInPixData)

pixData.copyAndPastestring

Full PIX Copia e Cola string (EMV QR Code payload).

Example: "00020101021226..."

pixData.qrCodeImageBase64string

QR Code image encoded as Base64. Present only when includeQrCodeImage is true.

Example: "iVBORw0KGgoAAAANSU..."

openFinanceDataobject(CashInOpenFinanceData)

openFinanceData.paymentUrlstring(uri)

Redirect URL to the user's OpenFinance payment authorization screen.

Example: "https://app.linaopenx.com.br/payments?paymentLinkId=b7116f6a..."

requestedAtstring(date-time)

Transaction creation timestamp (ISO 8601, UTC-3).

Example: "2026-03-10T11:20:00-03:00"

Response

application/json

{
  "transactionId": "kk6g232xel65a0daee4dd13kk2912714964",
  "internalCode": "US7B1JQ",
  "externalReference": "order_abc123",
  "status": "AWAITING_PAYMENT",
  "amount": 150.5,
  "payer": {
    "name": "João Silva",
    "document": "12345678909"
  },
  "pixData": {
    "copyAndPaste": "00020101021226...",
    "qrCodeImageBase64": "iVBORw0KGgoAAAANSU..."
  },
  "requestedAt": "2026-03-10T11:20:00-03:00"
}

List Cash-Ins

Request

Returns Cash-In transactions created within a period, oldest first by default. Pass order=desc for newest first.

Cursor pagination

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 total field. Counting the whole window would require a full scan, which is exactly what cursor pagination avoids. Every page costs the same, whether it is the first or the nine-hundredth.

Each item carries the same fields as GET /cash-in/{id}, minus pixData and openFinanceData — those only make sense at creation time.

Security

bearerAuth

Query

fromstringrequired

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.

Example: from=2026-08-01

tostringrequired

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.

Example: to=2026-08-01

limitinteger[ 1 .. 1000 ]

Maximum number of items per page. Defaults to 50, maximum 1000.

Default 50

Example: limit=50

cursorstring

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.

Example: cursor=MTM4OTU0NzI4MDAwMDAwMDB8YXxufFBIUVlST0I

orderstring

Sort direction by date. asc (default) returns the oldest first, desc the newest first.

⚠️ order cannot change mid-walk. The direction is baked into the cursor. Sending a different order alongside a cursor returns 422 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 without cursor.

Default "asc"

Enum"asc""desc"

Example: order=asc

Headers

ApplicationTokenstringrequired

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

Example: {{ApplicationToken}}

curl "https://api.homologacao.connectpsp.com/cash-in?from=2026-08-01&to=2026-08-01&limit=50" \
  -H "Authorization: Bearer <token>" \
  -H "ApplicationToken: <app-token>"

Responses

A page of Cash-In transactions.

Bodyapplication/json

itemsArray of objects(CashInDetailedResponse)

items[].transactionIdstring

Example: "kk6g232xel65a0daee4dd13kk2912714964"

items[].internalCodestring

Example: "US7B1JQ"

items[].externalReferencestring

Example: "order_abc123"

items[].endToEndIdstring

End-to-end ID issued by BACEN/SPI upon settlement.

For paid transactions: starts with E (e.g. E00416968...)
For refunded transactions: starts with D (Devolution)

Example: "E00416968202603101827cemeFscF6AG"

items[].originalEndToEndIdstring

The original E2E ID when endToEndId represents a refund.

Example: "E00416968202603101827cemeFscF6AG"

items[].statusstring

AWAITING_PAYMENT — created, not paid yet
PAID — payment confirmed
EXPIRED — expired without payment; see expiredAt
REFUNDED — paid, then returned to the payer; see reason and refundedAt
CANCELLED — cancelled before being paid; see cancelledAt

Enum"AWAITING_PAYMENT""PAID""EXPIRED""REFUNDED""CANCELLED"

Example: "PAID"

items[].reasonstring(CashInRefundReason)

Why a paid Cash-In went back to the payer. Present only when status is REFUNDED.

FRAUD, DUPLICATED_PAYMENT, CUSTOMER_REQUEST, MERCHANT_ERROR — the reason you sent on POST /cash-in/{id}/refund. FRAUD also covers a MED (Special Return Mechanism) claim, and CUSTOMER_REQUEST a devolution the bank flagged as requested by the customer
PAYER_NOT_ALLOWED — refunded automatically because the payer is not allowed to pay you
OTHER — any other reason

Enum"FRAUD""DUPLICATED_PAYMENT""CUSTOMER_REQUEST""MERCHANT_ERROR""PAYER_NOT_ALLOWED""OTHER"

items[].amountnumber(decimal)

Example: 150.5

items[].payerobject(CashInResponsePayer)

items[].payer.namestring

Example: "João Silva"

items[].payer.documentstring

Example: "12345678909"

items[].payer.bankDataobject(BankData)

Banking details returned after settlement. May be null before settlement.

items[].settlementobject(Settlement)

Present only when money actually moved: PAID and REFUNDED. Absent in AWAITING_PAYMENT, EXPIRED and CANCELLED — no ConnectPSP account received anything.

items[].settlement.ispbstring

ISPB of the settling institution. Key on this, not on bank.

Example: "12345678"

items[].settlement.bankstring

Example: "SETTLEMENT PARTNER A"

items[].settlement.branchstring

Example: "0001"

items[].settlement.accountstring

Example: "123456"

items[].requestedAtstring(date-time)

When the charge was created. Always present, in every status.

Example: "2026-03-10T11:20:00-03:00"

items[].paidAtstring(date-time)

Example: "2026-03-10T11:22:15-03:00"

items[].refundedAtstring(date-time)

Example: "2026-03-11T09:00:00-03:00"

items[].cancelledAtstring(date-time)

When the charge was cancelled. Present only on CANCELLED.

items[].expiredAtstring(date-time)

The charge's expiration date and time (the end of the payment window). Same value on GET by id, on the list and on the CASHIN_EXPIRED webhook. CASHIN_EXPIRED is sent 5 to 7 minutes after the expiration; the envelope eventAt is the send time, not the expiration.

nextCursorstring

Opaque cursor for the next page. Absent when there are no more pages — that is how you know the walk is finished.

Example: "MTM4OTU0NzI4MDAwMDAwMDB8YXxufFVTN0IxSlE"

previousCursorstring

Opaque cursor for the page before this one. Send it in the same cursor parameter. Absent on the first page — that is how you know you are at the start.

Example: "MTM4OTU0NzI4MDAwMDAwMDB8YXxwfFVTN0IxSlE"

Response

application/json

{
  "items": [
    { … }
  ],
  "nextCursor": "MTM4OTU0NzI4MDAwMDAwMDB8YXxufFVTN0IxSlE"
}

Summarize Cash-Ins

Request

Aggregated Cash-In figures for a period: totals per status, and the same figures broken down by settlement bank.

Use this instead of walking the whole list when you only need the numbers.

Status buckets

Key	Meaning
`pending`	Not paid — covers both awaiting payment and expired
`paid`	Settled
`refunded`	Returned to the payer

⚠️ There is no expired bucket. Expiry depends on the charge's due date, which the aggregate does not read, so expired charges are counted under pending. The listing endpoint does distinguish them per item.

A bucket only appears when it has at least one transaction.

Settlement breakdown

settlement counts and sums paid transactions only. Money that has not settled is not attributed to any bank — this is what makes the figures reconcile against GET /account/balance.

Security

bearerAuth

Query

fromstringrequired

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.

Example: from=2026-08-01

tostringrequired

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.

Example: to=2026-08-01

Headers

ApplicationTokenstringrequired

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

Example: {{ApplicationToken}}

curl "https://api.homologacao.connectpsp.com/cash-in/summary?from=2026-08-01&to=2026-08-01" \
  -H "Authorization: Bearer <token>" \
  -H "ApplicationToken: <app-token>"

Responses

Aggregated figures for the period.

Bodyapplication/json

fromstring(date-time)

Start of the period, echoed back in America/Sao_Paulo.

Example: "2026-08-01T00:00:00-03:00"

tostring(date-time)

Example: "2026-08-01T23:59:59-03:00"

currencystring

Example: "BRL"

totalsobject

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.

totals.property name*object(SummaryBucket)additional property

totals.property name*.countinteger(int64)

Example: 1284

totals.property name*.amountnumber(decimal)

Example: 192450.75

settlementArray of objects(SummaryByBank)

Breakdown by settlement bank, paid transactions only (paid on Cash-In, completed on Cash-Out), ordered by amount descending.

settlement[].ispbstring

Example: "12345678"

settlement[].bankstring

Example: "SETTLEMENT PARTNER A"

settlement[].countinteger(int64)

Example: 1103

settlement[].amountnumber(decimal)

Example: 165230.75

Response

application/json

{
  "from": "2026-08-01T00:00:00-03:00",
  "to": "2026-08-01T23:59:59-03:00",
  "currency": "BRL",
  "totals": {
    "paid": { … },
    "pending": { … },
    "refunded": { … }
  },
  "settlement": [
    { … },
    { … }
  ]
}

Cash-Out

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

Operations

Account

View consolidated wallet balances across all settlement partners and manage rebalancing between transactional and proprietary accounts.

Operations

Health

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.

Operations

ConnectPSP API (2.2.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Authentication

Idempotency

Recommended integration order

Authentication

Cash-In

Create Cash-In

Request

Responses

Was this helpful?

List Cash-Ins

Request

Responses

Was this helpful?

Summarize Cash-Ins

Request

Status buckets

Settlement breakdown

Responses

Was this helpful?

Cash-Out

Account

Health

ConnectPSP API (2.2.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Authentication

Idempotency

Recommended integration order

Authentication

Cash-In

Create Cash-In

RequestExpand all

Responses

Was this helpful?

List Cash-Ins

Request

Cursor pagination

Responses

Was this helpful?

Summarize Cash-Ins

Request

Status buckets

Settlement breakdown

Responses

Was this helpful?

Cash-Out

Account

Health

ConnectPSP API (2.2.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request