Pular para o conteúdo principal

Documentos da Cessão

Recupera os links para download do Termo de Cessão — tanto a versão original quanto a versão assinada. Este endpoint fica disponível a partir do momento em que o Termo é gerado, ou seja, após o lote atingir o status pending_assignment_term_signature.

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âmetroTipoDescrição
fund_class_keystringChave única do fundo (UUID).
assignment_configuration_keystringChave da configuração de cessão (UUID).
assignment_external_idstringO 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

CampoTipoDescrição
assignment_term_urlstringURL que direciona para o download do termo.
signed_assignment_term_urlstring | nullURL para o Termo de Cessão assinado. Retorna null enquanto o documento ainda não tiver sido assinado por todas as partes.
Observação

O campo signed_assignment_term_url será null enquanto o Termo de Cessão ainda não tiver sido assinado por todas as partes envolvidas. Após a conclusão da assinatura, o lote avançará para o status pending_payment e um webhook será enviado.


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. Este endpoint fica disponível a partir do momento em que o Termo é gerado, ou seja, após o lote atingir o status pending_assignment_term_signature.

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âmetroTipoDescrição
fund_class_keystringChave única do fundo (UUID).
assignment_configuration_keystringChave da configuração de cessão (UUID).
assignment_external_idstringO 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

CampoTipoDescrição
batchesarrayLista de lotes vinculados ao Termo de Cessão.
batches[].namestringNome do lote.
batches[].document_typestringTipo do documento (ex: assignment_term, duplicata).
batches[].statusstringStatus atual da assinatura do lote.
batches[].document_keystringChave identificadora do documento.
batches[].related_partiesarrayPartes envolvidas na assinatura do lote.
signature_urlstringURL para acesso à interface de assinatura na CertifiQI.
download_urlstringURL 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 no status pending_assignment_term_signature. Após a conclusão da assinatura por todas as partes, passa a apontar para o Termo de Cessão assinado.