VIvindi
charges

Cancela uma cobrança existente.

Utilize este método para efetuar o cancelamento de uma cobrança aguardando pagamento.

Após a operação de cancelamento, a cobrança assumirá status=canceled.

delete/v1/charges/{id}

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/charges/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID da cobrança que será cancelada.

Query parameters

commentsstring

Comentários opcionais sobre o cancelamento.

ignore_transaction_errorsstring

Indica se a operação deverá ser executada mesmo se houver falha na comunicação com a instituição financeira. Utilize apenas se a cobrança já foi modificada fora da plataforma Vindi. O uso indevido pode causar inconsistências no estado da transação. Recomendamos não enviar este parâmetro durante a utilização normal da API.

Response

Cancelamento efetuado 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

Changes

No recorded changes to this operation across all 1 revision of this API.