Cancelar CPR Ag

Em teste

POST

/v2/cpr-ag/{cprId}/cancel

Pede o cancelamento da CPR informada em cprId, com o motivo informado em reason. A CPR precisa ser da empresa do usuário, não removida, e não pode já estar cancelada ou com cancelamento em andamento. O status passa para processando-cancelamento e o pedido é enviado para processamento: a resposta 200 indica que o cancelamento foi solicitado, não que a CPR já está cancelada. A resposta traz o ID da CPR e o novo status. CPR inexistente, de outra empresa, removida ou já cancelada devolve 404, com a mensagem dentro de um array a mais. Sem reason, a resposta é 422. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Cancelamento solicitado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Falha ao solicitar o cancelamento

🟠404CPR não encontrada

🟠422Motivo não informado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/cpr-ag/3f2b8c1e-0000-4000-8000-00000000c001/cancel' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "CPR emitida com valor incorreto."
}'

Response Example

200 - Sucesso

{
    "_id": "3f2b8c1e-0000-4000-8000-00000000c001",
    "status": "processando-cancelamento"
}

Modificado em 2026-10-21 19:11:22

Página anterior

Exportar CPRs da empresa (Excel)

Próxima página

Registrar endosso de CPR de um cliente