Emitir Novo Boleto

POST/api/billissuer/new?accountNumber={accountNumber}

Este endpoint permite emitir um novo boleto, adicionando-o à fila de emissão e registro. Após o processamento, o boleto estará disponível para impressão.

O método recebe os dados de cobrança para emitir o boleto.

Requisição

Exemplo de requisição

{
  "issuerConfiguration": "00000000-0000-0000-0000-000000000000",
  "value": 0.00,
  "dueDate": "2023-01-01",
  "payerDocument": "string",
  "payerName": "string",
  "payerZipCode": "string",
  "payerCity": "string",
  "payerCityState": "string",
  "payerStreetAndNumber": "string",
  "payerNeighborhood": "string",
  "payerPhoneNumber": "string",
  "messageToThePayer": "string",
  "referenceCode": "string",
  "acceptOverduePayment": "string",
  "penaltyPercentMonth": 0.00,
  "interestPercentMonth": 0.00,
  "maxOverdueDays": 0
}

Dicionário de dados - Parâmetros

Query Parameters

Body

Retorno (200)

Exemplo de resposta

{
  "id": "00000000-0000-0000-0000-000000000000",
  "success": true,
  "message": "string"
}

Dicionário de dados

Recorrência

Os envios podem ser realizados a qualquer momento.

Informações Adicionais

Processo de Emissão

Após solicitada a emissão, o boleto entra na fila de emissão e registro. Esse processo leva cerca de 5 minutos. Em seguida, pode ser impresso.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Observado em homologação

Requisição sem o header Authorization. A camada de autenticação pode rejeitar a chamada antes de resolver a rota ou validar os dados.

HTTP/1.1 401 Unauthorized

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.