VUMI Documentation
  • Introduction
    • 🎉Welcome!
    • ➡️Quick Start
  • Platform
    • App Overview
      • API Products
      • Connections Overview
      • API Configuration
    • Link Overview
      • Link redirects
      • Link parameters
      • Customization
  • General API Resources
    • Authentication
      • API Login
    • Entities
      • List entities for app
    • Connections
      • Exchange public token
      • Get Connection status
      • List all connections
      • List public tokens
      • Delete Connection
    • Investments
      • List investments
    • Webhook
      • Get verification key
  • Aggregation
    • Accounts
      • List accounts
      • List account transactions
    • Portfolios
      • List portfolios
      • List portfolio transactions
      • List portfolio positions
  • Assets Transfer
    • Assets transfer
  • Developer Resources
    • API and Widget Errors
    • Webhooks and security
      • Webhook verification
    • Pagination
    • Tracing requests
Powered by GitBook
On this page
  1. Aggregation
  2. Accounts

List account transactions

Last updated 10 months ago

Retrieves all the account transactions for the given connection. Account Transactions in Vumi Finlink are understood as those financial movements that are have an impact in the cash balance of one account. Account Transactions are related to a specific through its ID

Account transaction types

Account transaction always alter cash balance. These are the different types you will encounter:

Type
Description

COUPON

Interest payments received from fixed-income securities, such as bonds

DEPOSIT

Cash added to an account by an investor or account holder

DIVIDENDS

Payments made by a corporation to its shareholders, typically from profits

DIVIDEND_RETENTION

Dividends retained by the investment firm or fund instead of being distributed to investors

DIVIDEND_RETENTION_REFUND

Refunds of previously retained dividends, given back to the investors

FEES

Charges deducted from an account for services provided by the financial institution, such as management or transaction fees. They can also be related to an exchange connection commission

FEES_REFUND

Refunds of previously charged fees

FOREX_DEPOSIT

Cash deposits resulting from foreign exchange transactions

FOREX_WITHDRAWAL

Cash withdrawals resulting from foreign exchange transactions

GIFT

Cash received as a gift from the financial institution, like a special promotion

INTEREST

Earnings from interest-bearing accounts or investments

INTEREST_CHARGE

Interest charges deducted from an account, typically related to loans or borrowed funds

RETURN_ON_CAPITAL

Payment that an investor receives as a portion of their original investment and that is not considered income or capital gains from the investment

TAXES

Amounts deducted from an account to pay for taxes

TAX_REFUND

Refunds of previously paid taxes

WITHDRAWAL

Cash removed from an account by the investor or account holder

UNKNOWN

Cash movements that could not be correctly classified

account

List account transactions for the given connection

get

Retrieve every account transaction for the given connection

Authorizations
Path parameters
tokenstringRequired

Token to identify the connection

Query parameters
fromstring · dateOptional

The initial date from which transactions are fetched. Inclusive

tostring · dateOptional

The last date up to which transactions are fetched. Inclusive

limitstringOptional

Max number of transactions to fetch

Default: 1000Example: 1000
pagestringOptional

Page number to fetch starting from 0

Default: 0Example: 0
Responses
200
Successfully retrieved all account transactions
application/json
401
Invalid credentials
application/json
404
Connection not found with the given token for the current app
application/json
500
Internal server error
application/json
get
GET /api/v1/queries/connections/{token}/accounts/transactions HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Accept: */*
{
  "items": [
    {
      "movementId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DEPOSIT",
      "amount": 1,
      "exchangeRate": 1,
      "commission": 1,
      "taxes": 1,
      "currency": "text",
      "localCurrency": "text",
      "description": "text",
      "operationDateDay": "2025-05-16",
      "originalOperationDateDay": "2025-05-16",
      "valueDateDay": "2025-05-16",
      "originalValueDateDay": "2025-05-16",
      "operationDateHour": "text",
      "originalOperationDateHour": "text",
      "valueDateHour": "text",
      "originalValueDateHour": "text",
      "originalOperationDateTz": "text",
      "originalValueDateTz": "text",
      "investment": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "limit": 1,
  "page": 1,
  "totalItems": 1
}
  • GETList account transactions for the given connection
  • Account transaction types