Isox.Camt055 (Isox v0.2.0)

Copy Markdown View Source

Pedido de cancelamento de Pix Agendado.

Versão 1.1. Aponta a ordem agendada por orgnl_end_to_end_id e traz o motivo em rsn_prtry. A resposta é uma Isox.Camt029. Todo campo do schema é obrigatório.

Um campo que a mensagem sozinha não decide

cxl_prcg_tp depende de qual lado está pedindo o cancelamento: "DHSR" quando quem pede é o participante do usuário recebedor, "DHIP" quando é o do pagador. Os campos desta mensagem não bastam para saber qual dos dois é: assgnr_ispb sozinho não diz o papel. A regra está na planilha do catálogo e a escolha certa cabe a quem chama encode/3.

Summary

Functions

Decodifica um XML de camt.055 de volta para a struct.

Monta o XML (envelope completo, AppHdr + Document) para a versão dada.

Types

t()

@type t() :: %Isox.Camt055{
  assgne_ispb: String.t(),
  assgnmt_id: String.t(),
  assgnr_ispb: String.t(),
  created_at: DateTime.t(),
  cxl_prcg_tp: String.t(),
  orgnl_end_to_end_id: String.t(),
  orgnl_pmt_inf_id: String.t(),
  orgtr_cpf_cnpj: String.t(),
  pmt_cxl_id: String.t(),
  prcg_dt_tm: DateTime.t(),
  rsn_prtry: String.t()
}

version()

@type version() :: :v1_1

Functions

decode(xml)

@spec decode(binary()) :: {:ok, t(), version()} | {:error, term()}

Decodifica um XML de camt.055 de volta para a struct.

encode(message, header, version)

@spec encode(t(), Isox.AppHdr.t(), version()) ::
  {:ok, binary()} | {:error, String.t()}

Monta o XML (envelope completo, AppHdr + Document) para a versão dada.