A Documentação contém a lista dos Objetos suportados e suas propriedades e métodos.

Transcrição

1 A Documentação contém a lista dos Objetos suportados e suas propriedades e métodos. ÍNDICE: 1. Objeto IcontaCorrente Objeto IacoesCobrancaRemessa Objeto IacaoCobrancaRemessa Objeto IarquivoRemessa Objeto IdocumentosCobranca Objeto IdocumentoCobranca Objeto IcartaoCredito Objeto IcontroleProcessamentoDocumento Objeto StatusControleProcessamentoEnum Objeto Ienderecos Objeto I Objeto IpadroesBoleto Objeto IpadroesBoleto Objeto Ipadroes Objeto FormaEnvio Enum Objeto ISMTP Objeto IpadroesBoletoImpresso Objeto IpadroesVersoBoleto Objeto IlayoutsArquivoRemessa Objeto IlayoutsArquivoRetorno Objeto IlayoutsBoleto Objeto IlayoutsBoleto Objeto IocorrenciasCobranca Objeto IocorrenciaCobranca Objeto ImotivosOcorrencia Objeto ImotivoOcorrencia Objeto IpadroesAprovacaoCartoes Objeto ModoOperacaoAprovacaoCartaoEnum Objeto IpadroesCobreBemECommerce Objeto ItiposDocumentosCobranca...18 Manual Técnico CobreBemX 1

2 Objeto IcontaCorrente AcoesCobrancaRemessa IAcoesCobrancaRemessa Define as ações de remessa possíveis para um determinado banco e carteira. AjudaCodigoAgencia String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''CodigoAgencia'' para o banco e carteira selecionados. AjudaCodigoCedente String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''CodigoCedente'' para o banco e carteira selecionados. AjudaContaCorrente String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''ContaCorrente'' para o banco e carteira selecionados. AjudaFimNossoNumero String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''FimNossoNumero'' para o banco e carteira selecionados. AjudaInicioNossoNumero String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''InicioNossoNumero'' para o banco e a carteira selecionados. AjudaOutroDadoConfiguracao1 String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''OutroDadoConfiguracao1'' para o banco e carteira selecionados. AjudaOutroDadoConfiguracao2 String Exibe uma breve ajuda a respeito da informação a ser passada na propriedade ''OutroDadoConfiguracao2'' para o banco e carteira selecionados. ArquivoLicenca String Usada para informar o arquivo de licença que será utilizado na geraração dos boletos. ArquivoLicencaCartoesCredito String Usada para informar o arquivo de licença que será utilizado para a aprovação de débito em cartões de crédito, através do serviço Aprova Fácil. ArquivoLicencaCartoesCreditoTexto String Permite que o conteúdo do arquivo de licença seja informado a partir de um banco de dados, ao invés de um arquivo físico em disco. Caso arquivo de licença seja informado a partir de um arquivo em disco, esta propriedade conterá o que deve ser salvo em um campo texto do seu banco de dados. ArquivoLicencaTexto String Permite que o conteúdo do arquivo de licença seja informado a partir de um banco de dados, ao invés de um arquivo físico em disco. Caso arquivo de licença seja informado a partir de um arquivo em disco, esta propriedade conterá o que deve ser salvo em um campo texto do seu banco de dados. ArquivoRemessa IArquivoRemessa Objeto que define as propriedades do arquivo de remessa. ArquivoRetorno IArquivoRetorno Objeto que define as propriedades do arquivo de retorno. CabecalhoCodigoAgencia String Exibe o nome externo usado pelo banco para a propriedade ''CodigoAgencia''. CabecalhoCodigoCedente String Exibe o nome externo usado pelo banco para a propriedade ''CodigoCedente''. CabecalhoContaCorrente String Exibe o nome externo usado pelo banco para a propriedade ''ContaCorrente''. Manual Técnico CobreBemX 2

3 CabecalhoFimNossoNumero String Exibe o nome externo usado pelo banco para a propriedade ''FimNossoNumero''. CabecalhoInicioNossoNumero String Exibe o nome externo usado pelo banco para a propriedade ''InicioNossoNumero''. CabecalhoOutroDadoConfiguracao1 String Exibe o nome externo usado pelo banco para a propriedade ''OutroDadoConfiguracao1''. CabecalhoOutroDadoConfiguracao2 String Exibe o nome externo usado pelo banco para a propriedade ''OutroDadoConfiguracao2''. CnpjCpfCedente String Esta é uma propriedade ''read only'' oriunda do arquivo de licença que identifica o CNPJ ou o CPF do emissor da cobrança. CodigoAgencia String Usada para informar o número da agência do banco que será utilizada para gerar os boletos. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. CódigoCarteira String Está é uma propriedade ''read only'' oriunda do arquivo de licença que identifica qual é o código da carteira. CodigoCedente String Usada para informar o código do cedente ou alguma outra informação necessária para configurar a conta corrente. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. ConfirmaAprovacaoCartao[Index: Integer] String Utilizada quando uma transação de cartão de crédito é aprovada, pois, após salvar os dados no seu banco de dados, é necessário confirmar o recebimento do resultado da aprovação. Caso esta confirmação não seja efetuada, o débito efetuado no cartão de crédito será automaticamente cancelado. DocumentosCobranca IDocumentosCobranca Coleção de objetos de documento de cobrança. FimNossoNumero String Usada para informar o final da numeração do campo ''nosso número''. Quando o campo ''nosso número'' atinge a tal numeração, esta volta para o número informado no campo ''inicio nosso número''. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. GeraHTMLBoleto[Index: Integer] String Propriedade onde é capturado o HTMLboleto usado para gerar boleto na web ou criar uma rotina para envio de boleto por e mail. GeraPDFBoleto[Index: Integer] String Reservado para versões futuras. ImpressaoSolicitada Boolean Indica se o botão de impressão foi clicado na tela de preview. InicioNossoNumero String Usada para informar o início da numeração do campo ''início nosso número''. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. LayoutsArquivoRemessa ILayoutsArquivoRemessa Objeto que define as propriedades dos LayoutsArquivoRemessa. LayoutsArquivoRetorno ILayoutsArquivoRetorno Objeto que define as propriedades dos LayoutsArquivoRetorno. LayoutsBoleto ILayoutsBoleto Propriedade ''read only'' que contém a coleção dos Layouts existentes para os bancos e carteiras especificados Manual Técnico CobreBemX 3

