Accounts

openapi: 3.0.1 info: title: Victor REST API version: 2.0.0 servers: - url: https://api.stage.victorfi.com description: Victor Staging Environment - url: https://api.victorfi.com description: Victor Production Environment tags: - name: Accounts description: Accounts Controller paths: /v2/accounts: get: description: "The Accounts API allows for the viewing and management of individual accounts (both ledgered and core\ \ accounts). Using this API, you can view balances, account information, and re-query the API for transaction information.\ \ \n\nThis endpoint returns a paged list of accounts belonging to the caller.\n" operationId: getAccounts parameters: - description: The type and page of accounts to return. in: query name: getAccountsRequest required: false schema: $ref: '#/components/schemas/GetAccountsRequest' explode: true style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/PagedResponseAccountListItem' description: Successful response '400': description: Invalid filter parameter. summary: List Accounts tags: - Accounts /v2/accounts/{victorAccountId}: get: description: 'The Accounts API allows for the viewing and management of individual accounts (both ledgered and core accounts). Using this endpoint, you can view balances, account information, and re-query the API for transaction information. This endpoint returns a single account based on the unique Victor account ID passed in as a parameter. ' operationId: getAccount parameters: - description: Victor ID of the account to be returned. in: path name: victorAccountId required: true schema: type: string - description: Whether to refresh the account balance against external systems to return the most up to date balance. Defaults to false. in: query name: refresh_balance required: false schema: type: boolean default: false example: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountDetails' description: Successful response '404': description: Account with given Victor ID not found. summary: Get Account tags: - Accounts components: schemas: AccountDetails: properties: account_name: type: string account_number: type: string available_balance: type: string balance_updated_at: format: int64 type: integer created_at: format: int64 type: integer currency: type: string current_balance: type: string program_name: type: string status: type: string victor_account_id: type: string ledgering_program_id: format: int64 type: integer type: object AccountListItem: properties: account_name: type: string account_number: type: string available_balance: type: number balance_updated_at: format: int64 type: integer created_at: format: int64 type: integer current_balance: type: number status: type: string victor_account_id: type: string ledgering_program_id: format: int64 type: integer line_original_amount: type: string account_type: type: string required: - account_name - account_number - available_balance - balance_updated_at - created_at - current_balance - status - victor_account_id - account_type type: object GetAccountsRequest: properties: account_type: enum: - all - core - ledger type: string default: all page: format: int32 minimum: 0 type: integer default: 50 description: Uses 0 based indexing. page_size: format: int32 minimum: 1 type: integer default: 50 type: object PagedResponseAccountListItem: properties: index: format: int32 type: integer results: items: $ref: '#/components/schemas/AccountListItem' type: array size: format: int32 type: integer type: object

Please ignore this field