Skip to main content
Sicredi is a Brazilian cooperative financial institution. Its Cobrança product lets companies issue and manage boletos, and the Cobrança API gives programmatic access to them. This connector brings to the Catalog the boletos liquidated (paid) each day, the daily financial movements of your Cobrança portfolio (the “francesinha”, with credits and debits such as fees) and the full data of each paid boleto (payer, due date, status, amounts), so you can reconcile what was received with your other systems.
The connector only reads data. It never registers, changes or writes off a boleto in Sicredi.
This connector reads the Cobrança API (boletos). Sicredi’s Pix API is a separate product with its own credentials and a digital certificate, and it is not covered by this connector.

Before you start

The connector logs in with credentials that your company generates at Sicredi; Nekt cannot generate them for you. You need:
  • The Cobrança product contracted with your cooperative in the API (Cobrança Online) modality, with the adhesion term signed. If you are not sure, ask your account manager at the cooperative.
  • Access to Sicredi’s Internet Banking with the account that holds the Cobrança agreement.
  • An account in the Sicredi Developer Portal (anyone can create one, for example the person in your company who handles integrations).
1

Find your cooperative, posto and beneficiary codes

Sicredi’s Cobrança manual points to the Internet Banking menu Cobrança, option Cadastrar títulos, which shows three codes (if you cannot find them, ask your cooperative):
  • Cooperativa: 4 digits (for example 0101). It is also the cooperative number you use, with the account number, to log in to the Internet Banking.
  • Posto: 2 characters, usually digits (for example 03), the agency of the account. Some postos contain letters; type it exactly as shown.
  • Código de beneficiário: 5 digits (for example 12345), the code of your Cobrança agreement (also called código do convênio).
If your company has more than one account with Cobrança, use the codes of the account you want to read. Each account needs its own source in Nekt, with its own API key and its own access code.
2

Create an app in the Developer Portal

Log in to the Sicredi Developer Portal, open Minha Conta > Minhas Apps and click Cadastrar Nova App (the portal’s current label; Sicredi’s manual calls it “criar uma nova aplicação”). Give it a name that identifies it as your production app, for example API Cobrança 0101 12345 Produção (your cooperative and beneficiary codes), and select these two APIs from the list:
  • Open API - Cobranca - Parceiros (called “API COBRANÇA BOLETO” in Sicredi’s manual)
  • Open API - OAuth - Parceiros (called “OPEN API – OAUTH - PARCEIROS” in the manual)
The portal shows a Client ID and a Client Secret for the app. Do not enter them in Nekt: the Client ID is only used in the next step, to identify the app in the request for the token.
3

Request the production access token (API key)

In the Developer Portal, open Suporte > Abra um chamado (it opens Sicredi’s support center) and fill in:
  • subject: API Cobrança Boletos
  • reason: Solicitar Token de Acesso
  • environment: Produção
  • the Client ID of the app you created
These options are not in Sicredi’s manual; they come from the guides of other systems that integrate with Sicredi. Sicredi issues the token after reviewing the request.When it is issued, open Minha Conta > Minhas Apps and, in the Access Tokens column of your app, click detalhes (the portal’s current screen, as other integrators also describe it; the manual calls it “Ver detalhes”). Copy the access token: it looks like 1a2b3c4d-1234-5678-9abc-1234567890ab. You will paste it in Nekt as the API Key (x-api-key).
4

Generate the access code in the Internet Banking

Do this step last, right before you create the source in Nekt. In the Internet Banking, logged in with the account of the Cobrança agreement, open Cobrança > Código de Acesso > Gerar and confirm with your security device. Copy the code that is shown and keep it as a password: you will paste it in Nekt as the Access Code.The Código de Acesso menu only appears when the agreement is in the API (Cobrança Online) modality. If you don’t see it, ask your account manager to enable it.
Create the source and run its first sync right after generating the access code. Sicredi’s manual gives no validity for the code, but other integrators report that it stays available for 24 hours.
Use the production token. Sicredi issues a different token for its test environment (sandbox), and it does not work with real data.

Configuring Sicredi Cobrança as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Sicredi Cobrança option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

