Docs
Abrir o painel

Pagar um link

POST
/pay

Gera a cobrança de um link. É a rota que o checkout usa; chame direto só se você monta o seu próprio checkout. Rota pública: não exige credenciais.

Pagador sem conta XPayZ: não envie payer_id. Só funciona com payment_method: pix e em links em BRL. Nome e documento não vão na requisição: quem enviar o Pix vira o pagador. payer_email é opcional e recebe o comprovante.

Cabeçalhos

X-Idempotency-Key?string

Corpo da requisição

application/json
  1. body
link_id*string

id do link.

payment_method*PaymentMethod
Value in"pix""credit_card""xpayz""token"
payer_id?integer

Customer XPayZ que paga. Omita para pagar sem conta (só Pix, link em BRL).

payer_email?string

Email que recebe o comprovante. Opcional.

Formatemail
amount?string

Valor, só para link sem valor fixo.

metadata?

Dados do meio de pagamento (cartão, parcelas). Não usado no Pix.

Corpo da resposta

Cobrança gerada. Para Pix, mostre o QR Code ou o copia e cola.

application/json
  1. response
correlation_id?string

ID do pagamento.

payment_qrcode?string

QR Code do Pix em PNG, base64.

payment_content?string

Pix copia e cola.

expected_amount?string
symbol?string
fee?string
Exemplo de requisição
curl -X POST 'https://sandbox.xpayz.us/payment-link/pay' \  -H 'Content-Type: application/json' \  -d '{  "link_id": "b3e1c2d4-5f67-4890-9abc-1234567890ab",  "payment_method": "pix",  "payer_email": "maria@example.com"}'
Exemplo de resposta
{  "correlation_id": "string",  "payment_qrcode": "string",  "payment_content": "string",  "expected_amount": "string",  "symbol": "string",  "fee": "string"}