Pagamento

Usamos a autenticação básica para manter a comunicação segura. Para realizar uma requisição, você precisará do token no cabeçalho da solicitação. Para obter o token entre em contato através do link na página de credenciais de acesso e procure o formulário para os produtos restritos via API.

Pagamento

Enviar pagamento

https://conciliacao.vert-capital.app/api/v1/pagamento/enviarpagamento

post

Este endpoint permite enviar pagamento de dívida sem criar uma carga, pois o mesmo faz isso automaticamente, criando, finalizando e processando a carga.

Header parameters

Acceptstringoptional

Example: application/json

Authorizationstringoptional

Example: Basic

Body

{ 'DividasPagamentos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ]}stringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://conciliacao.vert-capital.app/api/v1/pagamento/enviarpagamento' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{ 'DividasPagamentos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ]}=text'

200

200

No body

Successful response

Tipos de evento de pagamento

TpEvento = 3 [Baixa por retirada]

A baixa por retirada é utilizada quando uma dívida não foi paga e recebeu uma instrução de retirar a mesma de cobrança. A dívida não pode estar em um acordo ativo, pois se estiver a baixa será rejeitada.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

TpEvento = 4 [Baixa integral por pagamento]

Utilizar para baixar uma dívida que não tem acordo ativo e foi pago o valor integral.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• DtPagamento date

• VlPago double

TpEvento = 5 [Baixa parcial por pagamento]

Utilizar para baixar uma dívida que não tem acordo ativo e foi pago o valor parcial devendo assim o restante não pago permanecer em aberto.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• DtPagamento date

• VlPago double

• VlDividaCalculo double

O campo VlDividaCalculo deve conter o valor original que deve ser baixado da dívida. Supondo que você tenha uma dívida com valor original de R$ 150,00 e queira baixar somente R$ 50,00 da mesma, então o campo VlDividaCalculo deve ser preenchido com R$ 50,00

TpEvento = 6 [Baixa especial por pagamento]

Se existir acordo em aberto baixa a primeira parcela EM ABERTO do acordo, se não existir então baixa a dívida.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• DtPagamento date

• VlPago double

Se a dívida original não estiver em acordo e o valor pago for MENOR do que o valor da dívida original, então será baixado um valor parcial do valor da dívida original. Exemplo: Dívida original que não está em acordo no valor de R$ 120,00. Valor pago informado de R$ 20,00. O sistema vai baixar R$ 20,00 e vai deixar o valor da dívida original em R$ 100,00 Se a dívida original não estiver em acordo e o valor pago for MAIOR/IGUAL ao valor da dívida original, então será baixado o valor integral da dívida original colocando o valor pago a maior em JUROS.

TpEvento = 7 [Baixa integral da dívida original e quebra de acordo]

A dívida original será baixada de forma integral e caso a mesma esteja em um acordo o mesmo será quebrado.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• DtPagamento date

• VlPago double

Se a dívida original não estiver em acordo a mesma será baixada de forma integral.

Se a dívida original ESTIVER em acordo a mesma será baixada de forma integral e o acordo será quebrado.

TpEvento = 8 [Baixa parcial da dívida original e quebra de acordo]

A dívida original será baixada de forma parcial e caso a mesma esteja em um acordo o mesmo será quebrado.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• DtPagamento date

• VlPago double

• VlDividaCalculo double

O campo VlDividaCalculo deve conter o valor original que deve ser baixado da dívida. Supondo que você tenha uma dívida com valor original de R$ 150,00 e queira baixar somente R$ 50,00 da mesma, então o campo VlDividaCalculo deve ser preenchido com R$ 50,00

Se a dívida original não estiver em acordo a mesma será baixada de forma parcial.

Se a dívida original ESTIVER em acordo a mesma será baixada de forma parcial e o acordo será quebrado.

TpEvento = 9 [Baixa da dívida original por retirada e quebra de acordo]

A dívida original será excluída e caso a mesma esteja em um acordo o mesmo será quebrado.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

Se a dívida original não estiver em acordo a mesma será excluída.

Se a dívida original ESTIVER em acordo a mesma será excluída e o acordo será quebrado.

---

Enviar atualização de dívida

https://conciliacao.vert-capital.app/api/v1/pagamento/enviaratualizacaodedivida

post

Este endpoint permite enviar atualização de dívida sem criar uma carga, pois o mesmo faz isso automaticamente, criando, finalizando e processando a carga.

Header parameters

Acceptstringoptional

Example: application/json

Authorizationstringoptional

Example: Basic

Body

{ 'Dividas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'VlDivida':double, 'DtVencimento':'date', 'NuPrestacao':integer } ]}stringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://conciliacao.vert-capital.app/api/v1/pagamento/enviaratualizacaodedivida' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{ 'Dividas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'VlDivida':double, 'DtVencimento':'date', 'NuPrestacao':integer } ]}=text'

200

200

No body

Successful response

Tipos de evento de atualização

TpEvento = 1 [Incluir]

Fará a inclusão da dívida caso a mesma não exista na base de dados.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• VlDivida

• DtVencimento

• NuPrestacao

Se a dívida existir na base de dados então o TpEvento será alterado automaticamente para 2.

TpEvento = 2 [Alterar]

Efetua a alteração da dívida caso a mesma exista na base de dados.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• VlDivida

• DtVencimento

• NuPrestacao

Todas as alterações de TpEvento 2 no dia são rejeitadas se forem enviadas após a dívida ter recebido um TpEvento 18 no dia. Exemplo: No dia 20/12/2023 as 07:00 foi enviado o TpEvento 18 para a dívida "A" e no dia 20/12/2023 as 07:10 foi enviado o TpEvento 2 para a dívida "A" o qual será rejeitado, pois já tem um TpEvento 18 para a dívida "A" neste dia antes do TpEvento 2. No dia 21/12/2023 é enviado o TpEvento 2 para a dívida "A" as 08:00 e não é enviado TpEvento 18 antes das 08:00, então o TpEvento 2 será aceito.

TpEvento = 18 [Alterar dívida com checagem no Carga Execução]

Efetua a alteração da dívida caso a mesma exista na base de dados.

Campos obrigatórios

• NmClienteCedente

• NmCedenteCedente

• NmContratoCedente

• NmProdutoCedente

• NmDividaCedente

• VlDivida

• DtVencimento

• NuPrestacao

O TpEvento 18 foi criado para travar pela carga qualquer tipo de atualização de dívida TpEvento 2 no dia. Exemplo: No dia 20/12/2023 as 07:00 foi enviado o TpEvento 18 para a dívida "A" e no dia 20/12/2023 as 07:10 foi enviado o TpEvento 2 para a dívida "A" o qual será rejeitado, pois já tem um TpEvento 18 para a dívida "A" neste dia antes do TpEvento 2. No dia 21/12/2023 é enviado o TpEvento 2 para a dívida "A" as 08:00 e não é enviado TpEvento 18 antes das 08:00, então o TpEvento 2 será aceito.

Para realizar o processo via troca de arquivos, consulte a página:

Troca de dados via arquivo