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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados necessários para alterar o pagamento da comissão.

Dados para alterar o pagamento da comissão.

  • É obrigatório informar idpagamento ou idpagamentos.
  • É obrigatório informar idsituacao_cv ou situacao.
  • Os campos de boleto são opcionais, mas quando enviados devem vir em conjunto: idpagamento_int junto com boleto_url ou boleto_base64. Enviar parcialmente resulta em erro 400.

integer

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

idpagamentos
array of integers

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

idpagamentos
string

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

integer

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

string

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

string

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

string

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

Headers
string
required

Email de autenticação no CV

string
required

Token de autenticação no CV

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*