Alterar pagamento 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)

Atualizar pagamentos de comissão. Permite alterar a situação do pagamento e/ou associar dados de boleto.

O endpoint aceita dois grupos de dados independentes:

Situação do pagamento (idsituacao_cv ou situacao): obrigatório informar um dos dois.
Dados do boleto (idpagamento_int + boleto_url ou boleto_base64): opcional. Quando enviado, deve vir completo (o idpagamento_int é obrigatório junto com boleto_url ou boleto_base64). Caso contrário o sistema retorna erro 400.

Se a requisição enviar apenas a situação, somente ela será alterada e os dados de boleto existentes permanecem intocados.

Quando enviados vários idpagamentos junto com dados de boleto, um único registro de boleto é criado e vinculado a todos eles. Nesse caso, todos os pagamentos devem pertencer à mesma comissão.

Autenticação: Requer email e token nos Headers da requisição.

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

Identificador único de um pagamento da comissão. Use este campo OU idpagamentos.

idpagamentosinteger[]

Lista de identificadores de pagamentos da comissão. Quando enviados com dados de boleto, todos devem pertencer à mesma comissão.

situacaostring

Nome da situação do pagamento no workflow. Use este campo OU idsituacao_cv.

idsituacao_cvinteger

ID da situação do pagamento. Use este campo OU situacao.

idpagamento_intstring

Protocolo do(s) boleto(s) no sistema parceiro. Obrigatório quando boleto_url ou boleto_base64 é enviado.

boleto_urlstring

Link de acesso ao boleto. Use este campo OU boleto_base64 ao enviar dados de boleto.

boleto_base64string

Arquivo do boleto em Base64. Use este campo OU boleto_url ao enviar dados de boleto.

Example request

{
  "idpagamentos": [
    1,
    2,
    3
  ],
  "idsituacao_cv": 1,
  "idpagamento_int": "1111",
  "boleto_url": "http://www.site.com.br?arquivo=a"
}

Response

Operação realizada com sucesso no put de pagamento de comissão.

sucessoboolean

campo informando o status da operação

Example response

{
  "sucesso": true
}