Exibir código-fonte para Geração de linha digitável de boleto

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&oacute;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&ccedil;&otilde;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;">&nbsp;</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&uacute;mero</td>
<td style="width: 26.468%; height: 18px;">
<p>Id interno do boleto banc&aacute;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&atilde;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&aacute;rio<br />Informar o formato AAAA-MM-DD<br />N&atilde;o pode ser menor que o dia atual<br />Esse par&acirc;metro ser&aacute; descontinuado no final de 2018, devido &agrave;s novas regras de cobran&ccedil;as banc&aacute;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&aacute;vel ser&aacute; enviada, via SMS, para um n&uacute;mero de celular definido<br />true: enviar SMS<br />false: n&atilde;o enviar SMS<br />O SMS ser&aacute; enviado a partir do gateway cadastrado nos par&acirc;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&atilde;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&ccedil;o. Valores permitidos:</p>
<ul>
<li><strong>line</strong>: retorna a linha digit&aacute;vel do boleto, formatada</li>
<li><strong>barcode</strong>: retorna a representa&ccedil;&atilde;o num&eacute;rica do c&oacute;digo de barras</li>
</ul>
<p>Se este par&acirc;metro n&atilde;o for informado, o servi&ccedil;o ir&aacute; 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&atilde;o*</td>
<td style="width: 0.939078%; height: 18px;">A01</td>
<td style="width: 0.848896%; height: 18px;">N&uacute;mero</td>
<td style="width: 26.468%; height: 18px;">
<p>N&uacute;mero do celular - com ddd - para envio da linha digit&aacute;vel por SMS.<br />O n&uacute;mero informado neste campo deve conter 11 d&iacute;gitos.<br />Este campo dever&aacute; 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&atilde;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&uacute;do do SMS a ser enviado. <br />Este campo &eacute; opcional, mas se n&atilde;o for informado, o SMS ser&aacute; enviado com um texto padr&atilde;o.<br />Quando informado, este campo dever&aacute; conter a palavra&nbsp;|BARCODE|, que ser&aacute; substitu&iacute;da pela linha digit&aacute;vel do boleto.</p>
</td>
</tr>
</table>
<p>&nbsp;</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>