PIX OUT – Lista de Saques

Use este endpoint para listar todas as solicitações de saque via PIX que você fez.
Você pode aplicar filtros para encontrar os saques desejados.

Filtros opcionais (query param filters em JSON)

• storeId: ID da loja
• createdAt: data de criação (YYYY‑MM‑DD)
• value: valor em centavos
• key: chave Pix de destino
• status: status do saque
• externalCode: código interno opcional

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 os filtros que desejar.
3. Preencha os cabeçalhos:
   • 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 os saques e o objeto meta de paginação.

---

✅ Exemplo de Resposta

{
  "data": [
    {
      "id": "64905df5-ee95-42f7-bc79-6bbff92ee055",
      "amount": 1000,
      "taxes": 100.1,
      "pixKey": "12345678910",
      "pixKeyType": "cpf",
      "externalCode": "EXT-001",
      "withdrawStatusId": "AwaitingAprove",
      "createdAt": "2025-03-05T18:55:22.919Z",
      "updatedAt": "2025-03-05T18:55:22.919Z"
    }
  ],
  "meta": {
    "total": 1,
    "currentPage": 1,
    "pageSize": 15,
    "lastPage": 1
  }
}