Geração de linha digitável de boleto - Histórico de revisão

Felipe: Criou página com 'Objetivo: O objetivo deste serviço é possibilitar a geração da linha digitável de um boleto bancário em aberto. Abaixo, segue exemplo do json de envio:
2021-06-04T12:22:30Z

Criou página com 'Objetivo: O objetivo deste serviço é possibilitar a geração da linha digitável de um boleto bancário em aberto. Abaixo, segue exemplo do json de envio: <syntaxhighlight...'

Página nova
Objetivo: O objetivo deste serviço é possibilitar a geração da linha digitável de um boleto bancário em aberto. Abaixo, segue exemplo do json de envio:
<syntaxhighlight lang="json" line="1">
{
"get_barcode":
{
"banking_billet_id": 254875
"banking_billet_due_date": "2018-11-20",
"send_barcode": true,
"cell_phone_number": "44999887766",
"send_content": "Sua linha digitável para pagamento é: |BARCODE|"
}
}
</syntaxhighlight>

'''Detalhamento dos campos'''
<table style="border-collapse: collapse; width: 100%;" border="1">
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;"><strong>ID</strong></td>
<td style="width: 4.3254%; height: 18px;"><strong>Campo</strong></td>
<td style="width: 0.893236%; height: 18px;"><strong>Obrigatório</strong></td>
<td style="width: 0.939078%; height: 18px;"><strong>Pai</strong></td>
<td style="width: 0.848896%; height: 18px;"><strong>Tipo</strong></td>
<td style="width: 26.468%; height: 18px;"><strong>Observações</strong></td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 4.3254%; height: 18px;">Dados do boleto</td>
<td style="width: 0.893236%; height: 18px;">Sim</td>
<td style="width: 0.939078%; height: 18px;">Raiz</td>
<td style="width: 0.848896%; height: 18px;">-</td>
<td style="width: 26.468%; height: 18px;"> </td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 4.3254%; height: 18px;">banking_billet_id</td>
<td style="width: 0.893236%; height: 18px;">Sim</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">Número</td>
<td style="width: 26.468%; height: 18px;">
<p>Id interno do boleto bancário</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 4.3254%; height: 18px;">banking_billet_due_date</td>
<td style="width: 0.893236%; height: 18px;">Não</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">Data</td>
<td style="width: 26.468%; height: 18px;">
<p>Data de vencimento atualizada para o boleto bancário<br />Informar o formato AAAA-MM-DD<br />Não pode ser menor que o dia atual<br />Esse parâmetro será descontinuado no final de 2018, devido às novas regras de cobranças bancárias do Brasil.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 4.3254%; height: 18px;">send_barcode</td>
<td style="width: 0.893236%; height: 18px;">Sim</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">Booleano</td>
<td style="width: 26.468%; height: 18px;">
<p>Define se a linha digitável será enviada, via SMS, para um número de celular definido<br />true: enviar SMS<br />false: não enviar SMS<br />O SMS será enviado a partir do gateway cadastrado nos parâmetros da central do assinante.</p>
</td>
</tr>
<tr>
<td style="width: 2.56232%;">A05</td>
<td style="width: 4.3254%;">return_type</td>
<td style="width: 0.893236%;">Não</td>
<td style="width: 0.939078%;">A01</td>
<td style="width: 0.848896%;">Lista</td>
<td style="width: 26.468%;">
<p>Tipo de retorno do serviço. Valores permitidos:</p>
<ul>
<li><strong>line</strong>: retorna a linha digitável do boleto, formatada</li>
<li><strong>barcode</strong>: retorna a representação numérica do código de barras</li>
</ul>
<p>Se este parâmetro não for informado, o serviço irá assumir o valor "<strong>line</strong>" para o mesmo.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A06</td>
<td style="width: 4.3254%; height: 18px;">cell_phone_number</td>
<td style="width: 0.893236%; height: 18px;">Não*</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">Número</td>
<td style="width: 26.468%; height: 18px;">
<p>Número do celular - com ddd - para envio da linha digitável por SMS.<br />O número informado neste campo deve conter 11 dígitos.<br />Este campo deverá ser informado se o campo send_barcode for enviado com true.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A07</td>
<td style="width: 4.3254%; height: 18px;">send_content</td>
<td style="width: 0.893236%; height: 18px;">Não</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">Texto</td>
<td style="width: 26.468%; height: 18px;">
<p>Conteúdo do SMS a ser enviado. <br />Este campo é opcional, mas se não for informado, o SMS será enviado com um texto padrão.<br />Quando informado, este campo deverá conter a palavra |BARCODE|, que será substituída pela linha digitável do boleto.</p>
</td>
</tr>
</table>
<p> </p>

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": "00000.00000 00000.000000 00000.000000 0 00000000000000"
}
</syntaxhighlight>

Em caso de falha, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 0,
"error_code": 17,
"error_description": "Error generating barcode!",
"result": ""
}
</syntaxhighlight>