4 no arquivo de licença. LayoutsBoleto ILayoutsBoleto Propriedade ''read only'' que contém a coleção dos Layouts de Boletos para envio por e mail existentes para os bancos e carteiras especificados no arquivo de licença. LocalPagamento String Local de Pagamento do boleto. Caso nada seja informado será exibido a mensagem padrão do banco. MascaraCodigoAgencia String Propriedade ''read only'' carregada a partir do arquivo de licença, esta contém o valor da máscara para digitação deste campo. Recomendamos, utilizar a tela pronta do CBX, chamada a partir do método ''ConfiguraContaCorrente''. MascaraCodigoCedente String Propriedade ''read only'' carregada a partir do arquivo de licença, contém o valor da máscara para digitação do campo. Há uma tela pronta, chame a através do método ''ConfiguraContaCorrente''. MascaraContaCorrente String Propriedade ''read only'' carregada a partir do arquivo de licença, esta contém o valor da máscara para digitação deste campo. Recomendamos, utilizar a tela pronta do CBX, chamada a partir do método ''ConfiguraContaCorrente''. MascaraNossoNumero String Propriedade ''read only'' carregada a partir do arquivo de licença, esta contém o valor da máscara para digitação deste campo. Recomendamos, utilizar a tela pronta do CBX, chamada a partir do método ''ConfiguraContaCorrente''. MascaraOutroDadoConfiguracao1 String Propriedade ''read only'' carregada a partir do arquivo de licença, esta contém o valor da máscara para digitação deste campo. Recomendamos, utilizar a tela pronta do CBX, chamada a partir do método ''ConfiguraContaCorrente''. MascaraOutroDadoConfiguracao2 String Propriedade ''read only'' carregada a partir do arquivo de licença, esta contém o valor da máscara para digitação deste campo. Recomendamos, utilizar a tela pronta do CBX, chamada a partir do método ''ConfiguraContaCorrente''. NaoUsarFatorVencimento Boolean Esta propriedade indica para o componente CBX se deve ou não ser utilizado o fator de vencimento para geração dos boletos. NomeBanco String Propriedade ''read only'' carregada a partir do arquivo de licença, indica o nome do banco. NomeCarteira String Propriedade ''read only'' carregada a partir do arquivo de licença, indica o nome da carteira de cobrança utilizada. NomeCedente String Esta é uma propriedade ''read only'' oriunda do arquivo de licença, que identifica o nome do emissor das cobranças. NumeroBanco String Esta é uma propriedade ''read only'' oriunda do arquivo de licença, que identifica o número do banco. NumeroContaCorrente String Usada para informar o número da conta corrente que será utilizada para gerar os boletos. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. OcorrenciasCobranca IOcorrenciasCobranca Coleção onde são carregados os dados do arquivo de retorno. Manual Técnico CobreBemX 4

