Listar movimentações

O livro-razão da conta: toda entrada e saída, com filtros por tipo e situação.

GET /v1/transactions

cURL

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

200

{
  "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,
        "subaccount": null
      },
      "createdAt": "2026-10-08T15:04:11.000Z"
    }
  ],
  "nextCursor": null
}

Escopo transactions:read. Cada movimentação tem valor fixo (o valor nunca muda, só a situação) e a tarifa aparece como uma movimentação própria (TAR-, tipo FEE). É o endpoint certo para conciliação contábil.

limit · integer · default: "50"

De 1 a 100.

cursor · string

O nextCursor da página anterior.

type · string

Um ou mais tipos separados por vírgula: PIX_CHARGE, PIX_SENT, WITHDRAWAL, API_WITHDRAWAL, INTERNAL_TRANSFER, REFUND, MED, FEE, SUBACCOUNT.

status · string

Um ou mais: pending, processing, completed, failed, canceled.

​

Resposta

items · object[]

Show propriedades de cada item

id · string

Código com prefixo (BKY-, ENV-, SAQ-, TAR-…).

type · string

Tipo da movimentação.

direction · string

credit (entrou) ou debit (saiu).

amount · integer

Valor.

fee · integer

Tarifa ligada a esta movimentação.

status · string

pending, processing, completed, failed ou canceled.

statusTitle · string

Entrada concluída é “Aprovado”; saída concluída é “Concluído”.

description · string | null

Descrição.

details · object

O que vai no comprovante: counterparty (quem pagou ou recebeu), institution (banco), key (chave mascarada), document (mascarado), endToEndId, channel e subaccount. Campos ausentes vêm null. No saque e no Pix enviado, o nome, o banco, o documento e o endToEndId de quem recebeu chegam quando o envio é concluído. No saque de uma subconta, subaccount traz { "id": "sacc_...", "name": "..." }.

createdAt · string

Data e hora.

nextCursor · string | null

Próxima página; null quando acabou.

cURL

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

200

{
  "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,
        "subaccount": null
      },
      "createdAt": "2026-10-08T15:04:11.000Z"
    }
  ],
  "nextCursor": null
}