Documentos da Cessão

Três consultas sobre o Termo de Cessão: o link do termo de um lote, a listagem dos termos de uma classe de fundo e o link de assinatura eletrônica.

Link do Termo de Cessão

Recupera os links para download do Termo de Cessão — tanto a versão original quanto a versão assinada. O endpoint responde a partir do momento em que o Termo é gerado; antes disso devolve TRC000099.

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura
Consultoria	`consultant-api`	Ler Cessões
Cedente	`assignor-api`	Leitura

URL base de cada host: Ambientes (Hosts).

Quando utilizar

Após receber o webhook com status pending_assignment_term_signature, utilize este endpoint para obter o link do Termo de Cessão e acompanhar se a assinatura já foi concluída.

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignment_term_link

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
`fund_class_key`	string	Chave única do fundo (UUID).
`assignment_configuration_key`	string	Chave da configuração de cessão (UUID).
`assignment_external_id`	string	O `external_id` informado na criação do lote.

Response

STATUS

200

Response Body
{
    "assignment_term_url": "https://storage.example.com/term/abc123.pdf",
    "signed_assignment_term_url": "https://storage.example.com/term/abc123_signed.pdf"
}

Atributos da resposta

Campo	Tipo	Descrição
`assignment_term_url`	string	URL que direciona para o download do termo.
`signed_assignment_term_url`	string	URL pré-assinada para download do Termo de Cessão assinado. O arquivo só fica disponível depois que todas as partes assinarem.

Observação

As duas URLs são pré-assinadas e expiram em 1 hora. Gere um novo link chamando o endpoint novamente.

O campo signed_assignment_term_url é sempre retornado, mas o arquivo só existe depois que o Termo de Cessão for assinado por todas as partes envolvidas. Antes disso, o acesso à URL retorna erro. Após a conclusão da assinatura, o lote avança para pending_payment, com webhook, ou para pending_custody, sem webhook, conforme a configuração de cessão. Nesse segundo caso, acompanhe pela Recuperação do Lote.

Listagem de Termos de Cessão

Endpoint de consulta paginada que retorna os Termos de Cessão dos lotes de uma classe de fundo, com os links pré-assinados para download do termo original e do termo assinado. Utilize os filtros para buscar os termos por data da cessão, período, status ou por um lote específico.

Disponível em

Perfil	Host	Permissão exigida
Gestora	`manager-api`	Leitura
Consultoria	`consultant-api`	Ler Cessões

URL base de cada host: Ambientes (Hosts).

Endpoint por classe de fundo

Assim como a Listagem de Lotes, este endpoint utiliza apenas a fund_class_key na URL — não é necessário informar a assignment_configuration_key. Para obter o termo de um lote específico, informe o external_id do lote como filtro.

São retornados apenas os lotes que já possuem Termo de Cessão gerado e que pertencem ao agente autenticado (gestor ou consultor vinculado à classe de fundo).

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_terms

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
`fund_class_key`	string	Chave única do fundo (UUID).

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
`assignment_date`	string	opcional	Filtra por data da cessão no formato `YYYY-MM-DD`.
`start_date`	string	opcional	Retorna lotes com data da cessão igual ou posterior à data informada, no formato `YYYY-MM-DD`.
`end_date`	string	opcional	Retorna lotes com data da cessão igual ou anterior à data informada, no formato `YYYY-MM-DD`.
`external_id`	string	opcional	Filtra pelo `external_id` informado na criação do lote.
`assignment_key`	string	opcional	Filtra pela chave do lote (UUID).
`assignment_status`	string	opcional	Filtra por um status específico do lote.
`in_status`	string	opcional	Lista de status separados por vírgula. Retorna apenas lotes que estejam em um dos status informados.
`not_in_status`	string	opcional	Lista de status separados por vírgula. Exclui os lotes nesses status.
`assignor_document_number`	string	opcional	Filtra por número de documento (CPF/CNPJ) do cedente. Deve ser enviado com pontuação (ex.: `11.222.333/0001-81` ou `969.698.790-03`).
`origin_type`	string	opcional	Filtra pela origem do lote (ex: `client`).
`page`	integer	opcional	Número da página (começa em 0). Padrão: `0`.
`limit`	integer	opcional	Quantidade de registros por página. Padrão: `25`. Máximo: `155`.

Exemplo de chamada — termos de uma data
GET /trade_receivables/fund_class/{fund_class_key}/assignment_terms?assignment_date=2024-04-01&page=0&limit=25

Exemplo de chamada — termo de um lote pelo external_id
GET /trade_receivables/fund_class/{fund_class_key}/assignment_terms?external_id=931e9437-d025-41ab-bb53-6b94e10fd361

Response

STATUS

200

