Desvendando a API – Part. 6 : Adicionais – Mensagens e Configuração de Boleto
por MoIP LabsUtilizando a API MOIP você possui flexibilidade em sua aplicação, no caso de pagamentos por boleto bancário é possível definir a quantidade de dias para vencimento ou uma data fixa para vencimento do mesmo, além de poder informar instruções e um logotipo personalizado que serão visualizadas por seus clientes ao gerarem um boleto.
Utilizando o parâmetro DiasExpiracao em sua aplicação será possível estipular a quantidade de dias desejados para expiração do boleto, para isso é necessário informar os valores Corridos ou Uteis que correspondem a dias corridos ou dias úteis, conforme exemplo:
Código HTML:
<Boleto>
<DiasExpiracao Tipo="Corridos">7</DiasExpiracao>
</Boleto>
Repare que o parâmetro recebe o valor Corridos para definir que o tipo de contagem de dias para vencimento do boleto, no exemplo anterior são 7 dias corridos.
Invés de estipular uma quantidade de dias você também pode fixar uma data fixa para que ocorra o vencimento do boleto utilizando o parâmetro DataVencimento, seguindo exemplo:
Código HTML:
<Boleto>
<DataVencimento>2011-04-06T12:01:48.703-02:00</DataVencimento>
</Boleto>
Ressaltando que o parâmetro recebe um valor em formato dateTime, onde deve ser estipulado conforme exemplo anterior. Para maiores informações orientamos que acesse o seguinte artigo:
http://labs.moip.com.br/forum/showthread.php?17-lt-DataVencimento-gt
Caso os dois parâmetros sejam enviados (DiasExpiracao e DataVencimento), a data de vencimento do boleto será calculada a partir do DiasExpiracao. Caso a data calculada supere a DataVencimento, a DataVencimento é usada no Boleto.
Você também poderá informar o parâmetro Instrucao que exibirá o valor atribuído a mesma no boleto bancário, sendo que é possível a utilização de três parâmetros com a mesma funcionalidade, no caso Instrucao1, Instrucao2 e Instrucao3.
Código HTML:
<Boleto>
<Instrucao1>Primeira instrução de pagamento do boleto bancário</Instrucao1>
<Instrucao2>Segundo teste de instrução</Instrucao2>
<Instrucao3>Testando terceira instrução</Instrucao3>
</Boleto>
As informações inseridas no parâmetro em questão deve possuir o formato String e possuir no máximo 63 caracteres.
Além das informações em questão você poderá inserir um logotipo personalizado em seus boletos bancários, para efetuar o procedimento em questão basta utilizar o parâmetro URLLogo.
Código HTML:
<Boleto>
<URLLogo>https://desenvolvedor.moip.com.br/sandbox/imgs/logo_moip.gif</URLLogo>
</Boleto>
No parâmetro você deverá informar a URL onde a imagem de seu logo encontra-se, sendo que a imagem deverá possuir largura de 75 pixels e altura de 40 pixels. Imagens maiores ou menores que o tamanho citado serão automaticamente redimensionadas.
Segue instrução única utilizando todos os parâmetros abordados no tópico:
Utilizando o parâmetro DiasExpiracao :
Código HTML:
<EnviarInstrucao>
<InstrucaoUnica>
<Razao>MoIP Labs - Boleto Bancário</Razao>
<Valores>
<Valor moeda="BRL">41</Valor>
</Valores>
<IdProprio>MoIP Labs</IdProprio>
<FormasPagamento>
<FormaPagamento>BoletoBancario</FormaPagamento>
</FormasPagamento>
<Boleto>
<DiasExpiracao Tipo="Corridos">7</DiasExpiracao>
<Instrucao1>Primeira instrução de pagamento do boleto bancário</Instrucao1>
<Instrucao2>Segundo teste de instrução</Instrucao2>
<Instrucao3>Testando terceira instrução</Instrucao3>
<URLLogo>https://desenvolvedor.moip.com.br/sandbox/imgs/logo_moip.gif</URLLogo>
</Boleto>
</InstrucaoUnica>
</EnviarInstrucao>
Utilizando o parâmetro DataVencimento:
Código HTML:
<EnviarInstrucao>
<InstrucaoUnica>
<Razao>MoIP Labs - Boleto Bancário</Razao>
<Valores>
<Valor moeda="BRL">41</Valor>
</Valores>
<IdProprio>MoIP Labs</IdProprio>
<FormasPagamento>
<FormaPagamento>BoletoBancario</FormaPagamento>
</FormasPagamento>
<Boleto>
<DataVencimento>2020-04-06T12:01:48.703-02:00</DataVencimento>
<Instrucao1>Primeira instrução de pagamento do boleto bancário</Instrucao1>
<Instrucao2>Segundo teste de instrução</Instrucao2>
<Instrucao3>Testando terceira instrução</Instrucao3>
<URLLogo>https://desenvolvedor.moip.com.br/sandbox/imgs/logo_moip.gif</URLLogo>
</Boleto>
</InstrucaoUnica>
</EnviarInstrucao>
Enjoy!!!
P.S. Esse artigo foi originalmente escrito por Fernando Feitosa (Integração MoIP)
