Conta Stone: Extrato
Consultar extrato da conta
Retorna o extrato consolidado de transações da conta associada à API Key autenticada, com suporte a filtros avançados e paginação por cursor.
get
Query Parameters
afterstring
Cursor de paginação para buscar a próxima página de resultados.
Example:MTU4Nzc5Nzg2MA==
beforestring
Cursor de paginação para buscar a página anterior de resultados.
Example:MTU4Nzc5Nzg2MA==
limitinteger
Número máximo de registros a serem retornados por página.
Default:25
>= 1<= 100
start_datetimestring(date-time)
Data e hora inicial para filtrar as operações (formato RFC3339).
Example:2025-11-26T00:00:00Z
end_datetimestring(date-time)
Data e hora final para filtrar as operações (formato RFC3339).
Example:2025-11-26T00:00:00Z
created_at_startstring(date-time)
Data e hora inicial de criação para filtragem (formato RFC3339).
Example:2025-11-26T00:00:00Z
created_at_endstring(date-time)
Data e hora final de criação para filtragem (formato RFC3339).
Example:2025-11-26T00:00:00Z
typearray[string]
Lista de tipos de operação para filtrar os resultados, enviada como uma lista separada por vírgulas (ex: type=inbound_pix,outbound_pix). Valores conhecidos incluem inbound_pix, outbound_pix, pix_payment, pix_payment_pos, internal, investment e generic. Esta lista não é exaustiva.
Example:["inbound_pix","outbound_pix"]
operationstring
Filtra pela direção da operação.
Allowed values:debitcredit
Response
application/json
Response
application/json
Extrato da conta retornado com sucesso.
StatementResponse
cursorobjectrequired
Metadados de paginação.
Show Child Parameters
dataarray[object]required
Lista de registros de transações.
Show Child Parameters
get/v1/accounts/statement
Authentication
Query Parameters
application/json
StatementResponse
objectcursorobjectrequired
Metadados de paginação.
Show Child Parameters
dataarray[object]required
Lista de registros de transações.
Show Child Parameters
Example
Cursor
objectMetadados de paginação.
afterstring
Cursor apontando para a próxima página.
beforestring
Cursor apontando para a página anterior.
limitintegerrequired
Número máximo de registros por página.
Example:25
Example
Transaction
objectidstring(uuid)required
Identificador único da transação.
account_idstring(uuid)required
Identificador da conta associada à transação.
amountinteger(int64)required
Valor da transação em centavos (menor unidade da moeda).
fee_amountinteger(int64)
Valor da taxa cobrada na transação, em centavos.
operation_amountinteger(int64)
Valor líquido da operação, em centavos. Pode incluir ou excluir taxas dependendo do contexto.
created_atstring(date-time)required
Data e hora de criação da transação (UTC, ISO 8601).
created_at_tsstring
Componente de hora da criação da transação (HH:mm:ss.SSS).
Example:11:46:38.550
operation_idstring(uuid)
Identificador da operação relacionada.
operationstringrequired
Direção da movimentação.
Allowed values:creditdebit
typestringrequired
Tipo da transação. Valores conhecidos incluem inbound_pix, outbound_pix, pix_payment, pix_payment_pos, internal, investment e generic. Esta lista não é exaustiva.
Example:inbound_pix
balance_afterinteger(int64)required
Saldo da conta após a transação, em centavos.
balance_beforeinteger(int64)required
Saldo da conta antes da transação, em centavos.
titlestring
Rótulo principal descrevendo a transação (ex: nome da contraparte).
subtitlestring
Descrição secundária (ex: “Transferência | Pix”).
counterparty_agentobject
Informações sobre a contraparte envolvida na transação.
Show Child Parameters
Example
CounterpartyAgent
objectInformações sobre a contraparte envolvida na transação.
accountobject
Detalhes da conta da contraparte.
Show Child Parameters
entityobject
Detalhes de identidade da contraparte.
Show Child Parameters
institutionobject
Detalhes da instituição financeira.
Show Child Parameters
Example