Consulta de Cessão

Resumo

A cessão é o processo pelo qual as operações de crédito (itens) são transferidas para um cessionário. Você pode acompanhar e consultar as cessões a qualquer momento para obter informações ou verificar o status atual do processo.

Webhook de Confirmação de Cessão

Este webhook é disparado para notificar o cliente de que o processo de cessão foi iniciado. Ele fornece os metadados essenciais necessários para acompanhar a cessão.

Response Body

{
    "key": "19e34186-847b-4dd7-9fc2-d14e28bc2f10",
    "data": {
        "status": "settled",
        "total_amount": 1917.04,
        "assignment_key": "19e34186-847b-4dd7-9fc2-d14e28bc2f10",
        "reference_date": "2026-04-10",
        "number_of_items": 8,
        "term_of_assignment_url": null
    },
    "webhook_type": "assignment.status_change",
    "event_datetime": "2026-04-10T22:37:52"
}

Campo	Tipo	Descrição	Caracteres
assignment_key	string	Identificador único da operação de cessão	36
term_of_assignment_url	string	URL para download do Termo de Cessão (PDF)	2048
number_of_items	integer	Número total de operações de crédito (itens) incluídas nesta cessão	5
total_amount	float	Soma do valor presente de todos os itens da cessão	15,2
reference_date	string	Data base utilizada para os cálculos da cessão (YYYY-MM-DD)	10

---

Consultar uma Cessão Específica

Para consultar uma cessão específica, o cliente pode realizar uma requisição GET no endpoint utilizando a chave identificadora da cessão (assignment_key).

ENDPOINT

/v2/assignment/ASSIGNMENT-KEY

MÉTODO

GET

Testar no Playground

Path Params

Campo	Tipo	Descrição	Caracteres
assignment_key*	string	Chave identificadora única da cessão	UUID

Response

STATUS

200

Response Body

{
    "assignment_key": "77997168-5d61-430f-b5ae-08eb3d7b8c0e",
    "creation_datetime": "2023-10-01T12:00:00",
    "reference_date": "2023-10-01",
    "total_amount": 120000,
    "number_of_items": 5,
    "term_of_assignment_url": "https://example.com/assignment.pdf",
    "status": "settled",
    "signable_term_url": "https://example.com/signable_term.pdf"
}

---

Consultar os Itens (Contratos) de uma Cessão

Para consultar os contratos contidos em uma cessão, utilize uma requisição GET no endpoint com a mesma assignment_key.

ENDPOINT

/v2/assignment/ASSIGNMENT-KEY/assignment_items?page=1&page_size=100

MÉTODO

GET

Testar no Playground

Path Params

Campo	Tipo	Descrição	Caracteres
assignment_key*	string	Chave identificadora única da cessão	UUID

Query Params

Campo	Tipo	Descrição	Caracteres
page	string	Número da página	-
page_size	string	Tamanho da página, limitado a 100	-

Response

A resposta é uma lista paginada contendo as informações de cada contrato da cessão (status 200):

STATUS

200

Response Body

{
    "pagination": {
        "page": 1,
        "page_size": 10
    },
    "data": [
        {
            "assignment_date": "2026-04-10",
            "assignment_item_key": "uuid",
            "contract_number": "TIK000012312",
            "control_number": "TIK000012312",
            "requester_identifier_key": "uuid",
            "credit_operation_key": "string",
            "disbursed_amount": 80.0,
            "disbursement_date": "2026-04-10",
            "endorsement_url": "url",
            "issue_amount": 180.00,
            "issuer_document_number": "string",
            "issuer_name": "string",
            "number_of_installments": 10,
            "present_amount": 180.0,
            "contract_present_amount": 180.0,
            "purchaser_document_number": "string",
            "status": "settled",
            "rejected_reasons": [],
            "assignment_items": [
                {
                    "installment_key": "uuid",
                    "present_amount": 100,
                    "due_date": "2026-05-10",
                    "your_number": "TIK000012312001"
                },
                {
                    "installment_key": "uuid",
                    "present_amount": 80,
                    "due_date": "2026-06-10",
                    "your_number": "TIK000012312002"
                }
            ]
        }
    ]
}

---

Consultar Lotes de Cessão por Data

Consulte os lotes de cessão pela data de referência (reference_date).

ENDPOINT

/v2/assignment/assignments?reference_date=2026-05-15

MÉTODO

GET

Testar no Playground

Query Params

Campo	Tipo	Descrição	Caracteres
reference_date	string	Data da tentativa de cessão (YYYY-MM-DD)	10

Response

STATUS

200

Response Body

{
    "data": [
        {
            "assignment_key": "439b1257-82ac-4741-a416-a4428a9a7327",
            "number_of_items": 10000,
            "reference_date": "2025-01-01",
            "signable_term_url": "https://example.com/endorsement.pdf",
            "status": "settled",
            "term_of_assignment_url": "signed_url",
            "total_amount": 100.00
        },
        {
            "assignment_key": "439b1257-82ac-4741-a416-a4428a9a7327",
            "number_of_items": 10000,
            "reference_date": "2025-01-01",
            "signable_term_url": "https://example.com/endorsement.pdf",
            "status": "settled",
            "term_of_assignment_url": "signed_url",
            "total_amount": 100.00
        },
        {
            "assignment_key": "439b1257-82ac-4741-a416-a4428a9a7327",
            "number_of_items": 10000,
            "reference_date": "2025-01-01",
            "signable_term_url": "https://example.com/endorsement.pdf",
            "status": "canceled",
            "term_of_assignment_url": "signed_url",
            "total_amount": 100.00
        }
    ]
}