API Reference Isox v#0.2.0

Codec das mensagens ISO 20022 do catálogo do SPI (Pix).

Recusa de mensagem: o que o SPI responde quando nem chegou a entender o que recebeu.

Evento de sistema: o aviso que o SPI manda a todos os participantes, sem relação com transação nenhuma.

BAH (head.001): o cabeçalho que toda mensagem do catálogo carrega (Manual VIII).

Identificação de participante: quem é o dono de um ISPB e em que situação ele está.

Recibo: a resposta a uma ou mais Isox.Trck002.

Resposta ao pedido de cancelamento de Pix Agendado: aceita ou recusa a Isox.Camt055.

Relação de lançamentos da Conta PI: a resposta a uma Isox.Camt060 que pediu REL, TRD ou TRT.

Saldo da Conta PI: a resposta a uma Isox.Camt060 que pediu CSA ou CRE.

Detalhe de um lançamento da Conta PI: a contrapartida contábil de cada pagamento liquidado.

Pedido de cancelamento de Pix Agendado.

Consulta à Conta PI: saldo, extrato, relação de lançamentos ou detalhe de um lançamento.

O que cada campo de cada mensagem quer dizer.

Uma entrada do dicionário: tudo que se sabe sobre um campo de uma mensagem.

Cabeçalho mais mensagem: o par que Isox.encode/2 recebe e Isox.decode/1 devolve.

Relatório de status: a resposta a uma Isox.Pacs008 ou a uma Isox.Pacs004.

Devolução: a ordem que faz o dinheiro de um Pix já liquidado voltar.

Ordem de crédito: a mensagem que move o dinheiro de um Pix.

Solicitação de recorrência do Pix Automático: pede ao participante do pagador que autorize uma série de cobranças.

Cancelamento de recorrência do Pix Automático.

Resposta sobre uma recorrência do Pix Automático: aceita ou recusa uma Isox.Pain009 ou uma Isox.Pain011.

Instrução de pagamento agendada, vinculada a uma recorrência ativa do Pix Automático.

Resposta a uma instrução agendada: o participante do pagador aceita ou recusa a Isox.Pain013.

Eco: o ping do SPI.

Eco: o pong do SPI.

Pedido de registro de participante indireto sob um direto.

Resposta a um pedido de cadastro: o desfecho de uma Isox.Reda014, Isox.Reda022 ou Isox.Reda031.

Relatório de dados de participante.

Alteração do cadastro de um participante direto: contatos, diretor responsável, palavra-chave e CPF do diretor.

Pedido de encerramento do serviço de liquidação para um participante indireto.

Aviso de mudança no cadastro de um participante.

Descobre os módulos Isox.Generated.<Mensagem>.<Versao> já carregados e despacha o parse pela combinação namespace + MsgDefIdr (ADR 0002). Os dois precisam concordar, ou é erro.

Autorrelato de transferência interna: o participante avisa ao BC um pagamento que ele liquidou por dentro, sem passar pelo SPI.

Núcleo do XMLDSig do Pix (Manual de Segurança do SFN Vol. II §3), comum aos dois perfis que o manual define: SPI, com três <ds:Reference> (tabela 3), e DICT, com duas (tabela 4). Hoje só o perfil SPI está implementado, em sign/4. sign_references/3 e key_info_xml/2 já bastam para montar o do DICT quando existir um simulador para ele, já que a diferença entre os dois é só a lista de referências, não o resto do mecanismo (§3.2 do manual: os passos são os mesmos).

Gera, em memória, um par de chave privada + certificado autoassinado RSA-2048, para uso em testes e exemplos de Isox.Xmldsig.Signer e Isox.Xmldsig.Verifier.

Verificação do perfil de assinatura SPI (Manual de Segurança do SFN Vol. II §3.3): recalcula os três digests com canonicalização real, porque os bytes vêm de terceiro, então, diferente da assinatura na saída, não dá pra não dá para supor que já chegaram canônicos, e confere a assinatura RSA-SHA256 sobre o SignedInfo.

Lê todos os .xsd de mensagem em --xsd-dir (exceto xmldsig, que não é mensagem) e gera, em --out, um módulo Isox.Generated.<Mensagem>.<Versao> por arquivo, mais um módulo interno com o BAH (head.001), compartilhado entre todas as mensagens (ADR 0004).

Mede o throughput de assinar e verificar uma pacs.008 realista, sem servidor HTTP no caminho