v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Estorna uma cobrança existente.

Utilize este método para efetuar o estorno (ou cancelamento) de uma cobrança já efetuada com sucesso. É importante observar que não é possível reverter um estorno realizado com sucesso.

Após a operação de estorno, a cobrança assumirá status=canceled. O cancelamento da fatura associda é opcional e pode ser informado através da opção cancel_bill no corpo da requisição.

Estorno total e parcial

A operação de estorno pode ser realizada na totalidade do valor original ou parcialmente, caso seja necessário. É importante observar que nem todas as adquirentes suportam a modalidade de estorno parcial.

Para efetuar o estorno total não é obrigatório informar o parâmetro amount.

Retorno síncrono e assíncrono

Caso o estorno retorne uma transação (last_transaction) contendo o atributo status=success, é possível considerar que a operação foi realizada com sucesso e o valor será creditado na fatura do cliente respeitando as regras da adquirente e do banco emissor. Chamamos esta operação de estorno síncrono.

Em alguns casos também é possível que a plataforma retorne status=waiting. Isto significa que o estorno foi recebido com sucesso, porém ainda depende de um processamento adicional na adquirente. Esta operação é chamada de estorno assíncrono. Neste caso, você poderá optar pelo recebimento do webhook "Cobrança estornada" (charge_refunded) que será enviado assim que a adquirente emitir a confirmação de estorno. O recebimento da confirmação do estorno pode demorar entre alguns minutos até alguns dias.

post/v1/charges/{id}/refund

Path parameters

idinteger required

ID da cobrança que será estornada.

Request body

bodystring

JSON com atributos do estorno.

amountnumber

Valor do estorno. Se não for informado, o valor total será estornado

cancel_billstring

Informe se a fatura associada à cobrança será cancelada após o estorno. Se não informado, o valor false será utilizado

commentsstring

Descrição opcional

Response

Estorno emitido 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