Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
charges

Atualiza uma cobrança existente.

Utilize este método para atualizar cobranças existentes.

Alterar método de pagamento

Não é possível alterar o método de pagamento de uma cobrança existente. Para realizar esta operação, reemita a cobrança informando um novo método de pagamento usando o endpoint POST /charges/{id}/reissue.

put/v1/charges/{id}

Path parameters

idinteger required

ID da cobrança que deverá ser atualizada.

Request body

bodystring

JSON com os novos atributos da cobrança.

due_atstring

Data do vencimento da cobrança

installmentsinteger

Número de parcelas. Se não for informado, o valor '1' será utilizado

Response

Cobrança atualizada 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