Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
payment_profiles

Verifica a validade de um perfil de pagamento existente através do ID.

Este método permite verificar se um perfil de pagamento existente é válido na entidade emissora. Apenas o método de pagamento cartão de crédito suporta esta operação.

Utilize esta função para validar um perfil de pagamento antes da criação de uma assinatura que não possua cobrança imediata. Este método é desnecessário para assinaturas com cobrança imediata.

Funcionamento

Preferencialmente a plataforma Vindi irá executar o método de validação fornecido nativamente pelas adquirentes. Caso este método não esteja disponível, a plataforma poderá realizar uma autorização seguida de um cancelamento.

Resultado

Para verificar o resultado da validação, verifique no retorno se status=success.

Disponibilidade

Esta funcionalidade estará disponível para testes enquanto sua conta Vindi estiver no modo trial. Para habilitar no modo produção, instale a extensão "Transação de verificação" acessando Configurações > Extensões & Integrações no painel de administração da plataforma. Taxas adicionais por verificação poderão ser cobradas.

post/v1/payment_profiles/{id}/verify

Path parameters

idinteger required

ID do perfil de pagamento que deverá ser verificado.

Response

Ok. Transação de verificação realizada 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