Stater Platform

Extrato da conta

GET /accounts/:id/transactions — extrato com paginação por cursor.

Extrato da conta

Lista as transações de uma conta em um intervalo de datas, com paginação por cursor. Inclui transações Pix e TEF (transferência entre contas Stric), com metadata completa do pagador/beneficiário e lançamentos contábeis (ledgerEntries) inclusive entradas de tarifa (FEE) quando aplicáveis.

GET/accounts/:accountId/transactions

Valores monetários em reais (decimal). amount sempre positivo — credit indica o sentido. ledgerEntries[].amount tem sinal explícito. balanceAfterTransaction reflete o saldo após TODOS os lançamentos da transação (PRIMARY + FEE quando houver). statementMetadata varia conforme credit (saída tem beneficiary completo, entrada tem payer completo) e type (PIX traz pixKey/pixKeyType, TEF traz accountType/accountModel). Datas em UTC (campo `date` com Z). paymentDate vem em formato Python datetime com offset.

Path params

  • accountIdObrigatório
    string (UUID)
    ID da conta cujo extrato será retornado.

Query string

  • startDateObrigatório
    string (YYYY-MM-DD)
    Início do intervalo (inclusivo, fuso UTC).
  • endDateObrigatório
    string (YYYY-MM-DD)
    Fim do intervalo (inclusivo, fuso UTC).
  • limit
    number
    Tamanho da página. Padrão 20, máximo 100.
  • cursor
    string
    Cursor para próxima página (use o nextCursor da resposta anterior).

Headers

  • AcceptObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT de /authenticate.
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Exemplo de requisição

curl "https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/transactions?startDate=2026-04-14&endDate=2026-05-13" \  -H "Accept: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"

Resposta

  • transactions
    array
    Transações ordenadas do mais recente para o mais antigo.
  • transactions[].id
    string (UUID)
    ID da transação.
  • transactions[].amount
    number
    Valor da transação em reais (sempre positivo). Use `credit` para saber o sentido.
  • transactions[].credit
    boolean
    true = entrada na conta (recebimento). false = saída (envio).
  • transactions[].description
    string
    Descrição legível da transação.
  • transactions[].type
    "PIX" | "TEF"
    Pix (instantâneo) ou TEF (transferência interna entre contas Stric).
  • transactions[].status
    "DONE" | "PENDING" | "FAILED"
    Estado interno consolidado.
  • transactions[].statusExternal
    "SUCCESS" | "FAILURE" | ...
    Estado reportado pelo provider externo.
  • transactions[].createdAt
    string (ISO-8601 UTC)
    Momento do registro na conta.
  • transactions[].balanceAfterTransaction
    number
    Saldo da conta após esta transação ser totalmente liquidada (incluindo eventuais tarifas).
  • transactions[].endToEndId
    string
    EndToEndId Pix da liquidação.
  • transactions[].statementMetadata
    object
    Metadados de extrato. Shape varia: em credit:false (saída) traz payer interno (branch+account) e beneficiary completo; em credit:true (entrada) traz payer externo (ISPB, nome, documento) e beneficiary interno. PIX inclui pixKey/pixKeyType; TEF inclui accountType/accountModel.
  • transactions[].ledgerEntries
    array
    Lançamentos contábeis da transação. Sempre tem um PRIMARY (movimento principal, amount com sinal). Quando há tarifa, vem um FEE adicional (amount negativo). balanceAfter mostra o saldo após cada lançamento.
  • transactions[].ledgerEntries[].id
    string (cuid)
    ID do lançamento.
  • transactions[].ledgerEntries[].kind
    "PRIMARY" | "FEE"
    Tipo do lançamento.
  • transactions[].ledgerEntries[].amount
    number
    Valor com sinal (negativo em débito, positivo em crédito).
  • transactions[].ledgerEntries[].balanceAfter
    number
    Saldo após este lançamento específico.
  • pagination
    object
    Metadata de paginação por cursor.
  • pagination.limit
    number
    Tamanho efetivo da página.
  • pagination.nextCursor
    string | null
    Cursor da próxima página. null quando não há mais resultados.
  • pagination.hasMore
    boolean
    Indicador conveniente: nextCursor !== null.