5 OutroDadoConfiguracao1 String Usada como campo auxiliar no processo de configuração somente é usada quando necessária. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. OutroDadoConfiguracao2 String Usada como campo auxiliar no processo de configuração somente é usada quando necessária. Esta propriedade normalmente é informada pelo usuário no momento da configuração da conta corrente, podendo ser chamada pelo método ''ConfiguraContaCorrente''. PadroesAprovacaoCartoes IPadroesAprovacaoCartoes Objeto que especifica os padrões a serem utilizados na utilização do Aprova Fácil. PadroesBoleto IPadroesBoleto Este Objeto informa os dados definidos como padrões para a geração dos boletos. PadroesCobreBemECommerce IPadroesCobreBemECommerce Especifica as propriedades referentes ao processamento do Cobre Bem E Commerce. ProximoNossoNumero String Contém a informação do último nosso número gerado. SolicitaAprovacaoCartao[Index: Integer] Boolean Envia uma solicitação de aprovação de débito em um cartão de crédito para o serviço Aprova Fácil. Se retornar status verdadeiro o débito foi aprovado, se retornar status falso o débito foi negado. TiposDocumentosCobranca ITiposDocumentosCobranca Objeto que define as propriedades de TiposDocumentosCobranca. UltimaMensagemErro String Retorna a última mensagem de erro ocorrida na utilização do CobreBemX. Esta propriedade deve ser sempre verificada após passar um arquivo de licença para o CobreBemX. ValorNaoIdentificado Boolean Passe ''True'' nesta propriedade caso deseje que o valor do boleto não seja identificado no código de barras não é aconselhado o uso desta funcionalidade. Versao String Propriedade ''read only'' que retorna a versão do CobreBemX que está sendo utilizada. Métodos: CalcularDadosBoletos Efetua apenas os cálculos dos dados do documento de cobrança, como por exemplo, o(s) dígito(s) verificador(es) do Nosso Número. CarregaArquivosRetorno Carrega o arquivo retorno do banco, populando a coleção ''OcorrenciasCobranca''. CarregaBoletosCobreBemECommerce Reservado para versões futuras. ConfiguraContaCorrente Exibe uma tela para o Cedente configurar os dados da conta corrente. EnviaBoletosPor Verifica toda a coleção ''DocumentosCobranca'', procurando os boletos selecionados para o envio por e mail. ExportaBoletos2aVia Reservado para integração futura com o serviço 2aVia.com. GravaArquivoRemessa Verifica toda a coleção ''DocumentosCobranca'', procurando os boletos selecionados para a gravação da remessa, gravando então, o registro detalhe para ele. Manual Técnico CobreBemX 5

6 ImprimeBoletos Verifica toda a coleção ''DocumentosCobranca'', procurando os boletos não selecionados para o envio de e mail e geração do arquivo remessa ou boletos selecionados para impressão (default), gerando uma tela de ''Preview''. ImprimeBoletosSemPreview Este método é equivalente ao método ''ImprimeBoletos'', porém, não exibe a tela de preview da impressão, enviando os boletos diretamente para a impressora selecionada como padrão no Windows. SolicitaAprovacaoCartoes Solicita a aprovação de débito para todos os cartões de crédito informados na coleção ''IDocumentosCobranca''. Objeto IAcoesCobrancaRemessa Count Integer Indica quantas ações de cobrança existem na coleção. Item[Index: Integer] IAcaoCobrancaRemessa Objeto que define a lista de cobrança de remessas existentes. Métodos: Recarrega(const Values: WideString) Uso interno do CobreBemX. Objeto IAcaoCobrancaRemessa Codigo String Define o código para fazer a Remessa. Descricao String Informa a descrição do ''Codigo'' escolhido. Objeto IArquivoRemessa Arquivo String Especifica o nome do arquivo, se nenhum nome for informado, o arquivo será criado com o nome padrão. DataGravacao String Especifica a data de gravação, se nenhuma data for informada, será usada a data da máquina. Diretorio String Especifica o diretório onde será gravado o arquivo de remessa, caso nenhum diretório seja informado, será gravado no mesmo diretório onde se encontra o arquivo de licença. Layout String Informa se o arquivo de remessa será gerado no padrão FEBRABAN240 ou CNAB400. Sequencia Integer Indica a sequência dos arquivos gerados, se nada for informado, os arquivos irão como 001. TipoImpressao String Especifica o tipo de impressão que o Banco irá realizar, a partir dos dados contidos na remessa. Manual Técnico CobreBemX 6

7 Objeto IDocumentosCobranca Add IDocumentoCobranca Cria um novo documento de cobrança. Count Integer Indica quantos elementos tem a coleção. Item[Index: Integer] IDocumentoCobranca Identifica cada documento de cobrança criado. Métodos: Clear Apaga todos os itens da coleção. Delete(Index: Integer) Apaga um item da coleção. Objeto IdocumentoCobranca AcaoCobrancaRemessa IAcaoCobrancaRemessa Objeto do tipo ''AcaoCobrancaRemessa'', sendo assim, dentre a lista da coleção ''AcaoCobrancaRemessa'', poderá ser escolhido a ação de cobrança desejada. Associe o item da coleção a esta propriedade. Caso não seja associada nenhuma ''AcaoCobrancaRemessa'', o CobreBemX irá executar a 1a remessa Ex. Está sendo realizada a ação ''protesto'', esta é o 3o item dos elementos da coleção ''AcaoCobrancaRemessa''. Basta associar o 3o item da ''AcaoCobrancaRemessa'' a esta propriedade. Aceite String Informe nesta propriedade o tipo de ''aceite'' a ser impresso no boleto. Deverá ser especificado, se deseja ou não o ''Aceite''. No caso dos Bancos que não utilizam o ''Aceite'', como por exemplo, o HSBC, qualquer valor informado será ignorado pelo CobreBemX. AgenciaDebito String Reservado para futuras versões. BairroSacado String Atribua o valor desta propriedade com o bairro do sacado. BancoEmiteBoleto Boolean Indica se o Banco irá imprimir o boleto a partir do arquivo de remessa recebido. BancoGeraNossoNumero Boolean Indica se o Banco irá gerar o Nosso Número do boleto. Quando o banco for gerar o Nosso Número torna se necessário carregar este dado a partir do arquivo de retorno gerado pelo Banco. CalculaDacNossoNumero Boolean É preenchida com ''true'' caso tenha sido informado a propriedade NossoNumero, e deseje que o CobreBemX efetue o cálculo do dígito verificador. Em todas as outras situações esta propriedade deve ser deixada ''em branco''. CartaoCredito ICartaoCredito Objeto que contém os dados para aprovação de débito em cartão de crédito e os dados do resultado da solicitação de aprovação. CepSacado String Atribua o valor desta propriedade com o cep do Sacado. CidadeSacado String Atribua o valor desta propriedade com a cidade do Sacado. Manual Técnico CobreBemX 7

