Geração de linha digitável de boleto

De RBX ISP - Manual do Usuário
Revisão de 09h22min de 4 de junho de 2021 por Felipe (discussão | contribs) (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...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

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
Informar o formato AAAA-MM-DD
Não pode ser menor que o dia atual
Esse parâmetro será descontinuado no final de 2018, devido às novas regras de cobranças bancárias do Brasil.

A04 send_barcode Sim A01 Booleano

Define se a linha digitável será enviada, via SMS, para um número de celular definido
true: enviar SMS
false: não enviar SMS
O SMS será enviado a partir do gateway cadastrado nos parâmetros da central do assinante.

A05 return_type Não A01 Lista

Tipo de retorno do serviço. Valores permitidos:

  • line: retorna a linha digitável do boleto, formatada
  • barcode: retorna a representação numérica do código de barras

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.
O número informado neste campo deve conter 11 dígitos.
Este campo deverá ser informado se o campo send_barcode for enviado com true.

A07 send_content Não A01 Texto

Conteúdo do SMS a ser enviado.
Este campo é opcional, mas se não for informado, o SMS será enviado com um texto padrão.
Quando informado, este campo deverá conter a palavra |BARCODE|, que será substituída pela linha digitável do boleto.

 

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": ""
}