GET

Listar Transações

Consulte todas as transações da sua empresa com paginação, ordenação e filtros.

Endpoint

GET /api/Transaction/company/transactions

Retorna uma lista paginada de todas as transações da empresa autenticada.

Headers

Header	Valor	Obrigatório
`Accept`	`application/json`	Sim
`X-Client-Id`	seu-client-id	Sim
`X-API-Key`	sua-api-key-secreta	Sim

Parâmetros de Query (Opcionais)

page(number)Padrão: 1

Número da página

pageSize(number)Padrão: 50

Itens por página (máx: 100)

sort(string)Padrão: createdAt_desc

Ordenação: createdAt_desc, createdAt_asc

Resposta de Sucesso (200 OK)

{
  "ok": true,
  "res": {
    "items": [
      {
        "id": 19,
        "leadId": "56c77781-349b-4014-8992-a1d943a4dec2",
        "lead": {
          "id": "56c77781-349b-4014-8992-a1d943a4dec2",
          "externalId": null,
          "name": "João Teste",
          "email": "joao.teste@exemplo.com",
          "phone": "11987654321",
          "documentNumber": "47534460263",
          "documentType": "CPF"
        },
        "amount": 10000,
        "status": "PENDING",
        "paymentMethod": "PIX",
        "providerTxId": "abc123xyz",
        "createdAt": "2024-10-16T12:15:45.229Z",
        "updatedAt": "2024-10-16T12:15:45.229Z"
      }
    ],
    "totalItems": 150,
    "totalPages": 3,
    "currentPage": 1,
    "pageSize": 50
  }
}

Exemplos

cURL

curl -X GET "https://app.xflowpayments.com.br/api/Transaction/company/transactions?page=1&pageSize=50&sort=createdAt_desc" \
  -H "Accept: application/json" \
  -H "X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33" \
  -H "X-API-Key: sua-api-key-secreta"

JavaScript (fetch)

const CLIENT_ID = 'e1c98954cc404cbcb2868af9b40c7a33';
const API_KEY = 'sua-api-key-secreta';

const query = {
  page: 1,
  pageSize: 50,
  sort: 'createdAt_desc',
};

const queryString = Object.entries(query)
  .filter(([, v]) => v !== undefined && v !== null)
  .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
  .join('&');

const response = await fetch(
  `https://app.xflowpayments.com.br/api/Transaction/company/transactions?${queryString}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': CLIENT_ID,
      'X-API-Key': API_KEY,
    },
  }
);

const data = await response.json();
console.log('Transações:', data);

Notas Importantes

Paginação: Use os parâmetros page e pageSize para navegar pelos resultados.

Ordenação: O parâmetro sort aceita createdAt_desc (mais recentes primeiro) ou createdAt_asc (mais antigas primeiro).

Limite: O pageSize máximo é 100 itens por página.

Dados do Lead: Cada transação inclui informações completas do lead (cliente) associado.