openapi: 3.1.0
info:
title: Spiko Distributor Account transactions API
version: v0
description: The Distributor API allows third parties like SaaS providers, fintechs or Web3 companies to distribute the Spiko Funds to their customers. With this API, you can programmatically manage investors, send subscription and redemption orders, and access real-time portfolio information.
servers:
- url: https://distributor-api.spiko.io
description: Production Server
- url: https://distributor-api.preprod.spiko.io
description: Pre-production Server
security: []
tags:
- name: Account transactions
paths:
/v0/account-transactions/:
get:
tags:
- Account transactions
operationId: accountTransactions.getAccountTransactions
parameters:
- name: accountId
in: query
schema:
type: string
description: a Universally Unique Identifier
format: uuid
required: true
description: a Universally Unique Identifier
- name: transactionType
in: query
schema:
type: string
enum:
- deposit
- withdrawal
- transfer
- yield
required: false
- name: direction
in: query
schema:
type: string
description: '"desc" returns newest transactions first (anti-chronological), "asc" returns oldest first (chronological). Defaults to "desc".'
required: false
description: '"desc" returns newest transactions first (anti-chronological), "asc" returns oldest first (chronological). Defaults to "desc".'
- name: limit
in: query
schema:
type: string
title: Number of items per page
description: defaults to "50" if not provided, max 10000
required: false
description: defaults to "50" if not provided, max 10000
- name: cursor
in: query
schema:
$ref: '#/components/schemas/StringFromBase64Url'
required: false
- name: search
in: query
schema:
type: string
required: false
security:
- basicAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
required:
- items
- nextCursor
- hasMore
properties:
items:
type: array
items:
anyOf:
- anyOf:
- type: object
required:
- createdAt
- shareClassId
- shareClassSymbol
- shareDecimals
- accountId
- sharesAmount
- netAssetValue
- amount
- confirmedAt
- applicableExchangeRateConversion
- id
- orderType
- scheduled
- shareClassNetAssetValueAtCreation
- exchangeRateAtCreation
- bankAccountName
- bankAccountNumber
- bankAccountBic
- recurringWithdrawalScheduleId
- status
- amountAtCreation
properties:
createdAt:
$ref: '#/components/schemas/Date'
shareClassId:
type: string
description: a Universally Unique Identifier
format: uuid
shareClassSymbol:
$ref: '#/components/schemas/ShareClassSymbol'
shareDecimals:
$ref: '#/components/schemas/Int'
accountId:
type: string
description: a Universally Unique Identifier
format: uuid
sharesAmount:
anyOf:
- $ref: '#/components/schemas/BigDecimal'
- type: 'null'
netAssetValue:
anyOf:
- $ref: '#/components/schemas/NonNegativeAmount'
- type: 'null'
amount:
anyOf:
- $ref: '#/components/schemas/NonNegativeAmount'
- type: 'null'
confirmedAt:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
applicableExchangeRateConversion:
anyOf:
- type: object
required:
- exchangeRate
- convertedAmount
properties:
exchangeRate:
type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
fxRate:
$ref: '#/components/schemas/BigDecimal'
additionalProperties: false
convertedAmount:
$ref: '#/components/schemas/NonNegativeAmount'
additionalProperties: false
- type: 'null'
id:
type: string
description: a Universally Unique Identifier
format: uuid
orderType:
type: string
enum:
- Redemption
scheduled:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
shareClassNetAssetValueAtCreation:
$ref: '#/components/schemas/NonNegativeAmount'
exchangeRateAtCreation:
anyOf:
- type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
fxRate:
$ref: '#/components/schemas/BigDecimal'
additionalProperties: false
- type: 'null'
bankAccountName:
anyOf:
- type: string
- type: 'null'
bankAccountNumber:
anyOf:
- type: string
- type: 'null'
bankAccountBic:
anyOf:
- type: string
- type: 'null'
recurringWithdrawalScheduleId:
anyOf:
- type: string
description: a Universally Unique Identifier
format: uuid
- type: 'null'
status:
type: string
enum:
- scheduled-in-shares
- scheduled
- canceled
- created-on-app
- pending-valuation
amountAtCreation:
$ref: '#/components/schemas/NonNegativeAmount'
additionalProperties: false
- type: object
required:
- createdAt
- shareClassId
- shareClassSymbol
- shareDecimals
- accountId
- sharesAmount
- netAssetValue
- amount
- confirmedAt
- applicableExchangeRateConversion
- id
- orderType
- scheduled
- shareClassNetAssetValueAtCreation
- exchangeRateAtCreation
- bankAccountName
- bankAccountNumber
- bankAccountBic
- recurringWithdrawalScheduleId
- status
properties:
createdAt:
$ref: '#/components/schemas/Date'
shareClassId:
type: string
description: a Universally Unique Identifier
format: uuid
shareClassSymbol:
$ref: '#/components/schemas/ShareClassSymbol'
shareDecimals:
$ref: '#/components/schemas/Int'
accountId:
type: string
description: a Universally Unique Identifier
format: uuid
sharesAmount:
anyOf:
- $ref: '#/components/schemas/BigDecimal'
- type: 'null'
netAssetValue:
$ref: '#/components/schemas/NonNegativeAmount'
amount:
$ref: '#/components/schemas/NonNegativeAmount'
confirmedAt:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
applicableExchangeRateConversion:
anyOf:
- type: object
required:
- exchangeRate
- convertedAmount
properties:
exchangeRate:
type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
fxRate:
$ref: '#/components/schemas/BigDecimal'
additionalProperties: false
convertedAmount:
$ref: '#/components/schemas/NonNegativeAmount'
additionalProperties: false
- type: 'null'
id:
type: string
description: a Universally Unique Identifier
format: uuid
orderType:
type: string
enum:
- Redemption
scheduled:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
shareClassNetAssetValueAtCreation:
$ref: '#/components/schemas/NonNegativeAmount'
exchangeRateAtCreation:
anyOf:
- type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
fxRate:
$ref: '#/components/schemas/BigDecimal'
additionalProperties: false
- type: 'null'
bankAccountName:
anyOf:
- type: string
- type: 'null'
bankAccountNumber:
anyOf:
- type: string
- type: 'null'
bankAccountBic:
anyOf:
- type: string
- type: 'null'
recurringWithdrawalScheduleId:
anyOf:
- type: string
description: a Universally Unique Identifier
format: uuid
- type: 'null'
status:
type: string
enum:
- pending-execution
- executed
additionalProperties: false
- type: object
required:
- createdAt
- shareClassId
- shareClassSymbol
- shareDecimals
- accountId
- sharesAmount
- netAssetValue
- amount
- confirmedAt
- applicableExchangeRateConversion
- id
- status
- orderType
- bankAccountName
- bankAccountNumber
- bankAccountBic
properties:
createdAt:
$ref: '#/components/schemas/Date'
shareClassId:
type: string
description: a Universally Unique Identifier
format: uuid
shareClassSymbol:
$ref: '#/components/schemas/ShareClassSymbol'
shareDecimals:
$ref: '#/components/schemas/Int'
accountId:
type: string
description: a Universally Unique Identifier
format: uuid
sharesAmount:
anyOf:
- $ref: '#/components/schemas/BigDecimal'
- type: 'null'
netAssetValue:
anyOf:
- $ref: '#/components/schemas/NonNegativeAmount'
- type: 'null'
amount:
$ref: '#/components/schemas/NonNegativeAmount'
confirmedAt:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
applicableExchangeRateConversion:
anyOf:
- type: object
required:
- exchangeRate
- convertedAmount
properties:
exchangeRate:
type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
fxRate:
$ref: '#/components/schemas/BigDecimal'
additionalProperties: false
convertedAmount:
$ref: '#/components/schemas/NonNegativeAmount'
additionalProperties: false
- type: 'null'
id:
type: string
description: a Universally Unique Identifier
format: uuid
status:
type: string
enum:
- pending
- canceled
- executed
orderType:
type: string
enum:
- InstantRedemption
bankAccountName:
anyOf:
- type: string
- type: 'null'
bankAccountNumber:
anyOf:
- type: string
- type: 'null'
bankAccountBic:
anyOf:
- type: string
- type: 'null'
additionalProperties: false
- type: object
required:
- createdAt
- shareClassId
- shareClassSymbol
- shareDecimals
- accountId
- sharesAmount
- netAssetValue
- amount
- confirmedAt
- applicableExchangeRateConversion
- id
- status
- orderType
- wireReference
- accountNumber
- bic
- intermediaryBic
- intermerdiaryBic
- bankAccountName
- bankAccountNumber
- bankAccountBic
properties:
createdAt:
$ref: '#/components/schemas/Date'
shareClassId:
type: string
description: a Universally Unique Identifier
format: uuid
shareClassSymbol:
$ref: '#/components/schemas/ShareClassSymbol'
shareDecimals:
$ref: '#/components/schemas/Int'
accountId:
type: string
description: a Universally Unique Identifier
format: uuid
sharesAmount:
anyOf:
- $ref: '#/components/schemas/BigDecimal'
- type: 'null'
netAssetValue:
anyOf:
- $ref: '#/components/schemas/NonNegativeAmount'
- type: 'null'
amount:
$ref: '#/components/schemas/NonNegativeAmount'
confirmedAt:
anyOf:
- $ref: '#/components/schemas/Date'
- type: 'null'
applicableExchangeRateConversion:
anyOf:
- type: object
required:
- exchangeRate
- convertedAmount
properties:
exchangeRate:
type: object
required:
- fundId
- day
- baseCurrency
- quoteCurrency
- fxRate
properties:
fundId:
type: string
description: a Universally Unique Identifier
format: uuid
day:
type: string
title: Day
description: a day in ISO format "YYYY-MM-DD"
baseCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD"
quoteCurrency:
type: string
enum:
- EUR
- USD
- GBP
- CHF
- JPY
- SGD
title: Currency code
identifier: CurrencyCode
description
# --- truncated at 32 KB (155 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spiko/refs/heads/main/openapi/spiko-account-transactions-api-openapi.yml