json
{  "transactions": [    // ---------- Pix DEBIT (saída) ----------    {      "id": "00000000-0000-0000-0000-0000000000a1",      "amount": 0.01,      "credit": false,      "description": "Pix enviado para Fulano de Tal",      "type": "PIX",      "status": "DONE",      "statusExternal": "SUCCESS",      "createdAt": "2026-05-12T17:56:50.007Z",      "balanceAfterTransaction": 6.44,      "endToEndId": "E37319859202605121756NBC4AD2Z0P2",      "statementMetadata": {        "date": "2026-05-12T17:56:49.988Z",        "payer": { "branch": "1", "account": "1000001" },        "endToEndId": "E37319859202605121756NBC4AD2Z0P2",        "beneficiary": {          "ispb": "12345678",          "name": "Fulano de Tal",          "branch": "1",          "pixKey": "fulano@example.com",          "account": "49773517",          "document": "***456789**",          "pixKeyType": "EMAIL",          "accountType": null,          "institution": "BANCO EXEMPLO S.A."        },        "paymentDate": "2026-05-12 17:57:01.772969+00:00",        "pixAccountId": "cmoxample0001qkxyzpixaccount"      },      "ledgerEntries": [        {          "id": "cmoxample0001qkxyzentry01",          "kind": "PRIMARY",          "amount": -0.01,          "balanceAfter": 6.44,          "createdAt": "2026-05-12T17:56:50.007Z"        }      ]    },    // ---------- Pix CREDIT (entrada) ----------    {      "id": "00000000-0000-0000-0000-0000000000a2",      "amount": 5.00,      "credit": true,      "description": "PIX recebido de Outro Pagador",      "type": "PIX",      "status": "DONE",      "statusExternal": "SUCCESS",      "createdAt": "2026-05-05T00:25:28.683Z",      "balanceAfterTransaction": 5.00,      "endToEndId": "E00416968202605042035TZcKtDGZW20",      "statementMetadata": {        "date": "2026-05-04 20:36:12.264082+00:00",        "payer": {          "ispb": "87654321",          "name": "Outro Pagador",          "branch": "1",          "account": "19698100",          "document": "12345678901"        },        "endToEndId": "E00416968202605042035TZcKtDGZW20",        "beneficiary": { "branch": "1", "account": "1000001" }      },      "ledgerEntries": [        {          "id": "cmoxample0001qkxyzentry02",          "kind": "PRIMARY",          "amount": 5.00,          "balanceAfter": 5.00,          "createdAt": "2026-05-05T00:25:28.683Z"        }      ]    },    // ---------- TEF DEBIT (saída interna) ----------    {      "id": "00000000-0000-0000-0000-0000000000a3",      "amount": 0.01,      "credit": false,      "description": "TEV Enviada para NOME EMPRESA LTDA",      "type": "TEF",      "status": "DONE",      "statusExternal": "SUCCESS",      "createdAt": "2026-05-11T15:08:30.363Z",      "balanceAfterTransaction": 6.51,      "endToEndId": "E373198592026051115087X7t1gZ7ZcU",      "statementMetadata": {        "date": "2026-05-11T15:08:30.355Z",        "payer": { "branch": "1", "account": "1000001" },        "endToEndId": "E373198592026051115087X7t1gZ7ZcU",        "beneficiary": {          "ispb": "37319859",          "name": "NOME EMPRESA LTDA",          "branch": "0001",          "account": "1000002",          "document": "12345678000190",          "accountType": "Current Account",          "branchDigit": null,          "accountModel": "Movement"        },        "paymentDate": "2026-05-11 15:08:32.886566+00:00",        "pixAccountId": "cmoxample0001qkxyzpixaccount"      },      "ledgerEntries": [        {          "id": "cmoxample0001qkxyzentry03",          "kind": "PRIMARY",          "amount": -0.01,          "balanceAfter": 6.51,          "createdAt": "2026-05-11T15:08:30.363Z"        }      ]    },    // ---------- TEF CREDIT com tarifa (FEE) ----------    {      "id": "00000000-0000-0000-0000-0000000000a4",      "amount": 3.00,      "credit": true,      "description": "TEV Recebida de NOME EMPRESA LTDA",      "type": "TEF",      "status": "DONE",      "statusExternal": "SUCCESS",      "createdAt": "2026-05-06T23:07:31.808Z",      "balanceAfterTransaction": 5.00,      "endToEndId": "E37319859202605062307O94fGvIFOVB",      "statementMetadata": {        "date": "2026-05-06 23:07:23.759581+00:00",        "payer": {          "ispb": "37319859",          "name": "NOME EMPRESA LTDA",          "branch": "0001",          "account": "1000002",          "document": "12345678000190"        },        "endToEndId": "E37319859202605062307O94fGvIFOVB",        "beneficiary": { "branch": "1", "account": "1000001" }      },      "ledgerEntries": [        {          "id": "cmoxample0001qkxyzentry04a",          "kind": "PRIMARY",          "amount": 3.00,          "balanceAfter": 6.50,          "createdAt": "2026-05-06T23:07:31.808Z"        },        {          "id": "cmoxample0001qkxyzentry04b",          "kind": "FEE",          "amount": -1.50,          "balanceAfter": 5.00,          "createdAt": "2026-05-06T23:07:31.812Z"        }      ]    }  ],  "pagination": {    "limit": 20,    "nextCursor": null,    "hasMore": false  }}
URL base:https://baas.staterpay.io

Consultar conta

GET /accounts/:id — retorna saldo e dados da conta autenticada.

Resumo do extrato

GET /accounts/:id/statement/summary — totais agregados no intervalo.

On this page

Path paramsQuery stringHeadersExemplo de requisiçãoResposta