Envio de boleto por e-mail

De RBX ISP - Manual do Usuário

O objetivo deste serviço é possibilitar o envio de boletos para os clientes por e-mail. Abaixo, segue exemplo do json de envio:

{
  "send_banking_billet":
  {
    "document_id": 256325,
    "due_date": "2021-02-12",
    "customer_id": 2655,
    "customer_email": "cliente@provedor.com.br",
    "email_subject": "Solicitação de segunda via do boleto",
    "email_body": "Caro cliente, conforme solicitado, segue a segunda via do seu boleto com vencimento em 11/11/2018."
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 Dados do e-mail Sim Raiz -  
A02 document_id Sim A01 Número

Id interno do boleto bancário

A03 due_date Não A01 Data

Data de vencimento atualizada do boleto, no formato AAAA-MM-DD. Considerações:

  • Pode ser informada apenas para boletos vencidos.
  • Deve ser uma data maior ou igual ao dia atual.
  • Se o boleto for registrado, deve estar configurado no RBX para permitir a atualização da data de vencimento.
  • Boletos do Gerencianet não possuem suporte a este recurso.
  • Para não atualizar a data, não enviar este campo.
A04 customer_id Sim A01 Número

Código do cliente

A05 customer_email Sim A01 Texto

E-mail do cliente para envio do boleto

A06 email_subject Sim A01 Texto

Assunto do e-mail

A07 email_body Sim A01 Texto

Corpo do e-mail

 

Mensagem de retorno

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

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": "Banking billet sent successfully"
}

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

{
  "status": 0,
  "error_code": 12,
  "error_description": "Document not found!",
  "result": ""
}