Transactions
API Reference
>
Transactions
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: Transactions
description: Transactions Reader
paths:
/v2/transactions:
get:
description: 'The Transactions API allows for the viewing of individual transactions across ledgered and core accounts.
This endpoint returns a paged list of transactions for a specific account. The endpoint accepts a transactionsFilter
object as a query parameter that allows for the client to specify a date range and transaction type for restricting
the query to specific transactions.
'
operationId: getTransactions
parameters:
- description: Transactions and the page that should be returned.
in: query
name: transactionsFilter
required: false
schema:
$ref: '#/components/schemas/GetPagedTransactionsWithFilter'
explode: true
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PagedResponseTransactionListItem'
description: Request succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrors'
description: Invalid list request.
summary: List Transactions
tags:
- Transactions
/v2/transactions/{reference}:
get:
description: 'The Transactions API allows for the viewing of individual transactions across ledgered and core accounts.
This endpoint returns a single transaction and includes details about the specific transaction.
'
operationId: getTransactionById
parameters:
- description: The transaction Victor-generated reference or client-generated reference.
in: path
name: reference
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionDetails'
description: Request succeeded.
'404':
description: Transaction not found.
summary: Get Transaction
tags:
- Transactions
components:
schemas:
ConfigurationProperty:
properties:
name:
$ref: '#/components/schemas/ConfigurationPropertyName'
origin:
$ref: '#/components/schemas/Origin'
value:
type: object
type: object
ConfigurationPropertyName:
properties:
empty:
type: boolean
lastElementIndexed:
type: boolean
numberOfElements:
format: int32
type: integer
parent:
$ref: '#/components/schemas/ConfigurationPropertyName'
type: object
GetPagedTransactionsWithFilter:
properties:
account_numbers:
description: Account numbers to filter by, as comma-separated values.
example: 3821764659,3821928473,3821563258
end_datetime:
description: ISO 8601 date and time format requiring Zulu timezone.
example: YYYY-MM-DDThh:mm:ss.sTZD
type: string
page:
format: int32
minimum: 0
type: integer
default: 0
description: Uses 0 based indexing.
page_size:
format: int32
minimum: 1
type: integer
default: 50
reference:
type: string
deprecated: true
description: 'Victor Transaction Id to return. Note: this parameter is deprecated, use /v2/transactions/{victorTransactionId}'
start_datetime:
type: string
description: ISO 8601 date and time format requiring Zulu timezone.
example: YYYY-MM-DDThh:mm:ss.sTZD
transaction_type:
enum:
- all
- ach
- wire
- book-internal
- book-external
- rtp-send
- rtp-refund
- rtp-inbound
- instant-payment-send
- instant-payment-refund
- instant-payment-inbound
type: string
description: Defines what type of transactions to return. Defaults to all.
date_mode:
enum:
- CREATED
- COMPLETED
type: string
description: Defines the date field to use. Defaults to CREATED.
type: object
ObjectError:
properties:
arguments:
items:
type: object
type: array
code:
type: string
codes:
items:
type: string
type: array
defaultMessage:
type: string
objectName:
type: string
type: object
Origin:
properties:
parent:
$ref: '#/components/schemas/Origin'
type: object
PagedResponseTransactionListItem:
properties:
index:
format: int32
type: integer
results:
items:
$ref: '#/components/schemas/TransactionListItem'
type: array
size:
format: int32
type: integer
type: object
TransactionDetails:
properties:
victor_transaction_id:
type: string
client_reference_id:
type: string
amount:
type: string
completed_date:
format: int64
type: integer
created_date:
format: int64
type: integer
description:
type: string
error_code:
type: number
error_message:
type: string
fed_trace_id:
type: string
from_account_number:
type: string
imad:
type: string
omad:
type: string
originating_bank_bic:
type: string
originating_bank_name:
type: string
originator_account_number:
type: string
originator_to_beneficiary1:
type: string
originator_to_beneficiary2:
type: string
originator_to_beneficiary3:
type: string
originator_to_beneficiary4:
type: string
parent_client_reference_id:
type: string
parent_reference_id:
type: string
return_reference_id:
type: string
running_balance:
type: string
sending_bank_bic:
type: string
sending_bank_name:
type: string
status:
type: string
to_account_number:
type: string
to_name:
type: string
transaction_category:
type: string
transaction_code_description:
type: string
transaction_type:
type: string
victor_counterparty_id:
type: string
victor_trace_id:
type: string
wire_benf_id:
type: string
wire_init_dt:
format: int64
type: integer
wire_origin_to_benf_info_rec:
type: string
wire_orign_name:
type: string
type: object
TransactionListItem:
properties:
amount:
type: number
account_name:
type: string
client_reference_id:
type: string
completed_at:
type: string
created_at:
type: string
error_code:
type: number
error_message:
type: string
fed_trace_id:
type: string
from_account_number:
type: string
from_name:
type: string
imad:
type: string
ledgering_program_id:
type: number
omad:
type: string
parent_reference_id:
type: string
return_reference_id:
type: string
running_balance:
type: number
status:
type: string
to_account_number:
type: string
to_name:
type: string
transaction_category:
type: string
transaction_code_description:
type: string
transaction_type:
enum:
- BOOK_INTERNAL
- BOOK_EXTERNAL
- ACH_TRANSFER
- WIRE_TRANSFER
- IAT_ACH_TRANSFER
- RTP_SEND
- RTP_REFUND
- RTP_INBOUND
- INSTANT_PAYMENT_SEND
- INSTANT_PAYMENT_REFUND
- INSTANT_PAYMENT_INBOUND
victor_counterparty_id:
type: string
victor_transaction_id:
type: string
victor_trace_id:
type: string
type: object
ValidationErrors:
properties:
allErrors:
items:
$ref: '#/components/schemas/ObjectError'
type: array
boundProperties:
items:
$ref: '#/components/schemas/ConfigurationProperty'
type: array
uniqueItems: true
name:
$ref: '#/components/schemas/ConfigurationPropertyName'
type: object
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Tue Mar 3 2026