Informar pagamento ou inadimplência de uma CPR

POST

/cpr/payment/{cprId}

Registra um pagamento ou uma inadimplência de uma CPR da empresa. Envie em description pagamento, para informar um valor pago (payment_amount, na data payment_date), ou inadimplencia, para informar atraso, opcionalmente com a data prevista de pagamento em payment_forecast_date. O registro é aberto para tratamento pela equipe AgRisk e fica como processando até ser tratado: nesse período a CPR aparece como processando na listagem e não aceita outro registro (422). Depois do tratamento, a listagem mostra pagamento-parcial ou pagamento-completo, conforme o total pago, ou pagamento-atrasado. A soma dos pagamentos não pode passar do valor da CPR, exceto em CPR física (422). CPR inexistente devolve 404. Se o encaminhamento do registro falhar, a resposta traz a mensagem Falha na integração, com o status devolvido pelo serviço de integração ou 400. 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

Registro solicitado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404CPR não encontrada

🟠422Registro não permitido

🟠400Falha na integração

Request Example

Shell

JavaScript

Java

Swift

cURL

PagamentoInadimplência

curl --location '/cpr/payment/3f2b8c1e-0000-4000-8000-00000000c001' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "description": "pagamento",
    "payment_amount": 100000,
    "payment_date": "2026-09-25T03:00:00.000Z"
}'

Response Example

200 - Sucesso

{
    "message": "Solicitação de registro feita com sucesso."
}

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

Página anterior

Enviar documento de CPR Ag para análise automática

Próxima página

Reenviar documento de CPR Ag para análise automática