Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
transactions

Insere uma nova transação manual.

Este método deve ser utilizado apenas para efetuar a baixa manual de cobranças pagas através de métodos que não são controlados pela plataforma Vindi, como por exemplo, dinheiro em espécie ou depósito em conta.

Quando você utiliza a criação manual de transações, a plataforma Vindi considera que o valor em questão foi de fato recebido. Por este motivo, não use este método para conceder descontos, créditos ou abonos.

Cálculo de multa e juros

Caso a configuração do método de pagamento original da cobrança contenha multa e juros, tenha cuidado redobrado ao informar a data de pagamento correta através do atributo paid_at.

post/v1/transactions

Request body

bodystring

JSON com atributos da nova transação.

charge_idinteger required

ID da cobrança pendente

amountnumber required

Valor da transação

payment_method_codestring required

Código do método de pagamento

paid_atstring

Data opcional do pagamento da cobrança no formato ISO 8601. Se não informada, a data atual será utilizada

commentsstring

Descrição opcional

Response

Transação manual criada com sucesso.

idinteger required

ID da transação

transaction_type'charge' | 'refund' | 'authorization' | 'capture' | 'verify' | 'register' | 'void' | 'renew_payment_profile' | 'pre_authorization' | 'update' required

Tipo da transação

status'processing' | 'success' | 'rejected' | 'failure' | 'timeout' | 'waiting' | 'canceled' | 'fraud_review' required

Status da transação

amountnumber required

Valor da transação

installmentsinteger required

Número de parcelas

gateway_messagestring required

Mensagem de resposta do gateway

gateway_response_codestring required

Código de resposta do gateway

gateway_authorizationstring required

Código da autorização usado no estorno ou captura. Varia de acordo com o adquirente

gateway_transaction_idstring required

Código externo de referência do gateway. Para boletos, representa o "nosso número"

gateway_response_fieldsstring

Atributos de resposta específicos do gateway

fallback_typestring required

Tipo de Retentativa

fraud_detector_scorenumber

Pontuação da análise antifraude entre 0.00 e 1.00. Quanto maior a pontuação, maior o risco de fraude

fraud_detector_status'automatic_success' | 'manual_success' | 'automatic_rejected' | 'manual_rejected' | 'review' | 'failure'

Status da análise antifraude

fraud_detector_idstring

ID da análise antifraude

created_atstring required

Data e hora da transação

updated_atstring required

Data e hora da última atualização da transação