v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Efetua uma nova tentativa em uma cobrança existente.

A plataforma Vindi efetua retentativas automáticas de cobranças no intervalo configurado em cada método de pagamento. Você pode consultar a data da próxima tentativa no atributo next_attempt de cada cobrança. Ainda assim poderão haver casos onde seja necessário efetuar uma tentativa extraordinária, com ou sem um novo perfil de pagamento. Apenas cobranças no cartão de crédito e débito em conta poderão sofrer retentativas através deste método.

Retentativa com o perfil existente

Se desejar realizar uma retentativa com o perfil de pagamento atual do cliente, efetue o POST sem enviar qualquer informação adicional no corpo da requisição e especifique apenas o ID da cobrança existente.

Retentativa com novo perfil de pagamento

Caso seja possível obter os novos dados de pagamento, use este método para cadastrar o novo perfil de pagamento e efetuar a retentativa da cobrança, tudo em uma única requisição. Envie os dados do perfil de pagamento no corpo da requisição, seguindo os parâmetros descritos abaixo. O cadastro do perfil de pagamento também pode ser realizado através do método POST /payment_profiles.

Cuidados

As tentativas automáticas da Vindi são calculadas pensando na proteção do seu contrato de adquirência e na proteção do cartão de crédito ou da conta corrente do seu cliente. Efetuar retentativas desnecessárias repetidamente pode acabar bloqueando o cartão de crédito do seu cliente ou comprometendo a integração com seu banco ou adquirente.

Use este método exclusivamente para efetuar retentativas manuais em seu backend ou oferecer ao cliente uma tela para atualização das informações de pagamento. Nunca automatize os envio de retentativas.

post/v1/charges/{id}/charge

Path parameters

idinteger required

ID do perfil de pagamento existente

Request body

bodystring

JSON opcional com atributos do novo perfil de pagamento. Se não informado, o perfil de pagamento padrão será utilizado

holder_namestring

Nome do titular/portador do perfil de pagamento

registry_codestring

CPF ou CNPJ do titular/portador

bank_branchstring

Agência da conta bancária

bank_accountstring

Número da conta bancária

card_expirationstring

Validade do cartão de crédito no formato MM/AA

allow_as_fallbackstring

Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.

card_numberstring

Número completo do cartão de crédito

card_cvvstring

Código de segurança do cartão de crédito com 3 ou 4 dígitos

payment_method_codestring

Código do método de pagamento

payment_company_codestring

Código do banco ou bandeira

gateway_tokenstring

Token externo

Response

Tentativa efetuada.

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