Visão geral
Use este endpoint para gerar um link de pagamento que pode ser compartilhado com seus clientes via e-mail, WhatsApp ou redes sociais. O cliente acessa uma página de checkout hospedada pela Avantti Finance e pode pagar via PIX, cartão ou boleto, conforme habilitado.Endpoint
Parâmetros do corpo
integer
required
Valor a ser cobrado, em centavos (ex:
15000 representa R$ 150,00). Caso omitido, o valor pode ser definido pelo próprio pagador no checkout.string
required
Descrição exibida na página de checkout, identificando o motivo da cobrança.
array
required
Lista dos métodos de pagamento habilitados para este link. Valores aceitos:
pix, card, boleto.string
Data e hora de expiração do link, no formato ISO 8601. Após essa data, o link não aceitará novos pagamentos.
string
URL para a qual o cliente será redirecionado após concluir o pagamento.
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o link.
Resposta
string
Identificador único do link de pagamento, no formato
plink_xxxxxxxxxxxx.string
URL pública do checkout que pode ser compartilhada com o cliente.
integer
Valor configurado para a cobrança, em centavos.
string
Status atual do link. Valores possíveis:
active, expired, disabled.string
Data e hora de criação do link, no formato ISO 8601.
Exemplo de resposta
Erros comuns
Próximos passos
Listar links
Consulte todos os links de pagamento criados.
Editar link
Atualize as configurações de um link existente.

