Cursor

object

Metadados 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

object
idstring(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

object

Informaçõ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

CounterpartyAccount

object

Detalhes da conta da contraparte.

account_codestring

Número/código da conta.

branch_codestring

Código da agência, se aplicável.

account_typestring

Tipo de conta. Valores observados: PG, CC, PP, CD, CG.

Example

CounterpartyEntity

object

Detalhes de identidade da contraparte.

namestring

Nome da contraparte.

document_typestring

Tipo de documento (ex: cpf, cnpj).

documentstring

Número do documento.

Example