Pular para o conteúdo principal

Listar operações

GET/api/operations/list

Esse endpoint permite que um originador autenticado liste as operações vinculadas à sua conta. As operações são retornadas da mais recente para a mais antiga e podem ser filtradas por status, período de criação e documento do cedente. Cada operação traz também os pagadores e o cedente vinculados aos seus títulos.

Parâmetros da URL (Query Params)​

NomeTipoDescriçãoObrigatório
limitnumberQuantidade máxima de operações retornadas por requisição. Deve estar entre 1 e 100. Padrão: 20.Não
cursorstringCursor para paginação. Deve ser informado somente para buscar a próxima página de resultados.Não
statusstringFiltra as operações pelo status. Veja os valores aceitos.Não
startDatestringData inicial de criação da operação, no formato YYYY-MM-DD. Considera operações criadas a partir de 00:00:00 dessa data.Não
endDatestringData final de criação da operação, no formato YYYY-MM-DD. Considera operações criadas até 23:59:59 dessa data.Não
assignorDocumentstringCPF ou CNPJ do cedente, com ou sem máscara. Retorna as operações que possuem ao menos um título desse cedente.Não

Todos os filtros são opcionais e podem ser combinados entre si e com a paginação.

Paginação por cursor​

A listagem utiliza paginação baseada em cursor para garantir desempenho e consistência. Na primeira requisição, informe apenas o limit e os filtros desejados. A resposta retornará a lista de operações e indicará se existem mais registros por meio do campo hasNext. Se hasNext for true, utilize o valor de nextCursor na próxima requisição, mantendo os mesmos filtros.

Período de criação​

Os campos startDate e endDate podem ser informados juntos ou separadamente. Quando ambos forem informados, startDate deve ser anterior ou igual a endDate.

Documento do cedente​

O assignorDocument aceita o documento com ou sem máscara (por exemplo, 123.456.789-01 ou 12.345.678/0001-90). Os caracteres não numéricos são removidos e o valor resultante deve conter exatamente 11 dígitos (CPF) ou 14 dígitos (CNPJ).

Status aceitos​

StatusDescrição
CREATEDOperação criada.
PRE-APPROVEDOperação pré-aprovada.
APPROVEDOperação aprovada.
DENIEDOperação negada.
CONTRACT_SENTContrato de cessão enviado ao cedente.
SIGNATURE_PROCESSContrato em processo de assinatura.
ERROR_SENT_CONTRACTErro no envio do contrato.
WAITING_RELEASE_VALUEContrato assinado, aguardando o pagamento.
PAIDOperação paga.
CANCELLEDOperação cancelada.

Exemplos de requisição​

  • /api/operations/list?limit=10
  • /api/operations/list?limit=10&cursor=01962542-38ee-70de-92fe-4e4a0cc375ee
  • /api/operations/list?limit=10&status=PAID
  • /api/operations/list?limit=10&startDate=2026-09-01&endDate=2026-09-30
  • /api/operations/list?limit=10&assignorDocument=12.345.678/0001-90
  • /api/operations/list?limit=10&status=PAID&startDate=2026-09-01&endDate=2026-09-30&assignorDocument=12345678000190

Exemplos de resposta​

{
"hasNext": true,
"nextCursor": "01962542-38ee-70de-92fe-4e4a0cc375ee",
"operations": [
{
"id": "0196a1f0-7c2e-7b3a-9d1e-5f2c8a4b6e10",
"status": "PAID",
"totalValue": 1000,
"liquidValue": 743,
"createdAt": "2026-09-15T14:32:10.000Z",
"payers": [
{
"name": "Empresa Pagadora LTDA",
"document": "11222333000144"
},
{
"name": "Outra Pagadora S.A.",
"document": "55666777000188"
}
],
"assignor": {
"name": "Empresa Cedente LTDA",
"document": "12345678000190"
}
},
{
"id": "01962542-38ee-70de-92fe-4e4a0cc375ee",
"status": "CREATED",
"totalValue": 2500,
"liquidValue": 2210.5,
"createdAt": "2026-09-10T09:12:45.000Z",
"payers": [
{
"name": "Empresa Pagadora LTDA",
"document": "11222333000144"
}
],
"assignor": {
"name": "João da Silva",
"document": "12345678901"
}
}
]
}

Campos da resposta de sucesso​

CampoTipoDescrição
hasNextbooleanIndica se existem mais operações a serem buscadas.
nextCursorstring ou nullCursor a ser enviado na próxima requisição. Retorna null quando não há mais páginas.
operationsarrayLista de operações.
operations.idstringIdentificador único da operação.
operations.statusstringStatus da operação. Veja os valores aceitos.
operations.totalValuenumberValor total da operação.
operations.liquidValuenumberValor líquido da operação.
operations.createdAtstringData de criação da operação.
operations.payersarrayLista de pagadores (sacados) dos títulos da operação, sem repetição. Retorna vazia se a operação não tiver títulos.
operations.payers.namestringNome do pagador.
operations.payers.documentstringCNPJ do pagador, somente números.
operations.assignorobject ou nullCedente da operação. Retorna null se a operação não tiver títulos.
operations.assignor.namestringNome do cedente.
operations.assignor.documentstringCNPJ do cedente pessoa jurídica ou CPF do cedente pessoa física, somente números.