Consultar Aditamento
Dois endpoints de consulta: um devolve o aditamento completo pela chave, outro lista os aditamentos do seu tenant de forma paginada.
Como não há webhook dedicado às transições de status do aditamento, a consulta é o caminho para acompanhar o andamento.
Consulta por chave
Request
ENDPOINT
/security_amendment/amendment/AMENDMENT-KEYMÉTODO
GETPath Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
AMENDMENT-KEY | string | Chave única do aditamento (UUID v4). | 36 |
Response
STATUS
200A resposta é o objeto completo do aditamento — o mesmo formato devolvido pela criação, agora com os campos preenchidos pelas etapas já percorridas.
Response Body — aditamento aguardando o pagamento da taxa
{
"amendment_key": "7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33",
"status": "pending_charge_settlement",
"security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
"amendment_number": 2,
"operation_key": "8e2b4f10-77a1-4c3d-b9e5-1f6a0c9d2e47",
"operation_type": "commercial_paper",
"financial_base_date": "2026-09-20",
"outstanding_balance": 152340.55,
"created_by": "integration",
"created_at": "2026-09-14T10:22:41",
"applied_at": null,
"previous_financial_key": "b4d1e8a2-3c57-4f9b-8a06-5e2d7c1b9f34",
"new_financial_key": null,
"envelope_key": null,
"signature_method": "certifiqi",
"changes": [
{
"amendment_change_key": "c9e7a1b3-5d24-4f68-9b0c-3a7e6d5f2c18",
"type": "financial_flow",
"operation": "modification",
"target_key": null,
"status": "created",
"is_term_signer": false,
"applied_at": null,
"failure_reason": null,
"previous_value": { "interest_rate": { "monthly_rate": 0.0180, "interest_base": "workdays" } },
"new_value": { "interest_rate": { "monthly_rate": 0.0199, "interest_base": "workdays" } },
"term_wording": null,
"status_history": [
{ "status": "created", "status_reason": null, "reason": null, "event_actor": "integration", "event_datetime": "2026-09-14T10:22:41" }
],
"financial": {
"previous_interest_rate": { "monthly_rate": 0.0180, "interest_base": "workdays" },
"new_interest_rate": { "monthly_rate": 0.0199, "interest_base": "workdays" },
"closing_present_value": 152340.55,
"closing_difference": 0.00,
"closing_tolerance": 0.01
}
}
],
"documents": [
{
"document_key": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"document_type": "amendment_term",
"description": null,
"template_key": "de1862a0-e196-4329-9ca4-ba5068a78929",
"signed_file_key": null,
"externally_provided_at": null
}
],
"charges": [
{
"amendment_charge_key": "9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f",
"charge_status": "registered",
"charge_payer_type": "issuer",
"charge_attempt": 1,
"amount": 500.00,
"due_date": "2026-09-19",
"payer_name": "Emissor Exemplo S.A.",
"payer_document_number": "12.345.678/0001-90",
"external_charge_key": "4c3d2e1f-9a8b-4756-b342-1e0d9c8b7a65",
"digitable_line": "34191.79001 01043.510047 91020.150008 1 96690000050000",
"settled_at": null,
"charge_status_history": [
{ "status": "created", "event_actor": "system", "event_datetime": "2026-09-14T10:23:02" },
{ "status": "registration_requested", "event_actor": "system", "event_datetime": "2026-09-14T10:23:03" },
{ "status": "registered", "event_actor": "system", "event_datetime": "2026-09-14T10:23:18" }
]
}
],
"status_history": [
{ "status": "created", "status_reason": null, "reason": null, "event_actor": "integration", "event_datetime": "2026-09-14T10:22:41" },
{ "status": "pending_term_generation", "status_reason": null, "reason": null, "event_actor": "integration", "event_datetime": "2026-09-14T10:22:41" },
{ "status": "pending_charge_settlement", "status_reason": null, "reason": null, "event_actor": "system", "event_datetime": "2026-09-14T10:23:02" }
]
}
Onde está a linha digitável
Em charges[].digitable_line. Enquanto o aditamento estiver em pending_charge_settlement, é o pagamento desse boleto que libera o envio do termo para assinatura.
Consulta paginada
Request
ENDPOINT
/security_amendment/amendmentMÉTODO
GETQuery Params
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
security_key | string (UUID) | Não | — | Filtra os aditamentos de um título específico. |
page | integer | Não | 1 | Página desejada. |
page_size | integer | Não | 30 | Itens por página. |
Response
STATUS
200Resposta resumida
A listagem devolve uma versão reduzida de cada aditamento: sem documents, charges, status_history, envelope_key, signature_method nem as chaves de fluxo financeiro. As alterações vêm sem previous_value, new_value, term_wording e histórico. Para o objeto completo, consulte pela chave.
Response Body
{
"amendment_list": [
{
"amendment_key": "7f1c9a20-6c3e-4a51-9f0b-2d8e5b4c1a33",
"status": "pending_charge_settlement",
"security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
"amendment_number": 2,
"operation_key": "8e2b4f10-77a1-4c3d-b9e5-1f6a0c9d2e47",
"operation_type": "commercial_paper",
"financial_base_date": "2026-09-20",
"outstanding_balance": 152340.55,
"created_by": "integration",
"created_at": "2026-09-14T10:22:41",
"applied_at": null,
"changes": [
{
"amendment_change_key": "c9e7a1b3-5d24-4f68-9b0c-3a7e6d5f2c18",
"type": "financial_flow",
"operation": "modification",
"target_key": null,
"status": "created",
"is_term_signer": false,
"applied_at": null,
"failure_reason": null,
"financial": {
"closing_present_value": 152340.55,
"closing_difference": 0.00,
"closing_tolerance": 0.01
}
}
]
}
],
"total_count": 1,
"page": 1,
"page_size": 30
}
| Campo | Tipo | Descrição |
|---|---|---|
amendment_list | array | Aditamentos da página, em formato reduzido. |
total_count | integer | Total de aditamentos que atendem ao filtro. |
page | integer | Página devolvida. |
page_size | integer | Tamanho da página. |
Erros
| Status | Código | Descrição |
|---|---|---|
| 404 | AMD000017 | Aditamento não encontrado. |
| 403 | AMD000018 | O aditamento não pertence ao seu tenant. |