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:
{
"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|"
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados do boleto | Sim | Raiz | - | |
A02 | banking_billet_id | Sim | A01 | Número |
Id interno do boleto bancário |
A03 | banking_billet_due_date | Não | A01 | Data |
Data de vencimento atualizada para o boleto bancário |
A04 | send_barcode | Sim | A01 | Booleano |
Define se a linha digitável será enviada, via SMS, para um número de celular definido |
A05 | return_type | Não | A01 | Lista |
Tipo de retorno do serviço. Valores permitidos:
Se este parâmetro não for informado, o serviço irá assumir o valor "line" para o mesmo. |
A06 | cell_phone_number | Não* | A01 | Número |
Número do celular - com ddd - para envio da linha digitável por SMS. |
A07 | send_content | Não | A01 | Texto |
Conteúdo do SMS a ser enviado. |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": "00000.00000 00000.000000 00000.000000 0 00000000000000"
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 17,
"error_description": "Error generating barcode!",
"result": ""
}