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}

Retorna os detalhes de uma transação específica

Headers Obrigatórios

Parametro	Tipo	Descricao
`X-Client-Id`obrigatorio	`string`	ID público do seu aplicativo
`X-API-Key`obrigatorio	`string`	Chave secreta da sua empresa
`Accept`obrigatorio	`string`	Deve ser application/json

Parâmetros de Rota

Parametro	Tipo	Descricao
`transactionId`obrigatorio	`string (UUID)`	UUID da transação retornado no campo id ao criar uma transação.

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

Resposta de Sucesso (200 OK)

response.json

json

{
  "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

Parametro	Tipo	Descricao
`transactionId`	`string`	UUID único da transação
`enStatusTransaction`	`string`	Status atual (Awaiting, Paid, Cancelled, etc.)
`enPaymentSystem`	`string`	Método de pagamento (Pix, Boleto, CreditCard)
`value`	`number`	Valor da transação em centavos
`lead`	`object`	Dados completos do cliente

Exemplos

cURL

bash

curl -X GET "https://rayopay.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)

javascript

const transactionId = '9f9a917a-c265-4bd5-ba3d-c2cc7c766339';
 
const response = await fetch(
  `https://rayopay.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