Transações

Listar histórico de depósitos, saques e boletos.

Visão geral

Endpoint de leitura para listar transações da conta (depósitos PIX, saques PIX e boletos) com filtros por tipo, status e intervalo de datas. Suporta paginação.

Autenticação

Requer chave de API com scope read. Headers Authorization, X-DF-Secret e X-DF-Passphrase são obrigatórios.

Headers

Header	Exemplo	Obrigatório
Authorization	Bearer dfk_live_...	Sim
X-DF-Secret	sk_...	Sim
X-DF-Passphrase	...	Sim

Endpoint

GET /v1/transactions

Scope: read
Rate limit: 30 req/min, burst 5/5s

Retorna data com items[] e pagination com page, limit, total e pages. Cada item inclui campos comuns (_id, type, status, createdAt) e campos específicos do tipo (pixAmountInCents, payoutAmountInCents, etc).

Exemplo de requisição

bash

curl "https://api.deflow.exchange/v1/transactions?type=deposit&status=depix_sent&page=1&limit=20&from=2026-05-01T00:00:00Z&to=2026-05-15T23:59:59Z" \
  -H "Authorization: Bearer dfk_live_..." \
  -H "X-DF-Secret: sk_..." \
  -H "X-DF-Passphrase: minha-passphrase"

Exemplo de resposta da requisição

json

{
  "data": {
    "items": [
      {
        "_id": "6a0870c1...",
        "type": "withdraw",
        "userId": "699f2f39...",
        "pixKey": "39053344705",
        "payoutAmountInCents": 1000,
        "totalFeeInCents": 0,
        "status": "cancelled",
        "createdAt": "2026-05-16T13:27:29.276Z",
        "updatedAt": "2026-05-16T13:27:39.992Z"
      },
      {
        "_id": "6a07ec44...",
        "type": "deposit",
        "userId": "699f2f39...",
        "walletId": "69c30088...",
        "pixAmountInCents": 1099,
        "netDepixInCents": 1000,
        "totalFeeInCents": 99,
        "status": "pending",
        "qrCopyPaste": "00020101...",
        "createdAt": "2026-05-16T04:46:33.034Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 42,
      "pages": 3
    }
  },
  "meta": {
    "timestamp": "2026-05-16T13:59:43.834Z"
  }
}

Query params

Todos os parâmetros são opcionais. Combine filtros para refinar a busca:

Parâmetro	Tipo	Descrição
page	integer ≥ 1	Número da página (mínimo 1).
limit	integer 1-100	Itens por página (1 a 100).
type	"deposit" \| "withdraw" \| "boleto"	Filtra por tipo de transação.
status	string	Filtro exato por status (depende do tipo).
from	ISO 8601	Data inicial em ISO 8601 (UTC). Range fechado.
to	ISO 8601	Data final em ISO 8601 (UTC). Range fechado.

Tipos

deposit (PIX → DePix), withdraw (DePix → PIX), boleto (cobrança via boleto bancário).

deposit — depósito PIX → DePix (via /v1/deposit ou QR estático).
withdraw — saque DePix → PIX (via /v1/withdraw).
boleto — boleto bancário.

Status

Cada tipo tem enum próprio. Consulte as páginas específicas: Receber DePix para depósitos, Enviar PIX para saques.

Tipo	Status possíveis
deposit	pending, pending_pix2fa, under_review, delayed, depix_sent, expired, canceled, refunded, error
withdraw	unsent, sending, sent, error, cancelled, refunded

Filtros por data

from e to em ISO 8601 (UTC). Range fechado: from <= ts <= to.