GET/api/v1/orders/:id

Detalhe da compra

Bearer tokenescopo read:orders

Retorna o status e os dados não sensíveis de uma order (compra de créditos avulsos ou assinatura) pelo ID. Inclui os dados de pagamento PIX (QR Code) quando a order é PushinPay. Responde 200 OK.

Escopo necessário: read:orders (ver Escopos).

Exemplo de request

cURL

curl https://avatrix.io/api/v1/orders/ord_xxxxxxxx \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

Resposta — 200

JSON

{
  "success": true,
  "data": {
    "id": "ord_...",
    "type": "pix_credit_pack",
    "paymentMethod": "pushinpay",
    "status": "pending",
    "amount": 49.90,
    "credits": 1000,
    "planId": "credits",
    "planName": null,
    "billingInterval": null,
    "packName": "1.000 créditos",
    "createdAt": "2026-06-16T...",
    "paidAt": null,
    "canceledAt": null,
    "pix": {
      "qrCode": "00020126...",
      "qrCodeBase64": "data:image/png;base64,...",
      "expiresAt": "2026-06-16T..."
    }
  }
}

O campo pix é null em orders de assinatura.

Segurança

As consultas são restritas à sua conta: só é possível ler as próprias orders. O QR Code PIX exposto é o da sua própria conta (é o meio de pagamento), mas a resposta nunca expõe CPF, nome do pagador, end-to-end id nem o ID da transação no gateway.

Erros relevantes

Código	HTTP	Quando
`UNAUTHORIZED`	401	token ausente, inválido, expirado ou revogado
`FORBIDDEN`	403	token sem `read:orders`
`NOT_FOUND`	404	order inexistente ou de outra conta
`RATE_LIMITED`	429	rate limit (60 req/min por token), com `Retry-After`

Ver Erros.