Atualizar um link de pagamento
Pause ou reative o link e atualize suas URLs de retorno e meios de pagamento.
Atualiza a configuração de um link existente. Use is_active: false para
pausar o checkout e is_active: true para reativá-lo com a mesma URL. Omitir
esse campo preserva a configuração; null não é aceito. A pausa também
impede novos pedidos de envio do link por e-mail. Ela não cancela Pix ou boleto já emitidos
nem prorroga o vencimento da cobrança.
Você também pode enviar as URLs de retorno e a lista de meios aceitos no
checkout. URLs omitidas, null ou
vazias preservam os endereços cadastrados. Para remover um destino, envie
clear_success_redirect_url: true ou clear_cancel_redirect_url: true.
Enviar false ou omitir o comando não solicita remoção.
Não envie uma URL preenchida junto do seu comando de limpeza com true.
Essa combinação retorna HTTP 400, com MUTUALLY_EXCLUSIVE nos detalhes dos
dois campos. Você pode remover um destino e atualizar o outro na mesma
requisição. A resposta apresenta null no destino removido.
A cobrança vinculada precisa estar aberta e dentro do vencimento, inclusive para pausar ou reativar. Outras alterações não reativam um link pausado.
Omitir payment_method_types preserva a configuração do link. Enviar null
remove essa configuração própria e volta a usar os meios definidos pela
cobrança e pelo checkout da conta.
A requisição mantém o vínculo com a cobrança e não altera cliente, título, valor, vencimento ou status. Para consultar ou editar os dados permitidos da cobrança, use a referência de cobranças. Consulte Configurar o link para entender as URLs de retorno e a restrição dos meios de pagamento.
Parâmetros de caminho
Identificador público do link, recebido na criação ou na listagem.
Até 100 caracteres
Parâmetros do corpo
Envie false para pausar o checkout e true para reativar a mesma URL. Omitir preserva o estado atual. A pausa não cancela Pix ou boleto emitidos nem prorroga o vencimento.
URL HTTPS de retorno após o pagamento confirmado. Omitir, enviar null ou texto vazio preserva a URL existente. Para removê-la, use clear_success_redirect_url com true, sem informar uma URL preenchida.
Até 2048 caracteres
URL HTTPS para voltar ao seu site. Esse retorno não cancela a cobrança. Omitir, enviar null ou texto vazio preserva a URL existente. Para removê-la, use clear_cancel_redirect_url com true, sem informar uma URL preenchida.
Até 2048 caracteres
Envie true para remover o destino de retorno após o pagamento. False ou omissão não solicita remoção. Não envie true junto de success_redirect_url preenchida.
Envie true para remover o destino de voltar ao site. False ou omissão não solicita remoção. Não envie true junto de cancel_redirect_url preenchida.
Meios permitidos no link. Omitir preserva a configuração; null remove a configuração própria. Uma lista limita os meios do checkout e não amplia os permitidos pela cobrança.
1 a 2 itens
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.