Response Body
{
  "data": [
    {
      "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
      "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
      "name": "CESSÃO #12345",
      "assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
      "assignment_number": "00012345",
      "assignment_date": "2024-04-01",
      "status": "completed",
      "assignment_term_key": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
      "assignment_term_url": "https://storage.example.com/term/abc123.pdf",
      "signed_assignment_term_url": "https://storage.example.com/term/abc123_signed.pdf"
    }
  ],
  "limit": 25,
  "page": 0,
  "is_last_page": true
}

Atributos da resposta

Campo	Tipo	Descrição
`data`	array	Lista de Termos de Cessão. Veja tabela abaixo.
`page`	integer	Número da página atual.
`limit`	integer	Quantidade de registros por página.
`is_last_page`	boolean	Indica se esta é a última página de resultados.

Atributos de cada termo (objetos dentro de data)

Campo	Tipo	Descrição
`assignment_key`	string	Identificador único do lote (UUID).
`external_id`	string	Chave externa fornecida pelo parceiro.
`name`	string	Nome identificador da cessão.
`assignment_configuration_key`	string	Chave da configuração de cessão do lote (UUID).
`assignment_number`	string	Número do lote de cessão.
`assignment_date`	string	Data da cessão no formato `YYYY-MM-DD`.
`status`	string	Status atual do lote. Consulte os enumeradores de status do lote.
`assignment_term_key`	string	Chave do Termo de Cessão (UUID).
`assignment_term_url`	string	URL pré-assinada para download do Termo de Cessão original.
`signed_assignment_term_url`	string	URL pré-assinada para download do Termo de Cessão assinado. O arquivo só fica disponível depois que todas as partes assinarem.

Observação

As URLs são pré-assinadas e expiram em 1 hora. Para obter novos links, chame o endpoint novamente.

Os lotes são ordenados do mais recente para o mais antigo. Lotes que ainda não tiveram o Termo de Cessão gerado não aparecem na listagem.

Link de Assinatura

Recupera o link para acesso à interface de assinatura do Termo de Cessão na CertifiQI, além de informações sobre os lotes e o link para download do documento. O endpoint responde a partir do momento em que o Termo é gerado. Não está disponível quando a assinatura é feita pela QCertifica ou quando a configuração de cessão dispensa assinatura (TRC000131).

Disponível em

Perfil	Host	Permissão exigida
Consultoria	`consultant-api`	Ler Cessões

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assignment_signature_url

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
`fund_class_key`	string	Chave única do fundo (UUID).
`assignment_configuration_key`	string	Chave da configuração de cessão (UUID).
`assignment_external_id`	string	O `external_id` informado na criação do lote.

Response

STATUS

200

Response Body
{
    "batches": [
        {
            "name": "Termo de Cessão - Lote 001",
            "document_type": "assignment_term",
            "status": "pending",
            "document_key": "doc-uuid-example",
            "related_parties": []
        }
    ],
    "signature_url": "https://certifiqi.com/events/{external_batch_group_key}",
    "download_url": "https://storage.example.com/term/abc123.pdf"
}

Atributos da resposta

Campo	Tipo	Descrição
`batches`	array	Lista de lotes vinculados ao Termo de Cessão.
`batches[].name`	string	Nome do lote.
`batches[].document_type`	string	Tipo do documento (ex: `assignment_term`, `duplicata`).
`batches[].status`	string	Status atual da assinatura do lote.
`batches[].document_key`	string	Chave identificadora do documento.
`batches[].related_parties`	array	Partes envolvidas na assinatura do lote.
`signature_url`	string	URL para acesso à interface de assinatura na CertifiQI.
`download_url`	string	URL pré-assinada para download do Termo de Cessão.

Observação

O campo download_url aponta para o documento original (não assinado) enquanto o lote estiver em pending_send_to_signature ou pending_assignment_term_signature. Depois da assinatura por todas as partes, passa a apontar para o Termo de Cessão assinado. A URL é pré-assinada e expira em 1 hora.

Erros

Status	Código	Endpoint	Quando acontece
400	`TRC000099`	Link do termo, link de assinatura	O Termo de Cessão do lote ainda não foi gerado.
400	`TRC000131`	Link de assinatura	A configuração de cessão não usa assinatura eletrônica com link (por exemplo, assinatura pela QCertifica ou sem assinatura), ou o link ainda não está disponível.
400	—	Listagem de termos	`limit` acima de 155 ou `page` negativo (validação de parâmetro).
404	`TRC000018`	Link do termo, link de assinatura	Nenhum lote com esse `external_id` nesta configuração de cessão.

Erros de autenticação, permissão e host: veja Erros da API.

Link do Termo de Cessão​

Request​

Path params​

Response​

Atributos da resposta​

Listagem de Termos de Cessão​

Request​

Path params​

Query params​

Response​

Atributos da resposta​

Link de Assinatura​

Request​

Path params​

Response​

Atributos da resposta​

Erros​

Link do Termo de Cessão

Request

Path params

Response

Atributos da resposta

Listagem de Termos de Cessão

Request

Path params

Query params

Response

Atributos da resposta

Link de Assinatura

Request

Path params

Response

Atributos da resposta

Erros