GET

Buscar Transação por ID

Recupera os detalhes completos de uma transação específica usando seu transactionId.

Endpoint

GET /api/Transaction/transactionByTransactionId/{transactionId}

Headers Obrigatórios

X-Client-Id

ID público do seu aplicativo

X-API-Key

Chave secreta da sua empresa

Accept

Deve ser application/json

Parâmetros de Rota

transactionId

UUID da transação retornado no campo id ao criar uma transação.

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

Resposta de Sucesso (200 OK)

{
  "id": 123,
  "leadId": 456,
  "lead": {
    "id": 456,
    "name": "João 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

UUID único da transação

enStatusTransaction

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

enPaymentSystem

Método de pagamento (Pix, Boleto, CreditCard)

value

Valor da transação em centavos

lead

Dados completos do cliente

Exemplos

cURL

curl -X GET "https://app.xflowpayments.com.br/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"

JavaScript (fetch)

const transactionId = '9f9a917a-c265-4bd5-ba3d-c2cc7c766339';

const response = await fetch(
  `https://app.xflowpayments.com.br/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

• Use o transactionId retornado ao criar a transação

• O campo value está sempre em centavos (500 = R$ 5,00)

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

• Dados do cliente estão no objeto lead

• Para atualizações em tempo real, configure webhooks ao invés de fazer polling constante