Vorexy
IntroCriarSaldoHooksErros

Buscar Transacao por ID

Recupera os detalhes completos de uma transacao especifica usando seu transactionId.

GET/api/Transaction/transactionByTransactionId/{transactionId}

Headers Obrigatorios

X-Client-Id
Obrigatoriostring

ID publico do seu aplicativo

X-API-Key
Obrigatoriostring

Chave secreta da sua empresa

Accept
Obrigatoriostring

Deve ser application/json

Parametros de Rota

transactionId

UUID da transacao retornado no campo id ao criar uma transacao.

Exemplo: 9f9a917a-c265-4bd5-ba3d-c2cc7c766339

Exemplo cURL

cURL
curl -X GET "https://vorexy.com/api/Transaction/transactionByTransactionId/9f9a917a-c265-4bd5-ba3d-c2cc7c766339" \
  -H "Accept: application/json" \
  -H "X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33" \
  -H "X-API-Key: sua-api-key-secreta"

Resposta de Sucesso (200 OK)

Response
{
  "id": 123,
  "leadId": 456,
  "lead": {
    "id": 456,
    "name": "Joao Silva",
    "email": "joao@example.com",
    "phone": "11999999999",
    "document": "12345678900"
  },
  "companyId": 6,
  "value": 5,
  "transactionId": "9f9a917a-c265-4bd5-ba3d-c2cc7c766339",
  "enStatusTransaction": "Awaiting",
  "enPaymentSystem": "Pix",
  "updateDate": "2025-10-17T01:27:45.224075+00:00",
  "createdAt": "2025-10-17T01:27:45.224058"
}

Campos Principais

transactionId
string

UUID unico da transacao

enStatusTransaction
string

Status atual (Awaiting, Paid, Cancelled, etc.)

enPaymentSystem
string

Metodo de pagamento (Pix, Boleto, CreditCard)

value
number

Valor da transacao em centavos

lead
object

Dados completos do cliente

Status Possiveis

AwaitingAguardando pagamento PIX
PaidPagamento confirmado
CancelledTransacao cancelada
FailedFalha no pagamento
RefundedPagamento estornado

Exemplo JavaScript

JavaScript (fetch)
const transactionId = '9f9a917a-c265-4bd5-ba3d-c2cc7c766339';
const response = await fetch(
  `https://vorexy.com/api/Transaction/transactionByTransactionId/${transactionId}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'sua-api-key-secreta'
    }
  }
);
const transaction = await response.json();
console.log('Status:', transaction.enStatusTransaction);
console.log('Valor:', transaction.value / 100); // Converter centavos para reais

Notas Importantes

INFO

Use o transactionId retornado ao criar a transacao

INFO

O campo value esta sempre em centavos (500 = R$ 5,00)

INFO

O status enStatusTransaction pode ser: Awaiting, Paid, Cancelled, Failed, Refunded

INFO

Dados do cliente estao no objeto lead

TIP

Para atualizacoes em tempo real, configure webhooks ao inves de fazer polling constante