Consultar boletos de terceiros

Endpoint: GET /hb/bank-slips

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": []
}

GET /hb/bank-slips

• Autenticacao: Bearer JWT obrigatorio
• Contexto de conta: Exige conta ativa quando aplicavel
• Roles: OPERADOR, ADMIN, GERENTE
• Scopes: boleto.read

Request

Path params

Nao possui.

Query params

DTO: GetThirdPartyBankSlipsDto

Nao possui.

Body

Nao possui body tipado via DTO.

Headers

• Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

curl -X GET "https://api.seudominio.com/hb/bank-slips?digitable_line=0&barcode=string_exemplo" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT"

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (200):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

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