Finicity Transactions API
Fetch customer and account transactions and generate reports asynchronously
Finicity Transactions API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 9 operations across 9 paths, and defines 127 schemas. It is described by OpenAPI 3.2.0, at version 1.43.0.
Requests are made against a single base URL, https://api.finicity.com.
9 operations
9 paths
127 schemas
5 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Finicity Transactions API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Finicity-App-Key (FinicityAppKey).
An API key is passed in the header as Finicity-App-Token (FinicityAppToken).
By default, every request must be authenticated.
FinicityAppKey— The "Finicity-App-Key" from the developer dashboardFinicityAppToken— A token returned by the /authentication API
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Transactions 9
Fetch customer and account transactions and generate reports asynchronously
POST
/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic
Load Historic Transactions for Customer Account
GET
/aggregation/v3/customers/{customerId}/transactions
Get All Customer Transactions
GET
/aggregation/customers/{customerId}/transactions/{uniqueTransactionId}
Get Transaction by UniqueTransactionId
GET
/aggregation/v2/customers/{customerId}/transactions/{transactionId}
Get Customer Transaction by ID
GET
/aggregation/v4/customers/{customerId}/accounts/{accountId}/transactions
Get Customer Account Transactions
POST
/decisioning/v2/customers/{customerId}/transactions
Generate Transactions Report for the Customer
POST
/aggregation/customers/{customerId}/recurring-transactions
Get Recurring Transactions for Customer
POST
/aggregation/customers/{customerId}/transactions/refreshes
Trigger Customer Account Refresh
GET
/aggregation/customers/{customerId}/transactions/refreshes/{refreshId}
Get Customer Account Refresh Status
Schemas 127
The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are Transaction (39 properties), BaseReportAck (16 properties), RecurringInFlowTransaction (12 properties), RecurringOutFlowTransaction (12 properties). Each schema is shown below with its type and property counts.
SecurityFreezeErrorMessage
object
3 properties
2 required
EndUserUrl
string
Reseller end user URL
ReportType
string
A report type. Possible values: voi voa voaHistory history voieTxVerify voieWithReport voieWithInterview voieWithStatement paystatement preQualVoa assetSummary…
ZipCode
string
A ZIP code
TransactionRefreshStatusDetails
object
Transaction refresh status
8 properties
TransactionPostedDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was posted or cleared by the institution. This value isn't required…
ReportCustomField
object
3 properties
AccountIds
object
A list of account IDs
1 property
VOIReportConstraintsOut
object
4 properties
RecurringTransactionsDetails
object
Recurring transactions details
2 properties
Transactions
object
A list of transactions
8 properties
7 required
NumericCustomerId
integer
A customer ID represented as a number. See Add Customer API for how to create a customer ID.
TransactionsReportConstraintsOut
object
6 properties
DisplayingResults
integer
The number of results returned
ConsumerId
string
A consumer ID. See Create Consumer API for how to create a consumer ID.
BaseReportAckWithPortfolioId
Properties shared by all generated reports having a portfolio ID
PayStatementData
object
Data to be included within the pay statement report
4 properties
1 required
EmailAddress
string
An email address
VOAIncomeReportIncomeFromDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
FindTransactionDescriptionMemo
string
A string to return transactions that have an exact match to Description/Memo. - Description/Memo - Found in the PDF report for reach transactions. - A combinat…
FindTransactionAmountTo
number
A decimal value to return transactions with amount less than or equal to findTransactionAmountTo. - If both findTransactionAmountFrom and findTransactionAmount…
Age
integer
Age is an optional parameter. This data is used to determine the age band the customer falls into.
GeoLocation
array
Geolocation array of objects;
TransactionEffectiveDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it became effective on an account by an institution. See: [Handling Ep…
TransactionRefreshSuccessCount
integer
Total number of successful accounts refreshed.
TimeIntervalType
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
PayStatementReportConstraints
object
2 properties
1 required
VOAReportConstraintsOut
object
5 properties
AddressLine1
string
Address line 1
PortfolioId
string
A unique identifier that will be consistent across all reports created for the same customer
ReportAccountIds
array
An array of account IDs to be included in the report (all accounts will be included if not set)
PrequalificationReportConstraintsOut
object
4 properties
Categorization
object
Categorization Record
8 properties
3 required
VOIEWithStatementData
object
4 properties
1 required
IncomeStreamConfidenceMinimum
integer
Include income streams in the report, based on the income stream's confidence score. For example, Use the value 50 to include only income streams with a confid…
MiddleName
string
The middle name of the account holder
StatementReportConstraints
object
2 properties
1 required
TransactionDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it occurred. See: [Handling Epoch Dates and Times](https://developer.m…
Ending
number
Ending daily account balance.
IncludePending
boolean
If pending transactions must be included
PhoneNumber
string
A phone number (max length 15).
ForesightAnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
6 properties
UniqueTransactionId
string
A globally unique transaction identifier derived from accountId and transactionId.
ErrorMessage
object
10 properties
1 required
GeoLocationItems
object
2 properties
ReportCustomFields
array
The reportCustomFields parameter is used when experiences are associated with a credit decisioning report. Designate up to 5 custom fields that you'd like asso…
ShowNsf
boolean
Include the non-sufficient funds (NSF) summary JSON and the NSF summary PDF section in the report. Data included: Account Total number of NSF funds Days since…
AccountId
string
An account ID
SocialSecurityNumberLastDigits
string
Last 4 digits of a SSN
TransactionsFromDate
string
Value of the fromDate request parameter that generated this response. This date is in Unix epoch time (in seconds).
TransactionsToDate
string
Value of the toDate request parameter that generated this response. This date is in Unix epoch time (in seconds).
TransactionRefreshFailedCount
integer
Total number of accounts failed to refresh.
PayrollDataRetrievalId
string
An ID to identify the data retrieved from the payroll providers for the report.
VOAWithIncomeReportConstraintsOut
object
7 properties
TransactionId
integer
A transaction ID
ReportRequestId
string
Finicity indicator to track all activity associated with this report
EmploymentId
string
This is a Mastercard assigned ID to the employment record. It remains consistent for that employment record, even if the report is refreshed. It can be used to…
ExtractDeductions
boolean
Field to indicate whether to extract the deductions on all pay statements
Beginning
number
Beginning daily account balance
TransactionRefreshMode
string
Specifies the type of transaction refresh to perform, defaults to 'standard'. Supported modes are, standard - Triggers a standard refresh. The system will fetc…
InitiateNewTransactionRefresh
object
New transaction refresh request: Request must contain at least institutionLoginId OR accountIds If both are provided, accountIds takes preference "standard" is…
5 properties
FoundResults
integer
The total number of results matching search criteria
VOIEWithTXVerifyReportConstraintsOut
object
5 properties
1 required
CashFlowReportConstraintsOut
object
5 properties
AnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
FindTransactionAmountFrom
number
A decimal value to return transactions with amount greater than or equal to findTransactionAmountFrom. - If both findTransactionAmountFrom and findTransactionA…
TransactionType
string
If provided by the institution, the following values may be returned in the field of a record: "atm" "cash" "check" "credit" "debit" "deposit" "directDebit" "d…
InstitutionLoginId
string
An institution login ID (from the account record)
LastName
string
The last name of the account holder
Transaction
object
39 properties
7 required
SecurityIdType
string
The security type. This field is related to the securityId field. Possible values: "CUSIP" "ISIN" "SEDOL" "SICC" "VALOR" "WKN"
TransactionRefreshID
string
Unique identifier for refresh request
Income
integer
Income is an optional parameter. It is the dollar amount for the customer's annual household income and is used to determine the income band the customer falls…
TxVerifyInterview
object
2 properties
1 required
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
VOETransactionsReportConstraintsOut
object
5 properties
PayrollDataOut
object
6 properties
InstitutionId
string
The ID of a financial institution
ConsumerEndUser
object
Reseller end user information. This is populated only when the report requires a consumer record to be generated and the consumer object includes end user deta…
8 properties
6 required
AccountRecurringTransactions
object
Recurring transactions for each account
3 properties
FindTransactionConstraints
object
Parameters used to return transactions matching the given criteria. The presence of multiple parameters will be treated as an AND function.
4 properties
DisputeStatement
string
A consumer-provided statement describing the nature of an unresolved dispute. This field is populated only if a consumer dispute remains unresolved, and the co…
TransactionsReportConstraints
object
5 properties
ReportStatus
string
A report generation status. Possible values: inProgress success failure
RecurringInFlowTransaction
object
Credit recurring transaction stream.
12 properties
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
CustomerRecurringTransactions
object
Recurring transactions for customer
2 properties
AggregationStatusCode
integer
The status of the most recent aggregation attempt (see [Aggregation Status Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manag…
InvestmentTransactionTypes
string
Keywords in the description and memo fields were used to translate investment transactions into these types. Possible values: "cancel" "purchaseToClose" "purch…
AnalyticsType
string
Analytics type. Allowed Values are benchmarking and forecasting.
ForesightAnalyticsReportConstraints
object
3 properties
VOIEWithInterviewData
object
4 properties
1 required
TransactionRefreshInitiated
object
Transaction refresh response
9 properties
CustomerType
string
The type of customer ("active" or "testing" or "" for all types)
NumericAccountId
integer
An account ID represented as a number
ExtractDirectDeposit
boolean
Field to indicate whether to extract the direct deposits on all pay statements
PartnerName
string
Name of a Finicity partner
MoreResultsAvailableForTransactions
string
If the value of moreAvailable is "true", you can retrieve the next page of results by increasing the value of the start parameter in your next request:"...&sta…
PayrollReportConstraintsOut
object
3 properties
1 required
VOIEReportConstraints
object
The request details from the report generation that were used to generate the report
2 properties
1 required
AnalyticsReportConstraintsOut
object
4 properties
FindTransactionCategory
array
An array of categories to return transactions with an exact match to the array of category. Limit of 10.
PayrollAccountId
string
The payrollAccountIds for the Credentialed Payroll accounts the consumer has connected. Will be used to constrain the report to only include the specified acco…
ConsumerDetails
object
Details about the consumer. Populated if the report requires a consumer record to be generated.
11 properties
TransactionFirstEffectiveDate
integer
A date in Unix epoch time (in seconds). Represents the first timestamp of the transaction recorded in the effectiveDate field. See: [Handling Epoch Dates and T…
Categories
string
The different categories for transactions. "ATM Fee" "Advertising" "Air Travel" "Alcohol & Bars" "Allowance" "Amusement" "Arts" "Auto & Transport" "Auto Insura…
ExtractEarnings
boolean
Field to indicate whether to extract the earnings on all pay statements
ReportTitle
string
Title of the report
TransactionsReportAck
A Transaction report being generated
13 required
TransactionRefreshRequestStatus
string
This is the request status, supported request statuses are: NEW INPROGRESS COMPLETED FAILED
State
string
State
FirstName
string
The first name of the account holder
ReportId
string
A report ID
StatementData
object
2 properties
1 required
ReportAccountIdsString
string
A whitespace-separated list of account IDs to be included in the report (all accounts will be included if not set)
DailyBalance
object
3 properties
3 required
TransactionOptionExpireDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction expiration date when it became expires on an account by an institution. See…
ReportCreatedDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
DateTimeWithZone
string
A date-time with time zone
BaseReportAck
object
Properties shared by all generated reports
16 properties
UnixDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
ShowDailyBalance
boolean
RecurringOutFlowTransaction
object
Debit recurring transaction stream.
12 properties
City
string
City
TransactionCreatedDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was added to our platform. See: [Handling Epoch Dates and Times](ht…
AccountCount
integer
Total number of accounts returned.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Finicity 12
Other APIs Finicity publishes across the network.
Finicity Connect
Finicity Verification of Assets (VoA) API
Finicity Verification of Income & Employment (VoIE) API
Finicity Transaction Analysis (Cash Flow) API
Finicity Payments (Account Validation) API
Finicity Open Banking Data Access (FDX)
Finicity Account Validation Assistance API
Finicity Accounts API
Finicity Accounts (Simple) API
Finicity App Registration API
Finicity Authentication API
Finicity Balance Analytics API
#Transaction
Where this information came from
This is an independent, third-party profile of Finicity Transactions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.