Consultar transação por ID
Retorna os dados completos da transação pelo identificador.
Overview
Para apenas o status, use o endpoint de Consultar status rápido (menor payload).
Endpoint
GETGET /transactions/{transactionId}
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 |
|---|---|---|---|
| transactionId | string | Sim | ID da transação retornado na criação (POST /transactions). |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/transactions/txn_abc123" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"id": "txn_abc123",
"status": "completed",
"amount": 1000,
"description": "Pedido #1234",
"externalId": "pedido-1234",
"customerEmail": "cliente@email.com",
"createdAt": "2025-02-09T12:00:00.000Z",
"updatedAt": "2025-02-09T12:05:00.000Z",
"metadata": {}
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | ID da transação. |
| status | string | pending | completed | failed | cancelled. |
| amount | number | Valor em centavos. |
| description | string | Descrição. |
| externalId | string | ID externo. |
| customerEmail | string | E-mail do cliente (se informado). |
| createdAt | string | Data/hora de criação (ISO 8601). |
| updatedAt | string | Última atualização (ISO 8601). |
| metadata | object | Metadados customizados. |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | Transação 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": "Transação não encontrada."
}