Menu
Documentation

Boletos

Modulo tecnico: bank-slips

  • Endpoints HTTP: 11
  • MessagePattern/mensageria: nao incluido nesta pagina.

Funcoes

FuncaoMetodoRota
Consultar boletos de terceirosGET/hb/bank-slips
Consultar emissor de boletosGET/hb/bank-slips/issuer
Cadastrar emissor de boletosPOST/hb/bank-slips/issuer
Confirmar pagamento de boletoPOST/hb/bank-slips/payments/confirm
Validar pagamento de boletoPOST/hb/bank-slips/payments/validate
Vincular carteira de cobrancaPOST/hb/bank-slips/portfolios
Listar registros de boletosGET/hb/bank-slips/registrations
Registrar boletoPOST/hb/bank-slips/registrations
Cancelar registro de boletoDELETE/hb/bank-slips/registrations/:id
Consultar boleto por IDGET/hb/bank-slips/registrations/:id
Gerar PDF do boletoGET/hb/bank-slips/registrations/:id/pdf

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}