8 CNPJSacado String Atribua com o CNPJ do Sacado. CodigoBarras String Propriedade ''read only'' que contém os números utilizados para a geração do Código de Barras. O valor desta propriedade somente é gerado após ''chamar'' um dos métodos abaixo: ''ImprimeBoletos'' Impressão, ''ImprimeBoletosSemPreview'' Impressão sem preview, ''EnviaBoletosPor ' Enviar o boleto por e mail' ou ''GeraHTMLBoleto'' Gera o HTML do boleto. ContaCorrenteDebito String Reservado para versões futuras. ControleProcessamentoDocumento IControleProcessamentoDocumento Especifique qual o processo a ser utilizado para o ducumento de cobrança Ex. Deseja se enviar um boleto por e mail, imprimir o mesmo ou gravar arquivo de remessa. O objeto ''ControleProcessamentoDocumento'' possui as seguintes propriedades: ''ImprimeBoleto'', ''EnvioBoleto '', ''GravaRemessa'' e a Exportação para o 2a Via.com (ainda não disponível nesta versão). CPFSacado String Atribua o valor desta propriedade com o CPF do Sacado. DataDocumento String Data da geração do documento desejada para o boleto. Se esta propriedade for passada ''em branco'', será utilizada a data da máquina. Quando for informada esta propriedade, deverá seguir o formato dd/mm/aaaa. DataProcessamento String Utilize esta propriedade sempre que desejar informar uma data da máquina. Quando informado, esta propriedade, deverá seguir o formato dd/mm/aaaa. DataVencimento String Atribua o valor desta propriedade a data de vencimento desejada para o boleto. Se for necessário gerar um boleto ''sem data de vencimento'' definida, coloque o texto ''À Vista'' nesta propriedade. Se esta propriedade estiver ''em branco'' será verificado o valor desta propriedade como Prazo de Vencimento. Se informado, esta propriedade deve serguir o formato dd/mm/aaaa. DebitoContaCorrente Boolean Reservado para futuras versões. DiasProtesto Integer Se desejar protestar informe a quantidade de dias para realização do protesto. EnderecoSacado String Atribua o valor desta propriedade com o endereço do Sacado. Enderecos Sacado IEnderecos Especifique nesta propriedade, o endereço de e mail do destinatário. Para informar mais de um endereço para o mesmo sacado, utilize o separador ponto e vírgula (;) entre os mesmos. EstadoSacado String Atribua o valor desta propriedade com o estado do Sacado. LinhaDigitavel String Propriedade ''read olny'' que contém os números incluídos na Linha Digitável do Boleto. O valor desta propriedade somente é gerado após chamar um dos métodos a seguir: ''ImprimeBoletos'', ''ImprimeBoletosSemPreview'', ''EnviaBoletosPor '' ou ''GeraHTMLBoleto''. MinhaChave String Permite que o desenvolvedor associe a um documento de cobrança um código para localização fácil em seu banco de dados. Não é utilizada para nada no CobreBemX, podendo conter qualquer valor desejado. Moeda String Atribua o valor desta propriedade com o símbolo da moeda, somente quando o boleto não for emitido em Reais. Manual Técnico CobreBemX 8

