Criação de Cessões
A API de cessão permite a criação e consulta de cessões diretamente pelo cliente. É possível criar uma cessão utilizando a key (UUID4) de configuração de cessão e consultar informações gerais da cessão através de endpoints específicos.
Esse serviço está disponível apenas para parceiros com configuração de cessão cadastrados, por favor consulte nosso suporte para mais detalhes.
Criação de Cessão
Para criar uma cessão, é necessário realizar um POST no endpoint com a chave de configuração do cliente (assignment_configuration_key), o conjunto de credit_operation_keys das operações de crédito integrantes da cessão, e a daily_assignment_interest_rate, que corresponde à taxa de juros diária de cessão. Tal taxa está na mesma base de dias do contrato em questão.
Request
Params
| Campo | Descrição |
|---|---|
assignment_configuration_key | Chave identificadora da configuração de cessão do cliente |
Request Body
{
"credit_operation_keys": ["key1", "key2", "key3"],
"daily_assignment_interest_rate": 0.0003
}
Caso a daily_assignment_interest_rate não seja informada no Request para os contratos específicos, será usada a taxa de cessão cadastrada na configuração de cessão do cliente.
Response
Response Body
[
{
"assignment_key": "868a2951-efff-4e41-8adf-bc36871a20fb",
"creation_datetime": "2023-10-01T12:00:00",
"reference_date": "2023-10-01",
"total_amount": 120000,
"number_of_items": 3,
"status": "pending_items_calculation",
"created_at": "2023-10-01T11:00:00"
}
]
Consulta de Cessão
Para consultar uma cessão específica, o cliente pode realizar um GET no endpoint utilizando a chave identificadora da cessão (assignment_key).
Request
Params
| Campo | Descrição |
|---|---|
assignment_key | Chave identificadora da cessão |
Response
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"
}
Consulta de Itens da Cessão
Para consultar os contratos na cessão, utilize o GET no endpoint com a mesma assignment_key.
Request
Params
| Campo | Descrição |
|---|---|
assignment_key | Chave identificadora da cessão |
Response
O retorno é uma lista de informações de cada contrato na cessão (status 200), paginado:
Response
Response Body
{
"data": [
{
"assignment_item_key": "439b1257-82ac-4741-a416-a4428a9a7327",
"control_number": "0001",
"credit_operation_key": "d7f2ba40-30ea-4462-890c-6a99a7d85659",
"issuer_name": "João Santos",
"issuer_document_number": "12345678912",
"issue_amount": 50000,
"disbursed_amount": 45000,
"disbursement_date": "2023-01-01",
"number_of_installments": 12,
"contract_number": "XXX182938",
"present_amount": 48000,
"status": "settled",
"endorsement_url": "https://example.com/endorsement.pdf",
"purchaser_document_number": "1234567890001"
}
],
"pagination": {
"page": 1,
"page_size": 10
}
}