Introdução
Cobre por Pix e cartão com um link, sem construir checkout.
O Payment Link gera uma URL de checkout hospedada pela XPayZ. Você cria o link pela API, envia para o seu cliente por e-mail, WhatsApp ou no seu site, e recebe o resultado do pagamento por webhook.
1. Crie
POST /links devolve a URL do checkout.2. Envie
O cliente abre a URL e paga por Pix ou cartão.
3. Receba
Seu endpoint recebe
event.completed.4. Concilie
Consulte pagamentos, comprovantes e estornos.
O que dá para fazer
- Links com valor fixo ou aberto. Com
amount, o valor é travado e o link pode expirar. Sem ele, o pagador digita quanto quer pagar (doações, gorjetas). - Uso único ou recorrente.
single_use: trueencerra o link no primeiro pagamento concluído. - Checkout pré-preenchido. Mande nome, documento, e-mail e endereço em
metadatae o pagador só confirma. - Taxas e parcelas sob controle. Escolha quem paga a taxa do cartão e até quantas parcelas oferecer, por link ou como padrão da conta.
- Webhooks assinados. Cada evento chega com
X-Signature(HMAC-SHA256) e é reenviado automaticamente se o seu endpoint falhar. - Estornos pela API. Estorne pagamentos concluídos e acompanhe o resultado por webhook.
Explore
Começo rápido
Do zero ao primeiro pagamento no sandbox em 5 minutos.
Autenticação
Como enviar X-Secret-ID e X-Secret-Key.
Links de pagamento
Valor fixo ou aberto, expiração, status e idempotência.
Checkout no iframe
Incorpore o checkout no seu site, com as suas cores.
Webhooks
Tópicos, payload, assinatura e reenvios.
Referência da API
Todos os endpoints, com playground para testar.
Erros
Códigos PGPL e como tratar cada um.