Emissão de boleto

📘

Nota

A documentação da nova versão deste endpoint está disponível na aba v2 deste manual. Para acessá-la, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página.

Este endpoint permite que o parceiro Bankly emita boletos de depósito (Deposit) ou cobrança (Levy).

🚧

Importante

Para que seja possível utilizar o boleto emitido (gerar o pdf, realizar cancelamento, pagamento etc) , é necessário verificar se o status do boleto é Registered por meio do endpoint Consulta por authenticationCode.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O parceiro Bankly aguarde no mínimo 10 minutos após a criação da conta, para que ela esteja apta a emitir boletos.

Requisição

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/bankslip

--location --request POST 'https://api-mtls.sandbox.bankly.com.br/bankslip' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer {{Token}} '
--data-raw 
'{
    "account": {
        "number": "15164",
        "branch": "0001"
    },
    "documentNumber": "47742663023",
    "amount": 20,
    "minimumAmount": 5,
    "dueDate": "2022-02-15",
    "closePayment": "2022-03-15",
    "type": "levy",
    "alias": "Boleto da compra dos livros",
    "payer": {
        "document": "47742663023",
        "tradeName": "Editora Nísia Floresta",
        "name": "Editora Nísia Floresta",
        "address": {
            "addressLine": "Rua 6 de Março",
            "city": "Santarém",
            "state": "PA",
            "zipCode": "68060100"
        }
    },
    "interest": {
        "startDate": "2022-03-12",
        "value": 0.50,
        "type": "AmountPerCalendaryDay"
    },
    "fine": {
        "startDate": "2022-03-12",
        "value": 10,
        "type": "FixedAmount"
    },
    "discounts": {
        "limitDate": "2022-03-10",
        "value": 10,
        "type": "FixedAmountUntilLimitDate"
    }
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar campos no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

📘

Nota

É possível aplicar juros e multa ao mesmo título.

{
    "account": {
        "number": "15164",
        "branch": "0001"
    },
    "documentNumber": "47742663023",
    "amount": 20,
    "minimumAmount": 5,
    "dueDate": "2022-02-15",
    "closePayment": "2022-03-15",
    "type": "levy",
    "alias": "Boleto da compra dos livros",
    "payer": {
        "document": "47742663023",
        "tradeName": "Editora Nísia Floresta",
        "name": "Editora Nísia Floresta",
        "address": {
            "addressLine": "Rua 6 de Março",
            "city": "Santarém",
            "state": "PA",
            "zipCode": "68060100"
        }
    },
    "interest": {
        "startDate": "2022-03-12",
        "value": 0.50,
        "type": "AmountPerCalendaryDay"
    },
    "fine": {
        "startDate": "2022-03-12",
        "value": 10,
        "type": "FixedAmount"
    },
    "discounts": {
        "limitDate": "2022-03-10",
        "value": 10,
        "type": "FixedAmountUntilLimitDate"
    }
}

🚧

Importante

Se o boleto não possuir juros ou multa, o campo closePayment será preenchido automaticamente com o valor da data de vencimento (dueDate).

📘

Nota

Caso a data informada nos campos closePayments, startDate ou LimitDate corresponda a um dia de final de semana ou feriado, ela será alterada automaticamente para o primeiro dia útil subsequente.

Regras de juros, multa e descontos

Resposta (Response)

O status code 202 indicará que o boleto foi emitido com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
  "account": {
    "number": "string",
    "branch": "string"
  },
  "authenticationCode": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Após a solicitação da emissão de um boleto, em background, ocorrerá o processo de registro que demora cerca de 10 segundos. Inicialmente o status do boleto será Processed.

🚧

Importante

Enquanto o boleto não estiver com o status Registered (registrado), não será possível efetuar seu pagamento, emitir o pdf ou realizar seu cancelamento.

Portanto, é preciso consultar o status do boleto para dar continuidade ao processo de emissão.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Consulta de status

Como explicitado anteriormente, somente é possível dar continuidade ao processo de emissão quando o boleto apresentar o status Registered (registrado).

Realize a consulta do status por meio do endpoint consulta por authenticationCode

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400.

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: