1. Evento de notificação de Pagamento de Título de Concessionária
Callback responsável por enviar informações detalhadas sobre o pagamento de um título de concessionária.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “PagamentoTituloConcessionaria” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | LinhaDigitavel | string | Sequência de números do código de barras com o dígito verificador de cada agrupamento de números do código (até 48 dígitos) |
| Detalhes | CodigoBarras | string | Sequência de números do código de barras do título, excluídos os dígitos verificadores de cada agrupamento de números do código (total de 44 dígitos) |
| Detalhes | ValorTitulo | decimal | Valor do título |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do pagamento realizado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do pagamento do título |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
2. Evento de notificação de Devolução de Título de Concessionária
Callback responsável por enviar informações detalhadas sobre a devolução de um título de concessionária.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “DevolucaoPagamentoTituloConcessionaria” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | CodigoTransacaoOrigem | string | Código que faz referência à transação original responsável por gerar outras transações correlacionadas. Em casos como devoluções ou rejeições, este campo aponta para a transação de envio que originou o movimento |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor pago do título |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da devolução do título |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
3. Evento de notificação de Envio de PIX
Callback responsável por enviar informações detalhadas sobre o envio de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “EnvioPix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | ChaveDestino | string | Chave Pix de destino |
| Detalhes | ContaDestino | object | Objeto com os dados da conta de destino para o envio do Pix |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta com o dígito verificador |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | ModeloConta | integer | Identificador do modelo da conta, onde: 1 = Movimento, 2 = Escrow, 3 = Vinculada |
| Detalhes | NomeDestino | string | Nome do titular da conta |
| Detalhes | DocumentoFederalDestino | string | Nº do CPF ou CNPJ do titular da conta |
| Detalhes | AgenciaDestino | string | Nº da agência de destino |
| Detalhes | ISPBDestino | string | Código ISPB de destino |
| Detalhes | InformacoesAdicionais | string | Descrição de informações adicionais do envio do Pix |
| Detalhes | IdentificadorTransacao | string | Identificador TxId do QR Code para o envio do Pix |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | IdentificOperador | string | Nome do operador responsável pelo envio do Pix |
| Detalhes | NumeroOperacao | string | Código utilizado na mensageria com a CCM para identificar / agrupar as transações |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do Pix enviado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do envio do Pix |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada |
4. Evento de notificação de Rejeição de Envio de PIX
Callback responsável por enviar informações detalhadas sobre a rejeição de envio de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “RejeicaoEnvioPix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ChaveDestino | string | Chave Pix de destino |
| Detalhes | ContaDestino | object | Objeto com informações sobre a conta de destino do Pix enviado |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta com o dígito verificador |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | ModeloConta | integer | Identificador do modelo da conta, onde: 1 = Movimento, 2 = Escrow, 3 = Vinculada |
| Detalhes | NomeRecebedor | string | Nome do destinatário do Pix enviado |
| Detalhes | DocumentoFederalRecebedor | string | Nº ofuscado do CPF ou CNPJ do destinatário do Pix enviado |
| Detalhes | InformacoesAdicionais | string | Descrição de informações adicionais do Pix enviado |
| Detalhes | IdentificadorTransacao | string | Identificador TxId do QR Code para o envio do Pix |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | IdentificOperador | string | Nome do operador responsável pelo envio do Pix |
| Detalhes | VlrTransacao | decimal | Valor do Pix rejeitado |
| Detalhes | MotivoRejeicaoPix | string | Identificador do motivo da rejeição do Pix. Exemplos: CH11 = CPF/CNPJ do usuário recebedor incorreto, AM01 = Ordem de pagamento com valor zero, etc. |
| Detalhes | DescMotivoRejeicaoPix | string | Descrição do motivo da rejeição do Pix |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
5. Evento de notificação de Estorno de PIX
Callback responsável por enviar informações detalhadas sobre o estorno de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “EstornoPix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ContaRecebedor | object | Objeto com os dados da conta do recebedor do Pix estornado |
| ContaRecebedor | Agencia | string | Nº da agência sem o dígito verificador |
| ContaRecebedor | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaRecebedor | Conta | string | Nº da conta sem o dígito verificador |
| ContaRecebedor | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaRecebedor | TipoContaDesc | string | Descrição do tipo da conta |
| ContaRecebedor | ContaDigito | string | Nº do dígito verificador da conta |
| ContaRecebedor | ContaPgto | string | Nº da conta pagamento |
| ContaRecebedor | CodigoBanco | string | Código do banco |
| ContaRecebedor | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| ContaRecebedor | TpPessoaDesc | string | Descrição do tipo de pessoa |
| ContaRecebedor | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário do estorno do Pix |
| ContaRecebedor | Nome | string | Nome do destinatário do estorno do Pix |
| ContaRecebedor | CodigoConta | guid | Código da conta do destinatário da transação quando a conta for da BMP |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do estorno do Pix |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
6. Evento de notificação de Recebimento de PIX
Callback responsável por enviar informações detalhadas sobre o recebimento de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “RecebePix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | PagadorNome | string | Nome do pagador do Pix |
| Detalhes | PagadorDocumentoFederal | string | Nº do CPF ou CNPJ do pagador do Pix |
| Detalhes | PagadorParticipante | string | Identificador do participante SPI do pagador do Pix |
| Detalhes | PagadorAgencia | string | Nº da agência do pagador do Pix |
| Detalhes | RecebedorChave | string | Chave Pix do recebedor do Pix |
| Detalhes | RecebedorConta | object | Objeto com os dados da conta do recebedor do Pix |
| RecebedorConta | Agencia | string | Nº da agência sem o dígito verificador |
| RecebedorConta | AgenciaDigito | string | Nº do dígito verificador da agência |
| RecebedorConta | Conta | string | Nº da conta sem o dígito verificador |
| RecebedorConta | TipoConta | integer | Identificador do tipo da conta do recebedor do Pix, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| RecebedorConta | TipoContaDesc | string | Descrição do tipo da conta |
| RecebedorConta | ContaDigito | string | Nº do dígito verificador da conta |
| RecebedorConta | ContaPgto | string | Nº da conta pagamento |
| RecebedorConta | CodigoBanco | string | Código do banco |
| RecebedorConta | TpPessoa | integer | Identificador do tipo de pessoa do recebedor do Pix, onde: 1 = Física, 2 = Jurídica |
| RecebedorConta | TpPessoaDesc | string | Descrição do tipo de pessoa |
| RecebedorConta | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário do Pix recebido |
| RecebedorConta | Nome | string | Nome do destinatário do Pix recebido |
| RecebedorConta | CodigoConta | guid | Código da conta |
| Detalhes | InformacoesAdicionais | string | Descrição de informações adicionais do Pix recebido |
| Detalhes | IdentificadorTransacao | string | Identificador TxId do QR Code para o recebimento do Pix |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | NumeroOperacao | string | Código utilizado na mensageria com a CCM para identificar / agrupar as transações |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do Pix recebido |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do recebimento do Pix |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
| Lancamentos | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Lancamentos | DescricaoOperacao | string | Descrição da operação realizada |
| Lancamentos | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Lancamentos | DescCliente | string | Descrição livre fornecida pelo cliente para o lançamento gerado pelo recebimento do Pix |
| Lancamentos | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação que originou o lançamento gerado pelo recebimento do Pix |
| Lancamentos | DtMovimento | datetime | Data e hora da realização do lançamento gerado pelo recebimento do Pix |
| Lancamentos | VlrMovimento | decimal | Valor do lançamento gerado pelo recebimento do Pix |
7. Evento de notificação de Devolução de PIX
Callback responsável por enviar informações detalhadas sobre a devolução de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “DevolucaoPix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ContaDestino | object | Objeto com os dados da conta de destino para devolução do Pix |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta com o dígito verificador |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | ModeloConta | integer | Identificador do modelo da conta, onde: 1 = Movimento, 2 = Escrow, 3 = Vinculada |
| Detalhes | NomeDestino | string | Nome do titular da conta |
| Detalhes | DocumentoFederalDestino | string | Nº ofuscado do CPF ou CNPJ do titular da conta |
| Detalhes | InformacoesAdicionais | string | Descrição de informações adicionais do Pix devolvido |
| Detalhes | CodigoMovimentoOrigem | guid | Código utilizado pela BMP para identificar / agrupar transações |
| Detalhes | MotivoDevolucao | string | Código do motivo da devolução do Pix. Exemplos: AM05 = Ordem de pagamento em duplicidade, BE08 = Falha operacional do PSP do pagador, etc. |
| Detalhes | DescricaoCliente | string | Descrição da mensagem da devolução do Pix para o cliente |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | IdentificOperador | string | Nome do operador que efetuou a transação |
| Detalhes | NumeroOperacao | string | Código utilizado na mensageria com a CCM para identificar / agrupar as transações |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | CodigoTransacaoOrigem | guid | Código refere-se à transação original responsável por gerar outras transações correlacionadas. Em casos como devoluções ou rejeições, este campo aponta para a transação de envio que originou o movimento |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do Pix devolvido |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da devolução do Pix |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
8. Evento de notificação de Rejeição de Devolução de PIX
Callback responsável por enviar informações detalhatas sobre a rejeição da devolução de um PIX.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “RejeicaoDevolucaoPix” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | IdentificOperador | string | Nome do operador responsável pela devolução do Pix |
| Detalhes | ContaDestino | object | Objeto com informações sobre a conta de destino da transação |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta com o dígito verificador |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | ModeloConta | integer | Identificador do modelo da conta, onde: 1 = Movimento, 2 = Escrow, 3 = Vinculada |
| Detalhes | NomeDestino | string | Nome do titular da conta |
| Detalhes | DocumentoFederalDestino | string | Nº ofuscado do CPF ou CNPJ do titular da conta |
| Detalhes | InformacoesAdicionais | string | Descrição de informações adicionais do Pix devolvido |
| Detalhes | MotivoDevolucao | string | Código do motivo da devolução do Pix. Exemplos: AM05 = Ordem de pagamento em duplicidade, BE08 = Falha operacional do PSP do pagador, etc. |
| Detalhes | CodigoMovimentoOrigem | guid | Código utilizado pela BMP para identificar / agrupar transações |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | VlrTransacao | decimal | Valor do Pix devolvido |
| Detalhes | DtTransacao | datetime | Data e hora da devolução do Pix |
| Detalhes | CodigoTransacao | guid | Código utilizado para identificar o registro na entidade de transação que deu origem ao movimento realizado |
| Detalhes | CodigoTransacaoOrigem | guid | Código que faz referência à transação original responsável por gerar outras transações correlacionadas. Em casos como devoluções ou rejeições, este campo aponta para a transação de envio que originou o movimento |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
9. Evento de notificação de Registro de Boleto
Callback responsável por enviar informações detalhadas sobre o registro de um boleto. Exemplo de corpo do callback com modelo hídridofalse:
true:
| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “RegistroBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto |
| Detalhes | CodigoBarras | string | Sequência de números do código de barras do título excluídos os dígitos verificadores de cada agrupamento de números do código (total de 44 dígitos) |
| Detalhes | LinhaDigitavel | string | Sequência de números do código de barras com o dígito verificador de cada agrupamento de números do código (até 48 dígitos) |
| Detalhes | DtRegistroDDA | datetime | Data e hora do registro no Débito Direto Autorizado |
| Detalhes | IdentificadorTransacao | string | Identificador TxId do QR Code para pagamento do boleto |
| Detalhes | Sucesso | bool | Indicador de sucesso ou falha do registro do boleto |
| Detalhes | ErroRegistro | string | Descrição do erro ocorrido no registro do boleto |
| Detalhes | Emv | string | Código Emv para pagamento via Pix |
| Detalhes | Imagem | string | Imagem do QR Code em base 64 |
| Detalhes | Hibrido | bool | Indicador de boleto com possibilidade de pagamento através do código de barras ou através de QR Code Pix |
| Detalhes | Operador | string | Nome do operador responsável pela alteração |
| Detalhes | OperadorEmail | string | Endereço de e-mail do operador responsável pela alteração |
| Detalhes | NossoNumero | string | Identificador único do boleto no sistema do cedente |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
10. Evento de notificação de Alteração de Boleto
Callback responsável por enviar informações detalhadas sobre a alteração de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “AlteracaoBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto |
| Detalhes | CodigoAlteracaoBoleto | guid | Código do registro de alteração do boleto |
| Detalhes | IdentificadorTransacao | string | Identificador TxId do QR Code para pagamento do boleto |
| Detalhes | Sucesso | bool | Indicador da situação da alteração |
| Detalhes | Mensagem | string | Descrição referente ao indicador da situação da alteração |
| Detalhes | DtTransacao | datetime | Data e hora da alteração do boleto |
| Detalhes | Hibrido | bool | Indicador de boleto com possibilidade de pagamento através do código de barras ou através de QR Code Pix |
| Detalhes | Emv | string | Código Emv para pagamento através de Pix |
| Detalhes | Imagem | string | Imagem do QR Code em base 64 |
| Detalhes | Operador | string | Nome do operador responsável pela alteração |
| Detalhes | OperadorEmail | string | Endereço de e-mail do operador responsável pela alteração |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
11. Evento de notificação de Pagamento de Boleto
Callback responsável por enviar informações detalhadas sobre o pagamento de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “PagamentoBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | LinhaDigitavel | string | Sequência de números do código de barras com o dígito verificador de cada agrupamento de números do código (até 48 dígitos) |
| Detalhes | CodigoBarras | string | Sequência de números do código de barras do título excluídos os dígitos verificadores de cada agrupamento de números do código (total de 44 dígitos) |
| Detalhes | ValorTitulo | decimal | Valor do título |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | ControleBancario | string | Código utilizado pelo BACEN para identificar de forma única uma determinada transação. Ele é utilizado para conciliar o boleto emitido e o pagamento realizado, permitindo o rastreamento da operação. |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do pagamento realizado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do pagamento do título |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
12. Evento de notificação de Cancelamento de Boleto
Callback responsável por enviar informações detalhadas sobre o cancelamento de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CancelamentoBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto |
| Detalhes | CodigoCancelamento | guid | Código do registro de cancelamento do boleto |
| Detalhes | Sucesso | bool | Indicador da situação do cancelamento do boleto |
| Detalhes | Mensagens | string array | Mensagens da situação do cancelamento do boleto |
| Detalhes | DtTransacao | datetime | Data e hora do cancelamento do boleto |
| Detalhes | Operador | string | Identificador do operador responsável pelo cancelamento do boleto |
| Detalhes | OperadorEmail | string | Endereço de e-mail do operador responsável pelo cancelamento do boleto |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
13. Evento de notificação de Cessão de Boleto
Callback responsável por enviar informações detalhadas sobre a cessão de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CessaoBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto |
| Detalhes | CodigoCessaoBoleto | guid | Código do registro de cessão do boleto |
| Detalhes | SituacaoCessao | string | Descrição da situação da cessão do boleto |
| Detalhes | DtTransacao | datetime | Data e hora da cessão do boleto |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
14. Evento de notificação de Protesto de Boleto
Callback responsável por enviar informações detalhadas sobre o protesto de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “ProtestoBoleto” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto para protesto |
| Detalhes | CodigoProtestoBoleto | guid | Código do registro de protesto do boleto |
| Detalhes | MensagemSituacao | string | Descrição da situação do protesto do boleto |
| Detalhes | Situacao | integer | Identificador da situação do protesto do boleto, onde: 0 = Enviado Bloqueio Pagamento, 1 = Erro Bloqueio Pagamento, 2 = Pendente Envio Protesto, 3 = Processando Envio Protesto, 4 = Enviado Protesto, 5 = Erro Protesto, 6 = Protestado, 7 = Protesto Aguardando Conciliação de Valores, 8 = Protesto Cancelado, 9 = Protesto em Anuência, 10 = Pendente Cancelamento, 11 = Pendente Anuência, 12 = Protesto Pago |
| Detalhes | DtProtesto | datetime | Data e hora do protesto do boleto |
| Detalhes | Operador | string | Nome do operador responsável pelo protesto do boleto |
| Detalhes | OperadorEmail | string | Endereço de e-mail do operador responsável pelo protesto do boleto |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
15. Evento de notificação de Recebimento de Boleto Unificado
Callback responsável por enviar informações detalhadas sobre o recebimento de um boleto unificado.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “BoletoCreditoUnificado” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | Boletos | object array | Lista de boletos unificados |
| Boletos | CodigoBoleto | guid | Código do boleto |
| Boletos | BancoOrigem | string | Código do banco de origem do boleto |
| Boletos | AgenciaOrigem | string | Nº da agência de origem do boleto |
| Boletos | NomePortador | string | Nome do portador do boleto |
| Boletos | DocumentoPortador | string | Nº do documento do portador do boleto |
| Boletos | NossoNumero | string | Identificador único do boleto no sistema do cedente |
| Boletos | DtHrDDA | datetime | Data e hora do Débito Direto Autorizado |
| Boletos | VlrBaixa | decimal | Valor da baixa do boleto |
| Boletos | VlrJuros | decimal | Valor dos juros cobrados na baixa do boleto |
| Boletos | VlrMulta | decimal | Valor da multa cobrada na baixa do boleto |
| Boletos | VlrDesconto | decimal | Valor do desconto recebido na baixa do boleto |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do boleto unificado recebido |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do recebimento do boleto unificado |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
16. Evento de notificação de Prévia de Crédito de Boleto
Callback responsável por enviar informações detalhadas sobre a previsão de crédito de boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “PreviaBoletoCredito” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | CodigoBoleto | guid | Código do boleto |
| Detalhes | VlrTransacao | decimal | Valor informado na baixa do título |
| Detalhes | DtTransacao | datetime | Data e hora da baixa do título |
| Detalhes | BancoOrigem | string | Código do banco do portador do título |
| Detalhes | AgenciaOrigem | string | Nº da agência do portador do título sem o dígito verificador |
| Detalhes | NomePortador | string | Nome do portador do título |
| Detalhes | DocumentoPortador | string | Nº do CPF ou CNPJ do portador do título |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
17. Evento de notificação de Crédito de Boleto
Callback responsável por enviar informações detalhadas sobre o crédito de um boleto.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “BoletoCredito” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoBoleto | guid | Código do boleto creditado |
| Detalhes | BancoOrigem | string | Código do banco do portador do título |
| Detalhes | AgenciaOrigem | string | Nº da agência do portador do título sem o dígito verificador |
| Detalhes | NomePortador | string | Nome do portador do título |
| Detalhes | DocumentoPortador | string | Nº do CPF ou CNPJ do portador do título |
| Detalhes | NossoNumero | string | Identificador único do boleto no sistema do cedente |
| Detalhes | DtHrDDA | datetime | Data e hora do Débito Direto Autorizado |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do boleto creditado |
| Detalhes | VlrJuros | decimal | Valor dos juros recebidos sobre o boleto creditado |
| Detalhes | VlrMulta | decimal | Valor da multa recebida sobre o boleto creditado |
| Detalhes | DtTransacao | datetime | Data e hora do crédito do boleto |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
18. Evento de notificação de Devolução de Título Recebido
Callback responsável por enviar informações detalhadas sobre um título recebido.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “DevolucaoTitulo” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | string | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | CodigoMovimentoEnvioTitulo | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de pagamento de boletos |
| Detalhes | CodigoTransacaoEnvioTitulo | guid | Código utilizado para identificar o registro na tabela de pagamento de boletos que deu origem ao movimento realizado |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da TED devolvida |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da devolução da TED |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
19. Evento de notificação de Geração de Arquivo CNAB 400 de Boletos Cancelados
Callback responsável por enviar informações detalhadas sobre a geração de um arquivo CNAB 400 de boletos cancelados.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CNAB_CAN” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | Origem | integer | Identificador da origem da transação para geração de arquivos CNAB 400 de boletos cancelados. Valor informado = 2004 |
| Detalhes | TipoCNAB | integer | Tipo de arquivo CNAB, onde: 1 = 240, 2 = 400. Valor informado = 2 |
| Detalhes | NomeArquivo | string | Nome do arquivo CNAB 400 de boletos cancelados gerado |
| Detalhes | Situacao | string | Indicador da situação da operação |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da operação |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da geração do arquivo CNAB 400 de boletos cancelados |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
20. Evento de notificação de Geração de Arquivo CNAB 400 de Boletos Pagos
Callback responsável por enviar informações detalhadas sobre a geração de arquivo CNAB 400 de boletos pagos.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CNAB_PGT” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | Origem | integer | Identificador da origem da transação para geração de arquivos CNAB 400 de boletos pagos. Valor informado = 2002 |
| Detalhes | TipoCNAB | integer | Tipo de arquivo CNAB, onde: 1 = 240, 2 = 400. Valor informado = 2 |
| Detalhes | NomeArquivo | string | Nome do arquivo CNAB 400 de boletos pagos gerado |
| Detalhes | Situacao | string | Indicador da situação da operação |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da operação |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da geração do arquivo CNAB 400 de boletos pagos |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
21. Evento de notificação de Geração de Arquico CNAB 400 de Boletos Registrados
Callback responsável por enviar informações detalhadas sobre a geração de arquivo CNAB 400 de boletos registrados.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CNAB_REG” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | Origem | integer | Identificador da origem da transação para geração de arquivos CNAB 400 de boletos registrados. Valor informado = 2001 |
| Detalhes | TipoCNAB | integer | Tipo de arquivo CNAB, onde: 1 = 240, 2 = 400. Valor informado = 2 |
| Detalhes | NomeArquivo | string | Nome do arquivo CNAB 400 de boletos registrados gerado |
| Detalhes | Situacao | string | Indicador da situação da operação |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da operação |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da geração do arquivo CNAB 400 de boletos registrados |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
22. Evento de notificação de Importação de Arquivo CNAB 240 de Remessa
Callback responsável por enviar informações detalhadas sobre a importação de um arquivo CNAB 240 de remessa.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CNABRemessa” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NroVersaoLayout | string | Nº da versão do layout do arquivo CNAB 240 de remessa |
| Detalhes | Origem | integer | Identificador da origem da transação para importação de arquivos CNAB 240 de remessa. Valor informado = 2010 |
| Detalhes | TipoCNAB | integer | Tipo de arquivo CNAB, onde: 1 = 240, 2 = 400. Valor informado = 1 |
| Detalhes | NomeArquivo | string | Nome do arquivo CNAB 240 de remessa importado |
| Detalhes | Situacao | string | Descrição da situação da importação do arquivo CNAB 240 de remessa que poderá ser: - “Arquivo enviado para importação”; - “Arquivo importado com sucesso”. |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da operação |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da importação do arquivo CNAB 240 de remessa |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
23. Evento de notificação de Geração de Arquivo CNAB 240 de Retorno
Callback responsável por enviar informações detalhadas sobre a gerção do arquivo CNAB 240 de retorno.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CNABRemessa” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NroVersaoLayout | string | Nº da versão do layout do arquivo CNAB 240 de remessa |
| Detalhes | Origem | integer | Identificador da origem da transação para importação de arquivos CNAB 240 de remessa. Valor informado = 2010 |
| Detalhes | TipoCNAB | integer | Tipo de arquivo CNAB, onde: 1 = 240, 2 = 400. Valor informado = 1 |
| Detalhes | NomeArquivo | string | Nome do arquivo CNAB 240 de remessa importado |
| Detalhes | Situacao | string | Descrição da situação da importação do arquivo CNAB 240 de remessa que poderá ser: - “Arquivo enviado para importação”; - “Arquivo importado com sucesso”. |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da operação |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da importação do arquivo CNAB 240 de remessa |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
24. Evento de notificação de Compra por Meio de Cartão
Callback responsável por enviar informações detalhadas sobre uma compra realizada via cartão.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “CompraCartao” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NomeEstabelecimento | string | Nome do estabelecimento em que a compra foi realizada |
| Detalhes | CidadeEstabelecimento | string | Nome da cidade onde se localiza o estabelecimento onde a compra foi realizada |
| Detalhes | PaisEstabelecimento | string | Sigla do país onde se localiza o estabelecimento em que a compra foi realizada |
| Detalhes | CodigoMovimento | string | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | TipoTransacao | integer | Identificador do tipo de transação para compra com cartão. Valor informado = 2 |
| Detalhes | TipoTransacaoDesc | string | Descrição do tipo de transação para compra com cartão. Valor informado = “Compra” |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da compra realizada |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da realização da compra |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
25. Evento de notificação de Devolução de Compra por Meio de Cartões
Callback responsável por enviar informações detalhadas sobre a devolução de uma compra realizada via cartão.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “DevolucaoCompraCartao” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NomeEstabelecimento | string | Nome do estabelecimento onde a compra foi realizada |
| Detalhes | CidadeEstabelecimento | string | Nome da cidade onde se localiza o estabelecimento em que a compra foi realizada |
| Detalhes | PaisEstabelecimento | string | Sigla do país onde se localiza o estabelecimento em que a compra foi realizada |
| Detalhes | CodigoMovimento | string | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | TipoTransacao | integer | Identificador da origem da transação para devolução de compra com cartão. Valor informado = 1008 |
| Detalhes | TipoTransacaoDesc | string | Descrição do tipo de transação para compra com cartão. Valor informado = “DevolucaoCompraCartao” |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da compra realizada |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da devolução da compra |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
26. Evento de notificação de Saque por Meio de Cartão
Callback responsável por enviar informações detalhadas sobre um saque realizado via cartão.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “SaqueCartao” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NomeEstabelecimento | string | Nome do estabelecimento onde o saque foi realizado |
| Detalhes | CidadeEstabelecimento | string | Nome da cidade onde se localiza o estabelecimento em que o saque foi realizado |
| Detalhes | PaisEstabelecimento | string | Sigla do país onde se localiza o estabelecimento em que o saque foi realizado |
| Detalhes | CodigoMovimento | string | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | TipoTransacao | integer | Identificador do tipo de transação para saque com cartão. Valor informado = 1 |
| Detalhes | TipoTransacaoDesc | string | Descrição do tipo de transação para compra com cartão. Valor informado = “Compra” |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do saque realizado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da realização do saque |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
27. Evento de notificação de Devolução de Saque por Meio de Cartão
Callback responsável por enviar informações detalhadas sobre a devolução de um saque realizado via cartão.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “SaqueCartao” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | NomeEstabelecimento | string | Nome do estabelecimento onde o saque foi realizado |
| Detalhes | CidadeEstabelecimento | string | Nome da cidade onde se localiza o estabelecimento em que o saque foi realizado |
| Detalhes | PaisEstabelecimento | string | Sigla do país onde se localiza o estabelecimento em que o saque foi realizado |
| Detalhes | CodigoMovimento | string | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | TipoTransacao | integer | Identificador do tipo de transação para saque com cartão. Valor informado = 1 |
| Detalhes | TipoTransacaoDesc | string | Descrição do tipo de transação para compra com cartão. Valor informado = “Compra” |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor do saque realizado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da realização do saque |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
28. Evento de notificação de Envio de TED
Callback responsável por enviar informações detalhadas sobre o envio de um TED.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “EnvioTED” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | FinlddIF | integer | Código do identificador da finalidade da I.F. |
| Detalhes | FinlddIFDesc | string | Descrição do identificador da finalidade da I.F. |
| Detalhes | CodIdentdTransf | guid | Código de identificação da transferência |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | Destinatario | object | Objeto com os dados do destinatário para o envio da TED |
| Destinatario | Agencia | string | Nº da agência sem o dígito verificador |
| Destinatario | AgenciaDigito | string | Nº do dígito verificador da agência |
| Destinatario | Conta | string | Nº da conta sem o dígito verificador |
| Destinatario | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| Destinatario | TipoContaDesc | string | Descrição do tipo da conta de destino |
| Destinatario | ContaDigito | string | Nº do dígito verificador da conta |
| Destinatario | ContaPgto | string | Nº da conta pagamento |
| Destinatario | CodigoBanco | string | Código do banco |
| Destinatario | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| Destinatario | TpPessoaDesc | string | Descrição do tipo de pessoa |
| Destinatario | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário da TED |
| Destinatario | Nome | string | Nome do destinatário da TED |
| Destinatario | CodigoConta | guid | Código da conta do destinatário da TED |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da TED |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do envio da TED |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
29. Evento de notificação de Recebimento de TED
Callback responsável por enviar informações detalhadas sobre o recebimento de um TED.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “RecebTED” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | FinlddIF | integer | Código do identificador da finalidade da I.F. |
| Detalhes | FinlddIFDesc | string | Descrição do identificador da finalidade da I.F. |
| Detalhes | CodIdentdTransf | guid | Código de identificação da transferência |
| Detalhes | Remetente | object | Objeto com os dados do remetente da TED recebida |
| Remetente | Agencia | string | Nº da agência sem o dígito verificador |
| Remetente | AgenciaDigito | string | Nº do dígito verificador da agência |
| Remetente | Conta | string | Nº da conta sem o dígito verificador |
| Remetente | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| Remetente | TipoContaDesc | string | Descrição do tipo da conta |
| Remetente | ContaDigito | string | Nº do dígito verificador da conta |
| Remetente | ContaPgto | string | Nº da conta pagamento |
| Remetente | CodigoBanco | string | Código do banco |
| Remetente | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| Remetente | TpPessoaDesc | string | Descrição do tipo de pessoa |
| Remetente | DocumentoFederal | string | Nº do CPF ou CNPJ do remetente da TED |
| Remetente | Nome | string | Nome do remetente da TED |
| Remetente | CodigoConta | guid | Código da conta do remetente da TED |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da TED recebida |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do recebimento da TED |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
30. Evento de notificação de Devolução de TED
Callback responsável por enviar informações detalhadas sobre a TED realizada.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “DevolucaoTED” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | CodigoMovimentoOrigem | guid | Código que faz referência à transação original responsável por gerar outras transações correlacionadas. Em casos como devoluções ou rejeições, este campo aponta para a transação de envio que originou o movimento |
| Detalhes | Situacao | integer | Indicador da situação da devolução da TED, onde: 0 = Recebido, 1 = Devolvendo, 2 = Devolvido, 99 = Erro |
| Detalhes | SituacaoDesc | string | Descrição da situação da devolução da TED |
| Detalhes | ContaDestino | object | Objeto com os dados da conta de destino para devolução da TED |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta sem o dígito verificador |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | TipoContaDesc | string | Descrição do tipo da conta de destino |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | CodigoBanco | string | Código do banco |
| ContaDestino | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| ContaDestino | TpPessoaDesc | string | Descrição do tipo de pessoa |
| ContaDestino | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário da devolução da TED |
| ContaDestino | Nome | string | Nome do destinatário da devolução da TED |
| ContaDestino | CodigoConta | guid | Código da conta do destinatário da transação quando a conta for da BMP |
| Detalhes | DetalheDevolucao | string | Descrição detalhando o motivo da devolução da TED |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação que originou o lançamento gerado pelo envio da TED |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da TED devolvida |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da devolução da TED |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “C” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
31. Evento de notificação de Transferência Entre Contas da BMP
Callback responsável por enviar informações detalhadas sobre a realização de uma transferência entre contas BMP.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “EnvioTransf” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | CodigoMovimento | guid | Código destinado a identificar o registro de um movimento associado à transação na tabela de movimentos através da chave primária |
| Detalhes | FinlddIF | integer | Código do identificador da finalidade da I.F. |
| Detalhes | FinlddIFDesc | string | Descrição do identificador da finalidade da I.F. |
| Detalhes | CodIdentdTransf | guid | Código de identificação da transferência |
| Detalhes | TipoProcessamento | integer | Identificador do tipo de processamento da transferência |
| Detalhes | TipoProcessamentoDesc | string | Descrição do tipo de processamento da transferência |
| Detalhes | CodigoAutenticacao | guid | Código de autenticação da transferência |
| Detalhes | NumControle | integer | Nº de controle da transferência |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | CodOperacaoCli | string | Código interno para controle de operação do cliente enviado na geração da transação |
| Detalhes | Destinatario | object | Objeto com os dados do destinatário da transferência |
| Destinatario | Agencia | string | Nº da agência sem o dígito verificador |
| Destinatario | AgenciaDigito | string | Nº do dígito verificador da agência |
| Destinatario | Conta | string | Nº da conta sem o dígito verificador |
| Destinatario | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| Destinatario | TipoContaDesc | string | Descrição do tipo da conta de destino |
| Destinatario | ContaDigito | string | Nº do dígito verificador da conta |
| Destinatario | ContaPgto | string | Nº da conta pagamento |
| Destinatario | CodigoBanco | string | Código do banco |
| Destinatario | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| Destinatario | TpPessoaDesc | string | Descrição do tipo de pessoa |
| Destinatario | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário da transferência |
| Destinatario | Nome | string | Nome do destinatário da transferência |
| Destinatario | CodigoConta | guid | Código da conta do destinatário da transferência |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da transferência |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora do envio da transferência |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
32. Evento de notificação de Recebimento de Transferências Entre Contas BMP
Callback responsável por enviar informações detalhadas sobre o recebimento de uma transferência entre contas da BMP.33. Evento de notificação de Outro Movimento
Este callback é resposável por enviar informações detalhadas sobre a realização de um movimento manual executado por um operador da BMP em conta específica.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “OutrosMovimentos” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ContaDestino | object | Objeto com os dados da conta de destino do movimento |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta sem o dígito verificador |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta de destino, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | TipoContaDesc | string | Descrição do tipo da conta de destino |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | CodigoBanco | string | Código do banco |
| ContaDestino | TpPessoa | integer | Identificador do tipo de pessoa, onde: 1 = Física, 2 = Jurídica |
| ContaDestino | TpPessoaDesc | string | Descrição do tipo de pessoa |
| ContaDestino | DocumentoFederal | string | Nº do CPF ou CNPJ do destinatário |
| ContaDestino | Nome | string | Nome do destinatário da conta movimentada |
| ContaDestino | CodigoConta | guid | Código da conta do destinatário da conta movimentada |
| Detalhes | DescricaoOperacao | string | Descrição da operação realizada |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro dentro do contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor movimentado |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da realização do movimento |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
34. Evento de notificação de Recebimento de Mensagens de Integração do SAFE
Callback responsável por enviar informações detalhadas sobre uma mensagem recebida através da integração do SAFE.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “Safe” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | TipoMensagem | string | Código da mensagem recebida |
| Detalhes | DtMensagem | datetime | Data e hora do recebimento da mensagem |
| Detalhes | Mensagem | string | Mensagem recebida convertida em base 64 |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
35. Evento de notificação de Movimento de Cobrança de Serviço
Callback responsável por enviar informações detalhadas sobre um movimento de cobrança de um serviço realizado.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “movimentoServico” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ContaDestino | object | Objeto com os dados da conta onde foi realizada a cobrança |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta sem o dígito verificador |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | TipoContaDesc | string | Descrição do tipo da conta |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | CodigoBanco | string | Código do banco |
| ContaDestino | TpPessoa | integer | Identificador do tipo de pessoa do titular da conta, onde: 1 = Física, 2 = Jurídica |
| ContaDestino | TpPessoaDesc | string | Descrição do tipo de pessoa do titular da conta |
| ContaDestino | DocumentoFederal | string | Nº do CPF ou CNPJ do titular da conta |
| ContaDestino | Nome | string | Nome do titular da conta |
| ContaDestino | CodigoConta | guid | Código da conta |
| Detalhes | DescricaoOperacao | string | Descrição da operação realizada |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da cobrança realizada |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da cobrança realizada |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
36. Evento de notificação de Movimento de Split de Valores Entre Contas
Callback responsável por enviar informações detalhadas sobre um movimento de débito gerado na operação de split entre contas.| Atributo Pai | Atributo | Tipo | Descrição |
|---|---|---|---|
| root | Ambiente | string | Tipo de ambiente em que ocorreu o evento, onde: Staging = Homologação, Production = Produção |
| root | Registro | string | Tipo de registro da mensagem do Callback. Valor informado = “movimentoServico” |
| root | Detalhes | object | Objeto com os detalhes da mensagem do Callback |
| Detalhes | Identificador | string | Identificador do evento |
| Detalhes | ContaDestino | object | Objeto com os dados da conta onde foi realizada a cobrança |
| ContaDestino | Agencia | string | Nº da agência sem o dígito verificador |
| ContaDestino | AgenciaDigito | string | Nº do dígito verificador da agência |
| ContaDestino | Conta | string | Nº da conta sem o dígito verificador |
| ContaDestino | TipoConta | integer | Identificador do tipo da conta, onde: 1 = Corrente, 2 = Poupança, 3 = Pagamento, 4 = Salário |
| ContaDestino | TipoContaDesc | string | Descrição do tipo da conta |
| ContaDestino | ContaDigito | string | Nº do dígito verificador da conta |
| ContaDestino | ContaPgto | string | Nº da conta pagamento |
| ContaDestino | CodigoBanco | string | Código do banco |
| ContaDestino | TpPessoa | integer | Identificador do tipo de pessoa do titular da conta, onde: 1 = Física, 2 = Jurídica |
| ContaDestino | TpPessoaDesc | string | Descrição do tipo de pessoa do titular da conta |
| ContaDestino | DocumentoFederal | string | Nº do CPF ou CNPJ do titular da conta |
| ContaDestino | Nome | string | Nome do titular da conta |
| ContaDestino | CodigoConta | guid | Código da conta |
| Detalhes | DescricaoOperacao | string | Descrição da operação realizada |
| Detalhes | DescCliente | string | Descrição livre fornecida pelo cliente para a operação |
| Detalhes | NSU | integer | Nº sequencial exclusivo utilizado para identificar de forma única um registro na tabela de movimentos, garantindo a singularidade do registro no contexto do sistema |
| Detalhes | VlrTransacao | decimal | Valor da cobrança realizada |
| Detalhes | VlrJuros | decimal | Valor dos juros pagos |
| Detalhes | VlrMulta | decimal | Valor da multa paga |
| Detalhes | DtTransacao | datetime | Data e hora da cobrança realizada |
| Detalhes | TipoLancto | char | Identificador do tipo de lançamento, onde: C = Crédito, D = Débito. Valor informado = “D” |
| Detalhes | Lancamentos | object array | Lista de objetos com os movimentos referentes à cobrança de tarifas ou movimentos de split entre contas referentes ao evento gerado. Obs.: Esta informação será descontinuada em breve e não será mais enviada. |
37. Evento de notificação de Validação Inicial Aprovada
38. Evento de notificação de Validação Inicial Reprovada
- A situação fiscal do documento federal não permite a abertura da conta;
- Não será possível efetuar a abertura da conta;
- O nome informado está divergente com o consultado na receita federal.

