Menu
Documentation

Registrar boleto

Endpoint: POST /hb/bank-slips/registrations

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

POST /hb/bank-slips/registrations

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

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: RegisterBankSlipDto

CampoTipoObrigatorioDetalhes
aliasstringSim-
typeenumSimValores permitidos: Levy, Deposit
payerPayerDtoRBNaoObjeto esperado: { document: string; name: string; tradeName: string; address: { zipCode: string; addressLine: string; neighborhood: string; city: string; state: string } }
interestInterestDtoHBNaoObjeto esperado: { startDate: Date; value: number; type: 'FixedAmount' }
fineFineDtoHBNaoObjeto esperado: { startDate: Date; value: number; type: 'FixedAmount' }
discountDiscountDtoHBNaoObjeto esperado: { limitDate: Date; value: number; type: 'FixedAmountUntilLimitDate' }
dueDateDateSim-
closePaymentDateSim-
amountnumberSim-

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/hb/bank-slips/registrations" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "alias": "string_exemplo",
  "type": "EXEMPLO",
  "dueDate": "2026-02-13",
  "closePayment": "2026-02-13",
  "amount": 1
}'

Response

Data (schema)

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

Sucesso (201):

{
  "status_code": 201,
  "success": true,
  "message": "Created",
  "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/registrations",
  "details": []
}