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.
Referência rápida de termos e siglas utilizados na documentação do plugin Bank Transfer.
Termos regulatórios e de infraestrutura
| Termo | Definição |
|---|
| ANBIMA | Associação Brasileira das Entidades dos Mercados Financeiro e de Capitais. Fonte upstream da tabela nacional de feriados bancários consumida pelo fetcher de feriados do plugin para popular o calendário bacen_holidays. |
| BACEN | Banco Central do Brasil — regulamenta o sistema financeiro e opera o SPB. |
| SPB | Sistema de Pagamentos Brasileiro — infraestrutura para todas as liquidações interbancárias no Brasil. |
| STR | Sistema de Transferência de Reservas — componente de liquidação em tempo real do SPB. |
| RSFN | Rede do Sistema Financeiro Nacional — rede segura que conecta o BACEN e as instituições financeiras. |
| PSTI | Provedor de Serviço de Tecnologia da Informação — provedor autorizado pelo BACEN para operar infraestrutura de conectividade com a RSFN. A JD Consultores é um PSTI. |
| ISPB | Identificador de Sistema de Pagamentos Brasileiro — código de 8 dígitos que identifica cada instituição financeira no SPB. |
| STR0008 | Formato de mensagem BACEN para iniciar uma transferência TED. Enviado pela instituição de origem ao SPB. |
| STR0008R2 | Mensagem de resposta/confirmação do STR0008. Contém o resultado da liquidação. |
| STR0010R2 | Formato de mensagem de devolução. Enviado quando um TED precisa ser devolvido ao banco de origem (ex: destinatário não encontrado). |
Devolução / devolucao_code | Devolução de um TED de entrada ao banco de origem. devolucao_code é o código de motivo padronizado pelo BACEN persistido no registro da transferência (ex: destinatário não encontrado, conta encerrada) e carregado na mensagem de devolução STR0010R2. |
| JD / JD SPB | JD Consultores — o PSTI utilizado pela Lerian para rotear mensagens TED ao SPB. |
| JD parse failure | Mensagem JD de entrada que não pôde ser parseada (XML malformado, tipo de mensagem desconhecido, divergência de schema). Persistida em jd_incoming_parse_failures para triagem manual. Distinta de transferências não-entregáveis e da DLQ de webhooks. |
| NumCabSeq | Identificador sequencial atribuído pelo JD SPB a cada envio de STR0008. Usado para rastrear e consultar o status da transferência. |
| NumCtrlSTR | Número de controle de compensação do BACEN atribuído pelo STR (Sistema de Transferência de Reservas) quando uma mensagem é aceita no fluxo de compensação do SPB. Persistido na transferência como clearing_control_number. Distinto do NumCabSeq, que é a sequência de mensagem atribuída pelo JD no envio. |
Tipos de conta (ISO 20022)
| Código | Tipo de Conta |
|---|
| CACC | Conta corrente — tipo mais comum |
| SLRY | Conta salário |
| SVGS | Conta poupança |
| TRAN | Conta de pagamento / conta transitória |
| OTHR | Outro tipo de conta |
Tipos de transferência
| Termo | Definição |
|---|
| TED OUT | Transferência de saída — seu cliente envia recursos para uma conta em outro banco. |
| TED IN | Transferência de entrada — sua instituição recebe recursos de outro banco, detectados e creditados automaticamente. |
| P2P | Transferência interna — entre duas contas da mesma instituição (mesmo ISPB). Mais rápida e normalmente sem tarifa. |
| D+0 | Liquidação no mesmo dia — TED é um instrumento D+0 quando enviado antes das 17h, horário de Brasília. |
Termos específicos do plugin
| Termo | Definição |
|---|
| PaymentInitiation | Entidade criada pelo POST /v1/transfers/initiate. Contém o cálculo de tarifas e expira após 24 horas. |
| initiationId | UUID retornado pelo endpoint de iniciação. Necessário para confirmar uma transferência via POST /v1/transfers/process. |
| X-Idempotency | Header obrigatório para retentativas seguras. A mesma chave sempre retorna a mesma resposta (armazenada em cache por 24 horas). |
| Tarifa cashin | Tarifa deduzida do valor recebido em um TED IN. Configurada por organização via Fees Engine. |
| Tarifa cashout | Tarifa adicionada ao valor de um TED OUT. A conta do remetente é debitada pelo valor + tarifa. |
| Reconciliação | Processo para identificar transferências em estado desconhecido (PROCESSING sem confirmação) e cruzar com registros do JD SPB. |
| DLQ | Fila de mensagens mortas (dead-letter queue) — transferências que não puderam ser processadas após todas as tentativas são movidas aqui para revisão manual. |
| Signing artifact | Payload canônico de TED OUT congelado durante POST /v1/transfers/signing/prepare e persistido em jd_outbound_signing_artifacts. Consumido por integrações externas de HSM/assinador para produzir uma assinatura destacada sem que o plugin retenha a chave privada. |
| Systemplane | Plano administrativo de configuração em runtime exposto via /system/:namespace e /system/:namespace/:key. Mantém configurações com hot-reload que entram em vigor sem redeploy. Distinto das variáveis de ambiente de bootstrap, que são lidas apenas na inicialização. |
| Undeliverable transfer | TED de entrada que foi parseado com sucesso mas não pôde ser creditado (ex: conta do destinatário não encontrada no CRM). Persistido em undeliverable_incoming_transfers e pode disparar uma devolução automática. Distinto de um JD parse failure e da DLQ de webhooks. |