TED
TED Lerian publishes its permissions to the Access Manager
At startup, TED Lerian can publish its permissions to your Access Manager, so the Access Manager holds every TED Lerian permission without a manual load. It is off by default. When the Identity service does not answer, TED Lerian still starts and retries, and thedeclaration check in the GET /readyz body shows the result.To turn it on, set IDP_DECLARATION_ENABLED to true, with IDP_HOST and the IDP_M2M_CLIENT_ID and IDP_M2M_CLIENT_SECRET of an application with the source plugin-br-ted-lerian.Lerian ConsoleStreaming HubPaymentsLender
Lerian Console v3.3.0 Streaming Hub subscriptions, bill payments and Lender desks
Lerian Console v3.3.0 creates Streaming Hub subscriptions in a three-step wizard for webhook, pull, Amazon SQS, RabbitMQ and Amazon EventBridge destinations. The event catalog has a Subscribe button that opens the wizard with the event chosen, and the Console sets the credential of a queue destination. A subscription shows one status: Delivering, Failing, Awaiting verification or Stopped by the Hub. In Payments, you look a bill up at its source, then review and confirm the payment. The Console warns about a possible duplicate payment, and shows an unconfirmed payment as In confirmation. A boleto takes an optional nosso número, and its states read Registered, Not sent and Awaiting registration. In Lender, the Parked postings screen releases an accounting posting that stalled before Midaz. If you confirm that Midaz does not hold a posting that it does hold, Lender books it a second time. You can also archive loan products and close short retained instalments. Console fetches its license from the license service at every start and holds it in memory only.Pay bills with the digitable line. The Console refuses a barcode of 44 digits. Check the Bill Payments list before you send a payment again.Tracer
Tracer limit usage entry shows the scope it used
Each entry oflimitUsageDetails in the POST /v1/validations response, and in the validation record of a ledger reserve, now shows in scope the one scope object whose counter the transaction used: the first object of the limit that matches. Before, it listed every scope object of the limit, joined by OR. Records that Tracer wrote earlier keep the full list.If you read scope to find the counter that a transaction used, read it as one scope object, and expect the full list only in earlier records.Access Manager
Caradhras license file and readiness
Caradhras, the identity backend of Access Manager, can read its license from a signed license file that Lerian issues, set inLICENSE_FILE_PATH. When it is set, Caradhras ignores LICENSE_KEY and makes no call to the license service. With LICENSE_KEY, each start fetches the signed license from license.lerian.io. While the license service does not answer, Caradhras is not ready. A missing or refused license still stops the startup. The database migration step needs the same license.With LICENSE_KEY, keep outbound HTTPS to https://license.lerian.io open for Caradhras and for its migration step. Set LICENSE_KEY or LICENSE_FILE_PATH on the migration step too.SPBSILOC
Lerian Cabine shows STR and SILOC operators only what they may use
In the STR and SILOC workspaces, Lerian Cabine now hides the menu entries, screens and actions that the operator’s Access Manager permissions do not grant, as it already does in SPI. A saved link to a closed screen shows that the operator has no access. For example, the STR reconciliation case actions and the SILOC Executar control on homologation scenarios show only to theadmin role. The access page lists the groups that grant each role on Lerian SPB and Lerian SILOC. The SPB and SILOC pages list the permission of each control.Check that the Access Manager groups of your operators grant the Lerian SPB and Lerian SILOC permissions they use.Access Manager
Access Manager v3.20.0 license file and readiness
Auth and Identity can read their license from a signed license file that Lerian issues, set inLICENSE_FILE_PATH. When it is set, they ignore LICENSE_KEY and make no call to the license service. With LICENSE_KEY, they hold the signed license in memory only, so each start fetches it again from license.lerian.io. If the license service does not answer at startup, Auth and Identity stay up, not ready, and keep retrying instead of exiting. /readyz answers 503 until a license is accepted, and the main port opens only after that. A missing or refused license still stops the startup.With LICENSE_KEY, keep outbound HTTPS to https://license.lerian.io open on every Auth and Identity workload, and point readiness probes to HEALTH_PORT.TED
TED Lerian license in memory
WithLICENSE_KEY, TED Lerian holds the signed license in memory only, not in PostgreSQL. Each start fetches the license again from license.lerian.io. If the license service does not answer, TED Lerian stays not ready and keeps retrying until it answers.With LICENSE_KEY, keep outbound HTTPS to https://license.lerian.io open on every TED Lerian workload, restarts included.Lender
Lender v4.1.0 archived products, desks and chart of accounts
Lender archives and restores loan products: an archived product originates nothing new, and the contracts already written stay as they are. A partial prepayment quote can shorten the term or lower the instalments, and consignado keeps the instalment. A renegotiation at 0% is accepted as a restructuring concession. New operator desks release a posting that stalled before Midaz and close a short retained instalment of a sold consignado contract. A write-off closes a consignado contract that the payroll rail excluded. Reversing a payment after the refund desk paid the borrower reopens the contract and opens a returned-payment receivable. The refund desk covers renegotiated contracts. Charts of accounts book the incurred loss and the additional provision on separate allowances. Probes and metrics move to the health port, and the license can come from a mounted signed file.If you configured a chart of accounts before v4.1.0, add the incurred pair of posting rules before the provisions of contracts in default post. The quick start shows the rules. The database migration job needs a license. SetLICENSE_KEY or LICENSE_FILE_PATH, or the migration does not start.Pix
Pix BTG v1.15.0 license file and unrecorded outcome
Every Pix BTG component can load a signed license file throughLICENSE_FILE_PATH, as an alternative to LICENSE_KEY. See the environment variables. If the license service does not answer at startup, the components wait, not ready, and keep retrying instead of exiting. A new idempotency answer, 422 PIX-3005, tells you that the first request under the key ran but its outcome was not recorded.On PIX-3005, reconcile the original operation. Do not resend it, and do not use a new key.Access Manager
Access Manager refuses a partner permission that no request can use
When you create or change a partner, Access Manager refuses a permission that no request of that partner can use inside its scope. This applies to products that publish which scope items their routes carry, such as Lender from v4.1.0. The answer is400 IDE-1052, and its message names the product, the resource and the action.Remove that permission from the partner, or change its scope.Payments
Payments BTG v1.3.0 Pix key history
Payments keeps a history of every change to the Pix key that hybrid boletos charge into.GET /v1/admin/pix-config/history lists it, with CPF, e-mail and phone keys masked. Subscribe a webhook configuration to the new PIX_KEY_CHANGED event to hear of each change. Payments can also read its license from a license file that Lerian issues, set in LICENSE_FILE_PATH.Add PIX_KEY_CHANGED to enabledEvents if you want to track key changes.Streaming Hub
Streaming Hub v3.3.0 delivery status on subscriptions
A subscription read, the list or a single subscription, returnslast_success_at and last_failure_at. You can tell that a destination is failing without calling the health read. For Consignado partners, the subscription of an originador receives the result of its own pre-auction quotes (consignado.cotacao.resolved), and the subscription of a fund receives the failed FGTS block of a contract ceded to it (consignado.garantia.block_failed).Use last_failure_at to monitor your destinations.Lerian Console
Lerian Console v3.2.0 license key
Lerian Console v3.2.0 does not start without a Lerian license key inLICENSE_KEY, and its readiness check answers 503 until the license service accepts the key. The Console pages also describe account plans in the Fees Engine screens, the Tracer settings of a ledger, the Scheme field of a new transaction, passkey sign-in, and the Settings and Authorization areas.Before you upgrade, set LICENSE_KEY on your Console deployment, and allow outbound HTTPS from the Console to license.lerian.io. Grant the read permission on users to each administrator who opens Authorization.Consignado
Lerian Consignado 4.4.0 health port and partner subscriptions
The Consignado pages and API reference moved to Lerian Consignado 4.4.0. A fund or an originador manages its own event subscriptions with its partner credential. New facts announce the FGTS guarantee execution window, a failed FGTS block, and the deactivation or reactivation of an originador or a fund. Your back office can close a parked origin-side portability exclusion.GET /v1/consignado/fundo/creditos is removed.Before you upgrade, set HEALTH_PORT, and point the readiness probe and the metrics scrape to that port: the main port no longer serves /readyz or /metrics. Move a fund that reads its credits on the removed route to GET /v1/consignado/fundos/{fundo_id}/contracts, with the fund’s partner credential. Partner subscriptions need Streaming Hub 3.2.0 with STREAMING_HUB_PARTNERS_URL set. In a single-tenant deployment, also set SUBSCRIPTIONS_HUB_CLIENT_ID and SUBSCRIPTIONS_HUB_CLIENT_SECRET.Pix
Pix BTG v1.14.1 MED refunds
A cash-out withX-Purpose: INSTANT_PAYMENT_REFUND to an account at another institution needs contestedMedRootTransactionId in the body: the rootTransactionId of the funds recovery contested in the MED. After trimming, the value has exactly 32 letters, digits or underscores. A missing value answers 400 PIX-0481, and a malformed value answers 400 PIX-0482. A cash-out inside your institution ignores the field.Add contestedMedRootTransactionId to every INSTANT_PAYMENT_REFUND cash-out to another institution. To return a received Pix, use the refund operations.TED
TED Lerian health port and unbound ISPBs
TED Lerian serves/readyz and /metrics only on the port in HEALTH_PORT. The main port keeps /health and /version. A customer TED that arrives through an ISPB with no binding is not credited, and in a single-tenant installation TED Lerian returns it to the sending institution with reason 2. An internal transfer to a closed account answers 422 TED-1021, and an operator credit to a closed account answers 422 TED-0002. An incoming TED shows ledgerCreditId and ledgerRevertId when they exist.Before you upgrade, set HEALTH_PORT, and point the readiness probe and the metrics scrape to that port. Bind every ISPB through which your institution receives TEDs.Tracer
Tracer limit check, license and health port
The Tracer pages and API reference follow the newest Midaz build.POST /v1/validations runs your rules, then checks an ALLOW against your spending limits, with the current usage and the capacity that held reservations take. It moves no counter: only a transaction that the Midaz ledger reserves with Tracer in advisory or enforce mode consumes a limit. A requestId that you reuse with a different body, or on the other validate route, answers 409 with code 0084. GET /v1/validations/{validation_id}/reservations lists the holds of a ledger transaction. Rules can read transactionAmount, and a reserve with several source accounts records the outcome of each source.Before you upgrade, set LICENSE_KEY or LICENSE_FILE_PATH: Tracer does not start without a license. Set HEALTH_PORT, and point the readiness probe and the metrics scrape to that port: the main port no longer serves /readyz or /metrics. Review the rules and limits whose scope holds a blank sub type. The upgrade removes those scope alternatives: an active rule left with no scope becomes inactive, and a limit left with no scope counts nothing.FlowkerLerian Console
Flowker v1.6.0 webhook paths and runs
A webhook trigger path can end in one{name} segment, such as orders/{orderId}. The workflow reads the value at _webhook.params. A workflow owns its webhook path until you delete it, so deactivating a workflow does not free the path for a new version. A failed synchronous run answers 502 on every response view, and a passthrough view no longer relays the provider’s error. The workflow list shows the last run of each workflow, an execution records who started it and the step where a failed run stopped, and the results of a waiting execution are readable. The per-tenant pin of a catalog service’s spec version is removed, with PUT /v1/catalog/openapi-version-pins/{service} and GET /v1/catalog/openapi-versions/{service}. In Lerian Console, the Flowker dashboard opens with what needs attention, and a Settings page sets execution retention.Give each new version of a webhook workflow its own path, or delete the old workflow first. Update callers that treat a failed synchronous run as a 200 or that read the provider’s error through a passthrough view, and remove calls to the two removed catalog routes.Streaming Hub
Streaming Hub v3.2.0 tenant on deliveries and retention loss
A single-tenant Streaming Hub attributes every event to its configured tenant and sends no tenant identity on deliveries: noX-Lerian-Tenant-Id header and no ce-tenantid attribute. A pull read returns retention_loss: null, or the range of events that retention removed before your subscription read them. Streaming Hub verifies a pending webhook by itself: the first probe comes about one minute after you create the subscription, and the interval doubles up to one hour. A failed probe no longer changes the subscription state, and the upgrade returns each degraded subscription to active, so it receives events again. When your webhook answers 429, Streaming Hub holds the subscription for your Retry-After, 30 seconds when you send none, and at most one hour.If your consumers read the tenant from deliveries, use the tenant in STREAMING_HUB_TENANT_ID. Handle retention_loss in pull consumers.ConsignadoLerian Console
Lerian Consignado pre-auction between originadores
Lerian Consignado 4.4.0 can run a pre-auction before the bid. Several originadores, and your own account, quote the same loan request, each through a fund. The gateway elects one quote by the rule you configure: window, criterion, preferred fund, closing and rotation. It reserves the capacity of that fund and sends the elected quote to Dataprev. You set a policy and limits for each fund, and the funds that each originador can quote for. An averbação that cites a quote must name the fund of that quote. Theconsignado.solicitacao.received fact carries the quote deadline, and each quote ends with a consignado.cotacao.resolved fact. In Lerian Console, the Pre-auction, Pre-auction funds and Pre-auctions screens, the quote mode of the Auction form and the Funds button of each originador manage the pre-auction.The pre-auction is off by default. To use it, set CONSIGNADO_PRELEILAO_ENABLED to true, with DATAPREV_ENABLED, LEILAO_ENABLED, LEILAO_CLIENT_BID_ENABLED and CONSIGNADO_BID_RECONDUCTION_ENABLED also set to true. Give your roles the pre-auction, fund mandate and decline permissions, then save a pre-auction configuration.Pix
Pix Lerian v1.3.0 scheduled Pix
Pix Lerian sends a scheduled Pix by itself on its date, with up to three attempts in America/Sao_Paulo time: from 00:00 to 07:59, from 18:00 to 19:59 and from 20:00 to 20:59. Each component serves its health and readiness probes onHEALTH_PORT. DICT VSync checks each scope at least every 12 hours, and with the default scan interval VSYNC_GATE_TTL_SEC cannot go below 45540. Decode QR Code answers 422 PIX-0228 for a charge that can no longer be paid, and a lost database connection answers 503 PIX-0062: read the resource before you retry.SPI
Lerian SPI HSM key and QR resolve codes
The Lerian SPI pages and API reference moved to the newest Lerian SPI build. WithBACEN_TLS_KEY_KIND=kmip, the private key of the BACEN mutual-TLS certificate stays in your KMIP HSM. Each refusal of the dynamic QR resolve has its own code, SPI-0020 to SPI-0025. The donor-side dict_claim.received event carries the claimer and the account that the key would move to.If you branch on SPI-0003 for the QR resolve, branch on the new codes.TED
TED JD v3.5.1 returned TED OUT refunds
A return that arrives before a TED OUT completes is parked: the TED shows on the pending reconciliation list withTED_OUT_DEVOLUTION_PARKED, and the plugin sends transfer_outgoing.devolution_notified. When the TED completes, an operator of your institution refunds the payer with the REFUND action of Resolve Transfer Reconciliation. Close TED IN Reconciliation Gaps closes the open gaps of a time window after a person checks the JD statement. Automatic returns of received TEDs go out inside the operating window of returns.Review your operator process for returned TEDs and your event consumers.SPBSILOCSPI
Lerian SPB resgate purpose and Lerian Cabine permissions
A resgate from the Conta PI to the reserve account takesfinalidadeLPI 1, for the institution’s own movement or a transfer to an account at a liquidante in the STR, or 2, for the return of an aporte received in error. With 2, the request also carries originalControlNumber, the STR control number of that aporte. Any other value answers 422, a zero-padded 01 included. The STR schedule read shows whether the additional window is open. Lerian SILOC raises a PARTICIPANT_EXCLUDED alert when a PAG0101 excludes a participant, and reads CORS_ALLOWED_ORIGINS for browser clients such as Lerian Cabine. In the SPI workspace, Lerian Cabine hides the gated actions that the operator’s Access Manager permissions do not grant.Send finalidadeLPI as 1 or 2 with each resgate to the reserve account. Check that the Access Manager groups of your operators grant the SPI permissions they use.STA
Lerian STA v1.3.0 held uploads and refused credentials
Lerian STA keeps an outbound file waiting through a BACEN STA outage, a connection fault or a refused password, at most until BACEN’s 48-hour upload deadline. The wait spends none of the file’s attempts, and Retry brings a held upload forward. When BACEN refuses the password of a credential, Lerian STA marks the credential refused. An operator enters the current password withPUT /v1/credentials/{id}/current-password or in Lerian Cabine, and the held files go out at once.BC Correios
Lerian BC Correios v1.1.0 events
Lerian BC Correios publishes nine events to Kafka onlerian.streaming.br-correios: for received, read, archived and restored mail, the first synchronization, a confirmed or failed send, and the AI analysis. It needs a Kafka broker, and each installation serves one institution. Settings carry a version: send the version you read back as expectedVersion in every settings change. A save that another save overtook answers 409 BCC-0013.SISBAJUD
Lerian SISBAJUD executor v1.2.0
The executor stops posting a court result afterEXECUTOR_RESULT_MAX_ATTEMPTS failed attempts, 12 by default: it parks the result, records a human decision and raises an alarm. Later versions of the same order wait behind a parked result. When Midaz is unavailable at the cut of an order, the executor hands the order to a human decision and sends no result. A block order with a minimum amount goes to a human decision when the executor can block less than that minimum. In a single-tenant installation, an institution can move to the direct channel and send its orders to the executor directly. The executor no longer reads ORGANIZATION_IDS.Include parked results and orders handed over at the cut in your review of human decisions.Tracer
Tracer validation origin and license storage
A Tracer validation record of a transaction that the Midaz ledger reserves now carries theorganizationId and the ledgerId of that transaction. Retrieve a validation and each List validations result return both fields. Records of POST /v1/validations and of rules-only requests carry neither, and neither do records written before the upgrade.Use organizationId, ledgerId and transactionId to link a record to its ledger transaction. With LICENSE_KEY, Tracer holds the signed license in memory only and stores no license in PostgreSQL. Each restart fetches it from the license server again, and while that server does not answer, the restarted Tracer stays not ready.Flowker
Flowker v1.5.0 Pix JD provider
Flowker v1.5.0 includes the nativepix-jd provider for workflow nodes. Read the integration guide for provider configuration.Access Manager
Access Manager v3.17.0 readiness
Access Manager serves readiness on a separate health port. Before you upgrade, setHEALTH_PORT for Auth and Identity and point their readiness probes to that port.Lender
Lender v4.0.0 origination
Lender finds or registers each borrower as a holder in Midaz CRM during origination. Before you upgrade, complete the Lender prerequisites.Lender
Lender in Lerian Console
The Lender module in Lerian Console provides screens for loan operations. An administrator can turn it on under Settings, Products. The module requires Lender v4.0.0.Midaz
Midaz Go SDK v6.5.0 idempotency
The Midaz Go SDK no longer generates a random idempotency key by default. Without your own key, Midaz treats an identical transaction create within the idempotency window as a repeat. Set a distinct key for each transaction you intend to post.Pix
Pix BTG v1.14.0 refunds
A Pix BTG refund request needsX-Idempotency or X-Return-End-To-End. Add at least one of these headers to refund requests before you upgrade.Pix
Pix JD v1.6.1 readiness
Pix JD serves readiness and metrics onHEALTH_PORT. Before you upgrade, point the readiness probe and metrics scrape to that port and set a global production key in LICENSE_KEY.Reporter
Reporter v4.8.0 readiness
Reporter serves readiness onHEALTH_PORT. Before you upgrade, set HEALTH_PORT and point readiness probes to that port.Payments
Payments BTG v1.2.0 hybrid boletos
A hybrid boleto can also be paid by Pix. Before you issue one, configure the Pix key and receiver address.Pix
Pix Automático daily limit
Lerian configures a daily limit for individual CPF payers on request through Lerian Clients. If no limit is configured, no daily limit applies.Consignado
Lerian Consignado 4.2.0 license and portability booking
The Consignado pages and API reference moved to Lerian Consignado 4.2.0. The gateway needs a Lerian license in every deployment mode and does not start without one.numero_ccb accepts at most 20 characters. The bank’s cessão registration operation is gone, and the gateway records a cessão from Lender’s assignment fact.An accepted averbação by portability now waits for its documentation. Document it through the CCB attachment, as an averbação. With the booking block, which lists each paid-off origin contract in origins[], Lender books the contract once Dataprev confirms its documentation and its status record shows exactly those origin contracts. This booking requires Lender 4.0.0 or later; upgrade Lender before gateway 4.2.0. The origin institution’s exclusion must run first, because Dataprev refuses an earlier averbação with rule PT.Your back office reads the held repasse records in the held block of the repasse expectations and releases each one with POST /v1/consignado/reconciliation/held-repasses/{id}/release.The gateway publishes five new event types. consignado.refinanciamento.efetivado, consignado.refinanciamento.revertido and consignado.refinanciamento.recusado report the outcomes of a refinancing. With DATAPREV_MIGRACAO_ENABLED on, consignado.migracao.efetivada reports a contract that Dataprev moved to a new employment bond. consignado.certificate.expiring is published before the Dataprev certificate expires.Auction and portability discovery run for every tenant with a complete Dataprev custody, and LEILAO_TENANT_ID is gone. The automatic renegotiation is gone: every renegotiation comes from your renegotiation request.Before you upgrade, set LICENSE_KEY on every workload and allow outbound HTTPS to https://license.lerian.io. Upgrade Access Manager to 3.14.0 or later before an originador calls a route without an originador id. After a tenant migrates, do not roll the gateway back to 4.0.0. Turn on DATAPREV_AVERBACAO_ENABLED and set AVERBACAO_ARTIFACTS_BUCKET if you send averbações by portability, or the route answers 501.A rail command whose outcome Dataprev leaves unknown answers 503 OUTCOME_UNKNOWN. Do not send it again: the same key answers 409 RAIL_COMMAND_OUTCOME_UNRESOLVED. Read the rail commands, and close a parked refinancing, renegotiation or terms change from what the Dataprev portal shows. When a 503 DATAPREV_UNAVAILABLE says the command closed refused, send it again under a new X-Idempotency key. A subscription that lists event types receives none of the five new ones. To receive them, create a tenant-wide subscription that lists their keys from GET /v1/catalog, such as consignado_migracao.efetivada. If booking answers 422 LOAN_PRODUCT_VERSION_UNKNOWN for a Lender product version created before the gateway’s link to your tenant, create a new version. If the version was just created, wait for it to arrive and retry. A custom Access Manager role needs rail-command-close:execute to close a parked refinancing, renegotiation or terms change and held-repasses-release:execute to release a held repasse.Tracer
Tracer spending limits consumed only through the Midaz ledger
Only a transaction that the Midaz ledger reserves with Tracer inadvisory or enforce mode consumes a spending limit. Tracer records each reserve decision as a validation with the transactionId of the ledger transaction. GET /v1/validations and GET /v1/validations/{validation_id} return that field, and GET /v1/validations filters by transaction_id. Tracer no longer reads API_KEY_ENABLED_ONLY_VALIDATION.Before you upgrade, create each transaction whose spending you count in Midaz with Tracer in advisory or enforce mode: POST /v1/validations does not consume a limit. If a client calls POST /v1/validations or POST /v1/validations/rules-only with the API key alone while plugin authentication is on, give it an Access Manager credential. Remove API_KEY_ENABLED_ONLY_VALIDATION from your Tracer configuration.Correction on November 7, 2026: an earlier version of this entry said that POST /v1/validations was removed. The route is available, and it checks your rules and limits without consuming them. See the November 7 Tracer entry.SPB
Lerian SPB license and split BACEN answers
The Lerian SPB pages and API reference moved to the newest Lerian SPB build. Lerian SPB needs a license in every environment, development included, and does not start without one. The license is global: the rail reads no organization identifier. A refused license answers403 with an LCS- code on every route under /v1/str, and /readyz reports a license check. When a split BACEN answer still lacks a part 30 minutes after its first part, the rail opens a PARTITIONED_MESSAGE_INCOMPLETE reconciliation case.Before you upgrade, set LICENSE_KEY on every Lerian SPB workload. Include PARTITIONED_MESSAGE_INCOMPLETE cases in your reconciliation routine.SPI
Lerian SPI license and the resend of a Pix that never left
The Lerian SPI pages and API reference moved to the newest Lerian SPI build. Every Lerian SPI binary needs a license to start, in every environment, and stops when the license is refused. A Pix payment that endedFAILED with 503 and SPI-1001 or SPI-1004 can be sent again. Send the first request again under the same X-Idempotency key, or send the same request under a new key with the endToEndId of the failed payment. The rail sends it as a new attempt on the same payment and publishes spi_payment.initiated again. An approval request takes only the subject type MANUAL_RESOLUTION.Before you upgrade, set LICENSE_KEY on every Lerian SPI binary. If a consumer acts on spi_payment.failed, let it accept a later spi_payment.initiated for the same payment.SILOC
Lerian SILOC license and the cycle reconciliation
The Lerian SILOC pages and API reference moved to the newest Lerian SILOC build. Lerian SILOC needs a license in every environment and does not start without one. A request that the license refuses answers403 with an LCS- code. GET /api/v1/siloc/cycles and GET /api/v1/siloc/cycles/{cycleId} carry the cycle’s reconciliation, and the separate cycle reconciliation read is gone. GET /api/v1/siloc/ot-multilateral-results/{noticeId} returns the multilateral result that a reconciliation names in resultNoticeId. An SLC0004 request ends REFUSED when its SLC0004R1 answer carries a situation other than success. A DISPATCHED LTR0002 or LTR0008 whose LBTR cycle ended with no R1 is held for an answer, and two operators can close it.Before you upgrade, set LICENSE_KEY on Lerian SILOC. Read the reconciliation of a cycle from the cycle reads. Handle REFUSED on your SLC0004 requests.SCR
Lerian SCR license
The Lerian SCR pages and API reference moved to the newest Lerian SCR build. Lerian SCR refuses to start without a Lerian license, in every environment, and no setting turns the check off. Alicense check that is down turns /readyz to 503.Before you upgrade, set LICENSE_KEY on Lerian SCR.TED
TED Lerian installation license
The TED Lerian pages and API reference moved to the newest TED Lerian build. TED Lerian checks one license for the whole installation when it starts, and checks it again in the background. The service does not start with an emptyLICENSE_KEY, in any environment, and it stops when the license is refused. It no longer reads LICENSE_ENABLED, LICENSE_APPLICATION_ID, or ORGANIZATION_IDS.Set LICENSE_KEY on every TED Lerian workload, and allow outbound HTTPS to https://license.lerian.io. Remove LICENSE_ENABLED, LICENSE_APPLICATION_ID, and ORGANIZATION_IDS.Pix
Pix BTG v1.13.0 intra-PSP settlement and parked operations
The Pix BTG pages and API reference moved to v1.13.0. An intra-PSP Pix and its refund each settle in one Midaz transaction, with no@external leg. The plugin checks the payee first, so a denied payee causes no debit. A Pix to the payer’s own account is refused with PIX-0460. When the outcome of the Midaz debit of a cash-out is unknown, the process call answers 201 with the cash-out at CREATED, and the plugin sends no Pix. Unblock refuses an inter-PSP cash-out or refund at CREATED with 422 PIX-0470. Each client webhook notification carries one Idempotency-Key, and a re-sent notification carries the same key.If you reconcile or report on the ledger, read an intra-PSP Pix as one transaction between the two accounts. For an inter-PSP cash-out or refund at CREATED, open a support request with Lerian and give the transfer or refund id. Deduplicate client webhooks on Idempotency-Key.Access Manager
Access Manager v3.15.0: enroll a required MFA method during sign-in
In Access Manager v3.15.0, when the organization requires an MFA method that a user has not enrolled, sign-in answersAUT-0019 with an MFA token that is valid only for enrollment. The user sets up and confirms the method with Start MFA enrollment and Confirm MFA enrollment, and then completes the MFA challenge.Handle AUT-0019 on Request Access Token and on Verify MFA Login.SPB
Lerian SPB certificate activation and the two-operator close
The Lerian SPB pages and API reference moved to the newest Lerian SPB build. The rail reads the certifier code of an activation from the issuer of the certificate, so the activation request no longer carriescertifierCode, and a body that sends it answers 422. A certificate that you rotated before this release has no recorded certifier code, and its activation answers SPB-0003. Each statement day of a compulsory-deposit filing carries mode, I or A. Two operators can close as failed any message past its settlement deadline, not only a transfer, and can declare an LDL or LTR leg from an STR answer that the rail held unread. The rail now closes an LDL or LTR leg that it never sent when its STR grade closes or the day ends.Before you activate a certificate that you rotated before this release, rotate it again. Remove certifierCode from your activation requests. Send mode on each day of a compulsory-deposit filing.SPI
Lerian SPI Pix Automático answers and DICT query blocks
The Pix Automáticopain.014, camt.029, and camt.055 requests of Lerian SPI take only the decision. The rail reads the participants and the identifiers from the message that it recorded, and any other field gets 422. The DICT query block takes and returns payerId, the CPF or CNPJ of the end user, in place of payerIdHash. Upgrading removes every DICT query block.Send only the decision fields on these three requests. After you upgrade, place each DICT query block again with payerId.SILOC
Lerian SILOC held requests and the LBTR cycle
The Lerian SILOC pages and API reference moved to the newest Lerian SILOC build. Two different operators can now close an outbound request that is held for an answer Núclea never sent.GET /api/v1/siloc/outbound/messages takes held=true to list these requests. A FAILED request can therefore be one that Núclea may have received, and its studio.lerian.br-siloc.siloc_outbound.failed event carries the reason. An LTR0002 or LTR0008 for an operation whose earlier answer is live answers 409 and SILOC-0026. A 503 and SILOC-0002 now means the command did not run.Do not treat a FAILED request as proof that it never reached Núclea. List the held requests. Have two operators close one only after you confirm with Núclea that it will not answer. Handle SILOC-0026 in your integration. Send a request refused with SILOC-0002 again with the same X-Idempotency key.TED
TED Lerian return errors and the daily close
The TED Lerian pages and API reference moved to the newest TED Lerian build. On the two incoming-return actions,TED-1011 is an HTTP 422. A return whose rail answer is unknown (TED-1010) stays requested until reconciliation or manual review closes it. When the ledger refuses a revert (TED-1001), the credit stays and the incoming transfer goes to manual review. At the daily close, a pending TED that the rail does not know moves to AWAITING_RECONCILIATION. Incoming return events carry previousStatus.Handle TED-1011 as a 422 on the return actions. After a TED-1010 on a return, read the status of the TED before you act again. Accept AWAITING_RECONCILIATION for a pending TED.Lerian ConsoleMidazReporter
Console v3.0.0 optional operation routes and fee rounding
The Console pages moved to Console v3.0.0. An accounting route can mark an operation route as optional, and a transaction may leave an optional route unused. The Console checks the route at Go to Review and again when you send. A fee package can round every fee it charges, with Midaz 4.4.0 or later. Most screens show dates and times in Brasília time, whatever the time zone of your browser. The Reporter screens group regulatory documents under Regulatory Filings: Catalog, My Regulatory Documents and Filings.Review your accounting routes, and mark as optional each operation route that some transactions leave unused.Reporter
Reporter v4.6.0 license key, report calendar, and filing periods
The Reporter pages and API reference moved to Reporter v4.6.0. Reporter does not start without a Lerian license key inLICENSE_KEY. When REPORT_TIMEZONE is unset, report days and filing periods follow America/Sao_Paulo. Each regulatory filing records its period and its remittance, original or replacement. A mapping can join and compute on any read, read MongoDB lists and nested fields, and read one set from several data sources. You can preview one query of a mapping and read the rows of a filing. Report filters accept startsWith, notStartsWith, isNull, and notNull. A nin filter on PostgreSQL also returns the rows with no value. The role of reporter-contributor-group is now operator, with the same access.Before you upgrade, set LICENSE_KEY for every Reporter process. If your books close on UTC, set REPORT_TIMEZONE=UTC. Review the reports that filter with nin on PostgreSQL. Rewrite each saved mapping that uses sign, statedIn or accumulate, because Reporter v4.6.0 does not load it.Tracer
Tracer in Midaz 4.4.0 checks configuration values at startup
In Midaz 4.4.0, Tracer does not start when an environment variable holds a value that it cannot read, and the error names the variable. For example,API_KEY_ENABLED=1 and AUTH_CACHE_TTL=60 stop the start. Tracer also checks the STREAMING_* values when streaming is off.Before you upgrade, write each boolean variable as true or false, and each AUTH_TIMEOUT and AUTH_CACHE_TTL with a unit, such as 60s. Environment variables lists the checks.Midaz
Midaz 4.4.0 upgrade: configuration values and duplicate aliases
In Midaz 4.4.0, the Ledger does not start when an environment variable has a value that it cannot read, and the error names the variable. A boolean accepts onlytrue or false, a number must be a whole number, and a duration needs a unit, such as 12s. The onboarding migration stops if a ledger has two accounts with the same alias or two assets with the same code. Deleted accounts and assets do not count. The migration lists the duplicates, and Midaz does not merge or delete them.Before you upgrade, check your environment values. If the migration stops, contact Lerian before you run the upgrade again.Midaz
Midaz 4.4.0 account plans and fee charges
The Fees pages and the Ledger API reference moved to Midaz 4.4.0. An account plan is a set of fees that you assign to an account, with a free quota for each fee and calendar month. On the/v2 transactions that an account with an active plan sends, the plan charges that account instead of the fee packages. You charge the service fees of a plan with a fee charge, and the usage read returns the units of an account in a month. A fee package can round every fee it charges with rounding. Get balance totals by key and asset returns the available and on-hold totals of the balances of one key and asset in a ledger.To use account plans, give the account-plans and fee-charges permissions of Midaz to the applications that call them. Using account plans shows each step.PixTED
JD Courier v1.2.0 cross-core relay, account claims, and Pix transit
The JD Courier pages and API reference moved to v1.2.0. The Courier relays a TED credit or return, or a Pix cash-in or refund, between two engines of your institution. Cross-core relay gives the contract that each engine follows, the other core included. An engine can claim its accounts, the CNPJs of its Pix Automático chargers, and the charger side of its recurrences. With the Pix transit, the engines also send their Pix calls to JD through the Courier. One engine can hold several Access Manager applications, one for each product that calls the Courier.JD calls the Pix address of the Courier as an Access Manager partner of your installation. Set up the partner as Access Manager describes. Operators no longer declare an SPB bypass. JD Courier environment variables lists the variables of the Courier.SISBAJUD
Lerian SISBAJUD v1.1.0 AWS KMS key custody, order records, and executor roles
The Lerian SISBAJUD pages and API reference moved to the Mensageria v1.1.0 and the executor v1.1.0. With AWS KMS,KMS_AWS_KEY_MODE sets the key custody of each component. In managed mode, the component creates its keys for each institution. In provided mode, you create the keys, and the component records each rotation that your key custodian makes. AWS KMS on the Mensageria lists the key requirements and the AWS permissions.The Mensageria records the notice of an incoming judicial transfer (record 08). A block response file answers it with the code 01. The Mensageria parks the clarification requests (record 09) and the interruptions of a permanent block (record 10). Answer a parked clarification request manually. After a parked interruption, new credits can stay blocked until you stop the block manually.The executor declares the roles viewer, operator, investigator, cross-org-reader, admin, and platform-admin. Roles lists the permissions of each role. A key rotation can return the new codes SBJ-0012, SBJ-0013, and SBJ-0014. The error list describes them.TED
Bank Transfer v3.4.0 cross-core TED and fee labels
The TED JD pages and API reference moved to Bank Transfer v3.4.0. When your institution runs two cores on one ISPB, a TED between your two cores goes through the JD Courier relay as a cross-core TED, with the transfer typesCROSS_CORE and CROSS_CORE_IN. The plugin commits the hold when the other core credits the recipient, and releases it when the other core refuses the credit on the first attempt. A cross-core TED needs the tenant policy onus.shared_ispb_gate_enabled, the JD Courier variables, and the CROSS_CORE_OUT, CROSS_CORE_IN, and CROSS_CORE_RETURN_IN ledger routing bindings.In native fee mode, an initiation can carry a fee label in feeContext, and a fee package on the payer’s ledger selects on it. A label that no package selects is refused with 422 BTF-0008. The event catalogues added TED JD events, with the payload of each event.SPB
Lerian SPB grade close and queue-manager outages
Lerian SPB resends a message that has not left, with no attempt limit. After the close of its STR grade on its movement day, the rail closes such a message asFAILED without sending it. A transfer or a movement then reports settlement.failed. The rail does not close an LDL or LTR message this way. The rail marks a transfer that a send may have delivered as SENT. That transfer waits for BACEN’s answer or for operators to close it as failed. DISPATCH_MAX_AUTO_ATTEMPTS is gone.While the connection to the queue manager is down, the rail keeps serving reads. It refuses each request that would send a new STR message with 503 and SPB-1001, and it stores nothing for that request. Handle SPB-1001 in your integration: send the request again with the same X-Idempotency key when the connection comes back.SPI
Lerian SPI direct-participant requests and regulatory archive
Lerian SPI sends the connectivity test, the Conta PI report request, the MED 2.0 settlement report, and the responsáveis registration as your direct participant. It does the same for the Pix Automático mandate and schedule requests, their accept or reject answers, and their cancellations. Their request bodies take noparticipantIspb, and a body that carries it gets 422. The schedule cancellation also takes no counterpartyIspb or requestedBy. GET /api/v1/spi/responsibles returns the responsáveis of your direct participant. The rail archives each ICOM envelope and each DICT request and answer. A user with the resource br-spi-regulatory-archive reads one archived item through GET /api/v1/spi/regulatory-archive/{itemId}. For a sent Pix that BACEN did not answer, manual resolution declares it SETTLED or REJECTED, under an approval that names that outcome.Remove participantIspb, counterpartyIspb, and requestedBy from those request bodies. Set the regulatory archive variables for the spi and dict binaries: outside a development environment, they do not start without a bucket.STA
Lerian STA v1.2.0 idempotency keys
The Lerian STA pages and API reference moved to Lerian STA v1.2.0. Transfer creation and the manual inbound poll need anX-Idempotency header. A request without it returns 400 with STA-0001. For 7 days, a repeat with the same key and the same request returns the first successful response, and Lerian STA does not create the transfer or run the poll again. The same key with a different request returns 422. Lerian STA has no multi-tenant mode: one installation serves one client, and Lerian STA no longer reads DEFAULT_TENANT_ID. Lerian STA events carry the tenant default in ce-tenantid.Before you upgrade, send an X-Idempotency key with each transfer creation and each manual poll. Keep the same key when you retry the same request. If your event consumers filter on ce-tenantid, set the filter to default. Lerian CCS v1.0.0 submits its ACCS001 batches without an X-Idempotency header, so Lerian STA v1.2.0 refuses them. If you run Lerian CCS v1.0.0, keep Lerian STA on v1.1.0.SILOC
Lerian SILOC LBTR close and Núclea outages
Lerian SILOC refuses anLTR0002 or LTR0008 decision sent through the API at or after 17h30 Brasília with 422 and SILOC-0025, and stores nothing. An unsent request ends FAILED when its time runs out: LTR0002, LTR0008, and SLC0004 at 17h30 of their movement day, and the other codes when their movement day ends. Each FAILED request publishes studio.lerian.br-siloc.siloc_outbound.failed. REDIS_DB, CERT_READINESS_MIN_DAYS, SFN_CUSTODY_CACHE_ENTRIES, and XSD_VALIDATOR_TIMEOUT_SEC must hold an integer, or the service does not start.While Núclea’s SILOC queue manager cannot be reached, the service stays in rotation. It refuses each new outbound request with 503 and SILOC-0024, and it stores nothing. Handle SILOC-0025 and the FAILED outcome in your integration. Send a request refused with SILOC-0024 again with the same X-Idempotency key when the connection comes back.SCR
Lerian SCR during a BACEN outage
During a BACEN outage, Lerian SCR stays in rotation:scr_endpoint reports the outage, and /readyz does not turn to 503. A consultation that never reached BACEN answers 503 with SCR-1002, and its detail names BACEN. Review the alerts that use the readiness of Lerian SCR to detect a BACEN outage.Pix
Pix JD v1.5.0 fee labels, Tracer refusals, and QR hosts
The Pix JD pages and API reference moved to v1.5.0. A payment order can carry a fee label infeeContext, and the Midaz fee package that selects on the label prices the Pix. A label that no fee package of the payer’s ledger selects on answers 422 PIX-0162, and nothing is held. When your Tracer refuses the credit of a received Pix, the Pix waits as PENDING with pendingReason TRACER_DENIED. An operator of your institution can return it to its payer, or credit it once your Tracer lets the credit through. Each direct participant can publish its dynamic QR codes on its own host.Make sure that your integration accepts TRACER_DENIED in pendingReason. To price Pix by label, see Price a TED or Pix by a fee context. To move the QR host of a participant, follow Dynamic QR code hosting.TED
TED Lerian fees through your Midaz fee packages
TED Lerian charges fees only through the Midaz fee packages of your ledger. TED Lerian labels each posting withtedOperation (ted_sent, ted_internal, ted_received or ted_refund) and tedPurposeCode, so a package can select on them. A package that does not select on tedOperation can also price incoming TEDs and refunds. The fee quote is an estimate, and the feeAmount of a transfer shows the fee that Midaz charged the sender.Before it holds any money, TED Lerian checks the purpose code against the BACEN FinlddCli domain (TED-0003) and the check digits of the recipient’s CPF or CNPJ (TED-0007). A loaded holiday year covers every date in it, and a date whose year is not loaded gets 503 TED-0022. Scope your fee packages with these labels, and load the holiday calendar of each year before it starts.Streaming Hub
Streaming Hub v3.0.0 averbação facts for funds and originadores
A subscription scoped to a fund or an originador can receive the four averbação facts of Lerian Consignado. An originador receives them only whenoriginador_ref names it, and a fund only when remetente_fundo_ref names it.A scoped subscription that omits event_types receives them with no change to the subscription. A scoped subscription that lists its event types receives only the types it lists, and its event types cannot change. To receive another averbação fact, create a new subscription that lists it.Pix
Pix BTG v1.12.0 DICT rules and business events
The Pix BTG pages and API reference moved to v1.12.0. Create entry and create claim refuse a salary account (SLRY) with PIX-0129. An account number can have 1 to 20 uppercase letters or digits. When its check digit is a letter, DICT receives that digit as 0. The donor can cancel a claim with the reason COURT_ORDER.Infraction reports and tracking graph transactions carry transactionDepth. A funds recovery accepts a maxHops from 1 to 2, and the tracking graph does not use its query parameters.Pix BTG can publish business events on BYOC deployments. They are off by default. To turn them on, set the variables in Business events.Before you upgrade, stop sending a maxHops above 2, and do not register Pix keys for salary accounts. Keep the original account number in the CRM.Access Manager
Access Manager v3.14.0 passkey sign-in
The Access Manager pages and the Auth and Identity API references moved to Access Manager v3.14.0. When your organization turns passkey sign-in on, a person can sign in with a passkey instead of a password. A passkey sign-in does not ask for a second factor. While the option is on, Auth refuses the password sign-in of a person who has a passkey with403 AUT-1019. Passkeys and SSO exclude each other.Each person adds and removes their own passkey through the Identity API. In a BYOC deployment, set MFA_SECRET in Auth before you turn passkeys on. Read Passkeys for the calls, the permissions, and the deployment requirements.TED
Bank Transfer v3.3.0 returns and customer credits
The TED JD pages and API reference moved to Bank Transfer v3.3.0. Return a Transfer sends a completed TED IN back to the paying bank, or reverses a completed P2P. The request needs the permissiontransfers:return. A return sends only its own webhook events.The plugin also credits the recipient for seven customer credits that the paying bank sends as other STR messages. Each has its own transfer type, from TED_IN_STR0005 to TED_IN_STR0051, and its own ledger routing binding. A TED OUT that JD still answers as pending after 24 hours in reconciliation waits for an operator, with the hold kept. With the tenant policy fees.refund_on_devolucao set to true, the refund of a whole return of a completed TED OUT also gives the fee back to the sender. Before you upgrade, add a ledger routing binding for each customer credit type that you receive, and accept the new transfer types and return events in your integration.Pix
Pix JD v1.4.0 parked credits and indirect customers
The Pix JD pages and API reference moved to v1.4.0. When the ledger refuses the credit of a received Pix because the receiving balance does not accept credits, the Pix waits asPENDING with pendingReason BALANCE_NOT_RECEIVING. An operator can credit that Pix or return it to its payer. A list shows the Pix Automático debits that wait, with their pendingReason. To refuse a possession claim, send fraudDeclared as true. With JOBS_CLAIM_RECEIVED_POLL_ENABLED, OUTBOX_ENABLED, and STREAMING_ENABLED set to true, Pix JD emits key.claim-received when another participant claims a key that you hold.A request through an indirect participant declares the customer and names no account of yours: payer on a payment, X-Payer-Document on the key lookup and the QR decode, and recipient on a dynamic QR code. A refund of a Pix that landed on an indirect participant’s position needs its indirectId, or it answers 422 PIX-0135. A refund that names an indirect participant that did not receive the original Pix answers 404 PIX-0147. An ISPB is 8 uppercase letters or digits, and the error list added PIX-0151 to PIX-0160.Before you upgrade, follow the steps for 1.4.0 on the environment variables page. On a self-hosted deployment where Pix JD does not publish its permission declaration, give the Pix roles the permission parked-credits (action post). Upgrade outside 00:00 to 08:00, Brasília time. An existing JD application with the source jd-consultores keeps working. For a new direct integration, give JD its credential.Access Manager
Access Manager v3.13.1 service credentials and declared roles
The Access Manager pages and the Auth and Identity API references moved to Access Manager v3.13.1. In a single-tenant deployment, a person issues the application that a Lerian service signs in with through Issue a Service Credential. Create an Application refusessource with 400.A Lerian product can declare its own roles and permissions. Identity refuses with 422 to add or remove a role on a declared permission, or a group on a declared role. The Console lists a declared role as Custom. To change who has that access, add or remove people on the product’s role, or in a group that holds the role.Identity answers a missing token with 401 AUT-0006, an invalid token with 401 AUT-0007, and a permission denial with 403 AUT-1020. When the authorization check does not answer in time, Identity answers 504 AUT-1021. Remove source from your Create an Application requests, and update the error parsing of your integration.SPB
Lerian SPB SFN certificate and settlement states
Lerian SPB uses one SFN certificate, atPROCESS_CERT_PATH. Its private key signs every outbound STR message and decrypts the inbound messages that BACEN encrypts to this certificate. SPB_SIGNER_KIND sets the custody of that key. The variables CERT_PATH, KEY_PATH, OUTBOX_POSTGRES_MAX_OPEN_CONNS, and OUTBOX_POSTGRES_MAX_IDLE_CONNS are gone, and so is the metadata.json file. The default of STR_MQ_CIPHER_SPEC is ECDHE_RSA_AES_256_CBC_SHA384.After the STR settles a return, the returned credit ends RETURNED. A converted rediscount ends CONVERTED, and an electronic-money movement can end CANCELLED. A rediscount conversion reports two settlement.* facts, and the fact of the repayment has a settlementId that ends in -PGTO. The fact settlement.failed also reports a transfer that an operator closes as failed. The LTR0003R2 and LTR0006R2 notices have no settlement.* fact.Before you upgrade, set PROCESS_CERT_PATH and the custody of its key. In an HSM, allow both signing and decryption on this key. Set STR_MQ_CIPHER_SPEC to the CipherSpec of your STR_MQ_CHANNEL channel. Make your ledger consumer record the LTR0003R2 and LTR0006R2 notices from the spb.ldl.* facts, and handle the new final states.SPI
Lerian SPI stuck operations and catalogue 5.13.2
The SPI API reference removed the recovery evaluate, request, and execute operations of an operation. An operation that needs attention appears in the stuck-operations list with the actions that it accepts, and manual resolution needs anAPPROVED approval. When BACEN does not answer a sent Pix by its deadline, the RECONCILE_WITH_BACEN action asks BACEN for the payment’s entry. When BACEN’s camt.054 answer reports the payment as settled or rejected, the rail completes or rejects the payment.The default of BACEN_SPI_CATALOGUE_VERSION is 5.13.2. A BACEN_SPI_XSD_DIR that you set must hold the schemas of that version. A variable value that does not parse for its type, such as yes for a switch, stops startup. Move your recovery calls to the stuck-operations actions. If you set BACEN_SPI_XSD_DIR, put the 5.13.2 schemas in it.SILOC
Lerian SILOC parked frames and MQ TLS settings
Lerian SILOC parks a frame that it refused more thanMQ_BACKOUT_THRESHOLD times in its database, and MQ_BACKOUT_QUEUE is gone. The quarantine feed returns the frame bytes in frame, and it stops returning a frame after you resolve it. The service does not start when PostgreSQL does not answer within 10 seconds.The new MQ_CIPHER_SPEC sets the cipher spec of the MQ channel, with the default ECDHE_RSA_AES_256_CBC_SHA384. The new MQ_CERT_LABEL names the certificate that the service presents on the channel.Before you upgrade, remove MQ_BACKOUT_QUEUE, and set MQ_CIPHER_SPEC to the cipher spec of your server-connection channel. With REDIS_TLS=true, make sure that your Redis server accepts TLS. If the operating system does not trust the certificate authority of your Redis server, set that authority in REDIS_CA_CERT.Consignado
Lerian Consignado 4.0.0 partner credentials and renegotiation outcomes
The Consignado pages and API reference moved to Lerian Consignado 4.0.0. A fund or an originador can call its own routes with an Access Manager partner credential, and the API reference added those operations. You can reactivate a fund or an originador. A complete upload of a new certificate and a new OAuth client throughPUT /v1/credentials/dataprev ends a revocation of the Dataprev credentials. The portability status read is POST /v1/consignado/portabilidade/efetivacoes, with the filters in the body, and the API reference removed the usage read.The outcome of a renegotiation publishes consignado.renegociacao.efetivada or consignado.renegociacao.recusada. The fact consignado.exclusao.rejected has the schema version 1.1.0. An origin-side portability exclusion that got no answer publishes consignado.portabilidade.rejeitada with reason_code GW-M005-NAO-EXECUTADO. An averbação with the booking block answers RATE_OUTSIDE_PRODUCT_RANGE when its monthly_rate times 12 falls outside the annual rate range of the Lender product version that it names. An averbação with a contract number that is already a contract in the gateway answers CONTRACT_ALREADY_REGISTERED.The permission publish at startup needs Access Manager 3.13.0 or later. This replaces the Access Manager 3.12.0 advice in the October 26, 2026 Consignado entry. Upgrade Access Manager before you upgrade the gateway. Read the portability status with POST, and stop calls to the usage read. Read ce-schemaversion before you decode consignado.exclusao.rejected. After GW-M005-NAO-EXECUTADO, send the exclusion again under a new key.TED
TED Lerian incoming TED outcomes
An incoming TED to an account of the institution ends inRECORDED, credits no customer, and publishes incoming_transfer.recorded. An account is the institution’s own when the document of its holder in the Midaz CRM is the CNPJ of the organization that the ISPB is bound to. TED Lerian returns a TED for a customer account whose closingDate in the Midaz CRM is today or earlier, with the official reason 1 (closed account). When a Midaz CRM lookup fails or gives no clear answer, the TED goes to manual review.The ISPB bindings accept only the organization and the ledger where this installation credits incoming TEDs, and refuse any other with 422 TED-0002. Without a cut-off, the operating window follows the official STR schedule. Review how your system handles RECORDED and incoming_transfer.recorded.SCR
Lerian SCR late BACEN answers
When BACEN answers after a consultation already answeredSCR-1004, Lerian SCR still writes that answer to its result cache. A full cache hit skips the BACEN call and the tariff. The service does not start when Postgres does not answer within 10 seconds. Review how your integration retries a consultation after SCR-1004.SLCSILOCSPB
Native rail journeys and the SPB settlement event
In the SLC, SILOC, and STR journeys of Integration Diagrams, Lerian publishes a card cycle credit, the refund of an excess deposit, and an LTR0005R2 credit as the Lerian SPB eventspb.ldl.third-party-settlement-received. Your institution sends the card cycle deposit (LDL0022) on its own STR connection and receives the LDL0022R1 answer there. The SLC0002 dispute, the domicile ASLC files, DDA0101, the ROC, and the receivables registrar steps run between your institution and the infrastructure, outside Lerian.For settled and returned credits, this entry replaces the October 15, 2026 SLC entry. Review your subscriptions and operational runbooks against the revised journeys.DocumentationPixTED
Pix and TED journeys
The Native rails section of Integration Diagrams added journeys for Pix Lerian over Lerian SPI. They are Send and receive Pix, Charge with a dynamic QR code, Return a received Pix, Authorize and pay with Pix Automático, and Report a fraud and recover funds. The section also added journeys for TED Lerian over Lerian SPB: Send and receive TED, and Cancel or return a TED. The message index lists the message codes of these journeys.MidazLerian Console
Fee Debts page of the Midaz module
The Fees Engine pages of the Midaz module added a Fee Debts guide. It shows how to filter the fee debts of a ledger by balance and status, and what each column means. The Collect action applies to all the open debts of a balance. Midaz settles them oldest first, up to the available balance. Midaz charges no fee on a collection, and you cannot revert it. To set a maximum amount, use the collection API withmaxAmount.Reporter
Reporter access groups
The What is Reporter page lists the three access groups that Reporter declares in Access Manager. The groupreporter-viewer-group reads. The group reporter-contributor-group reads, creates, and changes. The group reporter-editor-group also deletes and approves a regulatory filing. The Access Manager administrator group, admin-group, has the same access as reporter-editor-group. Review the group of each Reporter user.Documentation
Event catalog and Try It host
The event streaming overview lists Pix Lerian and TED Lerian, with their event pages and the routes of their streaming manifests. The Try It of the TED JD, Payments BTG, Pix BTG, and BC Correios API references uses an example host. Replace it with the URL that you receive during environment onboarding.MidazTracer
Lerian products are closed source
Since October 21, 2026, every Lerian product is closed source. The Midaz Community model is gone. Midaz and Tracer install from their public images on Docker Hub. If you install Midaz or Tracer from its source code, move to the Docker Hub images. For support, use the Lerian Support Portal.MidazTracer
Midaz 4.3.0 authentication and tenant refusals
In Midaz 4.3.0, a missing or invalid token answersAUT-0006 or AUT-0007, not 0042. A permission denial answers AUT-1020, not 0043. When the Access Manager does not decide, the answer is AUT-0033, not 0525. In multi-tenant mode, tenant resolution refuses with codes such as TENANT_SUSPENDED and TENANT_MANAGER_UNAVAILABLE.Midaz keeps 0042, 0043, and 0525 only for a refusal that carries no code. If your integration branches on these three codes, branch on the HTTP status or on the new codes.MidazTracer
Midaz 4.3.0 upgrade and account deletion
In Midaz 4.3.0, the Ledger publishes transaction audit messages only whenAUDIT_LOG_ENABLED is true. The Ledger /readyz checks RabbitMQ through its management API with the RABBITMQ_DEFAULT_USER credentials, and answers 503 when that check fails. Each fee key that you add to a package must match ^[a-z][a-zA-Z0-9]*$.Before you upgrade, set AUDIT_LOG_ENABLED=true if you consume audit messages. Also give the RABBITMQ_DEFAULT_USER user access to the management API. Upgrade Tracer, then every Ledger, before your integration sends scheme or optionalOperationRoutes. While a 4.3.0 Ledger runs, do not roll Tracer back below 4.3.0.Each reserve that the Ledger sends to Tracer carries the segment and portfolio of the source account, and the scheme of the transaction. Tracer limits and rules that you scope by segment, portfolio, or scheme apply to these reserves. In enforce mode, they can deny the transaction. Before you upgrade, review those limits and rules.When you delete an account, Midaz also archives its Alias Accounts and removes its alias from the fee and billing packages. Midaz removes each fee that credits the alias. It disables a fee package left without fees, and a billing package that debits or credits the alias. Before you delete an account, register its closing date on its Alias Account. To keep a fee that posts to the alias, point it to another account first.TED
Bank Transfer v3.2.0 license and TED OUT completion
The TED JD pages and API reference moved to Bank Transfer v3.2.0. In v3.2.0, every environment needsLICENSE_KEY and ORGANIZATION_IDS. IS_DEVELOPMENT selects the development license service, and LICENSE_SERVICE_ADDRESS is gone.TED OUT sends transfer.completed when it settles, and also sends transfer.rejected when the STR refuses the settlement. From v3.2.0 on, use transfer.completed as the TED OUT completion signal, in place of the advice in the August 24, 2026 entry. Before you upgrade, set both license variables in every environment. Also make sure that ENVIRONMENT_NAME or ENV_NAME is production, staging, uat, development, local, or test.Pix
Pix JD v1.3.0 English field names only
The Pix JD pages and API reference moved to v1.3.0. In v1.3.0, a field that had an English name and a deprecated Portuguese name keeps only its English name. A request body with the Portuguese name answers400 PIX-0061, and the API ignores a query parameter with that name. A random key registration needs X-Idempotency. Before you upgrade, follow the steps for 1.3.0 on the environment variables page.Pix
Pix Lerian v1.1.0 end-to-end ID
The Pix Lerian pages and API reference moved to v1.1.0. Pix Lerian is the interface that connects Midaz to Lerian SPI through its Lerian connectivity adapter.On a key or QR Code payment, Pix Lerian fixes the end-to-end ID when you initiate the transfer, and processing reuses it. Processing refusesX-End-To-End-Id on these payments with 400 PIX-0300. An endToEndId that you send must carry your ISPB in characters 2 to 9. X-Idempotency is the idempotency key. Before you upgrade, stop sending X-End-To-End-Id when you process a key or QR Code payment.SPB
Lerian SPB events and LDL0022 deposits
Lerian SPB publishes every event family on the streaming backbone and sends no webhooks. A return (STR0010) gives back a TED credit that you received, and it ends on its ownsettlement.settled or settlement.failed. The settlement.returned event is gone. LDL settlements, LDL0022 deposits, the LTR0004 payment, and the unsolicited LDL and LTR0005R2 notices have no settlement.* fact. An LDL0022 deposit request names only advisoryId. The rail takes the amount, the side, and the period from the advisory, and it refuses a body with any other member.Before you upgrade, move every webhook consumer to the streaming backbone. Make your ledger consumer record those operations from the spb.ldl.* facts. Send only advisoryId in an LDL0022 deposit request. Set LDL_ADVISORY_CONSUMER_ENABLED to true or false, because the service does not start when it is unset.SPI
Lerian SPI inbound returns and required fields
Lerian SPI holds an inbound return and announces it inspi.payment.return_received, with its returnId. Your client authorizes or refuses the return by that returnId. An authorized return settles only when the SPI confirms it, and the rail refuses a return that no decision concludes within its window.A FRAD refusal of an inbound Pix goes out as FRAD only when your client marks it as the decision of its antifraud system. Otherwise, it goes out as DS04. A payment order needs acceptedAt, the instant that your system received the payer’s confirmation. A funds recovery needs userComplaintAt, the instant that your service channel registered the payer’s complaint. A BR Code recebedor profile needs ispbParticipante, the ISPB of a participant that the rail settles for. Without these fields, the rail answers 422.With an https BACEN SPI endpoint, set BACEN_SPI_SIGNING_CERT_FILE. With the file backend, the default of BACEN_SPI_SIGNER_KIND, also set BACEN_SPI_SIGNING_KEY_FILE. The DICT API reference removed the judicial block and unblock of a key, the cleanup of orphaned keys, and the on-demand reconciliation. This entry replaces the October 6, 2026 SPI entry. Send these fields, decide each inbound return, and update the error parsing of your integration.SILOC
Lerian SILOC switches and cycle settlement
Lerian SILOC does not start unlessOT_REPLAY_ENABLED, STATUS_REPLAY_ENABLED, RECONCILE_ENABLED, LDL_FACT_CONSUMER_ENABLED, and CARD_COMMAND_CONSUMER_ENABLED are each true or false. With RECONCILE_ENABLED=true, it settles an OT cycle only when the câmara’s GEN0015 multilateral result matches the obligation. The obligation also needs its STR proof, and its deposit period needs its PAG0103. The API reference removed the ROC intake and added the read of the câmara’s multilateral results. Set the five switches before you upgrade.SCR
Lerian SCR installation and idempotency
One installation of Lerian SCR serves one institution. A retry while the first request still runs answers409 SCR-0006, so send it again after Retry-After. A response with X-Idempotency-Fenced: true holds its key, and a retry under that key answers 422 SCR-0005 without running. SCR-1003, SCR-1004, and SCR-9001 tell whether the request reached BACEN. Run one installation for each institution, and update the error parsing of your integration.Consignado
Consignado documentation refusals and deadline
A contract number is 2 to 15 letters or digits on the averbação, refinancing, renegotiation, and inbound portability. When Dataprev refuses the documentation, the CCB attachment answers422 with Dataprev’s codes in upstream, and the contract waits for its documentation again. Send the corrected documentation under a new X-Idempotency key, or exclude the contract. The averbação read shows documentation_due_at and documentation_overdue. DEFAULT_TENANT_ID and DATAPREV_RECONCILIATION_TENANT_ID are gone, and only a multi-tenant deployment reads LEILAO_TENANT_ID. Upgrading a single-tenant gateway (MULTI_TENANT_ENABLED=false) needs a cleanup on the current version and a new database. Contact Lerian support before you upgrade it.With the default settings, the gateway publishes its permission manifest to Access Manager at startup, and a failed publish stops startup. The publish needs Access Manager 3.12.0 or later, so upgrade Access Manager before you upgrade the gateway. With a multi-tenant identity service, set IDP_DECLARATION_ENABLED to false instead, because it refuses the publish.Streaming Hub
Streaming Hub checks event types against the catalog
Take each key inevent_types from the eventKey field of GET /v1/catalog: the hub can refuse a key that the catalog does not list at the subscription’s schema major, with 422 unknown_event_type. A new subscription also takes an optional event_majors map, which sets the schema major per event type.A delivery job gets at most eight attempts, and an attempt that starts 24 hours or more after the hub received the event is the last one. The dashboard refuses a period that starts before the history the hub still holds and returns coverage_start. The subscription health counts cover the interval from window_start to snapshot_at.Midaz
Midaz 4.3.0 transactions
The Midaz pages and the Ledger API reference moved to Midaz 4.3.0. A/v2 transaction takes an optional scheme that names its payment scheme, for example PIX or CARD. On /v2, an accounting route can link optional operation routes in optionalOperationRoutes. A block or an unblock transaction cannot be reverted, and a revert answers 0539.Tracer
Tracer payment schemes and rules-only validation
The Tracer pages and API reference moved to Midaz 4.3.0. Tracer takesscheme as an open field of 1 to 50 characters: A-Z, 0-9, _, and -. A rules-only validation decides by rules alone and does not check or count any spending limit. The limit usage endpoint reports the current period, and every usage figure includes the capacity that unconfirmed ledger reservations hold. A maxAmount of 0 denies every transaction in its scope.Lerian Console
Lerian Console v2.16.0 pages
The Console pages changed to match Lerian Console v2.16.0. In Payments, the ledger comes from the Console header, and you pick the debited account by its alias or full ID. Boletos issues one boleto at a time. The Fees pages added the Fee Debts screen, which needs Midaz 4.2.0 or later, and the Metadata selector and Deferrable fields of a package. A Tracer limit takes its Reset Time (UTC) when you create it, and you can delete an accounting route.Pix
Pix BTG v1.11.0 fraud check and refund unblock
The Pix BTG pages and API reference moved to plugin v1.11.0. The pages added the fraud check on incoming Pix and incoming refunds, where the plugin asks a decision endpoint that you run. The check is off by default, andANTIFRAUD_HOOK_ENABLED turns it on. The refund pages describe the unblock of refunds in PENDING and of cash-out refunds in CREATED. The API reference added Complete a charge.TED
TED Lerian
The Interfaces section has a TED Lerian guide. TED Lerian is the interface that connects Midaz to Lerian SPB. It sends TEDs, makes internal transfers, receives TEDs, returns a received TED, and cancels a TED. Midaz records the money. The Events and ledger integration and Operating Lerian SPB pages moved from the TED Lerian section to the SPB (TED) section of Brazil Rails. The API Reference added TED Lerian and its error list.Tracer
Tracer transaction type field deprecated
In Midaz 4.3.0,transactionType is the deprecated name of the Tracer scheme. It still works in requests, rule and limit scopes, CEL expressions, and events. The list filters of rules, limits, and audit events take transaction_type as the deprecated name of scheme. Use scheme in your integration, rules, and limits.TED
Bank Transfer ENV_NAME deprecated
In Bank Transfer v3.2.0,ENVIRONMENT_NAME replaces ENV_NAME, which still works as its deprecated name. The service does not start when the two variables name different environments. Set ENVIRONMENT_NAME and remove ENV_NAME.Consignado
Consignado averbação in two steps
In Lerian Consignado, the averbação runs only Dataprev Manual 003, requiresnome_trabalhador, and carries no document. When Dataprev accepts it, the operation answers attachment_pending and the gateway publishes consignado.averbacao.accepted. Send the signed CCB and the signature evidence to the CCB attachment, under its own X-Idempotency key, within the 7 days that Manual 004 allows.The CCB attachment no longer performs an averbação. Before Dataprev accepts the averbação, the attachment answers 409 AVERBACAO_NOT_ACCEPTED. A contract takes one accepted documentation. A different package answers 409 AVERBACAO_DOCUMENTATION_CONFLICT while the first is accepted or on its way to Dataprev. The documentation carries data_hora_assinatura, the instant the worker signed, and the averbação refuses that field.The consignado.averbacao.confirmed event now follows the Dataprev acceptance of the documentation. The saldo devedor that the gateway reports to Dataprev under Manual 015 now starts when Dataprev accepts the averbação, no longer when it accepts the documentation. The API reference added GET and PATCH /v1/consignado/contracts/{numero_contrato}/registro-b3 for the B3 instrument code of a contract with a confirmed averbação, and the PATCH publishes consignado.registro_b3.registered.To drop a contract that waits for documents, send its exclusion. Documents sent after that answer 409 AVERBACAO_EXCLUDED unless Dataprev rejects the exclusion. If the documentation is already recorded or on its way to Dataprev, the exclusion answers 409 EXCLUSION_DOCUMENTATION_UNDERWAY. While the averbação reads attachment_pending, send the same documentation again to the CCB attachment, then exclude the contract once the averbação reads confirmed.Dataprev faults answer 503 DATAPREV_UNAVAILABLE or 504 DATAPREV_TIMEOUT in place of CLT-0008, and a Dataprev read with unusable data answers 502 DATAPREV_INVALID_RESPONSE. Tenant Manager, Access Manager and Streaming Hub faults also answer 503 or 504 with their own codes, such as TENANT_MANAGER_UNAVAILABLE, AUT-0033 and STREAMING_HUB_TIMEOUT. After 504 DATAPREV_TIMEOUT, retry a command under the same key and never under a new one, because it may have reached Dataprev. The portability auction response is the exception, as its reference explains.A key reused for a different request answers 422 IDEMPOTENCY_KEY_REUSE, so send a new key. A rail answer that the gateway could not record answers 503 OUTCOME_UNKNOWN, so retry under the same key. The averbação refuses inconsistent booking dates and terms with 422 before it calls Dataprev.Three 409 codes replace RAIL_COMMAND_CLAIM_CONFLICT in some cases. A different command under the same key answers RAIL_COMMAND_PAYLOAD_MISMATCH, and a retry of a refused command answers RAIL_COMMAND_ALREADY_REFUSED. A retry with no known outcome answers RAIL_COMMAND_OUTCOME_UNRESOLVED, so read the rail commands and do not send the command under a new key.Fund, bid and portability window refusals answer named 422 codes in place of CLT-0006, such as FUNDO_NOT_REGISTERED, BID_NO_PROPOSTA_LEFT and PORTABILIDADE_WINDOW_EXPIRED.A cessão of a credit that Dataprev has not answered yet answers 409 CESSAO_CREDIT_PENDING, and CESSAO_CREDIT_NOT_ACCEPTED now means that Dataprev refused the credit. The ceded-credit read lists each credit with numero_contrato and omits credit_key and id_solicitacao for a contract without a bid.The environment variables add IDP_DECLARATION_ENABLED, and OUTBOX_RETENTION_PUBLISHED_HOURS now defaults to 1. DATAPREV_RECONCILIATION_CNPJS is gone, because the repasse reconciliation now reads every employer. Send the averbação without documents and the documents through the CCB attachment, do not book or disburse on consignado.averbacao.accepted, and update the error parsing of your integration. Make this change with the upgrade, because v3.7.1 still needs the signed CCB on the averbação.Payments
Payments BTG v1.0.2 payer lookup
The Payments BTG pages moved to v1.0.2. Bill and DARF payments now read the payer from CRM endpoints served byMIDAZ_LEDGER_URL at /v2, and MIDAZ_CRM_URL no longer configures that lookup. Before you upgrade, make sure that the Midaz ledger URL serves CRM endpoints at /v2.STA
Lerian STA v1.1.0
The Lerian STA pages moved to Lerian STA v1.1.0. Lerian STA v1.1.0 can read its license from a signed license file that Lerian issues. Set the path of the file inLICENSE_FILE_PATH. With a license file, Lerian STA verifies the license locally and does not call the license service. When LICENSE_FILE_PATH is set, Lerian STA ignores LICENSE_KEY. Every environment needs LICENSE_FILE_PATH or LICENSE_KEY, and ORGANIZATION_IDS.SRC
Lerian SRC
The Brazil Rails tab and the API Reference added Lerian SRC. Lerian SRC sends restriction consultations to BACEN’s BC Protege+ before your institution opens an account or changes the ownership of an existing relationship. It records BACEN’s verdict for each consultation and keeps an evidence trail.SISBAJUD
Lerian SISBAJUD in two components
The Lerian SISBAJUD pages moved to two releases: the Lerian SISBAJUD Mensageria v1.0.0 and the Lerian SISBAJUD executor v1.0.0. The Mensageria receives the orders as files through Lerian STA and writes the response files. The executor runs the orders on Midaz and needs its own PostgreSQL database. Each component has its own environment variables: see the Mensageria and executor pages. The API reference has one section for each component, and the operation URLs changed. Before you move to these releases, register each institution on both components with the sameinstitutionId and enabled set to true.BC Correios
Lerian BC Correios
The Brazil Rails tab and the API Reference added Lerian BC Correios. Lerian BC Correios collects your institution’s BC Correio mail from BACEN, stores it with an audit trail, and sends messages to BACEN departments.Platform
Lifecycle Management through the Lerian BYOC agent
Lifecycle Management moved from the Lifecycle dashboard to the Lerian BYOC agent, and Lerian retired the dashboard. Lerian installs, upgrades, rolls back, and removes products in your cluster through the agent, at your request. To use Lifecycle Management, ask Lerian support for the agent credential and the control-plane address. Then install the agent with its chart.Access Manager
Access Manager startup guidance
The Access Manager lifecycle guidance no longer treats PostgreSQL, Valkey, or Caradhras reachability as a service-start prerequisite. Use the health checks to confirm readiness before you enable access enforcement in a product.SLC
SLC clearing events in integration diagrams
The SLC integration diagrams now identify the events for preview positions, settled credits, and returned credits. Review your subscriptions and operational runbooks against the revised journeys.Midaz
Midaz account and balance model
The Midaz account and balance guidance now distinguishes a customer’s separate accounts from multiple balances within one account. Review your account model and balance-level controls against the current guidance.Payments
Payments BTG v1.0.1 license variables
The Payments BTG pages moved to release v1.0.1, which validates its license when it starts. In v1.0.1, every pod, the worker included, needsLICENSE_KEY and ORGANIZATION_IDS in every environment. The value of ORGANIZATION_IDS is global or a comma-separated list of lowercase organization UUIDs. A license refusal carries an LCS code. The API operations did not change. Before you upgrade, set both variables on every pod, and open the outbound rule that License Manager describes.TED
Bank Transfer v3.1.0 deductible TED OUT fees
Bank Transfer v3.1.0 refuses a TED OUT with422 BTF-3002 when the fee package that matches it has a fee with isDeductibleFrom: true. The refusal applies in native mode, and in legacy mode with BTF_FEE_ENABLED=true. For TED OUT and P2P, the totalAmount is the amount that Bank Transfer debits from the sender, and usage limits count that amount. Transfer reads carry organizationId and ledgerId, List Transfers takes a ledgerId filter, and the API reference added 422 BTF-2004 and BTF-2005. Bank Transfer asks Midaz to create a transaction metadata index, which needs the Midaz settings post permission in both fee modes. Before you upgrade, make sure that no plugin-fees package that a TED OUT can match has a fee with isDeductibleFrom: true.Pix
Pix JD v1.2.4 English field names and key lookup
The Pix JD pages and API reference moved to v1.2.4, where the key lookup takes an optionalindirectId for a payment through an indirect participant. Pix JD adds English names for some fields of MED 2.0, Pix Automático, and the key lookup. Where a field has an English name, the Portuguese name still works and is deprecated, and two different values for one field answer 400 PIX-0148. Two MED routes have English paths that need the same permission as the Portuguese ones. As the environment variables page says, the rail no longer reads MULTI_TENANT_ALLOW_INSECURE_HTTP from 1.2.1. In multi-tenant mode with an http:// Tenant Manager, set ALLOW_INSECURE_TLS=true on the API and the worker before that upgrade, or the service does not start.Lerian Console
Lerian Console v2.13.0 pages
The Console pages changed to match Lerian Console v2.13.0, and Product versions lists the product version that some screens need. When a product runs an earlier version, a notice such as Requires Bank Transfer 3.1.0 or later replaces that part of the screen. The Tracer module opens on its dashboard with Tracer 4.1.0 or later, and the Console no longer readsNEXT_PUBLIC_TRACER_DASHBOARD_ENABLED. In Bank Transfer, the Transfers list and the Recent Transfers card show the transfers of the selected ledger. For TED Out and P2P, Total shows the amount debited from the sender, and the Fee Policy settings apply only in the legacy fee mode. A new page describes Environments, the screen that lists the environments where you have an account and lets you choose your default one.Access Manager
Access Manager v3.11.1 and partners
The Access Manager pages and the Auth and Identity API references moved to Access Manager v3.11.1. The Auth reference added the SSO discover and start operations, and the Identity reference added the partner, scope catalog and own tenant operations. The partner guides returned, with an overview, a Console guide and an API guide. You can give a partner permissions only on a product that accepts partners, and the overview says how to find those products in your deployment. A request to delete a group that has members or subgroups now answers409 with IDE-1058 or IDE-1059. The error list also added AUT-0033, AUT-1011, AUT-1012, IDE-0064, IDE-0065 and IDE-0066, and the Tenant Manager automatic provisioning page left the site.MidazTracer
Midaz v4.2.2
The Midaz pages and the Ledger and Tracer API references moved to Midaz v4.2.2. The API operations did not change.TED
Bank Transfer v3.1.0 fee mode
Bank Transfer v3.1.0, the TED JD plugin, can charge fees through the Midaz Fees Engine.MIDAZ_FEE_MODE selects legacy (plugin-fees, /v1) or native (Midaz, /v2), and the default auto selects native on Midaz 4.1.0 or later. Under auto, if your fee packages are still in plugin-fees, transfers carry no fee once Midaz runs 4.1.0 or later. native needs the Midaz permissions packages get and estimates post, an explicit native also needs organizations get, and BTF_FEE_ENABLED applies to legacy only. Set MIDAZ_FEE_MODE=legacy before you upgrade, then move your packages as the migration guide describes. Switch to native only when every Bank Transfer pod runs 3.1.0 or later and the packages exist in Midaz.Matcher
Matcher v5.0.0 idempotency header and auto-confirmation
The Matcher pages and API reference moved to Matcher v5.0.0, where aDATE_LAG match goes to review and the default duplicate policy is FLAG_AS_EXCEPTION. Matcher v5.0.0 reads an idempotency key only from the X-Idempotency header, and it does not use a key in Idempotency-Key or X-Idempotency-Key. Send idempotency keys in X-Idempotency, and review the matches that your process expects to confirm automatically.Access Manager
Access Manager v3.10.0 MFA code and partners
In Access Manager v3.10.0, a user who turns off MFA on their own account must send a code. The partner pages and the partner operations left the site. If your application lets users turn off MFA or remove a method on their own account, collect the code and send it in the request.Pix
Pix JD v1.2.0
The Pix JD pages and API reference moved to plugin release v1.2.0, which adds an asynchronous account validation for JD. In v1.2.0, a route claims Pix Automático recurrences on JD Courier. Before you upgrade, follow the 1.2.0 upgrade step on the environment variables page.CCS
CCS license variables
The CCS environment variables page changedLICENSE_KEY and ORGANIZATION_IDS from required in production to required in every environment. Set both variables in every environment, development included.Payments
Payments BTG guarantor and payment lookup
The Payments BTG API reference removed the guarantor from boleto issuance, and a request that sends one answers400 PBP-0001. The Boletos & Bill Payment page added how to find a payment by its Idempotency-Key when a creation request ends without a payment id. Remove the guarantor from your boleto requests, and after an error, resend under the same Idempotency-Key before you look up the payment.PixTED
JD Courier v1.1.0 rail activation
The JD Courier pages and API reference moved to v1.1.0 and added the activation and suspension of a rail. In v1.1.0, the Courier delivers no message of a rail to the engines until an operator activates the rail. Activate each rail as the deployment page describes.MatcherLerian Console
Matcher module of Lerian Console
The Matcher UI pages changed to describe the Matcher module of Lerian Console v2.12.0.Lerian Console
Lerian Console v2.12.0 pages
The Console pages changed to match Lerian Console v2.12.0. In v2.12.0, you open Authorization from the Settings sidebar or the gear menu, and the application list has a Description column. The Products page added Matcher.Documentation
Integration Diagrams journeys
The Integration Diagrams tab had four sections: Lerian Products, Native rails, Partner interfaces and Market infrastructures. Native rails had the SLC, SILOC and STR journeys for secured credit and daily settlement, with a Lerian column that shows the endpoint or the event of each step between your institution and Lerian. A message index lists each code and its journeys. On rail pages, the official manuals prevail over the diagrams.Documentation
Tab layout and Integration Diagrams
The site regrouped its tabs and removed the Solutions tab and its pages. Platform became a section of Lerian Products, and Interfaces became a section of Brazil Rails, with no change to the addresses of their pages. The site added an Integration Diagrams tab before API Reference.TracerMidaz
Tracer reservations use gRPC only in Midaz 4.2.0
In Midaz 4.2.0, the Ledger reaches Tracer for reservations over gRPC only, on port 4021 by default. The REST reservation operations left the Tracer API reference. Deploy Tracer before the Ledger, and do not roll Tracer back below 4.2.0 while a 4.2.0 Ledger runs.Pix
Pix JD v1.0.0 configuration and upgrade
The Pix JD pages moved to plugin release v1.0.0. In v1.0.0, the Midaz organization, ledger, asset and clearing account come from the systemplane binding and twotenant_policy/midaz.* keys, and payments and devoluções require X-Idempotency. Follow the new upgrade steps: write the tenant_policy/midaz.* keys first, then remove the retired MIDAZ_* identity variables.Payments
Payments BTG bill payment flow and consult
The Payments BTG pages added the steps of a bill payment: the ledger reserves the funds before BTG receives the payment. An unknown outcome answers202 with status UNCONFIRMED, the reference added a bill consult operation, and the error list added seven codes and removed PBP-0209. Do not resend an UNCONFIRMED payment under a new Idempotency-Key, and set CONSULT_AUDIT_HMAC_KEY: a pod that serves the payment API does not start without it.TED
TED JD v3.0.1 error format
In TED JD v3.0.1, every error is an RFC 9457 problem document onapplication/problem+json, and a JD SPB code is on upstream.code. Update the error parsing of your integration.SISBAJUD
SISBAJUD v1.2.0 license variables
Lerian SISBAJUD v1.2.0 needsLICENSE_KEY and ORGANIZATION_IDS in every environment. Set both variables.Access Manager
Access Manager chart environment name
The Access Manager Helm page added the environment name. The chart default isdevelopment. For any environment other than development, staging or local, expose Caradhras over https with a certificate from a public certificate authority. Then point Auth and Identity at that https address.Streaming Hub
Streaming Hub v2.3.0 refusals
In Streaming Hub v2.3.0, a401 or 403 refusal is a problem document with code unauthorized or forbidden. The hub answers 503 when Access Manager returns no verdict. Update the error parsing of your integration.Lerian Console
Lerian Console v2.6.0 pages
The Console pages changed to match Lerian Console v2.6.0. The update added pages for Reporter Institutions, TED IN operations, TED JD Accounting Routes and Pix BTG refunds, and covered report parameters and thePartial failure status. The update removed the BC Correios Console pages. The Console shows an application’s client secret once, when you create the application. Store it then.PixTED
JD Courier
The Interfaces tab and the API Reference added JD Courier. JD Courier lets two or more core banking engines share one JD channel and one ISPB on SPB (TED) and Pix. It runs in BYOC and on Lerian Cloud.Midaz
Fee debt in Midaz 4.2.0
In Midaz 4.2.0, the unpaid part of a deferrable fee on a/v2 direct transaction can become a fee debt that later /v2 credits settle, oldest first. Fee debt is off by default, and Valkey must persist its keys.Access Manager
Access Manager Identity API reference
The Identity API reference dropped the partner, scope catalog and user tenant operations. The Access Manager error list addedIDE-0038.Consignado
Consignado v3.7.0
The Consignado API reference added an operation that reads the cadastro stored with an averbação, and the events reference changed to match what v3.7.0 emits. In Lerian Consignado v3.7.0, the saldo devedor sent to Dataprev is the present value of the unpaid installments.SPI
SPI environment variables
The SPI environment variables page droppedBACEN_SPI_SIGNING_KEY_FILE.