Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Captura manualmente uma cobrança previamente autorizada.

Este método permite executar a captura de uma cobrança previamente autorizada através da criação de uma nova transação de captura. É importante verificar se o gateway utilizado está configurado para aceitar capturas manuais. Verifique também o prazo máximo de captura permitido pela adquirente utilizada.

post/v1/charges/{id}/capture

Path parameters

idinteger required

ID da cobrança que será capturada.

Response

Tentativa de captura efetuada 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