Documentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Quick reference for terms and acronyms used in the TED plugin documentation.
Regulatory and infrastructure terms
| Term | Definition |
|---|
| ANBIMA | Brazilian Financial and Capital Markets Association. Upstream source of the national bank-holiday table consumed by the plugin’s holiday fetcher to populate the bacen_holidays calendar. |
| BACEN | Banco Central do Brasil — the Central Bank of Brazil. Regulates the financial system and operates SPB. |
| SPB | Sistema de Pagamentos Brasileiro — Brazil’s Payment System, the infrastructure for all interbank settlements. |
| STR | Sistema de Transferência de Reservas — Reserve Transfer System, the real-time settlement component of SPB. |
| RSFN | Rede do Sistema Financeiro Nacional — the secure national financial network connecting BACEN and financial institutions. |
| PSTI | Provedor de Serviço de Tecnologia da Informação — an IT service provider authorized by BACEN to operate RSFN connectivity infrastructure. JD Consultores is a PSTI. |
| ISPB | Identificador de Sistema de Pagamentos Brasileiro — 8-digit code that uniquely identifies each financial institution in SPB. |
| STR0008 | The BACEN message format for initiating a TED transfer. Sent from the originating institution to SPB. |
| STR0008R2 | The response/confirmation message for STR0008. Contains the settlement result. |
| STR0010R2 | The chargeback message format. Sent when a TED must be returned to the origin bank (e.g., recipient not found). |
Devolução / devolucao_code | Return of an inbound TED to the origin bank. devolucao_code is the BACEN-standardized reason code persisted on the transfer record (e.g., recipient not found, account closed) and carried in the STR0010R2 return message. |
| JD / JD SPB | JD Consultores — the PSTI used by Lerian to route TED messages to SPB. |
| JD parse failure | Inbound JD message that could not be parsed (malformed XML, unknown message type, schema mismatch). Persisted in jd_incoming_parse_failures for manual triage. Distinct from undeliverable transfers and from the webhook DLQ. |
| NumCabSeq | Sequential message identifier assigned by JD SPB to each STR0008 submission. Used to track and query transfer status. |
| NumCtrlSTR | BACEN clearing control number assigned by STR (the Reserve Transfer System) once a message is accepted into the SPB clearing flow. Persisted on the transfer as clearing_control_number. Distinct from NumCabSeq, which is the JD-assigned message sequence on submission. |
Account type codes (ISO 20022)
| Code | Account Type |
|---|
| CACC | Current account (conta corrente) — most common type |
| SLRY | Salary account (conta salário) |
| SVGS | Savings account (conta poupança) |
| TRAN | Transit/payment account |
| OTHR | Other account type |
Transfer types
| Term | Definition |
|---|
| TED OUT | Outbound transfer — your client sends funds to an account at another bank. |
| TED IN | Inbound transfer — your institution receives funds from another bank, automatically detected and credited. |
| P2P | Internal transfer — between two accounts at the same institution (same ISPB). Faster and typically free. |
| D+0 | Same-day settlement — TED is a D+0 instrument when submitted before 17:00 Brasília time. |
Plugin-specific terms
| Term | Definition |
|---|
| PaymentInitiation | The entity created by POST /v1/transfers/initiate. Holds fee calculation and expires after 24 hours. |
| initiationId | UUID returned by the initiate endpoint. Required to confirm a transfer via POST /v1/transfers/process. |
| X-Idempotency | Required header for safe retries. The same key always returns the same response (cached for 24 hours). |
| Cashin fee | Fee deducted from a received TED IN amount. Configured per organization via Fees Engine. |
| Cashout fee | Fee added to a TED OUT amount. The sender’s account is debited for amount + fee. |
| Reconciliation | Process to match transfers in unknown state (PROCESSING with no confirmation) against JD SPB records. |
| DLQ | Dead-letter queue — transfers that cannot be processed after all retries are moved here for manual review. |
| Signing artifact | Canonical TED OUT payload frozen during POST /v1/transfers/signing/prepare and persisted in jd_outbound_signing_artifacts. Consumed by external HSM/signer integrations to produce a detached signature without the plugin holding the private key. |
| Systemplane | Runtime-config admin plane exposed via /system/:namespace and /system/:namespace/:key. Holds hot-reloadable settings that take effect without a redeploy. Distinct from bootstrap environment variables, which are read only at startup. |
| Undeliverable transfer | Inbound TED that was parsed successfully but could not be credited (e.g., recipient account not found in the CRM). Persisted in undeliverable_incoming_transfers and may trigger an automatic devolução. Distinct from a JD parse failure and from the webhook DLQ. |
