Consultar cobrança PIX
Retorna os dados completos da cobrança PIX pelo identificador, incluindo status e data de pagamento.
Overview
Útil para verificar se a cobrança já foi paga (status e paidAt) ou exibir detalhes no painel.
Endpoint
GETGET /pix/{pixId}
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Path Parameters
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| pixId | string | Sim | ID da cobrança PIX. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/pix/pix_xyz789" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"id": "pix_xyz789",
"status": "completed",
"amount": 5000,
"description": "Cobrança PIX",
"createdAt": "2025-02-09T12:00:00.000Z",
"paidAt": "2025-02-09T12:02:00.000Z"
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | Identificador da cobrança. |
| status | string | pending | completed | cancelled. |
| amount | number | Valor em centavos. |
| description | string | Descrição informada na criação. |
| createdAt | string | Data/hora de criação (ISO 8601). |
| paidAt | string | Data/hora do pagamento, quando status = completed (opcional). |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | Cobrança PIX não encontrada. |
| 401 | INVALID_API_KEY | Chave de API inválida ou ausente. |
Exemplo de resposta de erro
JSON
{
"code": "RESOURCE_NOT_FOUND",
"message": "Cobrança PIX não encontrada."
}