Ledgering

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: Ledgering description: Ledgering Controller paths: /v2/ledgering/account: post: description: Create a virtual account for a ledgering program. operationId: createAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/LedgeringAccountCreateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LedgeringAccountCreateResponse' description: Account created successfully summary: Create a virtual account tags: - Ledgering /v2/ledgering/{ledgeringProgramId}/accounts: get: description: List accounts that belong to a ledgering program. operationId: getLedgeringAccounts parameters: - in: path name: ledgeringProgramId required: true schema: format: int64 type: integer - in: query name: page required: true schema: $ref: '#/components/schemas/PagedRequest' explode: true style: form description: If not provided uses platform's defaults. responses: '200': content: application/json: schema: $ref: '#/components/schemas/PagedResponseAccountListItem' description: List of accounts for the ledgering program summary: List accounts tags: - Ledgering components: schemas: 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 LedgeringAccountCreateRequest: properties: client_reference_id: maxLength: 50 minLength: 1 type: string client_reference_name: maxLength: 64 minLength: 1 type: string ledgering_program_id: format: int64 type: integer name: maxLength: 64 minLength: 3 type: string kyc_reference_id: maxLength: 50 minLength: 1 type: string required: - ledgering_program_id - name type: object LedgeringAccountCreateResponse: properties: account_name: type: string account_number: type: string client_reference_id: type: string client_reference_name: type: string victor_account_id: type: string type: object PagedRequest: properties: page: format: int32 minimum: 0 type: integer default: 0 description: Uses 0 based indexing. page_size: format: int32 minimum: 1 type: integer 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