9 NomeSacado String Atribua o nome de quem irá pagar o boleto (Sacado). NossoNumero String Informe nesta propriedade o número a ser adotado para que seja gerado o Nosso Número. Se não for informado nenhum nosso número, o CobreBemX irá gerar o nosso número sequencialmente baseado na propriedade ''ProximoNossoNumero'' da conta corrente. Para isso será somado + 1 à propriedade ''ProximoNossoNumero'' e calculado o dígito verificador, atribuindo à propriedade ''NossoNumero'' o valor calculado. Resumindo, se desejar que o CobreBemX numere os boletos, siga o procedimento abaixo: Após o CobreBemX numerar os boletos, faça a leitura dos documentos de cobrança e salve no banco de dados os valores que ele gerou para o Nosso Número. Realizado este procedimento posteriormente, poderá ser processada a carga do arquivo de retorno. Veja o exemplo disponibilizado em VisualBasic e Delphi com Banco de Dados na pasta ''ExemplosUtilizacao'' existente na Documentação do componente CobreBemX. Na propriedade ''ProximoNossoNumero'' após a geração dos boletos, arquivo de remessa, envio por e mail ou impressão, salve o valor do próximo nosso número na base de dados. Também poderá ser informado um valor desejado para ser utilizado no Nosso Número do boleto, através da propriedade ''NossoNumero'', porém, este valor deve respeitar a quantidade máxima de caracteres da propriedade ''MascaraNossoNumero''. Sempre que for especificado um valor para a propriedade ''NossoNumero'', passe o valor ''True'' na propriedade ''CalculaDacNossoNumero''. Isto não é obrigatório, porém, se não for feito, será necessário informar a propriedade ''NossoNumero'' já com o(s) digíto(s) verificador(es) calculado(s). NumeroDocumento String Atribua o valor desta propriedade com o seu número de documento, por exemplo, o número do pedido ou nota fiscal. NumeroParcelaCarnet Integer Número da parcela a ser informada no arquivo de remessa, para impressão de carnets pelos Bancos. PadroesBoleto IPadroesBoleto Destina se à criação de Padrões a serem utilizados na emissão dos boletos, sendo possível, a emissão de boletos para diferentes layouts. No caso de utilização de dois layouts de boleto, o CobreBemX irá emitir o primeiro boleto utilizando o layout de Boleto Padrão e o segundo boleto utilizando o layout de Boleto Frente e Verso. Para não ocasionar erros, como por exemplo, a quebra de páginas, não é recomendável utilizar o modelo carnet. PercentualDesconto Double Atribua o valor desta propriedade com o Percentual do Desconto a ser concedido sobre o vaor do documento. PercentualJurosDiasAtraso Double Atribua o valor desta propriedade com o valor do percentual de juros a ser cobrado por dia em caso de atraso no pagamento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. PercentualMultaAtraso Double Atribua o valor desta propriedade com o percentual de multa a ser cobrado por atraso no pagamento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. PercentualOutrosAcrescimos Double Atribua o valor desta propriedade com o Percentual Outros Acréscimos a serem somados sobre o valor do documento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. QuantidadeMoeda Double Atribua este valor, se desejar emitir boletos em outras moedas, como por exemplo, Dólar. SacadorAvalista String Atribua o valor desta propriedade com o nome do avalista, caso este exista. Senha2aVia String Reservado para futuras versões para conexão com o serviço 2aVia.com. TipoDocumentoCobranca String Especifique o Tipo de Documento de Cobrança que será adotado para emissão do boleto bancário. Na coleção ''TiposDocumentosCobranca'', poderá ser escolhido o Tipo de Documento de Cobrança desejado. Associe o item desta Manual Técnico CobreBemX 9

10 coleção a esta propriedade. Se não for associado nenhum Tipo Documento Cobrança, o CobreBemX irá gerar RC Recibo. TotalParcelasCarnet Integer Quantidade total de parcelas informado no arquivo remessa para impressão pelo Banco. Usuario2aVia String Reservado para futuras versões para conexão com o serviço 2aVia.com. ValorDesconto Double Atribua a esta propriedade o valor do desconto a ser concedido sobre o valor do documento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. ValorDocumento Double Atribua o valor desta propriedade com o valor do desconto a ser concedido sobre o valor do documento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. Poderá ser especificado o Percentual do Desconto ou Valor desejado. ValorJurosDiaAtraso Double Atribua o valor desta propriedade com o valor de juros a ser cobrado por dia em caso de atraso no pagamento. Esta propriedade segue as mesm regras de formatação da propriedade ''ValorDocumento''. Poderá ser especificado o Percentual de Juros Dia Atraso ou Valor desejado. ValorMultaAtraso Double Atribua a esta propriedade o valor de Multa a ser cobrado por atraso no pagamento. Esta propriedade segue as mesmas regras de formatação da propriedade ''ValorDocumento''. ValorOutrosAcrescimos Double Atribua a esta propriedade o valor dos acréscimos a serem somados ao valor do documento. Esta propriedade segue as regras de formatação da propriedade ''ValorDocumento''. Objeto ICartaoCredito AnoValidade Integer Ano de validade do cartão de crédito. CartaoMascarado String Número do cartão de crédito sem conter todos os dígitos, o mascaramento é feito de acordo com o padrão especificado por cada Administradora. CodigoAutorizacao String Código de autorização retornado pela Administradora de cartão de crédito quando a transação foi aprovada. CodigoSeguranca String Código de segurança também conhecido como CVV2, impresso na maioria dos cartões. ComprovanteAdministradora String Comprovante retornado pela Administradora do cartão quando a transação foi aprovada. DiaParaAgendar Integer Dia para o qual deve ser agendado o próximo débito de um cartão de crédito em processos de débitos mensais sucessivos. Não é venda parcelada. ExcluiAgendamento Boolean Quando o valor é verdadeiro comanda a exclusão de agendamento, incluído anteriormente. IncluiAgendamento Boolean Quando verdadeiro solicita a inclusão de agendamento de débitos mensais. MesValidade Integer Mês de validade do cartão de crédito. Numero String Número do cartão de crédito com o mínimo de 13 e o máximo de 16 dígitos. Somente informar números. Manual Técnico CobreBemX 10

