Docs
Abrir o painel

Consultar pagamento

GET
/pay/{id}

Status de um pagamento criado em POST /pay. Rota pública: não exige credenciais, para o seu checkout acompanhar o Pix sem expor suas chaves. Para liberar o pedido, confirme pelo webhook event.completed.

Parâmetros de caminho

id*string

correlation_id devolvido em POST /pay.

Corpo da resposta

Status do pagamento.

application/json
  1. response
id?string
status?PaymentStatus
Value in"pending""processing""done""cancelled""rejected""expired""refund_requested""refunded"
paid_at?string

Quando o pagamento foi recebido. Só em processing e done.

Formatdate-time
rejected_reason?string

Motivo da recusa. Só em rejected.

Exemplo de requisição
curl -X GET 'https://sandbox.xpayz.us/payment-link/pay/string'
Exemplo de resposta
{  "id": "0d4ba8f5-bbc6-4cbb-ae65-13de2f903271",  "status": "processing",  "paid_at": "2026-11-04T15:13:05Z"}