Emitir Novo Boleto

Dados da API

• Dados da API:
  • URL: https://integration.enoqbank.com/enoq
  • Arquitetura: Representational State Transfer (REST)

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.

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

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

Requisição

{
  "issuerConfiguration": "00000000-0000-0000-0000-000000000000",
  "value": 0.00,
  "dueDate": "2023-01-01",
  "payerDocument": "string",
  "payerZipCode ": "2023-01-01T14:22:17.534Z",
  "payerCity": "string",
  "payerCityState": "string",
  "payerStreetAndNumber": "string",
  "payerNeighborhood": "string",
  "payerPhoneNumber": "string",
  "messageToThePayer": "string"
}

Dicionário de dados - Parâmetros

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
accountNumber	Número da conta que irá emitir o boleto	long	-	-
IssuerConfiguration	Configurações adicionais de emissão	GUID	-	Utilizado para configurações de emissão com juros e multa; se não preenchido, será adotada a configuração padrão.
Value	Valor original do boleto	decimal	11, 2	Formato 0.00
DueDate	Data de vencimento	date	-	Formato YYYY-MM-DD
PayerDocument	-	string	14	Somente números.
PayerName	Nome do devedor	string	50	-
PayerZipCode	CEP do devedor	string	8	Somente números.
PayerCity	Cidade do devedor	string	100	-
PayerCityState	Sigla da UF do devedor	string	2	-
PayerStreetAndNumber	Logradouro e número do devedor	string	100	-
PayerNeighborhood	Bairro do devedor	string	50	-
PayerPhoneNumber	Telefone do devedor	string	15	Somente números.
MessageToThePayer	Mensagem ao devedor	string	100	-

🟢 200

Resposta

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

Dicionário de dados - Retorno

HEADER	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
id	Identificador único do boleto	String	-	Identificador do boleto
success	Status da solicitação de emissão	bool	-	Formato: true para solicitações de emissão recepcionadas com sucesso e false para solicitações inválidas
message	Mensagem de retorno	string	-	Mais informações do erro, se existir

Recorrência

Os envios podem ser realizados a qualquer momento.

Informações Adicionais

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

Em todos os métodos da API, exceto o método de obtenção de token, a chamada deverá ser enviada com um header no seguinte formato:

Key	Value
Authorization	Bearer eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ

Onde o tipo de autenticação Bearer nunca mudará, e o token que vem logo em seguida, no caso exemplificado por: “eyJhbGciOiJSUzIlxdWVtZS [...] mj2m65fJfvmjdVXp6dQ”

corresponde ao token obtido através do método api/Auth/Token.

Atenção

Todo token tem uma data e hora de expiração, ficando a cargo do sistema integrador a responsabilidade de providenciar um novo token para realizar novas chamadas após a expiração deste.