Extrato da conta

Extrato da conta: saldo atual e lista de movimentações ordenadas do mais recente para o mais antigo. Cada movimento traz o tipo (CREDIT/DEBIT), origem (PIX_IN/PIX_OUT), metadados detalhados (pagador, beneficiário, endToEndId) e os lançamentos contábeis (entries) com saldo após a operação.

GET/v1/statement

metadata varia conforme source: em PIX_OUT (DEBIT) traz beneficiary completo e payer interno (branch/account); em PIX_IN (CREDIT) traz payer externo (ISPB, nome, documento, agência/conta) e beneficiary interno. document do contraparte sempre vem mascarado em PIX_OUT por regulação BCB; em PIX_IN o documento do payer pode vir completo quando o pagador autorizou.

Query string

from
string (YYYY-MM-DD)
Início do intervalo de criação.
to
string (YYYY-MM-DD)
Fim do intervalo.
type
"CREDIT" | "DEBIT"
Filtra por sentido.
source
"PIX_IN" | "PIX_OUT"
Origem do movimento.
cursor
string
Cursor de paginação.
limit
number
Padrão 20, máximo 100.

Headers

AuthorizationObrigatório
string
Bearer SUA_API_KEY

Exemplo de requisição

curl https://api.staterpay.io/v1/statement \  -H "Authorization: Bearer SUA_API_KEY"

Resposta

accountId
string
ID da conta consultada.
balance
string
Saldo atual em centavos.
movements
array
Lista de movimentos.
movements[].movementId
string
ID do movimento (cuid).
movements[].movement.type
"CREDIT" | "DEBIT"
Sentido do movimento.
movements[].movement.source
"PIX_IN" | "PIX_OUT"
Origem.
movements[].movement.description
string
Descrição legível.
movements[].movement.metadata
object
Detalhes Pix: payer, beneficiary, endToEndId, paymentDate.
movements[].entries
array
Lançamentos contábeis com amount (negativo em DEBIT) e balanceAfter.

json

{  "accountId": "cmoxample0001qkxyzaccount",  "balance": "1392",  "movements": [    {      "movementId": "cmoxample0001qkxyzmovement",      "movement": {        "type": "DEBIT",        "source": "PIX_OUT",        "description": "Pagamento pedido #123",        "externalRef": null,        "metadata": {          "date": "2026-05-07T21:19:07.911Z",          "payer": {            "branch": "1",            "account": "123456"          },          "endToEndId": "E37319859202605072119MRBLC3FYDDD",          "beneficiary": {            "ispb": "18236120",            "name": "Fulano de Tal",            "branch": "1",            "pixKey": "fulano@example.com",            "account": "49773517",            "document": "***456789**",            "pixKeyType": "EMAIL",            "accountType": null,            "institution": "BANCO EXEMPLO S.A."          },          "pixAccountId": "cmoxample0001qkxyzaccount",          "paymentDate": "2026-05-07 21:19:18.418272+00:00"        }      },      "entries": [        {          "id": "cmoxample0001qkxyzentry",          "amount": "-1",          "balanceAfter": "1392",          "kind": "PRIMARY",          "createdAt": "2026-05-07T18:19:07.919-03:00"        }      ]    },    {      "movementId": "cmoxample0002qkxyzmovement",      "movement": {        "type": "CREDIT",        "source": "PIX_IN",        "description": "PIX recebido de Fulano de Tal",        "externalRef": null,        "metadata": {          "date": "2026-05-06 22:53:01.642849+00:00",          "payer": {            "ispb": "18236120",            "name": "Fulano de Tal",            "branch": "1",            "account": "49773517",            "document": "12345678900"          },          "endToEndId": "E18236120202605062252s0788c38172",          "beneficiary": {            "branch": "1",            "account": "123456"          }        }      },      "entries": [        {          "id": "cmoxample0002qkxyzentry",          "amount": "300",          "balanceAfter": "1546",          "kind": "PRIMARY",          "createdAt": "2026-05-06T19:53:09.641-03:00"        }      ]    }  ]}

URL base:https://api.staterpay.io

Extrato da conta

Extrato da conta

Query string

Headers

Exemplo de requisição

Resposta

On this page