API docs by Redocly

api-laravel-boleto (v1)

Download OpenAPI specification:Download

License: MIT
Para maiores informações, consulte o projeto no Github

API para laravel-boleto

API em container docker para geração de boletos e arquivos CNAB, utilizando como base o package laravel-boleto.

Mais detalhes sobre os bancos implementados e sobre os campos disponíveis para cada banco podem ser encontrados no
laravel-boleto.

GET /api/boleto

Lista os boletos existentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": [
    ]
}

POST /api/boleto

Cria um novo boleto

Request Body schema: application/json
required
banco
required
string

Código COMPE do banco com 3 dígitos

required
object (BoletoDados)

Dados do boleto

Responses

Request samples

Content type
application/json
{
  • "banco": "001",
  • "dados": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

GET /api/boleto/{_id}

Exibe os dados de um boleto

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

PUT /api/boleto/{_id}

Atualiza um boleto

Request Body schema: application/json
required
banco
required
string

Código COMPE do banco com 3 dígitos

required
object (BoletoDados)

Dados do boleto

Responses

Request samples

Content type
application/json
{
  • "banco": "001",
  • "dados": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

DELETE /api/boleto/{_id}

Apaga um boleto

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "mensagem": "Erro na validação de dados",
  • "erros": [ ]
}

GET /api/remessa

Lista as remessas existentes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": [
    ]
}

POST /api/remessa

Cria um novo arquivo de remessa CNAB

Request Body schema: application/json
required
banco
required
string

Código COMPE do banco com 3 dígitos

layout
required
string

Layout do arquivo CNAB a ser gerado. Valores válidos: "240" ou "400"

boletos
required
Array of arrays

Array contendo os IDs dos boletos que irão compor a remessa

required
object (RemessaDados)

Dados da remessa

Responses

Request samples

Content type
application/json
{
  • "banco": "001",
  • "layout": "400",
  • "boletos": [
    ],
  • "dados": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

GET /api/remessa/{_id}

Exibe os dados de uma remessa

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

PUT /api/remessa/{_id}

Atualiza uma remessa

Request Body schema: application/json
required
banco
required
string

Código COMPE do banco com 3 dígitos

layout
required
string

Layout do arquivo CNAB a ser gerado. Valores válidos: "240" ou "400"

boletos
required
Array of arrays

Array contendo os IDs dos boletos que irão compor a remessa

required
object (RemessaDados)

Dados da remessa

Responses

Request samples

Content type
application/json
{
  • "banco": "001",
  • "layout": "400",
  • "boletos": [
    ],
  • "dados": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

DELETE /api/remessa/{_id}

Apaga uma remessa

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "mensagem": "Erro na validação de dados",
  • "erros": [ ]
}

GET /file

Endpoint para download de arquivos PDF ou REM gerados pela API

Responses