11 QuantidadeMesesParaAgendar Integer Quantidade de meses a debitar sucessivamente o cartão de crédito. Atentamos que esse tipo de venda não é a mesma coisa que venda parcelada. QuantidadeParcelas Integer Quantidade de parcelas a ser utilizada na venda parcelada. É necessário que o contrato com a Administradora do cartão permita venda parcelada. ResultadoSolicitacaoAprovacao String Descrição do resultado da solicitação de aprovação da transação no cartão de crédito. Transacao String Número da transação gerada para a solicitação no Aprova Fácil. TransacaoAprovada Boolean Se verdadeiro indica que a Administradora do cartão de crédito aprovou a transação de débito. Objeto IControleProcessamentoDocumento Envia StatusControleProcessamentoEnum Esta propriedade poderá assumir o valor scpexecutar = $ para enviar boletos por e mail. Caso não seja informado nenhum valor para as propriedades de Controle de Processamento do Documento, o CobreBemX irá assumir que os boletos serão enviados por e mail. Para retorno do processamento o CobreBemX retornará um dos valores listados abaixo: scpexecutar $ Se o envio foi com sucesso; spcinvalido = $ Deu inválido; scperro = $ Se ocorreu algum erro no envio o CobreBemX poderá executar a Impressão de Boletos, o envio de Boleto por e mail, a gravação do arquivo de remessa e a exportação para o 2aVia.com (ainda não disponível nesta versão). Após o processamento das referidas propriedades, o CobreBemX retornará um dos valores acima citados, informando a mensagem de erro. Exporta2aVia StatusControleProcessamentoEnum Reservado para versões futuras. GravaRemessa StatusControleProcessamentoEnum Esta propriedade poderá assumir o valor scpexecutar = $ para gravar arquivo de remessa. Caso não seja informado nenhum valor para a propriedade de Controle de Processamento do Documento, o CBX irá assumir que os boletos serão enviados por e mail. Para retorno do processamento o CobreBemX retornará um dos valores listados a seguir: scpexecutar $ Se o envio foi com sucesso; spcinvalido = $ Deu inválido; scperro = $ Se ocorreu algum erro no envio o CobreBemX poderá executar a Impressão de Boletos, o envio de Boleto por e mail, a gravação do arquivo de remessa e a exportação para o 2aVia.com (ainda não disponível nesta versão). Após o processamento das referidas propriedades, o CBX retornará um dos valores acima citados, informando a mensagem de erro. Imprime StatusControleProcessamentoEnum Esta propriedade poderá assumir o valor scpexecutar = $ para imprimir boletos. Caso não seja informado nenhum valor para as propriedades de Controle de Processamento do Documento, o CobreBemX irá assumir que os boletos serão enviados por e mail. Para retorno do processamento o CobreBemX retornará um dos possíveis valores listados a seguir: scpexecutar $ Se o envio foi com sucesso; spcinvalido = $ Deu inválido; scperro = $ Se ocorreu algum erro no envio o CobreBemX poderá executar a Impressão de Boletos, o envio de Boleto por e mail, a gravação do arquivo de remessa e a exportação para o 2aVia.com (ainda não disponível nesta versão). Após o processamento das referidas propriedades, o CobreBemX retornará um dos valores acima citados, informando a mensagem de erro. Manual Técnico CobreBemX 11

12 MensagemEnvio String Reservado para versões futuras. MensagemExportacao2aVia String Reservado para versões futuras. MensagemGravacaoRemessa String Reservado para versões futuras. MensagemImpressao String Reservado para versões futuras. Objeto StatusControleProcessamentoEnum scperro = $ scpexecutar = $ scpinvalido = $ scpnaoexecutar = $ scpok = $ Objeto IEnderecos Add I Cria um novo endereço de e mail. Count Integer Indica quantos elementos tem a coleção. Item[Index: Integer] I Identifica cada endereço de e mail criado. Métodos: Clear Apaga todos os itens da coleção. Delete(Index: Integer) Apaga um item da coleção. Objeto I Endereco String Indica o endereço de e mail de quem está enviando o e mail obrigatório. Nome String Indica o nome de quem está enviando o e mail opcional. Objeto IPadroesBoleto Demonstrativo String Seta as informações que serão exibidas no campo ''demonstrativo'' dos boletos. IdentificacaoCedente String Seta as informações que aparecerão à direita do logotipo no cabeçalho do boleto. InstrucoesCaixa String Seta as informações que serão exibidas no campo ''instruções caixa'' dos boletos. Manual Técnico CobreBemX 12

13 PadroesBoleto IPadroesBoleto Este objeto define as propriedades padrões para envio de boletos por e mail. PadroesBoletoImpresso IPadroesBoletoImpresso Este objeto define as propriedades padrões para impressão dos boletos. Titulo String Esta propriedade seta o título que aparecerá no navegador do browser quando da geração do boleto. Objeto IPadroesBoleto LayoutBoleto String Informa qual o tipo de layout a ser utilizado no boleto a ser enviado por e mail. NomeFonte String Nome do fonte a ser utilizado para todo o texto contido nos boletos enviados por e mail. O fonte deve estar instalado no computador que efetivamente vai imprimir os boletos, ou seja, de quem irá receber o e mail. Padroes IPadroes Este objeto defini as informações padrões para envio de boleto por e mail. SMTP ISMTP Objeto que define as propriedades do objeto ISMTP. URLImagensCodigoBarras String Define a URL onde está as imagens do código de barras para enviar os boletos por e mail. URLLogotipo String Define a URL onde está a imagem do logotipo para enviar os boletos por e mail. Objeto IPadroes Assunto String Define o assunto do e mail. CopiaFrom Boolean Indica se deve ou não ser enviada uma cópia para o emissor do boleto. CopiaReply Boolean Indica se deve ou não ser enviada uma cópia para endereço de reply. From I Define o endereço de e mail da pessoa quebra está enviando o boleto por e mail. Reply I Indica se deve ou não ser enviada uma cópia para o endereço de reply. Forma Envio FormaEnvio Enum Objeto do tipo enumerador. Mensagem String Define a mensagem que irá no corpo do e mail. Objeto FormaEnvio Enum feeoutlookboletohtml = $ Envia o boleto em HTML no corpo de e mail conectando se ao outlook através de OLEAutomation não funciona no Outlook Express. feeoutlookmensagemboletohtmlanexo = $ Envia o boleto em HTML anexado ao e mail conectando se ao outlook através do OLEAutomation, com a Manual Técnico CobreBemX 13

