Consultar boletos

GET/api/operations/bills

Esse endpoint permite que um originador autenticado consulte os boletos de uma operação usando o id ou o operationNumber. Um dos dois deve obrigatoriamente estar presente.

Parâmetros da URL (Query Params)

Nome	Tipo	Descrição	Obrigatório
id	string	Identificador único da operação. Necessário se number não for enviado.	Condicional
number	string	Número da operação. Necessário se id não for enviado.	Condicional

Exemplos de requisição

• /api/operations/bills?id=01962542-38ee-70de-92fe-4e4a0cc375ee
• /api/operations/bills?number=0001

Exemplos de resposta

200 - Sucesso

{
  "id": "01962542-38ee-70de-92fe-4e4a0cc375ee",
  "operationNumber": 0001,
  "value": 15000,
  "bills": [
    {
      "description": "Cessão de direito creditório - Nº 0001 - 1/1",
      "identifier": 120527025,
      "value": 15000,
      "dueDate": "2025-07-15T00:00:00.000Z",
      "status": "unpaid",
      "pdfUrl": "https://d2ej8tz2k7ovji.cloudfront.net/contractor/MjgxMDE2MTIwMDAxOTA=/ae87547c-4770-42eb-bca8-cf36b866a4bb",
      "paidDate": null,
      "digitableLine": "34191790010104351004791020150008712340000010000",
      "barCode": "3419712340000010000179001010435100479102015",
      "brCode": "00020126400014br.gov.bcb.pix0114+5599999999995204000053039865802BR5910FULANO TESTE6009SÃO PAULO62100506abcde6304B13E"
    }
  ]
}

400 - Requisição Inválida

{
  "message": "Validation error",
  "errors": [
    {
      "field": "query params",
      "message": "Query params 'id' or 'number' is required to search opetarion bills."
    }
  ]
}

404 - Não encontrado

{
  "message": "We could not find the operation with this params."
}

Campos da resposta de sucesso

Campo	Tipo	Descrição
id	string	Identificador único da operação.
operationNumber	string	Número da operação.
value	number	Valor total da operação.
bills	array	Lista de boletos.
bills.description	string	Descrição do boleto.
bills.identifier	number	Código identificador do boleto.
bills.value	number	Valor do boleto.
bills.dueDate	string	Data de vencimento do boleto.
bills.status	string	Status do boleto, valores: paid e unpaid.
bills.pdfUrl	string	URL para baixar PDF do boleto.
bills.paidDate	string ou null	Data do pagamento do boleto.
bills.digitableLine	string	Linha digitável do boleto.
bills.barCode	string	Código de barras do boleto.
bills.brCode	string	Código do PIX copia e cola referente ao boleto.