The following configurations are available:
  • Cooperative Code: the 4-digit cooperative number from step 1 (for example 0101). If you type fewer digits, the leading zeros are added.
  • Posto Code: the posto from step 1, usually 2 digits (for example 03) but it may contain letters. A single digit gets its leading zero (3 becomes 03); letters are sent in upper case (a1 becomes A1).
  • Beneficiary Code: the 5-digit beneficiary code of your Cobrança agreement from step 1 (for example 12345).
  • Access Code: the access code generated in the Internet Banking in step 4.
  • API Key (x-api-key): the production access token of your Developer Portal app from step 3 (one per account; not the Client ID or the Client Secret).
  • Start Date: the first day to read. Liquidations and financial movements are read from this day on. For example, 2026-01-01. The connector reads Sicredi one day at a time, so an older date makes the first run longer. If you select the Boletos stream, prefer a recent date: it makes one request per paid boleto.
  • Lookback Days (advanced): (Default: 5) each run reads again this many days before the last day already read, to catch payments Sicredi reports on a later business day, for example after a long holiday. From 0 to 60.
Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis.
Tip: The stream can be found more easily by typing its name.
Boletos makes one request to Sicredi for each paid boleto, so it is the slowest stream: with a Start Date far in the past, the first run can take hours. Select it when you need the payer, due date or status of each boleto, preferably with a recent Start Date; Boletos Liquidados already has the amounts paid. Boletos saves its progress at the end of each day it reads, so a first run that stops halfway continues from the last complete day. Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: all streams are INCREMENTAL, which is the recommended type: each run reads only the days since the last run (plus the lookback). Read more about Sync Types here.
A full sync (FULL_TABLE, or an Additional Full Sync) reads every day again since the Start Date and replaces the table with what Sicredi returns at that moment. Sicredi does not document how long it keeps old days available: if it no longer serves very old days, their rows leave the table. Prefer incremental sync, and avoid full syncs on Boletos, which also repeat one request per boleto.
Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. Once a day is enough for most uses: Sicredi lists liquidations by day, and each run also reads the current day again. Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. See the warning above before enabling it.
Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.
Each run first logs in and makes one request per listing the selected streams use, so a wrong access code or API key stops the run before any table is written, with a message saying what to check. Sicredi answers “not found” for days without data. While a source has never listed any row, a week or more of “not found” in every listing stops the run and asks you to check the codes, since wrong codes look the same; once the source has listed rows with its current codes, a quiet week is only a warning (after you edit the codes, the first week counts as a new source again). If one listing has rows and the other answers “not found” for a week or more (the posto and the cooperative filter the financial movements differently), the run also stops, unless both listings had rows before. Every day is read completely (all its pages) before it is saved. If a day’s listing changes while it is read, it is read again; if Sicredi keeps returning an inconsistent listing, fewer financial movements than it announces, or exactly the 1,000 movements per day it documents as its limit, the run stops before writing that stream, so its table is never updated with a partial read.

How the data is organized

  • Boletos Liquidados has one row per liquidation Sicredi lists for a day. Pix payments made on weekends and holidays are listed by Sicredi on the next business day. tipo_liquidacao can be a payment notice (AVISO DE PAGAMENTO REDE or AVISO DE PAGAMENTO COMPE) or the liquidation itself (REDE, COMPE, PIX and others). When Sicredi lists a notice and the liquidation of the same boleto, they are separate rows: filter by tipo_liquidacao before summing amounts.
  • Movimentações has every credit and debit posted to your Cobrança portfolio on each day: liquidations (credits) and charges such as fees (debits), with the payer and the account the amount was distributed to.
  • Boletos has the boleto’s own data (payer, issue and due dates, status, interest and discounts, liquidation date and amounts, expected credit date) for each boleto in Boletos Liquidados. Sicredi has no listing of all boletos: open, overdue or written-off boletos that were not paid inside the synced period are not available through the API.
Two identical rows listed together on the same day (for example a boleto paid twice with the same data) are kept as two rows, told apart by the ocorrencia column. In the financial movements, a row that Sicredi repeats on two pages is a copy and is saved once, as long as the rows kept add up to the total Sicredi announces. In the liquidated boletos, which have no total, a row repeated on two pages means another one was left out, so the run stops instead (see Troubleshooting).

Troubleshooting

Streams and Fields

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description. Amounts are decimals. Dates are the business dates Sicredi gives; the liquidation timestamp is in UTC. Lists of objects (the boleto’s discounts and credit distribution) are JSON text.
The connector was built from Sicredi’s Manual da API de Cobrança (version 3.9). Some values are not fully listed in the manual (for example every portfolio type); the first runs confirm them.

Fields by stream

One row per boleto liquidation that Sicredi lists for a day.Table: boletos_liquidados · Primary key: liquidacao_id · Sync: Incremental (dia_consulta), the last days re-read on every run
Every credit and debit posted to the Cobrança portfolio on each day (the “francesinha”).Table: movimentacoes · Primary key: movimentacao_id · Sync: Incremental (dia_consulta), the last days re-read on every run
The full data of each boleto listed in Boletos Liquidados, read from Sicredi’s boleto lookup (one request per boleto).Table: boletos · Primary key: cooperativa, codigo_beneficiario, nosso_numero · Sync: Incremental (dia_consulta)

Skills for agents

Download Sicredi Cobrança skills file

Sicredi Cobrança connector documentation as plain markdown, for use in AI agent contexts.