14 possibilidade de escrever uma mensagem no corpo do e mail. Não funciona no outlook express. feeoutlookmensagemboletopdfanexo = $ Ainda não disponível. feeoutlookmensagemlinhadigitavel = $ B Envia apenas a linha digitável no corpo do e mail, obrigando o sacado a pagar o boleto apenas no HomeBanking conectando se ao outlook através de OLEAutomation e não funciona com o outlook express. feeoutlookmensagemlinhadigitavelurlcobrebemecommerce = $ Seta uma mensagem padrão que fica logo abaixo da linha digitável, onde o CBX inclui ao final da mensagem uma URL para chamar o Cobre Bem E Commerce e gerar o boleto on line conectando se ao outlook através de OLEAutomation e não funciona com outlook express. feeoutlookmensagemurlcobrebemecommerce = $ A Seta uma mensagem padrão onde o CBX inclui ao final da mensagem uma URL para chamar o Cobre Bem E Commerce e gerar o boleto on line, porém, sem a linha digitável no corpo do e mail, conecta se ao outlook através de OLEAutomation e não funciona com outlook express. feesmtpboletohtml = $ Envia o boleto em HTML no corpo do e mail. feesmtpmensagemboletohtmlanexo = $ Envia o boleto em HTML anexado ao e mail, dando a possibilidade de escrever uma mensagem no corpo do e mail, esta, setada pela propriedade ''Mensagem'' do objeto ''IPadroes ''. feesmtpmensagemboletopdfanexo = $ Formato ainda não disponível. feesmtpmensagemlinhadigitavel = $ Envia apenas a linha digitável no corpo do e mail, obrigando o Sacado a pagar o boleto apenas no HomeBanking. feesmtpmensagemlinhadigitavelurlcobrebemecommerce = $ Seta uma mensagem padrão que fica logo abaixo da linha digitável, onde o CBX inclui ao final da mensagem uma URL para chamar o Cobre Bem E Commerce e gerar o boleto on line. feesmtpmensagemurlcobrebemecommerce = $ Seta uma mensagem padrão que o CBX inclui ao final da mensagem uma URL para chamar o Cobre Bem E Commerce e gerar o boleto on line, porém sem a linha digitável no corpo do e mail. Objeto ISMTP Porta Integer Identifica a porta a ser utilizada obrigatório. Senha String Define a senha do usuário SMTP. Servidor String Especifica o domínio SMTP a ser usado obrigatório. Usuario String Define o usuário SMTP. Objeto IPadroesBoletoImpresso AlturaPapel Integer Especifica a altura em pixels para papéis não padrão. Manual Técnico CobreBemX 14

15 ArquivoLogotipo String Define o caminho físico de onde está o logotipo a ser usado no boleto. CaminhoImagensCodigoBarras String Define o caminho físico de onde estão as imagens que compõe o código de barras. ExibeSelecaoImpressora Boolean Se verdadeiro, exibirá automaticamente a tela de seleção de impressora, antes de enviar os boletos a serem impressos para a impressora padrão. Desta forma, o usuário poderá solicitar a impressão para uma impressora que não esteja selecionada como padrão. HTMLReciboPersonalizado String Define o código HTML a ser usado no ''recibo do sacado''. LarguraPapel Integer Especifica a largura em pixels para papéis não padrão. LayoutBoleto String Especifica o layout do boleto a ser utilizado. Os valores válidos estão disponíveis na coleção ''LayoutsBoleto'' da classe ''ContaCorrente''. Se nenhum valor for atribuido a esta propriedade será utilizado o valor ''Padrao''. MargemEsquerda Integer Especifica a margem esquerda para impressão do boleto. MargemSuperior Integer Especifica a margem superior para impressão do boleto. NomeFonte String Nome do fonte a ser utilizado para todo o texto contido nos boletos impressos. O fonte deve estar instalado no computador que efetivamente vai imprimir os boletos. NomeImpressora String Especifica o nome da impressora para a qual deverá ser enviada a impressão dos boletos. PadroesVersoBoleto IPadroesVersoBoleto Define os padrões para impressão do verso do boleto. RedutorLargura Integer Reduz a largura da área impressa do boleto e tem como objetivo permitir o ajuste das dimensões do boleto para utilização de máquinas envelopadoras. Os valores são informados em pixels, utilize valores positivos para aumentar e valores negativos para diminuir a largura do boleto. Objeto IPadroesVersoBoleto HTMLVersoPersonalizado String Caso não queira usar o verso padrão, defina aqui o código HTML do formato desejado. Propaganda String Informa o código HTML de propaganda que vai no verso. Remetente String Informa o código HTML que possui os dados do remetente. Objeto ILayoutsArquivoRemessa Count Integer Quantidade de elementos para banco e carteira. Propriedade ''read only'' oriundo do arquivo de licença. Item[Index: Integer] String Indica o nome do elemento. Manual Técnico CobreBemX 15

