Skip to main content

PIX IN – Lista de Transações

Use este endpoint para listar várias transações via PIX.
Você pode aplicar filtros para encontrar exatamente o que precisa, como período, valor ou status.

Filtros opcionais (query param filters em JSON)

  • page: número da página (ex: "1")
  • limit: itens por página (ex: "15")
  • orderId: filtra por ID da transação
  • minPrice / maxPrice: valor mínimo/máximo
  • customerCpfCnpj, customerName, customerEmail, customerPhone
  • paymentMethod, startDate, endDate, orderStatus

Cabeçalhos

  • x-authorization-key (obrigatório): sua chave secreta
  • x-store-key (opcional): chave pública, se aplicável

Como testar no Swagger

  1. Clique em Try it out.
  2. No campo filters, cole um JSON com seus filtros.
  3. Insira suas credenciais:
    • x-authorization-key: sua chave secreta
    • x-store-key: chave pública (opcional)
  4. Clique em Execute.

Verifique a resposta
Role até o painel Response para ver o array data com as transações e o objeto meta de paginação.


✅ Exemplo de Resposta

{
"data": [
{
"id": "uuid",
"status": "paid",
"total": 1,
"paymentMethod": "PIX",
"liquidValue": 0.77,
"createdAt": "2025-06-08T04:28:46.553Z",
"updatedAt": "2025-06-08T04:28:46.553Z",
"flag": null,
"customerName": "John Doe",
"customer": {
"name": "John Doe",
"email": "john@gmail.com",
"phone": "99999999999",
"cpfCnpj": "12345678901"
},
"orderItems": [
{
"id": "uuid",
"name": "products",
"price": 1,
"type": "PRODUCT"
}
],
"products": [
{
"id": "uuid",
"name": "products",
"price": 1,
"type": "PRODUCT"
}
]
}
],
"meta": {
"total": 3,
"currentPage": 1,
"pageSize": 15,
"lastPage": 1
}
}