v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Pagamentos da comissão

Bloqueia os pagamentos da comissão

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Este endpoint é a interface de gestão para bloquear pagamentos individuais de parcelas de comissões dentro do sistema Construtor de Vendas (CVCRM).

O bloqueio impede que o pagamento seja processado ou disponibilizado para saque, sendo essencial para ações de retenção ou auditoria.

put/v1/financeiro/comissoes/parcelas/bloquear

Headers

emailstring required
Example:email@email.com

Email de autenticação no CV

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no CV

Request body

idpagamentointeger required

Identificador do pagamento da comissão no bloquear pagamento

motivo_bloqueiostring required

motivo do bloqueio do pagamento

Example request

{
  "idpagamento": 5458954,
  "motivo_bloqueio": "pagamento bloqueado por motivo tal"
}

Response

Operação realizada com sucesso no bloquear pagamento.

sucessoboolean

campo informando o status da operação

Example response

{
  "sucesso": true
}