v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Revisa manualmente uma cobrança suspeita de fraude.

Utilize este método para aprovar ou rejeitar uma cobrança suspeita de fraude (status=fraud_review).

O comportamento desta operação irá depender da configuração da integração antifraude:

Análise antes da autorização

Neste caso a análise ocorre antes da comunicação com a adquirente.

  • Aprovar (approve): A aprovação de uma suspeita de fraude irá disparar a tentativa de aprovação da transação junto à adquirente. Lembre-se que esta transação pode ser aprovada ou aprovada pela adquirente.
  • Rejeitar (reject): A rejeição atualizará o status da transação para rejeitado (rejected) com uma mensagem de erro genérica. Nenhuma tentativa é realizada na adquirente.

Análise depois da autorização

A análise ocorre após a autorização da adquirente.

  • Aprovar (approve): A plataforma Vindi executa a operação de captura na adquirente.
  • Rejeitar (reject): A rejeição dispara a operação de cancelamento da autorização na adquirente e gera uma transação de captura com o status rejected.
post/v1/charges/{id}/fraud_review

Path parameters

idinteger required

ID da cobrança que será revisada.

Request body

bodystring

JSON com atributos da revisão.

fraud_review_action'approve' | 'reject' required

Ação desejada para revisão

commentsstring

Descrição opcional

Response

Cobrança revisada com sucesso.

idinteger required

ID da cobrança

amountnumber required

Valor da cobrança

status'pending' | 'paid' | 'canceled' | 'processing' | 'fraud_review' required

Status da cobrança

due_atstring required

Data do vencimento da cobrança

paid_atstring

Data do pagamento da cobrança, apenas se a cobrança já foi paga

installmentsinteger required

Número de parcelas da cobrança. Valores acima de 1 são usados apenas para parcelamento através da administradora do cartão de crédito

attempt_countinteger

Número de tentativas automáticas de cobrança já realizadas

next_attemptinteger

Data da próxima tentativa automática de cobrança

print_urlstring

URL para impressão da cobrança. Usado apenas para boletos

created_atstring required

Data e hora da geração da cobrança

updated_atstring required

Data e hora da última atualização da cobrança