16 Métodos: Recarrega(const Values: WideString) Uso interno do CobreBemX. Objeto ILayoutsArquivoRetorno Count Integer Quantidade de elementos para este banco e carteira. Item[Index: Integer] String Indica o nome do elemento. Métodos: Recarrega(const Values: WideString) Uso interno do CobreBemX. Objeto ILayoutsBoleto Count Integer Informa o número de elementos da coleção. Item[Index: Integer] String Informa os nomes dos layouts disponíveis dentro do arquivo de licença. Métodos: Recarrega(const Values: WideString) Uso interno do CobreBemX. Objeto ILayoutsBoleto Count Integer Informa o número de elementos da coleção. Item[Index: Integer] String Informa os nomes dos dos tipos de layouts disponíveis, dentro do arquivo de licença que está sendo utilizado. Métodos: Recarrega(const Values: WideString) Uso interno do CobreBemX. Objeto IOcorrenciasCobranca Count Integer Lista quantos itens tem na coleção. Item[Index: Integer] IOcorrenciaCobranca Indica cada elemento do tipo ocorrência cobrança. Métodos: Add(const NossoNumero: WideString) Método para uso interno do componente. Não utilizar este método. Manual Técnico CobreBemX 16

17 Clear Método para uso interno do componente. Não utilizar este método. Objeto IOcorrenciaCobranca CodigoOcorrencia String Dado informado pelo banco no arquivo de retorno. DataCredito String Data em que vai ser feito o crédito do boleto dd/mm/aaaa. DataOcorrencia String Data da ocorrência junto ao banco. MotivosOcorrencia IMotivosOcorrencia Coleção que contém os Motivos da Ocorrência caso eles existam. NossoNumero String Informação fornecida pelo banco ao cedente através do arquivo de retorno. Verifique com seu banco como ele disponibilizará este arquivo para que seja possível ser verificado por você. NumeroDocumento String Para cobranças do tipo escritural, ou seja, com registro. Esta propriedade será preenchida com o número do documento enviado para o banco através do arquivo de remessa. Verifique com seu banco como o arquivo deverá ser encaminhando ao mesmo. Pagamento Boolean Informa os pagamentos das ocorrências, ou seja, se a ocorrência apresenta que esta paga ou se não está apresentando pagamento. ValorCredito Double Valor líquido creditado pelo banco. ValorJurosPago Double Valor do juros pago. ValorMultaPaga Double Valor da multa paga. ValorPago Double Valor que foi pago. ValorTaxaCobranca Double Valor das taxas cobradas pelo banco. Objeto IMotivosOcorrencia Count Integer Indica quantos motivos estão disponíveis. Item[Index: Integer] IMotivoOcorrencia Identificação de uma ocorrência da coleção. Objeto IMotivoOcorrencia Codigo String Indica o código do motivo. Descricao String Descreve o motivo. Manual Técnico CobreBemX 17

18 Objeto IPadroesAprovacaoCartoes ModoOperacao ModoOperacaoAprovacaoCartaoEnum Modo de operação a ser utilizado na solicitação de aprovação de débito em cartão de crédito. O valor padrão é 0 que identifica o modo de operação de teste. O valor 1 identifica o modo de operação de simulação e o valor 2 identifica o modo de operação em produção. Somente no modo de produção a solicitação de débito no cartão de crédito é enviada para a Administradora. O modo de teste é aprovado ou negado de forma aleatória pelo próprio CobreBemX e no modo de simulação a solicitação é aprovada ou negada de forma aleatória pelo servidor do Aprova Fácil. NomeFrameRetorno String Quando utilizada a solução de automação Komerci e a página da loja virtual tiver frames informe para esta propriedade o nome do frame que deve ser utilizado para a exibição da página de digitação dos dados. URLImagemSuperiorKomerci String URL a ser utilizada pelo sistema Komerci para exibir a parte superior da página de digitação dos dados do cartão de crédito no site da Redecard. URLRetornoAdministradora String URL que será chamada pela Administradora para informar para o Aprova Fácil o resultado da transação. ValidarCPF Boolean Reservado para versões futuras. Objeto ModoOperacaoAprovacaoCartaoEnum moacproducao = $ moacsimulacao = $ moacteste = $ Objeto IPadroesCobreBemECommerce CabecalhoHTML String Indica qual é o HTML do cabeçalho. CSID String Indica o CSID, ou seja, apelido de conta corrente, utilizado para gerar boletos para esta conta corrente. RodapeHTML String Indica qual é o HTML do rodapé. ScriptHTML String Indica qual é o script html que deseja utilizar para gerar boletos para esta conta. URL String Indica onde está o Cobre Bem E Commerce na web para gerar os boletos. URLOrigem String Utilizado para indicar o domínio que está gerando o boleto. UsuarioBoleto String Indica qual é o usuário boleto para gerar os boletos. Objeto ITiposDocumentosCobranca Codigo String Indica o código do tipo de documento de cobrança Ex. RC, DM etc. Nome String Descreve o tipo de documento de cobrança. Manual Técnico CobreBemX 18