Extrato

Todas as movimentações da conta, com filtros por tipo e situação e paginação por cursor.

​

Listar movimentações

GET /v1/transactions · escopo transactions:read

Parâmetro	O que faz
limit	1 a 100 (padrão 50)
cursor	o nextCursor da página anterior
type	um ou mais tipos separados por vírgula: PIX_CHARGE, PIX_SENT, WITHDRAWAL, API_WITHDRAWAL, INTERNAL_TRANSFER, REFUND, MED, FEE, SUBACCOUNT
status	um ou mais: pending, processing, completed, failed, canceled

curl "https://bukio-backend-production.up.railway.app/v1/transactions?type=PIX_CHARGE&status=completed&limit=20" \
  -H "Authorization: Bearer bk_live_..."

{
  "items": [
    {
      "id": "BKY-7KQ2M9XP4RZT",
      "type": "PIX_CHARGE",
      "direction": "credit",
      "amount": 15000,
      "fee": 50,
      "status": "completed",
      "statusTitle": "Aprovado",
      "description": "Pedido 1842",
      "details": {
        "counterparty": "Ana Souza",
        "institution": "Banco Exemplo",
        "key": null,
        "document": "***.456.789-**",
        "endToEndId": "E12345678202610081504abcdef123456",
        "channel": null
      },
      "createdAt": "2026-10-08T15:04:11.000Z"
    },
    {
      "id": "TAR-2M9XP4RZT7KQ",
      "type": "FEE",
      "direction": "debit",
      "amount": 50,
      "fee": 0,
      "status": "completed",
      "statusTitle": "Concluído",
      "description": "Tarifa da cobrança BKY-7KQ2M9XP4RZT",
      "details": { "counterparty": null, "institution": null, "key": null, "document": null, "endToEndId": null, "channel": null },
      "createdAt": "2026-10-08T15:04:11.000Z"
    }
  ],
  "nextCursor": null
}

Campo	O que é
id	código com prefixo (BKY-, ENV-, SAQ-, TAR-…)
type	tipo da movimentação
direction	credit (entrou) ou debit (saiu)
amount, fee	valor e tarifa ligada (centavos)
status, statusTitle	situação; entrada concluída é “Aprovado”, saída concluída é “Concluído”
details	o que vai no comprovante: quem pagou ou recebeu (counterparty), banco, chave (mascarada), documento (mascarado), endToEndId do Pix e o canal. Em cobrança paga (PIX_CHARGE), também method (pix, card ou crypto), card (bandeira e final), crypto (moeda e valor nela) e availableAt (cartão: quando libera)

A tarifa aparece como uma movimentação própria (TAR-, tipo FEE) ligada à principal. O valor de uma movimentação nunca muda; só a situação.

Venda no cartão: a movimentação PIX_CHARGE e a tarifa ligada ficam pending (“A liberar”) até details.availableAt e então passam a completed. Até lá, o valor está em pending no saldo, não no disponível.

​

Uma movimentação

GET /v1/transactions/{id} · escopo transactions:read. Mesmo formato de um item da lista.

​

Extrato resumido

GET /v1/statement?days=30&direction=all&category=charge&q=1842 · escopo transactions:read

O mesmo extrato que o painel mostra, já montado: movimentações (sem a linha da tarifa), cobranças pendentes ou expiradas e pedidos de MED, cada linha com title, statusTitle, tone (in, out, pending, muted, med) e balanceEffect, mais os totais do período (entradas, saídas, resultado, a receber). Filtros: days (0 = hoje, 7, 30 ou 90), direction (all, income, expense), category (pix, charge, transfer, withdraw, refund, med) e q (busca por código, descrição, contraparte ou valor). Até 500 linhas, sem cursor. Para conciliação contábil, use /v1/transactions.