Criar um link de pagamento
Crie ou recupere o link de pagamento de uma cobrança existente.
Cria ou recupera o link de uma cobrança já cadastrada na empresa e no
ambiente da sua chave de API. Informe em charge_id o identificador da
cobrança que o cliente deve pagar.
A cobrança precisa estar aberta e dentro do vencimento para criar ou configurar seu link.
O link usa o cliente, o valor, o vencimento e os demais dados da cobrança. Enquanto a cobrança permitir essa ação, repetir a requisição reutiliza o link existente. Você pode configurar as URLs de retorno e restringir os meios de pagamento aceitos no checkout. Criar o link não cria outra cobrança nem solicita e-mail. Um link novo começa ativo. Se a cobrança já tiver um link pausado, essa requisição conserva a pausa; use o PATCH para reativá-lo.
Consulte Links de pagamento para entender os campos de configuração e acompanhar o pagamento pela cobrança vinculada.
Parâmetros do corpo
Identificador da cobrança existente. O link utiliza o cliente, o valor e o vencimento dessa cobrança.
Até 100 caracteres
URL HTTPS de retorno após o pagamento confirmado. Omitir, enviar null ou texto vazio preserva a URL existente.
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.
Até 2048 caracteres
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.