GET
Recuperar transação

Authorizations

X-API-KEY
string
header
required

Chave de API da aplicação. Obrigatória em todos os endpoints. Renove via POST /auth.

Path Parameters

id
string<uuid>
required

Identificador primário da transação.

Response

Objeto Transaction.

Transação de uma conta bancária ou de cartão de crédito.

Convenção de sinal de amount: em contas bancárias (type=BANK), amount é assinado — débitos (saída) são negativos, créditos (entrada) positivos, e o sinal sempre concorda com type. Em contas de cartão de crédito (type=CREDIT), o sinal é invertido: amount positivo = despesa/compra (type=DEBIT) e amount negativo = pagamento/estorno ao cartão (type=CREDIT). O campo type permanece normalizado para a perspectiva do titular.

id
string<uuid>
required

Identificador primário.

Example:

"a8534c85-53ce-4f21-94d7-50e9d2ee4957"

accountId
string<uuid>
required

Conta à qual a transação pertence.

Example:

"562b795d-1653-429f-be86-74ead9502813"

description
string
required

Descrição limpa/normalizada.

Example:

"* PROV * COMPRA TESOURO DIRETO CLIENTES"

currencyCode
string
required

Código ISO 4217.

Example:

"BRL"

amount
number
required

Valor da transação. Veja a convenção de sinal na descrição do schema.

Example:

-212.45

date
string<date-time>
required

Quando a transação foi realizada (data de postagem).

Example:

"2020-10-15T00:00:00.000Z"

createdAt
string<date-time>
required

Timestamp de ingestão (par com o filtro createdAtFrom).

Example:

"2020-10-15T00:00:00.000Z"

updatedAt
string<date-time>
required

Timestamp da última modificação.

Example:

"2020-10-15T00:00:00.000Z"

descriptionRaw
string | null

Descrição original da instituição antes da limpeza; null quando não fornecida.

amountInAccountCurrency
number | null

Valor convertido para a moeda da conta. Presente apenas quando a moeda da transação difere da moeda da conta (cartões multi-moeda).

type
enum<string>

Direção sob a perspectiva do titular. CREDIT = entrada (depósitos, transferências recebidas, estornos); DEBIT = saída (pagamentos, saques, transferências enviadas, compras no cartão). Para cartões, o agregador normaliza: compras são sempre DEBIT, pagamentos de fatura são CREDIT.

Available options:
DEBIT,
CREDIT
balance
number | null

Saldo corrente da conta logo após esta transação; null quando a instituição não o retorna.

Example:

4439.4

providerCode
string | null

Referência/código do lado da instituição (NSU, número de extrato); formato varia por instituição.

status
enum<string>

POSTED = confirmada/liquidada. PENDING = ainda não liquidada. UNKNOWN preserva um registro válido cujo status oficial do provedor é não enquadrado; consulte providerStatus.

Available options:
POSTED,
PENDING,
UNKNOWN
Example:

"POSTED"

providerStatus
string | null

Status bruto do provedor quando disponível. No fluxo internacional pode ser BOOK, PDNG, HOLD, SCHD ou OTHR; CNCL/RJCT removem a transação e geram transactions/deleted.

category
string | null

Nome da categoria (ex.: Transfers); null se não houver correspondência.

Example:

"Fixed Income Investment"

categoryId
string | null

Id estável de 8 dígitos numéricos (ex.: 05000000). Use para joins/regras; nomes podem mudar.

paymentData
object | null

Detalhes de transferência/pagamento. null para transações que não são transferências.

creditCardMetadata
object | null

Informações de parcelamento/MCC. Apenas para transações de cartão de crédito.

merchant
object | null

Estabelecimento associado à transação.

operationType
string | null

Tipo de operação classificado pela instituição (Open Finance), ex.: TED, PIX.

providerId
string | null

Id da transação no provider. Retornado apenas para conectores Open Finance.