Este artigo apresenta uma lista de rotas disponíveis da API PlugBoleto para emissão de boletos. A API foi desenvolvida para facilitar a integração com sistemas de gestão financeira e automatizar o processo de geração e controle de boletos bancários. Através das rotas documentadas aqui, você poderá realizar operações essenciais, como inclusão de novos boletos, consulta de status, cancelamento, atualização de informações, entre outros.
| Rota | Descrição |
|---|---|
| Incluindo um Boleto |
A inclusão do boleto se resume em preenchermos um objeto JSON com os dados do boleto e enviarmos para o nosso servidor. |
| Consultando um boleto | O objetivo da Consulta é que você receba um json contendo todos os campos de seu boleto. |
| Solicitando o PDF | Solicita o PDF, e a API disponibilizará um protocolo, que deve ser consultado através da rota a seguir |
| Consultando o protocolo da solicitação do PDF | Consulta o protocolo obtido para efetivamente, receber o resultado da geração do PDF |
| Gerando o arquivo de remessa | Gera o arquivo de remessa, que será importado no site do banco para registar o boleto gerado. |
| Descartando um boleto | Descarta um boleto onde a Situação seja igual a EMITIDO, FALHA ou REJEITADO. |
| Solicitando o arquivo de remessa de alteração | Indica a alteração no boleto (data de vencimento, valor, etc). |
| Solicitando a alteração individual de boleto via WebService | É através do arquivo gerado por essa rota que vamos indicar a baixa no boleto. |
| Solicitando a baixa | É através do arquivo gerado por essa rota que vamos indicar a baixa no boleto. |
| Realizando a consulta da baixa | Consulta o protocolo obtido para efetivamente, receber o resultado da geração do PDF. |
| Realizando o upload do arquivo de retorno | É através desta rota que vamos saber se o boleto foi Registrado, Liquidado, Rejeitado, etc. |
| Realizando a consulta do processamento de retorno | Consulta o protocolo obtido na rota anterior, para efetivamente, receber o resultado do processamento de seus boletos. |
| Listar Boletos por Período | Esse recurso permite listar todos os boletos que foram gerados por uma assinatura, no período de um mês. |
| Listar Boletos gerados por Assinaturas | Esse recurso permite listar todos os boletos que foram gerados por uma assinatura. |
Comentários
0 comentário
Por favor, entre para comentar.