openapi: 3.0.3
info:
title: Open Finance
description: |-
OpenAPI specification for Finicity APIs.
Open Finance (formerly Open Banking) solutions in the US are provided by
Finicity, a Mastercard company.
contact:
name: API Support
email: apisupport@mastercard.com
url: 'https://developer.mastercard.com/open-finance-us/documentation/support/'
version: 1.35.0
servers:
- url: 'https://api.finicity.com'
description: Production
tags:
- name: Accounts
description: Fetch or refresh customer accounts
- name: 'Accounts (Simple)'
description: Fetch simple customer accounts
- name: Account Validation Assistance
description: Micro entries and account verification
- name: App Registration
description: Register and assign apps to customers
- name: Assets
description: Download asset files
- name: Authentication
description: Generate authentication tokens and manage credentials
- name: Balance Analytics
description: Balance Analytics for businesses
- name: Bank Statements
description: Fetch account statements and generate reports asynchronously
- name: Businesses API
description:
Create and manage business associated with customers in order to use
Balance Analytics or Cash Flow Analytics
- name: Cash Flow
description: Generate cash flow reports asynchronously
- name: Cash Flow Analytics
description: Cash Flow Analytics for business
- name: Connect
description:
Allow customers to log into their financial institutions and grant
Finicity authorization
- name: Connect Components
description:
Allow customers to log into their financial institutions and grant
Finicity authorization
- name: Consumers
description:
Create and manage consumers associated with customers in order to use
report services
- name: Customers
description: Enroll and manage customers
- name: Customer Authorization Details
description: APIs to retrieve customer authorization details
- name: Identity
description:
Match the request details to the Institution account holder details
- name: Institutions
description: Search and fetch financial institutions
- name: Payments
description: Fetch ACH details and account balances
- name: Pay Statements
description: Upload pay statements
- name: Payment History Report
description: Payment History Report for business
- name: Payment Success Indicator
description: Predict a transaction's likelihood to settle
- name: Payment Enablement Bundle
description: Any or all of the Payments endpoints in one API call
- name: Portfolios
description: Generate portfolios of the most recent reports
- name: Reports
description: Fetch generated reports when ready
- name: Third Party Access
description: Generate and manage access keys for other partners
- name: Transactions
description:
Fetch customer and account transactions and generate reports
asynchronously
- name: Transfer
description: Fetch details of the deposit and bill pay switches
- name: TxPush
description: Manage TxPush subscriptions
- name: Verify Assets
description: Generate asset reports asynchronously
- name: Verify Income and Employment
description: Generate income and employment reports asynchronously
- name: Transaction Data Enrichment
description: Enhance the transaction data set
- name: Small Business Credit Analytics
description: Fetch merchant location matches and generate reports
- name: Webhook Subscription
description: APIs for Managing Partner Webhook Event Subscriptions
security:
- FinicityAppKey: []
FinicityAppToken: []
paths:
/aggregation/v2/partners/authentication:
post:
tags:
- Authentication
summary: Create Access Token
description: >-
Send Partner ID and Partner Secret to the Partner Authentication service
to obtain a token for accessing Finicity APIs.
* The token is valid for two hours and is required on all calls to the
Finicity APIs
* As a best practice, use a single token for all calls. Assign a
timestamp for each token, and then check the current timestamp before
making any calls. If the token is greater than 90 minutes, generate a
new one.
* โ ๏ธ After five failed attempts to authenticate, your account will be
locked. To reset your account, you can report a support issue using the
support.finicity.com portal. Alternatively, contact your Client Success
Manager or your onboarding representative.
_Supported regions_: 
operationId: CreateToken
requestBody:
$ref: '#/components/requestBodies/CreateTokenRequest'
responses:
'200':
$ref: '#/components/responses/CreateTokenResponse'
'400':
$ref: '#/components/responses/GeneralBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
security:
- FinicityAppKey: []
put:
tags:
- Authentication
summary: Modify Partner Secret
description: >-
Change the Partner Secret used to authenticate this partner.
The secret does not expire, but can be changed by calling this API. A
valid Partner Secret may contain upper and lowercase characters,
numbers, and the characters !, @, #, $, %, &, *, _, -, +. It must
include at least one number and at least one letter, and its length
should be between 12 and 255 characters.
_Supported regions_: 
operationId: ModifyPartnerSecret
requestBody:
$ref: '#/components/requestBodies/ModifyPartnerSecretRequest'
responses:
'204':
$ref: '#/components/responses/ModifyPartnerSecretResponse'
'400':
$ref: '#/components/responses/ModifyPartnerSecretBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
security:
- FinicityAppKey: []
/connect/v2/generate:
post:
tags:
- Connect
summary: Generate Data Connect URL
description: >-
Generate a Data Connect URL link to add within your own applications.
Optional Parameters:
* `experience`: Configure different customer experiences per Data
Connect session by changing the brand, color, logo, icon, the type of
credit decisioning report to generate after the session ends, and more.
* `language`: By default, the Data Connect application is in English.
You don't need to pass this parameter unless you want to translate Data
Connect into one of our supported languages.
* Spanish (United States)
* French (Canada)
MVS Developers: You can pre-populate the consumer's SSN on the Find
employment records page at the beginning of the MVS payroll app. Pass
the SSN value for the consumer in the body of the request call.
_Supported regions_: 
operationId: GenerateConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/lite:
post:
tags:
- Connect
summary: Generate Lite Data Connect URL
description: >-
Data Connect Lite is a variation of Data Connect Full (`POST
/connect/v2/generate`), which has a limited set of features.
* Sign in, user's credentials, and Multi-Factor Authentication (MFA)
* No user account management
The Data Connect Web SDK isn't a requirement when using Data Connect
lite. However, if you want to use the SDK events, routes, and user
events, then you must integrate with the Data Connect Web SDK.
_Supported regions_: 
operationId: GenerateLiteConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateLiteConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/fix:
post:
tags:
- Connect
summary: Generate Fix Data Connect URL
description: >-
Use the Data Connect Fix API when the following conditions occur:
* The connection to the user's financial institution is lost
* The user's credentials were updated (for any number of reasons)
* The user's MFA challenge has expired
_Supported regions_: 
operationId: GenerateFixConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateFixConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
/connect/v2/send/email:
post:
tags:
- Connect
summary: Send Data Connect Email
description: >-
Same as Data Connect Full (`POST /connect/v2/generate`) but send a
Connect email to a consumer.
_Supported regions_: 
operationId: SendConnectEmail
requestBody:
$ref: '#/components/requestBodies/SendConnectEmailRequest'
responses:
'200':
$ref: '#/components/responses/SendConnectEmailResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/jointBorrower:
post:
tags:
- Connect
summary: Generate Data Connect URL - Joint Borrower
description: >-
Same as Data Connect Full (`POST /connect/v2/generate`) but for joint
borrowers.
MVS prompts both the primary and joint borrower to enter each of their
financial, payroll, and paystub information in the same Data Connect
session.
_Supported regions_: 
operationId: GenerateJointBorrowerConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateJointBorrowerConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateJointBorrowerConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/microentry/verify:
post:
tags:
- Connect
summary: 'Account Validation Assistant User Verification of Microdeposits'
description: >-
The UI re-engages the consumer to enter two microdeposit amounts found
in their account and validates them.
_Supported regions_: 
operationId: VerifyMicroEntryMicrodeposit
requestBody:
$ref: '#/components/requestBodies/MicroEntryVerifyRequest'
responses:
'200':
$ref: '#/components/responses/MicroEntryVerifyUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/generate/transfer/bill-pay-switch:
post:
tags:
- Connect
summary: Generate Connect Transfer URL for Bill Pay Switch
description: >-
Generate a Connect Transfer URL which you can use in your application to
allow end users to set up a bill pay switch.
operationId: GenerateTransferBillPaySwitchUrl
requestBody:
$ref: '#/components/requestBodies/ConnectGenerateTransferBillPaySwitch'
responses:
'200':
$ref: '#/components/responses/ConnectGenerateTransferBillPaySwitchResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/generate/transfer/deposit-switch:
post:
tags:
- Connect
summary: Generate Connect Transfer URL for Deposit Switch
description: >-
Generate a Connect Transfer URL which you can use in your application to
allow end users to set up a deposit switch.
operationId: GenerateTransferDepositSwitchUrl
requestBody:
$ref: '#/components/requestBodies/ConnectGenerateTransferDepositSwitch'
responses:
'200':
$ref: '#/components/responses/ConnectGenerateTransferDepositSwitchResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/send/email/jointBorrower:
post:
tags:
- Connect
summary: Send Data Connect Email - Joint Borrower
description: >-
Same as Data Connect Joint Borrower (`POST
/connect/v2/generate/jointBorrower`) but send a Data Connect email to
at least one of the joint borrower's email addresses.
When the consumer opens the email, MVS prompts both the primary and
joint borrower to enter each of their financial, payroll, and paystub
information in the same Data Connect session.
_Supported regions_: 
operationId: SendJointBorrowerConnectEmail
requestBody:
$ref: '#/components/requestBodies/SendJointBorrowerConnectEmailRequest'
responses:
'200':
$ref: '#/components/responses/SendConnectEmailResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/aggregation/v2/customers/testing:
post:
tags:
- Customers
summary: Add Testing Customer
description: >-
Enroll a testing customer (Test Drive accounts).
For using testing customers with FinBank OAuth, you must register a test
application with your systems engineer or account manager. Then, use
that testing `applicationId` when creating testing customers.
Testing Customers can access FinBank profiles (except "FinBank Billable"
profiles), and cannot access live financial institutions.
_Supported regions_: 
operationId: AddTestingCustomer
requestBody:
$ref: '#/components/requestBodies/AddCustomerRequest'
responses:
'201':
$ref: '#/components/responses/AddCustomerResponse'
'400':
$ref: '#/components/responses/GeneralBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'409':
$ref: '#/components/responses/AddCustomerConflictErrorResponse'
/aggregation/v2/customers/active:
post:
tags:
- Customers
summary: Add Customer
description: >-
Enroll an active customer, which is the actual owner of one or more
real-world accounts. This is a billable customer.
Active customers must use the "FinBank Billable" profiles for testing
purposes.
_Supported regions_: 
operationId: AddCustomer
requestBody:
$ref: '#/components/requestBodies/AddCustomerRequest'
responses:
'201':
$ref: '#/components/responses/AddCustomerResponse'
'400':
$ref: '#/components/responses/GeneralBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'409':
$ref: '#/components/responses/AddCustomerConflictErrorResponse'
/aggregation/v1/customers:
get:
tags:
- Customers
summary: Get Customers
description: >-
Find all customers enrolled by the current partner, where the search
text is found in the customer's username or any combination of
`firstName` and `lastName` fields. If no search text is provided, all
customers will be returned.
_Supported regions_: 
operationId: GetCustomers
parameters:
- $ref: '#/components/parameters/CustomerUsernameParameter'
- $ref: '#/components/parameters/CustomerTypeParameter'
- $ref: '#/components/parameters/CustomerSearchParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomersResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/aggregation/v1/customers/{customerId}/application':
get:
tags:
- Customers
summary: Get Customer With App Data by ID
description: >-
Retrieve a customer along with additional details about the OAuth
application.
_Supported regions_: 
operationId: GetCustomerWithAppData
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerWithAppDataResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}':
get:
tags:
- Customers
summary: Get Customer by ID
description: >-
Retrieve a customer by ID.
_Supported regions_: 
operationId: GetCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
put:
tags:
- Customers
summary: Modify Customer by ID
description: >-
Modify an enrolled customer by ID.
You must specify either `firstName`, `lastName`, or both in the request.
_Supported regions_: 
operationId: ModifyCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/ModifyCustomerRequest'
responses:
'204':
$ref: '#/components/responses/ModifyCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/DisputeStatementErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
delete:
tags:
- Customers
summary: Delete Access to Customer by ID
description: >-
Delete access to a customer and all associated accounts.
This will delete access to the customer and all their linked accounts.
The customer data will no longer be accessible. Any customer data
already collected will be retained in accordance with our enterprise
data retention policy consistent with legal and business purposes.
โ ๏ธ Use this service carefully! It will not pause for confirmation before
performing the operation!
_Supported regions_: 
operationId: DeleteCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/customers/{customerId}/consumer':
post:
tags:
- Consumers
summary: Create Consumer for the Customer
description: >-
Create a consumer record associated with the given customer. A consumer
persists as the owner of any reports that are generated, even after the
original customer is deleted from the system.
A consumer must be created for the given customer before calling any of
the Generate Report services.
_Supported regions_: 
operationId: CreateConsumer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/CreateConsumerRequest'
responses:
'201':
$ref: '#/components/responses/CreateConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'409':
$ref: '#/components/responses/ConflictErrorResponse'
get:
tags:
- Consumers
summary: Get the Consumer Record for the Given Customer
description: >-
Get the details of a consumer record by customer ID.
_Supported regions_: 
operationId: GetConsumerForCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetConsumerForCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/consumers/{consumerId}':
get:
tags:
- Consumers
summary: Get Consumer by ID
description: >-
Get the details of a consumer record by consumer ID.
_Supported regions_: 
operationId: GetConsumer
parameters:
- $ref: '#/components/parameters/ConsumerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
put:
tags:
- Consumers
summary: Modify Consumer by ID
description: >-
Modify an existing consumer. All fields are required for a consumer
record, but individual fields for this call are optional because fields
that are not specified will be left unchanged.
_Supported regions_: 
operationId: ModifyConsumer
parameters:
- $ref: '#/components/parameters/ConsumerIdParameter'
requestBody:
$ref: '#/components/requestBodies/ModifyConsumerRequest'
responses:
'204':
$ref: '#/components/responses/ModifyConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts by Institution Login ID
description: >-
Get all accounts associated with the given institution login. All
accounts returned are accessible by a single set of credentials on a
single institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
post:
tags:
- Accounts
summary: Refresh Customer Accounts by Institution Login ID
description: >-
Refresh account and transaction data for all accounts associated with a
given `institutionLoginId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Because many financial institutions only post transactions once per day,
calling Refresh repeatedly is usually a waste of resources and is not
recommended.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
The recommended timeout setting for this request is 180 seconds in order
to receive a response. However, you can terminate the connection after
making the call the operation will still complete. You will have to pull
the account records to check for an updated aggregation attempt date to
know when the refresh is complete.
Note: Do not use this service if you use Data Access Tiers.
_Supported regions_: 
operationId: RefreshCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
- $ref: '#/components/parameters/ToDateParameterForRefreshAccounts'
- $ref: '#/components/parameters/FromDateParameterForRefreshAccounts'
responses:
'200':
$ref: '#/components/responses/RefreshCustomerAccountsResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts':
post:
tags:
- Accounts
summary:
Refresh Customer Accounts by Institution Login ID for Data Access Tiers
description: >-
Refresh account and transaction data for all accounts associated with a
given `institutionLoginId` with a connection to the institution. Client
apps are not permitted to automate calls to the Refresh services. Active
accounts are automatically refreshed by Finicity once per day.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
Note: Use this service for Data Access Tiers ASD, AFD and ATD.
_Supported regions_: 
operationId: RefreshCustomerAccountsByInstitutionLoginV2
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'204':
$ref: '#/components/responses/RefreshCustomerV2AccountsResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}':
delete:
tags:
- Accounts
summary: Delete Access to Customer Accounts by Institution Login ID
description: >-
This will delete access to the underlying account(s) under a given
Institution Login ID. The customer data will no longer be accessible.
Any customer data already collected will be retained in accordance with
our enterprise retention policy consistent with legal and business
purposes.
_Supported regions_: 
operationId: DeleteCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerAccountsByInstitutionLoginResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/accounts/{accountId}':
get:
tags:
- Accounts
summary: Get Customer Account by ID
description: >-
Get a customer account by ID.
_Supported regions_: 
operationId: GetCustomerAccount
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}':
delete:
tags:
- Accounts
summary: Delete Access to Customer Account by ID
description: >-
This will delete access to a specific account only. If there are
multiple permissioned accounts, then partners and their customers will
have the flexibility to continue to access data from other connected
accounts using the consented (Oauth) token for the customer.
The customer data on that specific account will no longer be accessible.
Any customer data already collected will be retained in accordance with
our enterprise retention policy consistent with legal and business
purposes. โ
_Supported regions_: 
operationId: DeleteCustomerAccount
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerAccountResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts
description: >-
Get all accounts owned by the given customer.
_Supported regions_: 
operationId: GetCustomerAccounts
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountStatusParameter'
- $ref: '#/components/parameters/AccountTypeParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
post:
tags:
- Accounts
summary: Refresh Customer Accounts
description: >-
Refresh account and transaction data for all accounts associated with
the given `customerId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Because many financial institutions only post transactions once per day,
calling Refresh services repeatedly is usually a waste of resources and
is not recommended.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
The recommended timeout setting for this request is 180 seconds in order
to receive a response. However, you can terminate the connection after
making the call the operation will still complete. You will have to pull
the account records to check for an updated aggregation attempt date to
know when the refresh is complete.
Note: Do not use this service if you use Data Access Tiers.
_Supported regions_: 
operationId: RefreshCustomerAccounts
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/RefreshCustomerAccountsResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/accounts':
post:
tags:
- Accounts
summary: Refresh Customer Accounts for Data Access Tiers
description: >-
Refresh account and transaction data for all accounts associated with
the given `customerId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
Note: Use this service for Data Access Tiers ASD, AFD and ATD.
_Supported regions_: 
operationId: RefreshCustomerAccountsV2
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'204':
$ref: '#/components/responses/RefreshCustomerV2AccountsResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts by Institution ID
description: >-
Get all active accounts owned by the given customer at the given
institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitution
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts by Institution ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by Institution
ID, returning only basic information of active accounts owned by the
given customer at the given institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts by Institution Login ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by Institution
Login ID, returning only basic information of all active accounts owned
by the given customer at the given institution login ID.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionLoginSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Account by ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by ID, returning
only basic information of a customer account.
_Supported regions_: 
operationId: GetCustomerAccountSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts (Simple)
description: >-
This API is a lighter version of Get Customer Accounts, returning only
basic information of all active customer accounts.
_Supported regions_: 
operationId: GetCustomerAccountsSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic':
post:
tags:
- Transactions
summary: Load Historic Transactions for Customer Account
description: >-
Connect to the account's financial institution and load up to 24 months
of historic transactions for the account. Length of history varies by
institution.
This is a premium service. The billable event is a call to this service
specifying a customer ID that has not been seen before by this service.
(If this service is called multiple times with the same customer ID, to
load transactions from multiple accounts, only one billable event has
occurred.)
The recommended timeout setting for this request is 180 seconds in order
to receive a response. However, you can terminate the connection after
making the call the operation will still complete. You will have to pull
the account records to check for an updated aggregation attempt date to
know when the refresh is complete.
The date range sent to the institution is calculated from the account's
`createdDate`. This means that calling this service a second time for
the same account normally will not add any new transactions for the
account. For this reason, a second call to this service for a known
account ID will usually return immediately.
In a few specific scenarios, it may be desirable to force a second
connection to the institution for a known account ID. Some examples are:
* The institution's policy has changed, making more transactions
available
* Finicity has now added a longer transaction history support for the
institution
* The first call encountered an error, and the resulting Aggregation
Ticket has now been fixed by the Finicity Support Team
In these cases, the POST request can contain the parameter `force=true`
in the request body to force the second connection.
_Supported regions_: 
operationId: LoadHistoricTransactionsForCustomerAccount
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'203':
$ref: '#/components/responses/MFAChallengeNeededResponse'
'204':
$ref: '#/components/responses/LoadHistoricTransactionsForCustomerAccountResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/owner':
get:
tags:
- Payments
summary: Get Account Owner
description: >-
Retrieve the names and addresses of the account owner from a financial
institution.
Note: this is a premium service, billable per every successful API call.
This service retrieves account data from the institution. This usually
returns quickly, but in some scenarios may take a few minutes to
complete. In the event of a timeout condition, retry the call.
_Supported regions_: 
operationId: GetAccountOwner
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetAccountOwnerResponse'
'203':
$ref: '#/components/responses/MFAChallengeNeededResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v3/customers/{customerId}/accounts/{accountId}/owner':
get:
tags:
- Payments
summary: Get Account Owner Details
description: >-
This service retrieves the account details for an account holder from an
institution. The following data objects are available.
* Account holders
* Addresses
* Emails
* Phones
* Documentations
* Identity Insights
Note: The data returned varies from institution to institution as not
all of them make the same data available. This is a premium service,
billable per each successful API call.
_Supported regions_: 
operationId: GetAccountOwnerDetails
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/WithInsightsParameter'
- $ref: '#/components/parameters/MetaDataParameter'
responses:
'200':
$ref: '#/components/responses/GetAccountOwnerDetailsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators:
post:
tags:
- Payment Success Indicator
summary: Generate FCRA Payment Success Indicators
description: >-
Payment Success Indicator (PSI) allows the user to evaluate the
likelihood of a specific ACH transaction resulting in either an
insufficient funds return (NSF) or an unauthorized return due to first-
or third-party fraud. PSI is powered by a machine learning model trained
on consumer-permissioned data. PSI provides a risk assessment, which
includes a real-time balance check, predictive risk scores forecasting a
consumerโs likelihood of having sufficient funds over a 10-day period, a
real-time score predicting the likelihood of an unauthorized return, and
risk attributes to explain and enhance decisioning. Provision and use of
this report is subject to all applicable obligations of the FCRA and any
applicable analogous state law. This product may only be used for the
stated permissible purpose under the FCRA.
_Supported regions_: 
operationId: GenerateFcraPaymentSuccessIndicators
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/PurposeParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePaymentSuccessIndicatorsRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePaymentSuccessIndicatorsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'406':
$ref: '#/components/responses/NotAllowedErrorResponse'
/payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators/{payRequestId}:
get:
tags:
- Payment Success Indicator
summary: Get FCRA Payment Success Indicators by Pay Request ID
description: >-
Get the FCRA Payment Success Indicator scores that have been generated
by a previous call to Generate FCRA Payment Success Indicators.
_Supported regions_: 
operationId: GetFcraPaymentSuccessIndicators
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/PayRequestIdParameter'
- $ref: '#/components/parameters/IncludeReasonsParameter'
responses:
'200':
$ref: '#/components/responses/RetrieveFcraPaymentSuccessIndicatorsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'406':
$ref: '#/components/responses/NotAllowedErrorResponse'
/payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators:
post:
tags:
- Payment Success Indicator
summary: Generate Non-FCRA Payment Success Indicators
description: >-
Payment Success Indicator (PSI) allows the user to evaluate the
likelihood of a specific ACH transaction resulting in either an
insufficient funds return (NSF) or an unauthorized return due to first-
or third-party fraud. PSI is powered by a machine learning model trained
on consumer-permissioned data. PSI provides a risk assessment, which
includes a real-time balance check, predictive risk scores forecasting a
consumerโs likelihood of having sufficient funds over a 10-day period, a
real-time score predicting the likelihood of an unauthorized return, and
risk attributes to explain and enhance decisioning. This product may not
be used for uses subject to the FCRA.
_Supported regions_: 
operationId: GeneratePaymentSuccessIndicators
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePaymentSuccessIndicatorsRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePaymentSuccessIndicatorsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/ForbiddenErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'406':
$ref: '#/components/responses/NotAllowedErrorResponse'
/payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators/{payRequestId}:
get:
tags:
- Payment Success Indicator
summary: Get Non-FCRA Payment Success Indicators by Pay Request ID
description: >-
Get the Non-FCRA Payment Success Indicator scores that have been
generated by a previous call to Generate Payment Success Indicators.
_Supported regions_: 
operationId: GetPaymentSuccessIndicators
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/PayRequestIdParameter'
- $ref: '#/components/parameters/IncludeReasonsParameter'
responses:
'200':
$ref: '#/components/responses/RetrievePaymentSuccessIndicatorsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'406':
$ref: '#/components/responses/NotAllowedErrorResponse'
/aggregation/v1/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator/fcra:
get:
tags:
- Payment Success Indicator
summary: Get FCRA Payment Success Indicator (Legacy)
description: >-
Payment Success Indicator (PSI) allows the user to evaluate the
likelihood of a specific ACH transaction resulting in an insufficient
funds return (NSF). PSI is powered by a machine learning model trained
on Finicityโs consumer-permissioned data network. PSI provides a risk
assessment, which includes a real-time balance check, a predictive risk
score for the up to the next 9 days, and 8 risk attributes to explain
and enhance decisioning. Provision and use of this report is subject to
all applicable obligations of the FCRA and any applicable analogous
state law. This product may only be used for the stated permissible
purpose under the FCRA.
_Supported regions_: 
operationId: GetFCRAPaymentSuccessIndicator
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/SettlementAmountParameter'
- $ref: '#/components/parameters/SettleByDateParameter'
- $ref: '#/components/parameters/PayPurposeCodeParameter'
responses:
'200':
$ref: '#/components/responses/GetPaymentSuccessIndicatorResponse'
'400':
$ref: '#/components/responses/GetPaymentSuccessIndicatorFcraBadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetPaymentSuccessIndicatorNotFoundResponse'
/aggregation/v2/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator:
get:
tags:
- Payment Success Indicator
summary: Get Non-FCRA Payment Success Indicator (Legacy)
description: >-
Payment Success Indicator (PSI) is a Payment Intelligence solution that
uses Financial Institution (FI) data to help payment originators
evaluate a consumer's ability to pay now and in the future within a
given time period. PSI is for payment originators to assess a consumer's
real-time FI account balance and historical FI account activities to
help minimize ACH declines and enable payment originators to gracefully
transition to alternative payment methods or schedules when payment
settlement using ACH / Account-based payment is less likely. PSI may not
be used for credit or insurance underwriting, employment or rental
screening, or any other purpose(s) that would implicate the Fair Credit
Reporting Act or other consumer reporting law.
_Supported regions_: 
operationId: GetPaymentSuccessIndicator
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/SettlementAmountParameter'
- $ref: '#/components/parameters/SettleByDateParameter'
responses:
'200':
$ref: '#/components/responses/GetPaymentSuccessIndicatorResponse'
'400':
$ref: '#/components/responses/GetPaymentSuccessIndicatorBadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetPaymentSuccessIndicatorNotFoundResponse'
/aggregation/v1/partners/applications:
post:
tags:
- App Registration
summary: Register App
description: >-
Register a new application to access financial institutions using OAuth
connections.
_Supported regions_: 
operationId: RegisterApp
requestBody:
$ref: '#/components/requestBodies/RegisterAppRequest'
responses:
'201':
$ref: '#/components/responses/RegisterAppResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/aggregation/v1/partners/applications/{preAppId}':
put:
tags:
- App Registration
summary: Modify App Registration
description: >-
Update a registered application.
_Supported regions_: 
operationId: ModifyAppRegistration
parameters:
- $ref: '#/components/parameters/PreAppIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/ModifyAppRegistrationRequest'
responses:
'200':
$ref: '#/components/responses/ModifyAppRegistrationResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
/aggregation/v2/partners/applications:
get:
tags:
- App Registration
summary: Get App Registration Status (Deprecated)
deprecated: true
description: >-
This endpoint will not be supported after May 2026.
You must update your code to use one of the following alternatives.
* To check the status of your app registrations on Mastercard's
Open Finance platform, use:
[GET /applications](#getApplications)
* To check the status of your application with a particular
Financial Institution, use:
[GET
/applications/{application_id}/institutions](#getRegisteredInstitutions)
_Supported regions_: 
operationId: GetAppRegistrationStatus
parameters:
- $ref: '#/components/parameters/PreAppIdQueryParameter'
- $ref: '#/components/parameters/ApplicationIdQueryParameter'
- $ref: '#/components/parameters/AppRegistrationStatusParameter'
- $ref: '#/components/parameters/ApplicationNameParameter'
- $ref: '#/components/parameters/SubmittedDateParameter'
- $ref: '#/components/parameters/ModifiedDateParameter'
- $ref: '#/components/parameters/ResultPageParameter'
- $ref: '#/components/parameters/ResultPageSizeParameter'
responses:
'200':
$ref: '#/components/responses/GetAppRegistrationStatusResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
/applications:
get:
tags:
- App Registration
summary: Get App Registration Details
description: >-
This endpoint returns the status of the submitted application and
provides additional details.
_Supported regions_: 
operationId: getApplications
parameters:
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/ApplicationLimitParameter'
- $ref: '#/components/parameters/PreAppIdParameter'
- $ref: '#/components/parameters/ApplicationIdParameter'
- $ref: '#/components/parameters/AppNameParameter'
- $ref: '#/components/parameters/AppStatusParameter'
responses:
'200':
$ref: '#/components/responses/AppResponse'
'400':
$ref: '#/components/responses/GetApplicationsStatusBadErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/applications/{application_id}/institutions:
get:
tags:
- App Registration
summary: Get App Registration Status by Institution
description: >-
Query the status of your application registration. If you specify the ID
of a financial instituion in your query then the status for that
institution is returned. If you do not specify an instituion ID then the
status for all financial instituions is returned.
_Supported regions_: 
operationId: getRegisteredInstitutions
parameters:
- $ref: '#/components/parameters/AppIdPathParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/InstitutionLimitParameter'
- $ref: '#/components/parameters/InstitutionIdQueryParameter'
responses:
'200':
$ref: '#/components/responses/InstitutionsResponse'
'400':
$ref: '#/components/responses/GetApplicationsRegistrationStatusBadErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetApplicationRegistrationStatusResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/applications/{applicationId}':
put:
tags:
- App Registration
summary: Set Customer App ID
description: >-
If you have multiple applications for a single client, and you want to
register their applications to access financial institutions using OAuth
connections, then use this API to assign applications to an existing
customer.
_Supported regions_: 
operationId: SetCustomerAppID
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ApplicationIdPathParameter'
responses:
'200':
$ref: '#/components/responses/SetCustomerAppIDResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration':
put:
tags:
- App Registration
summary: Migrate Institution Login Accounts
description: >-
The `institutionLoginId` parameter uses Finicity's internal FI mapping
to move accounts from the current FI legacy connection to the new OAuth
FI connection.
This API returns a list of accounts for the given institution login ID.
_Supported regions_: 
operationId: MigrateInstitutionLoginAccounts
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/MigrateInstitutionLoginAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
/institution/v2/certifiedInstitutions/rssd:
get:
tags:
- Institutions
summary: Get Certified Institutions With RSSD
description: >-
Search for financial institutions by certified product type. Returns a
list of financial institutions, including the institution's
certification details and RSSD identifier. The returned institutions can
be filtered based on specified search criteria, provided using the
requestโs query parameters. If no institutions are found, a 200 response
will be returned with an empty institutions array in the response body.
This is not a billable endpoint.
Response time for this endpoint should be < 500 milliseconds on average.
_Supported regions_: 
operationId: GetCertifiedInstitutionsWithRSSD
parameters:
- $ref: '#/components/parameters/InstitutionSearchParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/ProductTypesParameter'
- $ref: '#/components/parameters/SupportedCountriesParameter'
responses:
'200':
$ref: '#/components/responses/GetCertifiedInstitutionsWithRssdResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/institution/v2/institutions:
get:
tags:
- Institutions
summary: Get Institutions
description: >-
Search for financial institutions. The returned list of institutions can
be filtered based on specified search criteria, provided using the
requestโs query parameters. If no institutions are found, a 200 response
will be returned with an empty institutions array in the response body.
This is not a billable endpoint.
Response time for this endpoint should be < 500 milliseconds on average.
_Supported regions_: 
operationId: GetInstitutions
parameters:
- $ref: '#/components/parameters/InstitutionSearchParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/ProductTypeParameter'
- $ref: '#/components/parameters/SupportedCountriesParameter'
responses:
'200':
$ref: '#/components/responses/GetInstitutionsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/institution/v2/certifiedInstitutions:
get:
tags:
- Institutions
summary: Get Certified Institutions
description: >-
Search for financial institutions by certified product type. Returns a
list of financial institutions, including the institution's
certification details. The returned institutions can be filtered based
on specified search criteria, provided using the requestโs query
parameters. If no institutions are found, a 200 response will be
returned with an empty institutions array in the response body.
This is not a billable endpoint.
Response time for this endpoint should be < 500 milliseconds on average.
_Supported regions_: 
operationId: GetCertifiedInstitutions
parameters:
- $ref: '#/components/parameters/InstitutionSearchParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/ProductTypesParameter'
- $ref: '#/components/parameters/SupportedCountriesParameter'
responses:
'200':
$ref: '#/components/responses/GetCertifiedInstitutionsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/institution/v2/institutions/{institutionId}':
get:
tags:
- Institutions
summary: Get Institution by ID
description: >-
Get financial institution details by institution ID. If an institution
was not found for the requested institution ID, the response status will
be a 404.
This is not a billable endpoint.
Response time for this endpoint should be < 500 milliseconds on average.
_Supported regions_: 
operationId: GetInstitution
parameters:
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetInstitutionResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/institution/v2/institutions/{institutionId}/branding':
get:
tags:
- Institutions
summary: Get Institution Branding by ID
description: >-
Get the branding assets for a single financial institution, given the
institutionโs ID. Branding assets are stored in S3 as SVGs, and links to
the assets are returned on the response payload. If branding does not
exist for the requested institution, the response status will be a 404.
This is not a billable endpoint.
Response time for this endpoint should be < 500 milliseconds on average.
_Supported regions_: 
operationId: GetInstitutionBranding
parameters:
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetInstitutionBrandingResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/institution/v1/institutions/routingNumber/{routing_number}':
get:
summary: Get Institutions by Routing Number
description: >-
Get institution details for a given routing number. The endpoint will
return an error if it is unable to find a match for the routing number
(404 response), or if the routing number provided is not the correct
length (400 response).
Please note, this endpoint only returns FIs that are mapped to
Mastercard financial institutions. Not every institution can be mapped
as not every institution type has a routing number.
This is not a billable endpoint.
Response time for this endpoint should be < 1000 milliseconds on
average.
_Supported regions_: 
operationId: GetInstitutionsByRoutingNumber
tags:
- Institutions
parameters:
- $ref: '#/components/parameters/RoutingNumberParameter'
responses:
'200':
$ref: '#/components/responses/GetInstitutionsByRoutingNumberResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/sbca/location-matches':
get:
tags:
- Small Business Credit Analytics
summary: Get Merchant Location Matches
description: >-
Using the provided merchant metadata, similarity to merchant information
in Mastercard's central locations table is determined and up to 3 of the
best matches are returned for consideration. Merchant details can be
searched using one of the following two ways 1. Using idType,
idValue 2. Using merchantName, address details.
_Supported regions_: 
operationId: GetLocationMatches
parameters:
- $ref: '#/components/parameters/IdTypeParameter'
- $ref: '#/components/parameters/IdValueParameter'
- $ref: '#/components/parameters/MerchantNameParameter'
- $ref: '#/components/parameters/StreetAddressParameter'
- $ref: '#/components/parameters/CityParameter'
- $ref: '#/components/parameters/StateProvinceRegionParameter'
- $ref: '#/components/parameters/PostalCodeParameter'
responses:
'200':
$ref: '#/components/responses/LocationMatchesResponse'
'400':
$ref: '#/components/responses/SbcaBadRequestErrorResponse'
'401':
$ref: '#/components/responses/SbcaUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/SbcaResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voa':
post:
tags:
- Verify Assets
summary: Generate VOA Report for the Customer
description: >-
Generate a Verification of Assets (VOA) report for all checking,
savings, money market, and investment accounts for the given customer.
This service retrieves up to twelve months of transaction history for
each account and uses this information to generate the VOA report.
This is a premium service. The billing rate is the variable rate for
Verification of Assets under the current subscription plan. The billable
event is the successful generation of a VOA report.
Before calling this API, a consumer must be created for the given
customer ID (see Consumers APIs).
If no account of type checking, savings, money market, or investment is
found, the service will return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GenerateVOAReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOAReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOAReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voaHistory':
post:
tags:
- Verify Assets
summary: Generate VOA With Income Report for the Customer
description: >-
Generate a Verification of Assets with Income (VOAI) report for all
checking, savings, money market, and investment accounts for the given
customer.
This service retrieves up to 24 months of transaction history for each
account and uses this information to generate the VOAI report. By
default, the history is set to 61 days, however, you can change the
transaction history by setting the `fromDate` parameter. The report also
includes up to 24 months of income credit transactions (ordered by
account and confidence level) regardless of `fromDate` for income
verification.
With `incomeFromDate`, user can alter the income data to be displayed in
the Report.
This is a premium service. The billable event is the successful
generation of a VOAI report.
Before calling this API, a consumer must be created for the given
customer ID (see Consumers APIs).
If no account of type checking, savings, money market, or investment is
found, the service will return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GenerateVOAWithIncomeReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOAWithIncomeReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOAWithIncomeReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/preQualVoa':
post:
tags:
- Verify Assets
summary: Generate Prequalification (CRA) Report for the Customer
description: >-
Retrieve all checking, savings, money market, and investment accounts
for a consumer. The account, owner information, and the number of
insufficient funds (NSFs) for checking accounts are also provided.
If no account of type checking, savings, money market, or investment is
found, the service will return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GeneratePrequalificationCRAReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePrequalificationReportRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePrequalificationCRAReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/assetSummary':
post:
tags:
- Verify Assets
summary: Generate Prequalification (Non-CRA) Report
description: >-
Retrieve all checking, savings, money market, and investment accounts
for a customer. The account, owner information, and the number of
insufficient funds (NSFs) for checking accounts are also provided.
If no account type of checking, savings, money market, or investment is
found, the service will return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GeneratePrequalificationNonCRAReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePrequalificationReportRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePrequalificationNonCRAReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voi':
post:
tags:
- Verify Income and Employment
summary: Generate VOI Report for the Customer
description: >-
Generate a Verification of Income (VOI) report for all checking,
savings, and money market accounts for the given customer. This service
retrieves up to two years of transaction history for each account and
uses this information to generate the VOI report.
This is a premium service. The billing rate is the variable rate for
Verification of Income under the current subscription plan. The billable
event is the successful generation of a VOI report.
If no account of type checking, savings, or money market is found, the
service will return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GenerateVOIReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOIReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOIReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voePayroll':
post:
tags:
- Verify Income and Employment
summary: Generate VOE - Payroll Report for the Customer
description: >-
Generate or refresh a VOE - Payroll report. Often used as a
complementary report to the VOIE-Payroll report to fulfill the pre-close
VOE requirements. It retrieves the customer's employment details and
employment status through the payroll source without any income
information.
This is a premium service. The billable event is the successful
generation of a VOE - Payroll report.
_Supported regions_: 
operationId: GenerateVOEPayrollReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePayrollReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOEPayrollReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voeTransactions':
post:
tags:
- Verify Income and Employment
summary: Generate VOE - Transactions Report for the Customer
description: >-
Premium Service: A billable event when the API response is successful.
MVS-Direct integration developers only.
Used as a complimentary report to the VOA with Income and VOIE - Paystub
(with TXVerify) reports and used to fulfill the pre-close VOE
requirements.
Retrieve the latest credit transaction information from the borrower's
connected bank accounts and groups them into income streams so that you
can view their payment history to ensure a direct deport was made within
the expected cadence. The report displays transaction descriptions
without any dollar amounts so that income re-verification isn't
necessary.
_Supported regions_: 
operationId: GenerateVOETransactionsReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOETransactionsReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOETransactionsReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/payStatement':
post:
tags:
- Verify Income and Employment
summary: Generate Pay Statement Report for the Customer
description: >-
Generate Pay Statement Extraction Report for the given customer. This
service accepts asset IDs of the stored pay statements to generate a Pay
Statement Extraction Report.
This is a premium service. The billing rate is the variable rate for Pay
Statement Extraction Report under the current subscription plan. The
billable event is the successful generation of a Pay Statement
Extraction Report.
_Supported regions_: 
operationId: GeneratePayStatementReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePayStatementReportRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePayStatementReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voieTxVerify/withInterview':
post:
tags:
- Verify Income and Employment
summary: Generate VOIE Paystub (With TXVerify) Report for the Customer
description: >-
Generate a VOIE - Paystub (with TXVerify) report for all checking and
savings under the given customer. This service retrieves up to two years
of transaction history for the given accounts. It then uses this
information as well as the provided paystub(s), which are passed into
the request body as asset IDs (generated using the Store Customer Pay
Statement API) to generate the VOIE - Paystub (with TXVerify) report.
Note: if you are using this API to refresh the bank transactions, use
the same asset ID from the first report. A new paystub is not required
unless the paystub is too old for underwriting requirements. Using the
same asset ID that was on the original report and the previously
extracted details will be used to speed up report generation response
time.
This is a premium service. The billing rate is the variable rate for
VOIE TXVerify under the current subscription plan. The billable event is
the successful generation of a VOIE TXVerify Report.
_Supported regions_: 
operationId: GenerateVOIEPaystubWithTXVerifyReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOIEPaystubWithTXVerifyReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOIEPaystubWithTXVerifyReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voieTxVerify/withStatement':
post:
tags:
- Verify Income and Employment
summary: Generate VOIE - Paystub Report for the Customer
description: >-
Generate a VOIE - Paystub report. This service uses the provided
paystub(s), which are passed into the request body as asset IDs
(generated using the Store Customer Pay Statement API) to generate the
VOIE - Paystub report with digitized paystub details.
This is a premium service. The billing rate is the variable rate for
VOIE - Paystub under the current subscription plan. The billable event
is the successful generation of a VOIE - Paystub Report.
_Supported regions_: 
operationId: GenerateVOIEPaystubReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateVOIEPaystubReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateVOIEPaystubReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/voiePayroll':
post:
tags:
- Verify Income and Employment
summary: Generate VOIE - Payroll Report for the Customer
description: >-
Generate or refresh a VOIE - Payroll report. For clients using the
product via a consumer permissioning experience via Connect, the
original VOIE - Payroll report generates when the consumer completes the
Data Connect experience, and this API is only used for future report
refreshes without reengaging the consumer.
This is a premium service. The billable event is the successful
generation of a VOIE - Payroll report.
_Supported regions_: 
operationId: RefreshVOIEPayrollReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePayrollReportRequest'
responses:
'202':
$ref: '#/components/responses/RefreshVOIEPayrollReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/statement':
get:
tags:
- Bank Statements
summary: Get Customer Account Statement
description: >-
Retrieve the customer's bank statements in PDF format. Up to 24 months
of history is available depending on the financial institution. Since
this is a premium service, charges incur per each successful statement
retrieved.
For certified financial institutions, statements are available for the
following account types:
* Checking
* Savings
* Money market
* CDs
* Investments
* Mortgage
* Credit cards
* Loans
* Line of credit
* Student Loans
Note: setting the timeout to 180 seconds is recommended to allow enough
time for a response.
_Supported regions_: 
operationId: GetCustomerAccountStatement
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/StatementIndexParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountStatementResponse'
'203':
$ref: '#/components/responses/MFAChallengeNeededResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/statement':
post:
tags:
- Bank Statements
summary: Generate Statement Report for Customer
description: >-
Generate a Statement Report for the given accounts under the given
customer.
This is a premium service. A billable event will be created upon the
successful generation of the Statement Report.
Before calling this API, a consumer must be created for the given
customer ID (see Consumers APIs).
_Supported regions_: 
operationId: GenerateStatementReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateStatementReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateStatementReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v3/customers/{customerId}/accounts/{accountId}/statement':
get:
tags:
- Bank Statements
summary: Get Customer Account Multiple Statement Details
description: >-
This endpoint retrieves details of the account statements available for
a given customer (up to a maximum of 24 statements).
Use the asset ID of the statement you are interested in to obtain the
statement report using Get Asset by Customer and ID.
_Supported regions_: 
operationId: GetCustomerAccountMultipleStatement
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/StatementIndexesParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsMultipleStatementResponse'
'203':
$ref: '#/components/responses/MFAChallengeNeededResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v3/customers/{customerId}/transactions':
get:
tags:
- Transactions
summary: Get All Customer Transactions
description: >-
Get all transactions available for this customer within the given date
range, across all accounts. This service supports paging and sorting by
`transactionDate` (or `postedDate` if no transaction date is provided),
with a maximum of 1000 transactions per request.
Standard consumer aggregation provides up to 180 days of transactions
prior to the date each account was added to the Finicity system. To
access older transactions, you must first call the service Load Historic
Transactions for Account.
There is no limit for the size of the window between `fromDate` and
`toDate`, however, the maximum number of transactions returned on one
page is 1000.
_Supported regions_: 
operationId: GetAllCustomerTransactions
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/RequiredFromDateParameter'
- $ref: '#/components/parameters/RequiredToDateParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/SortParameter'
- $ref: '#/components/parameters/IncludePendingParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerTransactionsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/transactions/{transactionId}':
get:
tags:
- Transactions
summary: Get Customer Transaction by ID
description: >-
Get details for the given transaction.
_Supported regions_: 
operationId: GetCustomerTransaction
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/TransactionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerTransactionResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v4/customers/{customerId}/accounts/{accountId}/transactions':
get:
tags:
- Transactions
summary: Get Customer Account Transactions
description: >-
Get all transactions available for this customer account within the
given date range. This service supports paging and sorting by
`transactionDate` (or `postedDate` if no transaction date is provided),
with a maximum of 1000 transactions per request.
Standard consumer aggregation provides up to 180 days of transactions
prior to the date each account was added to the Finicity system.
There is no limit for the size of the window between `fromDate` and
`toDate`, however, the maximum number of transactions returned on one
page is 1000.
_Supported regions_: 
operationId: GetCustomerAccountTransactions
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/RequiredFromDateParameter'
- $ref: '#/components/parameters/RequiredToDateParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/SortParameter'
- $ref: '#/components/parameters/IncludePendingParameter'
- $ref: '#/components/parameters/ShowDailyBalanceParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerTransactionsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/transactions':
post:
tags:
- Transactions
summary: Generate Transactions Report for the Customer
description: >-
Generate a Transaction Report for the given accounts under the given
customer. This service retrieves up to 24 months of transaction history
for the given customer. It then uses this information to generate the
Transaction Report.
This is a premium service. A billable event will be created upon the
successful generation of the Transactions Report.
Before calling this API, a consumer must be created for the given
customer ID (see Consumers APIs).
There cannot be more than 24 months between `fromDate` and `toDate`.
_Supported regions_: 
operationId: GenerateTransactionsReport
parameters:
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/RequiredTransactionReportFromDateParameter'
- $ref: '#/components/parameters/RequiredTransactionReportToDateParameter'
- $ref: '#/components/parameters/IncludePendingParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateTransactionsReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateTransactionsReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/customers/{customerId}/recurring-transactions':
post:
tags:
- Transactions
summary: Get Recurring Transactions for Customer
description: >-
Identify recurring debit and credit transactions within an account or
set of accounts
_Supported regions_: 
operationId: GetRecurringTransactions
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/GetRecurringTransactionRequest'
responses:
'200':
$ref: '#/components/responses/GetRecurringTransactionsResponse'
'400':
$ref: '#/components/responses/GetRecurringTransactionsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetRecurringTransactionsResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/reports/balance-analytics/userTypes/{userType}':
post:
tags:
- Balance Analytics
summary:
Generate Balance Analytics Report for the customer - Personal/Business
description: >-
Generate a Balance Analytics Report for a given customer. This service
retrieves up to two years of transaction history from connected
accounts.
Balance Analytics analyzes bank balances over time to report metrics
and identify behavior that may indicate risk.
Before calling this API, a consumer or business may need to be created
for the given customer ID based on the user type (see Consumer/Business
APIs).
If no account type of checking or savings is found, the service will
return HTTP 400 Bad Request.
This is a premium service, billable per every successful API call for
non-testing customers. A successful call to this API will generate an
analytics report which can be retrieved via Get Report by Customer or
Get Report by Consumer.
_Supported regions_: 
operationId: GenerateBalanceAnalyticsReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/UserTypeParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateBalanceAnalyticsReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateBalanceAnalyticsReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/reports/cashflow-analytics/userTypes/{userType}':
post:
tags:
- Cash Flow Analytics
summary:
Generate Cash Flow Analytics Report for the customer - Personal/Business
description: >-
Generate a Cashflow Analytics Report for a given customer. This service
retrieves up to two years of transaction history from connected
accounts.
Cashflow Analytics analyzes transaction over time to report metrics and
identify behavior that may indicate risk.
Before calling this API, a consumer or business may need to be created
for the given customer ID based on the user type (see Consumer/Business
APIs).
If no account type of checking or savings is found, the service will
return HTTP 400 Bad Request.
This is a premium service, billable per every successful API call for
non-testing customers. A successful call to this API will generate an
analytics report which can be retrieved via Get Report by Customer or
Get Report by Consumer.
_Supported regions_: 
operationId: GenerateCashflowAnalyticsReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/UserTypeParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateCashflowAnalyticsReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateCashflowAnalyticsReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/customers/{customerId}/reports/payment-history/userTypes/business':
post:
tags:
- Payment History Report
summary: Generate Payment History Report for the Customer - Business
description: >-
Generate a Payment History Report for a given customer. This service
retrieves up to two years of transaction history from connected
accounts.
Payment History along with payment risk score provides the financial
history and risk score based on a customer's financial history.
Before calling this API, a Business entity must be created, and a
Consumer entity may need to be created for the given customer ID, based
on whether the purpose is CRA or Non-CRA (see Consumer/Business APIs).
If no account type of checking or savings is found, the service will
return HTTP 400 Bad Request.
This is a premium service, billable per every successful API call for
non-testing customers. A successful call to this API will generate an
analytics report which can be retrieved via Get Report by Customer or
Get Report by Consumer.
_Supported regions_: 
operationId: GeneratePaymentHistoryReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GeneratePaymentHistoryReportRequest'
responses:
'202':
$ref: '#/components/responses/GeneratePaymentHistoryReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/payStatements':
post:
tags:
- Pay Statements
summary: Store Customer Pay Statement
description: >-
Upload pay statements for a customer.
_Supported regions_: 
operationId: StoreCustomerPayStatement
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/StoreCustomerPayStatementRequest'
responses:
'200':
$ref: '#/components/responses/StoreCustomerPayStatementResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/accounts/{accountId}/loanDetails':
get:
tags:
- Payments
summary: Get Loan Payment Details
description: >-
Return the loan payment details of the customer for a loan-type account.
Note: this is a premium service, billable per every successful API call.
_Supported regions_: 
operationId: GetLoanPaymentDetails
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetLoanPaymentDetailsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/customers/{customerId}/portfolios/{portfolioId}':
get:
tags:
- Portfolios
summary: Get Portfolio by Customer and Portfolio
description: >
Return a portfolio of most recently generated reports for each report
type for the given customer. If there are multiple reports that were
generated for a report type (VOA, VOI, etc.), only the most recently
generated report for the type will be returned.
_Supported regions_: 
operationId: GetPortfolioByCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/PortfolioIdParameter'
responses:
'200':
$ref: '#/components/responses/GetPortfolioByCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush':
post:
tags:
- TxPush
summary: Subscribe to TxPush Notifications
description: >-
Register a client app's TxPush Listener to receive TxPush notifications
related to the given account.
Each call to this service will return two records, one with class
account and one with class transaction. Account events are sent when
values change in the account's fields (such as `balance` or
`interestRate`). Transaction events are sent whenever a new transaction
is posted for the account. For institutions that do not provide TxPush
services, notifications are sent as soon as Finicity finds a new
transaction or new account data through regular aggregation processes.
The listener's URL must be secure (HTTPS) for any real-world account. In
addition, the client's TxPush Listener will need to be verified. HTTP
and HTTPS connections are only allowed on the standard ports 80 (HTTP)
and 443 (HTTPS). The use of other ports will result with the call
failing.
For additional details on this process, see [TxPush Listener
Service](https://developer.mastercard.com/open-finance-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service).
_Supported regions_: 
operationId: SubscribeToTxPushNotifications
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
# ID of the account whose events will be sent to the TxPush Listener
- $ref: '#/components/parameters/AccountIdParameter'
requestBody:
$ref: '#/components/requestBodies/SubscribeToTxPushNotificationsRequest'
responses:
'201':
$ref: '#/components/responses/SubscribeToTxPushNotificationsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
delete:
tags:
- TxPush
summary: Disable TxPush Notifications
description: >-
Delete all TxPush subscriptions with their notifications for the given
account. No more notifications will be sent for account or transaction
events.
For additional details on this process, see [TxPush Listener
Service](https://developer.mastercard.com/open-finance-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service).
_Supported regions_: 
operationId: DisableTxPushNotifications
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
# ID of the account whose events won't be sent to the TxPush Listener
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'204':
$ref: '#/components/responses/DisableTxPushNotificationsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions':
post:
tags:
- TxPush
summary: Create TxPush Test Transaction
description: >-
Inject a transaction into the transaction list for a testing account.
This allows an app to trigger TxPush notifications for the account in
order to test the app's TxPush Listener service. This causes the
platform to send one transaction event and one account event (showing
that the account balance has changed). This service is only supported
for testing accounts.
For additional details on this process, see [TxPush Listener
Service](https://developer.mastercard.com/open-finance-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service).
_Supported regions_: 
operationId: CreateTxPushTestTransaction
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
# ID of the account whose events will be sent to the TxPush Listener
- $ref: '#/components/parameters/AccountIdParameter'
requestBody:
$ref: '#/components/requestBodies/CreateTxPushTestTransactionRequest'
responses:
'201':
$ref: '#/components/responses/CreateTxPushTestTransactionResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/subscriptions/{subscriptionId}':
delete:
tags:
- TxPush
summary: Delete TxPush Subscription
description: >-
Delete a specific subscription to TxPush notifications for the given
account. This could be individual deleting the account or transactions
events. No more events will be sent for that specific subscription.
For additional details on this process, see [TxPush Listener
Service](https://developer.mastercard.com/open-finance-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service).
_Supported regions_: 
operationId: DeleteTxPushSubscription
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/SubscriptionIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteTxPushSubscriptionResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/consumers/{consumerId}/portfolios/{portfolioId}':
get:
tags:
- Portfolios
summary: Get Portfolio by Consumer and Portfolio
description: >-
Return a portfolio of most recently generated reports for each report
type for a given consumer. If there are multiple reports that were
generated for a report type (VOA, VOI, etc.), only the most recently
generated report for the type will be returned.
_Supported regions_: 
operationId: GetPortfolioByConsumer
parameters:
- $ref: '#/components/parameters/ConsumerIdParameter'
- $ref: '#/components/parameters/PortfolioIdParameter'
responses:
'200':
$ref: '#/components/responses/GetPortfolioByConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/details':
get:
tags:
- Payments
summary: Get Account ACH Details
description: >-
Return the real account number and routing number details for an ACH
payment.
Note: this is a premium service, billable per every successful API call.
_Supported account types_: "checking", "savings",
"moneyMarket","certificateOfDeposit"
_Supported regions_: 
operationId: GetAccountACHDetails
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetAccountACHDetailsResponse'
'400':
$ref: '#/components/responses/GetAccountACHDetailsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/reports/{reportId}/partners':
post:
tags:
- Reports
summary: Report Reissue
description: >-
Report Reissue is a billable service that enables authorized third
parties - such as investors, mortgage insurers, QC agencies, and loan
management systems - to securely access an existing CRA report
originally generated by another Mastercard partner.
To retrieve a report, the requesting partner must provide the report ID
which should be obtained from the partner who originally generated the
report and the permissible purpose code which should match the original
purpose the report was generated for. Note: This is not required today
but will be changed to be required by April 30, 2026.
Report data can either be retrieved as a JSON document or a PDF file. To
specify the format required, set the Accept request header to either
application/json or application/pdf. If neither is set, the report
format will be returned as a JSON document.
_Supported regions_: 
operationId: ReportReissue
parameters:
- $ref: '#/components/parameters/ReportIdParameter'
requestBody:
$ref: '#/components/requestBodies/LenderRequest'
responses:
'200':
$ref: '#/components/responses/GetReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v3/reports/{reportId}':
post:
tags:
- Reports
summary: Get Report by Report ID
description: >-
Get a report that has been generated by a previous call to one of the
Generate Report services.
The report's `status` field contains "inProgress", "failure", or
"success". If the status shows "inProgress", the client app should wait
20 seconds and then call this API again.
Report data can either be retrieved as a JSON document or a PDF
file. To specify the format required, set the _Accept request header_
to either **application/json** or **application/pdf**. If neither is
set, the report format will be returned as a JSON document.
_Supported regions_: 
operationId: GetReportById
parameters:
- $ref: '#/components/parameters/ReportIdParameter'
- $ref: '#/components/parameters/OnBehalfOfParameter'
- $ref: '#/components/parameters/PurposeParameter'
requestBody:
$ref: '#/components/requestBodies/LenderRequest'
responses:
'200':
$ref: '#/components/responses/GetReportWithFirstThirdPartyResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v3/customers/{customerId}/reports/{reportId}':
get:
tags:
- Reports
summary: Get Report by Customer and ID
description: >-
Get a report that has been generated by a previous call to one of the
Generate Report services.
The report's `status` field contains "inProgress", "failure", or
"success". If the status shows "inProgress", the client app should wait
20 seconds and then call this API again.
Report data can either be retrieved as a JSON document or a PDF
file. To specify the format required, set the _Accept request header_
to either **application/json** or **application/pdf**. If neither is
set, the report format will be returned as a JSON document.
_Supported regions_: 
operationId: GetReportByCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportIdParameter'
- $ref: '#/components/parameters/OnBehalfOfParameter'
- $ref: '#/components/parameters/PurposeParameter'
responses:
'200':
$ref: '#/components/responses/GetReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v3/consumers/{consumerId}/reports/{reportId}':
get:
tags:
- Reports
summary: Get Report by Consumer and ID
description: >-
Get a report that has been generated by a previous call to one of the
Generate Report services.
The report's `status` field contains "inProgress", "failure", or
"success". If the status shows "inProgress", the client app should wait
20 seconds and then call this API again.
Report data can either be retrieved as a JSON document or a PDF
file. To specify the format required, set the _Accept request header_
to either **application/json** or **application/pdf**. If neither is
set, the report format will be returned as a JSON document.
_Supported regions_: 
operationId: GetReportByConsumer
parameters:
- $ref: '#/components/parameters/PurposeParameter'
- $ref: '#/components/parameters/ConsumerIdParameter'
- $ref: '#/components/parameters/ReportIdParameter'
- $ref: '#/components/parameters/OnBehalfOfParameter'
responses:
'200':
$ref: '#/components/responses/GetReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/customers/{customerId}/reports':
get:
tags:
- Reports
summary: Get Reports by Customer ID
description: >-
Get all reports that have been generated by previous calls to Generate
Report services for the given customer.
The `status` fields in the returned list contain "inProgress",
"failure", or "success". If the status shows "inProgress", the client
app should wait 20 seconds and then call this API again.
_Supported regions_: 
operationId: GetReportsByCustomerId
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/PurposeParameter'
responses:
'200':
$ref: '#/components/responses/GetReportsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
'/decisioning/v1/consumers/{consumerId}/reports':
get:
tags:
- Reports
summary: Get Reports by Consumer ID
description: >-
Get all reports that have been generated by previous calls to Generate
Report services for the given consumer.
The `status` fields in the returned list contain "inProgress",
"failure", or "success". If the status shows "inProgress", the client
app should wait 20 seconds and then call this API again.
_Supported regions_: 
operationId: GetReportsByConsumerId
parameters:
- $ref: '#/components/parameters/PurposeParameter'
- $ref: '#/components/parameters/ConsumerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetReportsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
/decisioning/v1/partners/{partnerId}/billing/reseller:
get:
tags:
- Reports
summary: Get Billing Summary for Partner
operationId: getResellerBillingReport
description:
Use the Partner ID to fetch all reports generated by a partner. A
partner can get their own reports and a reseller partner can get the
reports for their customerโs partner account as long as the partner is
set up with them as the reseller.
parameters:
- $ref: '#/components/parameters/PartnerIdParameter'
- name: startDate
in: query
required: true
description:
The earliest date to be analyzed in this report. The range between
startDate and endDate must be 31 days or less.
schema:
type: integer
- name: endDate
in: query
required: true
description: The latest date to be analyzed in this report
schema:
type: integer
- name: size
in: query
required: false
description:
The size of the results returned per page. By default, this is 100
results per page and can be no more than 1000 results per page.
schema:
type: integer
default: 100
maximum: 1000
- name: page
in: query
required: false
description: The page to be viewed. Zero based index.
schema:
type: integer
default: 0
- name: viewTestingReports
in: query
required: false
description:
Whether reports for testing customer types are included. If not
passed, it is defaulted to only return reports for active customer
types.
schema:
type: boolean
default: false
responses:
'200':
$ref: '#/components/responses/GetBillingResellerReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/assets/{assetId}':
get:
tags:
- Assets
summary: Get Asset by Customer and ID
description: >-
Retrieve a binary file for the given asset ID.
This is a premium service. The billable event is the successful download
of an asset.
_Supported regions_: 
operationId: GetAssetByCustomerID
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AssetIdParameter'
responses:
'200':
$ref: '#/components/responses/GetAssetByCustomerIDResponse'
'400':
$ref: '#/components/responses/GenericBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetAssetNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance/live':
get:
tags:
- Payments
summary: Get Available Balance
description: >-
Retrieve the available and cleared account balances for a single account
in real-time directly from a financial institution.
You can define an additional query parameter `balance_cache_interval` to
specify the time interval of the last cached balance. This parameter is
used by the server to determine whether the cached balance is still
valid or if it needs to be refreshed.
Note: this is a premium service, billable per every successful API call.
_Supported account types_: "checking", "savings", "moneyMarket", "cd"
_Supported regions_: 
operationId: GetAvailableBalanceLive
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/AllowedBalanceCacheIntervalParameter'
responses:
'200':
$ref: '#/components/responses/GetAvailableBalanceLiveResponse'
'400':
$ref: '#/components/responses/GetAvailableBalanceLiveBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance':
get:
tags:
- Payments
summary: Get Available Balance - Cached
deprecated: true
description: >-
_This endpoint will no longer be available after June 2025. You must
transition to using the regular Get Available Balance endpoint, which
can return either live or cached data depending on your requirements._
Retrieve the latest cached available and cleared account balances for a
customer. Since we update and store balances throughout the day, this is
the most accurate balance information available when a connection to a
financial institution is unavailable or when a faster response is
needed. Only deposit account types are supported: Checking, Savings,
Money Market, and CD.
Note: this is a premium service, billable per every successful API call.
Enrollment is required.
_Supported account types_: "checking", "savings", "moneyMarket", "cd"
_Supported regions_: 
operationId: GetAvailableBalance
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetAvailableBalanceResponse'
'400':
$ref: '#/components/responses/GetAvailableBalanceBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/cashFlowBusiness':
post:
tags:
- Cash Flow
summary: Generate Cash Flow Report for the Customer (Business)
description: >-
Generate a Cash Flow Report (Business) report for all checking and
savings under the given customer. This service retrieves up to two years
of transaction history for the given account. It then uses this
information to generate the CFR report. A consumer is not required to
generate this report.
This report is not provided under FCRA rules, and this report is not
available in the Finicity Consumer Portal for the borrower to view.
If no account type of checking or savings is found, the service will
return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GenerateCashFlowBusinessReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateCashFlowReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateCashFlowReportBusinessResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v2/customers/{customerId}/cashFlowPersonal':
post:
tags:
- Cash Flow
summary: Generate Cash Flow Report for the Customer (Personal)
description: >-
Generate a Cash Flow Report (Personal) report for all checking and
savings under the given customer. This service retrieves up to two years
of transaction history for the given account. It then uses this
information to generate the CFR report.
This report is provided under FCRA rules, with Finicity acting as the
CRA (Consumer Reporting Agency). If an individual account is included in
the report - for example, with an individual acting as an personal
guarantor on the loan - then this version of the report should be used.
In case of an adverse action on the loan where the decision was based on
this report, then the borrower can be referred to the [Finicity Consumer
Portal](https://consumer.finicityreports.com) where they can view this
report and submit a dispute if they feel any information in this report
is inaccurate.
Before calling this API, a consumer must be created for the given
customer ID (see Consumers APIs).
If no account type of checking or savings is found, the service will
return HTTP 400 Bad Request.
_Supported regions_: 
operationId: GenerateCashFlowPersonalReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateCashFlowReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateCashFlowReportPersonalResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/microentry/v1/customers/{customerId}':
post:
tags:
- Account Validation Assistance
summary: Initiate Micro Entries
description: >-
Initiate the micro entries to customer's account.
Two random micro amounts less than a dollar each will be deposited to
provided customer's account.
_Supported regions_: 
operationId: InitiateMicroAmountDeposits
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/InitiateMicroAmountDepositsRequest'
responses:
'200':
$ref: '#/components/responses/InitiateMicroAmountDepositsResponse'
'400':
$ref: '#/components/responses/InitiateMicroEntriesBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'409':
$ref: '#/components/responses/ConflictErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
'/microentry/v1/customers/{customerId}/accounts/{accountId}/amounts':
post:
tags:
- Account Validation Assistance
summary: Verify Micro Entries
description: >-
Verify the micro entries as received by customer in customer's account.
Customer needs to verify the micro amounts received in customer's
account. `customerId` and `accountId` are the identifiers of the
customer and account receiving the micro entries.
_Supported regions_: 
operationId: VerifyMicroAmountDeposits
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
requestBody:
$ref: '#/components/requestBodies/VerifyMicroAmountDepositsRequest'
responses:
'200':
$ref: '#/components/responses/VerifyMicroAmountDepositsResponse'
'400':
$ref: '#/components/responses/VerifyMicroAmountDepositsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/microentry/v1/customers/{customerId}/accounts/{accountId}':
get:
tags:
- Account Validation Assistance
summary: Get Micro Entries Details
description: >-
Fetch the micro entries details.
`customerId` and `accountId` are the identifiers of the customer and
account receiving the micro entries.
_Supported regions_: 
operationId: GetMicroDepositsDetails
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetMicroDepositsDetailsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/partners/accessKey':
post:
tags:
- Third Party Access
summary: Generate Third Party Access Key
description: >-
Generate access key for third party partners.
A partner can provide access to third party partners with this access
key.
operationId: GenerateThirdPartyAccessKey
requestBody:
$ref: '#/components/requestBodies/GenerateThirdPartyAccessKeyRequest'
responses:
'200':
$ref: '#/components/responses/GenerateThirdPartyAccessKeyResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/partners/accessKey/{consentReceiptId}':
put:
tags:
- Third Party Access
summary: Update Third Party Access
description: >-
Update access for third party partners
operationId: UpdateThirdPartyAccessKey
parameters:
- $ref: '#/components/parameters/ConsentReceiptIdParameter'
requestBody:
$ref: '#/components/requestBodies/UpdateThirdPartyAccessKeyRequest'
responses:
'200':
$ref: '#/components/responses/UpdateThirdPartyAccessKeyResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
delete:
tags:
- Third Party Access
summary: Revoke Third Party Access
description: >-
Revoke access of third party partners
operationId: RevokeThirdPartyAccessKey
parameters:
- $ref: '#/components/parameters/ConsentReceiptIdParameter'
responses:
'204':
$ref: '#/components/responses/RevokeThirdPartyAccessKeyResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/customers/institution-logins/{institution_login_id}/authorization-details':
get:
tags:
- Customer Authorization Details
summary: Get Customer Authorization Details
description: >-
Retrieve the start date and end date of Data Connect authorization
granted by a customer for a specific financial institution.
Requires the customer's `institutionLoginId`.
Note: details can only be retrieved for authorizations granted via an
OAuth connection. If authorization was granted via a legacy connection,
the endpoint returns error code 3003.
Note: if authorization was granted before this endpoint was introduced,
authorization details may be unavailable (error code 3004).
_Supported regions_: 
parameters:
- $ref: '#/components/parameters/InstitutionLoginIdPathParam'
responses:
'200':
$ref: '#/components/responses/CustomerAuthorizationDetails'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetCustomerAuthorizationDetailsNotFoundErrorResponse'
operationId: getCustomerAuthorizationDetails
'/business-services/customers/{customer_id}/businesses':
post:
tags:
- Businesses API
summary: Create a New Business for a Customer
description: >-
Create a new business record for the associated customer.
A customer can have one business record associated.
_Supported regions_: 
operationId: AddBusinessDetails
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/BusinessDetailRequest'
responses:
'200':
$ref: '#/components/responses/BusinessCreatedResponse'
'404':
$ref: '#/components/responses/CustomerNotFoundErrorResponse'
'409':
$ref: '#/components/responses/ConflictErrorResponse'
get:
tags:
- Businesses API
summary: Get Business for Customer
description: >-
Retrieve business details associated with a specific customer. By
providing the unique customer identifier, details about the associated
business can be accessed.
_Supported regions_: 
operationId: GetBusinessByCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
responses:
'200':
$ref: '#/components/responses/BusinessFoundResponse'
'404':
$ref: '#/components/responses/CustomerNotFoundErrorResponse'
'/business-services/businesses/{business_id}':
put:
tags:
- Businesses API
summary: Update Business by ID
description: >-
Update the details of a business based on its unique identifier. By
providing the specific business ID and the updated information in the
request, modifications can be made to the business's profile.
_Supported regions_: 
operationId: UpdateBusiness
parameters:
- $ref: '#/components/parameters/BusinessIdParameter'
requestBody:
$ref: '#/components/requestBodies/BusinessDetailRequest'
responses:
'200':
$ref: '#/components/responses/BusinessUpdatedResponse'
'404':
$ref: '#/components/responses/BusinessNotFoundErrorResponse'
get:
tags:
- Businesses API
summary: Get Business by ID
description: >-
Retrieve business details.
_Supported regions_:
operationId: GetBusinessById
parameters:
- $ref: '#/components/parameters/BusinessIdParameter'
responses:
'200':
$ref: '#/components/responses/BusinessFoundResponse'
'404':
$ref: '#/components/responses/BusinessNotFoundErrorResponse'
'/aggregation/v3/customers/{customerId}/accounts/{accountId}/details':
get:
tags:
- Payments
summary: Get Account ACH Details with RTP/FedNow
description: >-
Return the real account number and routing number details for an ACH
payment along with the supported payment instruction details. The
response indicates whether the account can receive/send RTP and FedNow
instant payments. For each payment type, transferInEnabled is true if
the account can receive the payment type and transferOutEnabled is true
if the account can send the payment type.
Note: this is a premium service, billable per every successful API call.
_Supported account types_: "checking", "savings", "moneyMarket"
_Supported regions_: 
operationId: GetAccountPaymentInstructionDetails
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetAccountPaymentInstructionDetailsResponse'
'400':
$ref: '#/components/responses/GetAccountPaymentInstructionBadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/account-owner-verification-matchings/customers/{customerId}/accounts/{accountId}':
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/InsightsParameter'
post:
x-internal: true
tags:
- Identity
summary: Account Owner Match
description: "This service returns a confidence score measuring if the
values provided in the request match the account holder details
retrieved from an institution. The following data objects are available.
* Account holders
* Addresses
* Emails
* Phones
* Documentations
* Identity insights
* Matching scores
Any customer information included in the request should be obtained from
a separate source, not from the customer's connected account; while the
name value is required, all other data elements are optional. The
account owner data elements (name, address, email, phone, etc.) returned
in the response are obtained from the customer's financial institution
and will be accompanied by a matching score for any value(s) provided in
the request. These scores range from 0 to 100, with a higher number
signifying an increased confidence that the two values are matching.
Note: The data returned varies from institution to institution as not
all of them make the same data available. This is a premium service,
billable per each successful API call.
_Supported regions_:
"
operationId: AccountMatchingScoreDetails
requestBody:
$ref: '#/components/requestBodies/AccountOwnerVerificationMatchingRequest'
responses:
'200':
$ref: '#/components/responses/AccountOwnerVerificationGetMatchScoreResponse'
'400':
$ref: '#/components/responses/AccountOwnerVerificationBadRequest'
'404':
$ref: '#/components/responses/AccountOwnerVerificationErrorResponse'
'408':
$ref: '#/components/responses/TimedOutRequestResponse'
'/connect/experiences':
get:
tags:
- Connect
summary: Get Experience IDs
description:
Retrieve Data Connect experiences by application name. Optionally,
filter the experiences by product codes.
operationId: GetAllExperience
security:
- FinicityAppToken: []
- FinicityAppKey: []
parameters:
- $ref: '#/components/parameters/ProductCodeParam'
- $ref: '#/components/parameters/AppNameParam'
responses:
'200':
$ref: '#/components/responses/GetAllExperienceResponse'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundResponse'
'/transfer/customers/{customer_id}/deposit-switches':
get:
tags:
- Transfer
summary: Get Deposit Switches by Customer ID
description: |-
Retrieve summary of deposit switches performed by given customer ID.
_Supported regions_: 
operationId: getAllDepositSwitches
security:
- FinicityAppToken: []
- FinicityAppKey: []
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
responses:
'200':
$ref: '#/components/responses/DepositSwitchesSummary'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/transfer/externals/{external_id}/deposit-switches':
get:
tags:
- Transfer
summary: Get Deposit Switches by External ID
description: |-
Retrieve summary of deposit switches performed by given external ID.
_Supported regions_: 
operationId: getAllExternalDepositSwitches
security:
- FinicityAppToken: []
- FinicityAppKey: []
parameters:
- $ref: '#/components/parameters/ExternalIdPathParameter'
responses:
'200':
$ref: '#/components/responses/ExternalDepositSwitchesSummary'
'400':
$ref: '#/components/responses/GetExternalSwitchesBadRequestResponse'
'404':
$ref: '#/components/responses/ExternalSwitchesResourceNotFoundResponse'
'401':
$ref: '#/components/responses/ExternalSwitchesUnauthorizedErrorResponse'
'/transfer/customers/{customer_id}/deposit-switches/{switch_id}':
get:
tags:
- Transfer
summary: Get Deposit Switch by ID
description: |-
Retrieve deposit switch details by switch ID.
_Supported regions_: 
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
- $ref: '#/components/parameters/SwitchIdPathParameter'
responses:
'200':
$ref: '#/components/responses/DepositSwitchDetails'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/SwitchDetailsNotFoundErrorResponse'
operationId: getDepositSwitchDetails
security:
- FinicityAppKey: []
FinicityAppToken: []
/notification-subscriptions/webhooks:
post:
tags:
- Webhook Subscription
summary: Create Webhook Subscription
description: >-
Creates a new webhook subscription for receiving event notifications.
You can specify the URL for receiving notifications and select the
events to subscribe to, including any conditions for filtering. Each
partner can have multiple subscriptions, and each subscription can cover
multiple events. The API supports URL overrides at the event level,
ensuring that each subscription is tailored to specific events and their
respective requirements.
_Supported regions_: 
operationId: createWebhookSubscription
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
requestBody:
$ref: '#/components/requestBodies/CreateSubscriptionRequest'
responses:
'201':
$ref: '#/components/responses/SubscriptionCreatedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
get:
tags:
- Webhook Subscription
summary: List Webhook Subscriptions
description: >-
Retrieves a list of all webhook subscriptions. The response includes
details of each subscription, such as the subscription ID, URL, events,
and their conditions. This API provides an overview of all active and
inactive subscriptions.
_Supported regions_: 
operationId: listWebhookSubscriptions
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ObwmsOffsetParameter'
- $ref: '#/components/parameters/ObwmsLimitParameter'
responses:
'200':
$ref: '#/components/responses/SubscriptionsResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}:
get:
tags:
- Webhook Subscription
summary: Get Webhook Subscription Details
description: >-
Retrieves detailed information about a specific webhook subscription
using the provided subscription ID. The response includes subscription
details such as the events, conditions, and current status.
_Supported regions_: 
operationId: getWebhookSubscriptionById
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
responses:
'200':
$ref: '#/components/responses/SubscriptionDetail'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
put:
tags:
- Webhook Subscription
summary: Update Webhook Subscription
description: >-
Updates an existing webhook subscription with the specified subscription
ID. You can modify the subscription URL and the events associated with
it.
_Supported regions_: 
operationId: updateWebhookSubscription
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/UpdateSubscriptionRequest'
responses:
'200':
$ref: '#/components/responses/SubscriptionUpdatedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
delete:
tags:
- Webhook Subscription
summary: Delete Webhook Subscription
description: >-
Deletes a subscription specified by its ID. Once deleted, the
subscription and its associated events will no longer be active or
receive notifications
_Supported regions_: 
operationId: deleteWebhookSubscription
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
responses:
'204':
$ref: '#/components/responses/SubscriptionDeletedResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}:
put:
tags:
- Webhook Subscription
summary: Update Webhook Subscription Event
description: >-
Updates a specific webhook event in a subscription. Use subscription Id
and webhook Event Id to identify the event and modify its details.
_Supported regions_: 
operationId: updateWebhookSubscriptionEvent
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
- $ref: '#/components/parameters/WebhookEventIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/UpdateEventRequest'
responses:
'200':
$ref: '#/components/responses/EventUpdatedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
delete:
tags:
- Webhook Subscription
summary: Delete Webhook Subscription Event
description: >-
Deletes a specific webhook event from a subscription identified by
subscription Id and webhook Event Id.
_Supported regions_: 
operationId: deleteWebhookSubscriptionEvent
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
- $ref: '#/components/parameters/WebhookEventIdPathParameter'
responses:
'204':
$ref: '#/components/responses/EventDeletedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/status:
put:
tags:
- Webhook Subscription
summary: Enable or Disable Webhook Subscription Event
description: >-
Enables or disables a specific webhook event within a subscription
identified by subscription ID and webhook event ID. Update the event's
status to either active or inactive.
_Supported regions_: 
operationId: changeWebhookSubscriptionEventStatus
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
- $ref: '#/components/parameters/WebhookEventIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/EventStatusUpdateRequest'
responses:
'200':
$ref: '#/components/responses/EventStatusUpdatedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/events:
get:
tags:
- Webhook Subscription
summary: List Available Webhook Subscription Events
description: >-
Allows partners to retrieve a list of all event subscriptions supported
by the Open Finance system. This endpoint provides information about
each subscription, including the webhook URL and associated events,
enabling partners to understand all available subscription options.
_Supported regions_: 
operationId: listAvailableWebhookSubscriptionEvents
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
'200':
$ref: '#/components/responses/AvailableEventsResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}/status:
put:
tags:
- Webhook Subscription
summary:
Enable or disable all the webhook event under a given webhook
subscription
description: >-
Enables or disables all webhook subscription event for partner. Update
the status to either active or inactive. _Supported regions_:
operationId: changeWebhookSubscriptionStatus
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
requestBody:
$ref: '#/components/requestBodies/EventStatusUpdateRequest'
responses:
'200':
$ref: '#/components/responses/EventStatusUpdatedResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}/test-subscriptions:
get:
tags:
- Webhook Subscription
summary: Test Webhook Subscription Based on Subscription ID
description: >-
Test all the webhook event under the given webhook subscription using
subscription_id. _Supported regions_:
operationId: testWebhookSubscription
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
responses:
'200':
$ref: '#/components/responses/TestWebhookSubscriptionResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/test-subscriptions:
get:
tags:
- Webhook Subscription
summary:
Test Webhook Subscription Based on Subscription id & Webhook event id.
description: >-
Test the webhook event under the given webhook subscription using
subscription_id & webhook event id. _Supported regions_:
operationId: testWebhookSubscriptionBasedOnEventId
security:
- FinicityAppKey: []
FinicityAppToken: []
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SubscriptionIdPathParameter'
- $ref: '#/components/parameters/WebhookEventIdPathParameter'
responses:
'200':
$ref: '#/components/responses/TestWebhookSubscriptionResponse'
'400':
$ref: '#/components/responses/ObwmsBadRequestErrorResponse'
'401':
$ref: '#/components/responses/ObwmsUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ObwmsResourceNotFounderrorResponse'
'/connect-components/institutions/{institution_id}/oauth-urls':
parameters:
- $ref: '#/components/parameters/InstitutionIdPathParameter'
post:
summary: Create OAuth URL
operationId: post-institutions-institutionId-oauth-urls
tags:
- 'Connect Components'
responses:
'201':
$ref: '#/components/responses/GenerateOAuthUrl'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/ResourceNotFound'
description: >-
Generates a new OAuth URL that can be used to connect an end-user into
their direct-connection institution. The `redirectURI` will be called
when the oauth session has completed. An optional configuration object
can be applied by including a valid `configurationId` in the request
body.
requestBody:
$ref: '#/components/requestBodies/OauthUrl'
'/connect-components/institutions/{institution_id}/login-forms':
parameters:
- $ref: '#/components/parameters/InstitutionIdPathParameter'
post:
summary: Create Login Form
operationId: post-institutions-institutionId-login-forms
tags:
- 'Connect Components'
responses:
'201':
$ref: '#/components/responses/LoginForms'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/ResourceNotFound'
description: >-
Generate a new login form for a given institution, customer, and
language.
requestBody:
$ref: '#/components/requestBodies/LoginForm'
'/connect-components/customers/{customer_id}/institution-login-ids/{institution_login_id}/reconnections':
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
- $ref: '#/components/parameters/InstitutionLoginIdPathParam'
post:
summary: Initiate Reconnection
operationId: post-reconnections
tags:
- 'Connect Components'
responses:
'201':
$ref: '#/components/responses/LoginForms'
'203':
$ref: '#/components/responses/MfaChallenge'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
description: >-
Use the Data Connect Fix API when the following conditions occur:
* The connection to the user's financial institution is lost.
* The user's credentials were updated (for any number of reasons).
* The user's MFA challenge has expired.
requestBody:
$ref: '#/components/requestBodies/NoBody'
/connect-components/configurations:
post:
summary: Create Components Configuration
operationId: post-configurations
tags:
- 'Connect Components'
responses:
'201':
$ref: '#/components/responses/Configuration'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
description: >-
Optional endpoint. This endpoint is use to generate a
configuration object, which an then be passed in during the login flow.
If used, the ID provided will need to be passed in the Create
Login Form or Create OAuth URL.
requestBody:
$ref: '#/components/requestBodies/CreateConfiguration'
get:
summary: Get All Configurations for Current Partner
description:
Get all previously saved Data Connect Component configurations.
operationId: get-configurations
tags:
- 'Connect Components'
responses:
'200':
$ref: '#/components/responses/Configurations'
'401':
$ref: '#/components/responses/Unauthorized'
/connect-components/configurations/{configuration_id}:
parameters:
- $ref: '#/components/parameters/ConfigurationIdPathParameter'
get:
summary: Get Configuration Details
tags:
- 'Connect Components'
responses:
'200':
$ref: '#/components/responses/Configuration'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/ResourceNotFound'
operationId: get-configurations-configurationId
description: >-
Returns the configuration with the specified id if the configuration
exists and belongs to the partner calling this endpoint
delete:
summary: Delete Configuration
tags:
- 'Connect Components'
operationId: delete-configurations-configurationId
responses:
'204':
$ref: '#/components/responses/NoBody'
'401':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/ResourceNotFound'
description: Removes the configuration from the database
'/data-enrichment/transactions':
post:
tags:
- Transaction Data Enrichment
summary: Performs Enrichment of the Provided Transactions
description: >-
The operation processes the enclosed transactions for enrichment with
categorization and entity recognition. Accepts a batch of 1000
transactions.
operationId: enrichTransactions
requestBody:
$ref: '#/components/requestBodies/EnrichTransactionsPayload'
responses:
'200':
$ref: '#/components/responses/EnrichedTransactions'
'400':
$ref: '#/components/responses/BadRequestErrorTransactionResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/NotFoundErrorResponse'
security:
- FinicityAppKey: []
FinicityAppToken: []
'/transfer/customers/{customer_id}/bill-pay-switches':
get:
tags:
- Transfer
summary: Get Pay Switches by Customer ID
description: |-
Retrieve summary of bill pay switches performed by given customer ID.
_Supported regions_: 
operationId: getAllPaySwitches
security:
- FinicityAppToken: []
- FinicityAppKey: []
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
responses:
'200':
$ref: '#/components/responses/PaySwitchesSummary'
'400':
$ref: '#/components/responses/BadRequestResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/decisioning/customers/{customerId}/reports/foresight-analytics/userTypes/{userType}':
post:
tags:
- Analytics
summary:
Generate foresight analytics non-CRA report for the customer - Personal
description: >-
Generate a foresight analytics non-CRA report for a given customer. The
report includes benchmarking and forecasting data for a customer based
on inputs of account and transaction data as permitted by the customer,
and segments (e.g., postal code) provided by the partner. A consumer is
not required to generate this report.
If no account type of checking, credit card, or savings is found, the
service will return an HTTP 400 Bad Request.
This is a premium service, billable per every successful API call for
non-testing customers. A successful call to this API will generate a
foresight analytics report which can be retrieved via Get Report by
Customer.
_Supported regions_: 
operationId: GenerateForesightAnalyticsNonCraReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/PersonalUserTypeParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateForesightAnalyticsNonCraReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateForesightAnalyticsNonCraReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/reports/foresight-analytics/userTypes/{userType}':
post:
tags:
- Analytics
summary:
(Beta) Generate Non CRA Foresight Analytics Report Using 1st/3rd Party
Transaction Data
description: >-
__Warning - early Beta preview, endpoint might not be responsive.__
Generate a non-CRA Foresight Analytics report for the provided customer.
The report includes benchmarking and forecasting insights into the
customer's spending habits compared against other Mastercard profiles
across various inputted segments.
To use third-party data permissioned via Data Connect, provide a
`customerId` value in the request body.
To use first-party data you submitted via Data Enrichment, provide the
`externalCustomerId` you supplied when uploading the data.
You can use third-party data, first-party data, or both in the same
request.
Supported account types are checking, savings and credit card. A
consumer is not required to generate this report.
This is a premium service, billable per every successful API call. A
successful call to this API will generate a Foresight Analytics report
which is retrieved by calling Get Report by Report ID.
_Supported regions_: 
operationId: GenerateForesightAnalyticsFirstThirdPartyNonCraReport
parameters:
- $ref: '#/components/parameters/PersonalUserTypeParameter'
- $ref: '#/components/parameters/ReportCallbackUrlParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateForesightAnalyticsFirstThirdPartyNonCraReportRequest'
responses:
'202':
$ref: '#/components/responses/GenerateForesightAnalyticsFirstThirdPartyNonCraReportResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
$ref: '#/components/responses/SecurityFreezeErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/transfer/customers/{customer_id}/bill-pay-switches/{switch_id}':
get:
tags:
- Transfer
summary: Get Pay Switch by ID
description: |-
Retrieve bill pay switch details by switch ID.
_Supported regions_: 
parameters:
- $ref: '#/components/parameters/CustomerIdPathParameter'
- $ref: '#/components/parameters/SwitchIdPathParameter'
responses:
'200':
$ref: '#/components/responses/PaySwitchDetails'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/SwitchDetailsNotFoundErrorResponse'
operationId: getBillPaySwitchDetails
security:
- FinicityAppKey: []
FinicityAppToken: []
'/aggregation/v1/paysuite/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts':
get:
tags:
- Payment Enablement Bundle
description: >-
This bundled API returns any or all of the Payments endpoints in one API
call using institution login ID. This includes, Account Simple details,
ACH details, Account Owner, and Account Balance. This requires initial
setup to determine which endpoints are included in the API response.
For Account Balance, You can define an additional query parameter
`balance_cache_interval` to specify the time interval of the last cached
balance. This parameter is used by the server to determine whether the
cached balance is still valid or if it needs to be refreshed.
_Supported regions_: 
summary: Fetch all the requested field details using institution login ID
operationId: GetAccountDetailsByInstitutionLoginId
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameterPEB'
- $ref: '#/components/parameters/IncludeParameter'
- $ref: '#/components/parameters/PebAllowedBalanceCacheIntervalParameter'
responses:
'200':
$ref: '#/components/responses/GetPaymentEnablementBundleResponse'
'400':
$ref: '#/components/responses/GetPaymentEnablementBundleBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetPaymentEnablementBundleResourceNotFoundForInstitutionLoginIdErrorResponse'
'/aggregation/v1/paysuite/customers/{customerId}/accounts/{accountId}':
get:
tags:
- Payment Enablement Bundle
description: >-
This bundled API will return any or all of the Payments endpoints in one
API call using account ID. This includes, Account Simple details, ACH
details, Account Owner, and Account Balance. This requires initial setup
to determine which endpoints are included in the API response.
For Account Balance, You can define an additional query parameter
`balance_cache_interval` to specify the time interval of the last cached
balance. This parameter will be used by the server to determine whether
the cached balance is still valid or if it needs to be refreshed.
_Supported regions_: 
summary: Fetch all the requested details using the account ID
operationId: GetAccountDetailsByAccountId
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
- $ref: '#/components/parameters/IncludeParameter'
- $ref: '#/components/parameters/PebAllowedBalanceCacheIntervalParameter'
responses:
'200':
$ref: '#/components/responses/GetPaymentEnablementBundleResponse'
'400':
$ref: '#/components/responses/GetPaymentEnablementBundleBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/GetPaymentEnablementBundleResourceNotFoundForAccountIdErrorResponse'
'/decisioning/customers/{customerId}/sbca':
post:
tags:
- Small Business Credit Analytics
summary: Generate Small Business Credit Analytics Report
description: >-
Generate a report with Merchant performance metrics (Retail Sales
Analytics) or Merchant benchmarking metrics (Retail Sales Benchmarks).
_Supported regions_: 
operationId: GenerateSBCAMetricsReport
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/GenerateSBCAMetricsReportRequest'
responses:
'200':
$ref: '#/components/responses/GenerateSBCAReportResponse'
'400':
$ref: '#/components/responses/SmallBusinessReportBadRequestErrorResponse'
'401':
$ref: '#/components/responses/SBCAUnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/SBCAResourceNotFoundErrorResponse'
components:
securitySchemes:
FinicityAppKey:
name: Finicity-App-Key
type: apiKey
in: header
description: The "Finicity-App-Key" from the developer dashboard
FinicityAppToken:
name: Finicity-App-Token
type: apiKey
in: header
description: A token returned by the `/authentication` API
requestBodies:
GetRecurringTransactionRequest:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIds'
LenderRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Lender'
examples:
LenderRequestExample:
$ref: '#/components/examples/LenderRequestExample'
AccountOwnerVerificationMatchingRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingRequest'
BusinessDetailRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewBusiness'
CreateTokenRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerCredentials'
ModifyPartnerSecretRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerCredentialsWithNewSecret'
GenerateConnectUrlRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectParameters'
GenerateLiteConnectUrlRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LiteConnectParameters'
GenerateFixConnectUrlRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FixConnectParameters'
ConnectGenerateTransferBillPaySwitch:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectGenerateTransferBillPaySwitchParameters'
ConnectGenerateTransferDepositSwitch:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferDepositSwitchParameters'
SendConnectEmailRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectEmailParameters'
GenerateJointBorrowerConnectUrlRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectJointBorrowerParameters'
MicroEntryVerifyRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MicroEntryVerifyRequestParameter'
SendJointBorrowerConnectEmailRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectJointBorrowerEmailParameters'
AddCustomerRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomer'
ModifyCustomerRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerUpdate'
CreateConsumerRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewConsumer'
ModifyConsumerRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerUpdate'
RegisterAppRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
ModifyAppRegistrationRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
GeneratePayrollReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayrollReportConstraints'
examples:
GeneratePayrollReportRequestExample:
$ref: '#/components/examples/GeneratePayrollReportRequestExample'
GeneratePayStatementReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayStatementReportConstraints'
examples:
GeneratePayStatementReportRequestExample:
$ref: '#/components/examples/GeneratePayStatementReportRequestExample'
GenerateCashFlowReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CashFlowReportConstraints'
examples:
GenerateCashFlowReportRequestExample:
$ref: '#/components/examples/GenerateCashFlowReportRequestExample'
GenerateTransactionsReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsReportConstraints'
examples:
GenerateTransactionsReportRequestExample:
$ref: '#/components/examples/GenerateTransactionsReportRequestExample'
GenerateVOAReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOAReportConstraints'
examples:
GenerateVOAReportRequestExample:
$ref: '#/components/examples/GenerateVOAReportRequestExample'
GenerateVOAWithIncomeReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOAWithIncomeReportConstraints'
examples:
GenerateVOAWithIncomeReportRequestExample:
$ref: '#/components/examples/GenerateVOAWithIncomeReportRequestExample'
GeneratePrequalificationReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PrequalificationReportConstraints'
examples:
GeneratePrequalificationReportRequestExample:
$ref: '#/components/examples/GeneratePrequalificationReportRequestExample'
GenerateVOIReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOIReportConstraints'
examples:
GenerateVOIReportRequestExample:
$ref: '#/components/examples/GenerateVOIReportRequestExample'
GenerateVOIEPaystubWithTXVerifyReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOIEWithTXVerifyReportConstraints'
examples:
GenerateVOIEPaystubWithTXVerifyReportRequestExample:
$ref: '#/components/examples/GenerateVOIEPaystubWithTXVerifyReportRequestExample'
GenerateVOIEPaystubReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOIEReportConstraints'
examples:
GenerateVOIEPaystubReportRequestExample:
$ref: '#/components/examples/GenerateVOIEPaystubReportRequestExample'
StoreCustomerPayStatementRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PayStatement'
GenerateVOETransactionsReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VOETransactionsReportConstraints'
examples:
GenerateVOETransactionsReportRequestExample:
$ref: '#/components/examples/GenerateVOETransactionsReportRequestExample'
GenerateStatementReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StatementReportConstraints'
examples:
GenerateStatementReportRequestExample:
$ref: '#/components/examples/GenerateStatementReportRequestExample'
GenerateBalanceAnalyticsReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportConstraints'
examples:
GenerateBalanceBusinessCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateBalanceBusinessCraAnalyticsReportRequestExample'
GenerateBalanceBusinessNonCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateBalanceBusinessNonCraAnalyticsReportRequestExample'
GenerateBalanceBusinessFtcAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateBalanceBusinessFtcAnalyticsReportRequestExample'
GenerateBalancePersonalCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateBalancePersonalCraAnalyticsReportRequestExample'
GenerateBalancePersonalNonCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateBalancePersonalNonCraAnalyticsReportRequestExample'
GenerateCashflowAnalyticsReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportConstraints'
examples:
GenerateCashflowBusinessCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateCashflowBusinessCraAnalyticsReportRequestExample'
GenerateCashflowBusinessNonCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateCashflowBusinessNonCraAnalyticsReportRequestExample'
GenerateCashflowBusinessFtcAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateCashflowBusinessFtcAnalyticsReportRequestExample'
GenerateCashflowPersonalCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateCashflowPersonalCraAnalyticsReportRequestExample'
GenerateCashflowPersonalNonCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GenerateCashflowPersonalNonCraAnalyticsReportRequestExample'
GeneratePaymentHistoryReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportConstraints'
examples:
GeneratePaymentHistoryBusinessCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessCraAnalyticsReportRequestExample'
GeneratePaymentHistoryBusinessNonCraAnalyticsReportRequestExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessNonCraAnalyticsReportRequestExample'
GeneratePaymentHistoryBusinessFtcAnalyticsReportRequestExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessFtcAnalyticsReportRequestExample'
CreateTxPushTestTransactionRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TestTxPushTransaction'
SubscribeToTxPushNotificationsRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TxPushSubscriptionParameters'
InitiateMicroAmountDepositsRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MicroDepositInitiation'
VerifyMicroAmountDepositsRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MicroDepositVerification'
GenerateThirdPartyAccessKeyRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyAccessKeyData'
UpdateThirdPartyAccessKeyRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyAccessKeyData'
LoginForm:
required: true
description: >-
An optional configuration object can be applied by including a valid
`configurationId` in the request body.
The preferred language
translation for the login form is request with the `language` property
in the request body. Supported languages are:
* English: `en`
* English-United States:'en-us`
* Spanish: `es`
* Spanish-United States: `es-us`
* French: `fr`
* French-Canada: `fr-ca`
content:
application/json:
schema:
type: object
description: Object used to generate a new session'ed login form.
required:
- language
- customerId
- serviceAgreement
properties:
language:
type: string
description: >-
The preferred language translation of the requested login
form. Supported languages are English:'en', English-United
States:'en-us', Spanish:'es', Spanish-United States:'es-us',
French:'fr', French-Canada:'fr-ca'
example: 'en'
customerId:
$ref: '#/components/schemas/CustomerId'
configurationId:
$ref: '#/components/schemas/ConfigurationId'
serviceAgreement:
$ref: '#/components/schemas/ServiceAgreement'
CreateSubscriptionRequest:
description: Request body for creating event subscription.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
examples:
CreateSubscriptionRequestExample:
$ref: '#/components/examples/SubscriptionRequestExample'
UpdateSubscriptionRequest:
description: Request body for updating event subscription.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
examples:
CreateSubscriptionRequestExample:
$ref: '#/components/examples/SubscriptionRequestExample'
UpdateEventRequest:
description: Request body to update Event
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookEvent'
examples:
UpdateEventRequestExample:
$ref: '#/components/examples/UpdateEventRequestExample'
EventStatusUpdateRequest:
description: Request body to an event active or inactive.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EventStatusUpdate'
OauthUrl:
required: true
content:
application/json:
schema:
type: object
description: >-
Used to request an oauth url for a given a given institution and
customer.
required:
- customerId
- serviceAgreement
- redirectURI
properties:
redirectURI:
description:
The `redirectURI` will be called when the oauth session has
completed.
type: string
format: uri
example: 'https://oauth.example.com/redirect'
minLength: 1
maxLength: 1024
customerId:
$ref: '#/components/schemas/CustomerId'
configurationId:
$ref: '#/components/schemas/ConfigurationId'
serviceAgreement:
$ref: '#/components/schemas/ServiceAgreement'
CreateConfiguration:
required: true
content:
application/json:
schema:
type: object
description: >-
Used to generate a new configuration, which can be used during the
login flow
properties:
filterAccounts:
$ref: '#/components/schemas/FilterAccounts'
accountClassificationType:
$ref: '#/components/schemas/AccountClassificationType'
aoRequired:
$ref: '#/components/schemas/AoRequired'
NoBody:
required: true
content:
application/json:
schema:
type: object
nullable: true
GenerateForesightAnalyticsNonCraReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ForesightAnalyticsReportConstraints'
examples:
GenerateForesightAnalyticsNonCraReportRequestExample:
$ref: '#/components/examples/GenerateForesightAnalyticsNonCraReportRequestExample'
GenerateForesightAnalyticsFirstThirdPartyNonCraReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ForesightAnalyticsReportFirstThirdPartyConstraints'
examples:
GenerateForesightAnalyticsNonCraReportRequestExample:
$ref: '#/components/examples/GenerateForesightAnalyticsFirstThirdPartyNonCraReportRequestExample'
EnrichTransactionsPayload:
required: true
description:
A list of maximum of 1000 transactions to submit for transaction
enrichment
content:
application/json:
schema:
$ref: '#/components/schemas/EnrichTransactionsPayload'
examples:
EnrichTransactionsPayload:
$ref: '#/components/examples/EnrichTransactionsPayloadExample'
GeneratePaymentSuccessIndicatorsRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentSuccessIndicatorsProperties'
GenerateSBCAMetricsReportRequest:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SBCAMetricsReportConstraints'
responses:
LocationMatchesResponse:
description: The location matches were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/LocationMatches'
examples:
LocationMatchesResponseExample:
$ref: '#/components/examples/LocationMatchesResponseExample'
SbcaUnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check
"Finicity-App-Key" or "Finicity-App-Token".
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ExpiredTokenExample:
$ref: '#/components/examples/ExpiredTokenExample'
InvalidFinicityAppKeyExample:
$ref: '#/components/examples/InvalidFinicityAppKeyExample'
MissingFinicityAppKeyExample:
$ref: '#/components/examples/MissingFinicityAppKeyExample'
MissingFinicityAppTokenExample:
$ref: '#/components/examples/MissingFinicityAppTokenExample'
SbcaBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingSbcaMandatoryDataExample:
$ref: '#/components/examples/MissingSbcaMandatoryDataExample'
InvalidSbcaDataExample:
$ref: '#/components/examples/InvalidSbcaDataExample'
InvalidSbcaDataCombinationExample:
$ref: '#/components/examples/InvalidSbcaDataCombinationExample'
SbcaResourceNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NoLocationMatchFoundExample:
$ref: '#/components/examples/NoLocationMatchFoundExample'
GetRecurringTransactionsResponse:
description: The recurring transactions were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/RecurringTransactionsDetails'
GetRecurringTransactionsBadRequestErrorResponse:
description: >-
We couldn't handle your request, see response payload for more
information.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
GetRecurringTransactionsResourceNotFoundErrorResponse:
description: Customer ID or Account ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NoAccountForCustomerIdExample:
$ref: '#/components/examples/NoAccountForCustomerIdExample'
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
TransactionNotFoundExample:
$ref: '#/components/examples/TransactionNotFoundExample'
GenerateForesightAnalyticsNonCraReportResponse:
description: >-
The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status.
headers:
Location:
schema:
type: string
description: >-
Please Check the Report status at URL
/decisioning/v3/customers/{customer_id}/reports/{report_id}
example: '/decisioning/v3/customers/567890/reports/247th25xwyhd-farpbfnoncra'
content:
application/json:
schema:
$ref: '#/components/schemas/ForesightAnalyticsReportAck'
examples:
GenerateForesightAnalyticsNonCraReportResponseExample:
$ref: '#/components/examples/GenerateForesightAnalyticsNonCraReportResponseExample'
GenerateForesightAnalyticsFirstThirdPartyNonCraReportResponse:
description: >-
The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status.
headers:
Location:
schema:
type: string
description: >-
Please Check the Report status at URL
/decisioning/v3/reports/{report_id}
example: '/decisioning/v3/reports/247th25xwyhd-farpbfnoncra'
content:
application/json:
schema:
$ref: '#/components/schemas/ForesightAnalyticsFirstThirdPartyReportAck'
examples:
GenerateForesightAnalyticsNonCraReportResponseExample:
$ref: '#/components/examples/GenerateForesightAnalyticsFirstThirdPartyNonCraReportResponseExample'
AccountOwnerVerificationErrorResponse:
description: The customer or account does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
CustomerIdNotFoundErrorMessage:
$ref: '#/components/examples/CustomerIdNotFound'
AccountsDetailsNotFoundErrorMessage:
$ref: '#/components/examples/AccountsDetailsNotFound'
AccountOwnerVerificationBadRequest:
description: The request send to Account Owner Service is inappropriate
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFieldBadRequestErrorMessage:
$ref: '#/components/examples/AccountOwnerVerificationMissingField'
AOV3BadRequestErrorMessage:
$ref: '#/components/examples/AOV3BadRequestErrorMessage'
IdMatchBadRequestErrorMessage:
$ref: '#/components/examples/IdMatchBadRequestErrorMessage'
AccountOwnerVerificationGetMatchScoreResponse:
description:
Shows the details of the match score after comparison with account owner
response.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountOwnerVerificationMatchResults'
TimedOutRequestResponse:
description: Response for when a request has timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
TimedOutRequestErrorMessage:
$ref: '#/components/examples/TimedOutRequestErrorMessage'
BusinessUpdatedResponse:
description: The business information was updated.
content:
application/json:
schema:
$ref: '#/components/schemas/Business'
BusinessNotFoundErrorResponse:
description: The business does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
BusinessIdNotFoundResponse:
$ref: '#/components/examples/BusinessIdNotFound'
BusinessFoundResponse:
description: The business information was successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessList'
CustomerNotFoundErrorResponse:
description: The customer does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
CustomerIdNotFoundResponse:
$ref: '#/components/examples/CustomerIdNotFound'
BusinessCreatedResponse:
description: The business was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/Business'
CreateTokenResponse:
description: The access token was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/AccessToken'
ModifyPartnerSecretResponse:
description: The Partner Secret was successfully updated
ModifyPartnerSecretBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InvalidNewPartnerSecretExample:
$ref: '#/components/examples/InvalidNewPartnerSecretExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
GenerateConnectUrlResponse:
description: The URL link was successfully generated
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectUrl'
ConnectGenerateTransferDepositSwitchResponse:
description: Successful response. Returns Connect Transfer URL.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectTransferDepositSwitchLink'
ConnectGenerateTransferBillPaySwitchResponse:
description: Successful response. Returns Connect Transfer URL.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectTransferBillPaySwitchLink'
AppResponse:
description: Response containing one or more application details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationResponse'
examples:
AppResponseExample:
$ref: '#/components/examples/AppResponseExample'
InstitutionsResponse:
description:
The requested application registration status against financial
institutions.
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionResponse'
examples:
InstitutionsDetailResponseExample:
$ref: '#/components/examples/InstitutionResponseExample'
SendConnectEmailResponse:
description: The URL link was successfully generated and the email sent
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectEmailUrl'
MicroEntryVerifyUrlResponse:
description: The URL link was successfully generated
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectUrl'
GenerateJointBorrowerConnectUrlResponse:
description: The URL link was successfully generated
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectUrl'
AddCustomerResponse:
description: The customer was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedCustomer'
GetCustomersResponse:
description: Customers were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Customers'
GetCustomerResponse:
description: The customer was successfully retrieved
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Customer'
- type: object
properties:
applicationId:
$ref: '#/components/schemas/ApplicationId'
GetCustomerWithAppDataResponse:
description: The customer was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerWithAppData'
ModifyCustomerResponse:
description: The customer was successfully updated
DeleteCustomerResponse:
description: Access to the customer was successfully removed
CreateConsumerResponse:
description: The consumer was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedConsumer'
GetConsumerForCustomerResponse:
description: The consumer was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Consumer'
GetConsumerResponse:
description: The consumer was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Consumer'
GetCustomerAccountsSimpleResponse:
description: The account list was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccountsSimple'
GetCustomerAccountSimpleResponse:
description: The account was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccountSimple'
ModifyConsumerResponse:
description: The consumer was successfully updated
GetCustomerAccountsResponse:
description: The account list was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccounts'
GetPaymentSuccessIndicatorBadRequestResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
MissingSettleByDateExample:
$ref: '#/components/examples/MissingSettleByDateExample'
MissingSettlementAmountExample:
$ref: '#/components/examples/MissingSettlementAmountExample'
InvalidSettleByDateExample:
$ref: '#/components/examples/InvalidSettleByDateExample'
IncorrectFieldTypeExample:
$ref: '#/components/examples/IncorrectFieldTypeExample'
AccountHasNoTransactionExample:
$ref: '#/components/examples/AccountHasNoTransactionExample'
RequiredFieldParameterExample:
$ref: '#/components/examples/RequiredFieldParameterExample'
InactiveAccountExample:
$ref: '#/components/examples/InactiveAccountExample'
GetPaymentSuccessIndicatorFcraBadRequestResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
MissingSettleByDateExample:
$ref: '#/components/examples/MissingSettleByDateExample'
MissingSettlementAmountExample:
$ref: '#/components/examples/MissingSettlementAmountExample'
InvalidPurposeCodeExample:
$ref: '#/components/examples/InvalidPurposeCodeExample'
InvalidSettleByDateExample:
$ref: '#/components/examples/InvalidSettleByDateExample'
IncorrectFieldTypeExample:
$ref: '#/components/examples/IncorrectFieldTypeExample'
AccountHasNoTransactionExample:
$ref: '#/components/examples/AccountHasNoTransactionExample'
RequiredFieldParameterExample:
$ref: '#/components/examples/RequiredFieldParameterExample'
InactiveAccountExample:
$ref: '#/components/examples/InactiveAccountExample'
MissingEmailExample:
$ref: '#/components/examples/MissingEmailExample'
GetPaymentSuccessIndicatorNotFoundResponse:
description: Required details not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
InvalidAccountIdExample:
$ref: '#/components/examples/InvalidAccountIdExample'
GetPaymentSuccessIndicatorResponse:
description: The payment success indicator was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentSuccessIndicator'
examples:
PaymentSuccessIndicatorExample:
$ref: '#/components/examples/PaymentSuccessIndicatorExample'
PaymentSuccessIndicatorWarningExample:
$ref: '#/components/examples/PaymentSuccessIndicatorWarningExample'
GeneratePaymentSuccessIndicatorsResponse:
description:
Successfully requested to generate a Payment Success Indicators score
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentSuccessIndicators'
examples:
PaymentSuccessIndicatorsInProgressResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
RetrieveFcraPaymentSuccessIndicatorsResponse:
description:
Successfully requested to retrieve a Payment Success Indicators score
content:
application/json:
schema:
$ref: '#/components/schemas/FcraPaymentSuccessIndicators'
examples:
PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsNoReasonsSuccessResponseExample'
PaymentSuccessIndicatorsSuccessResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsSuccessResponseExample'
PaymentSuccessIndicatorsInProgressResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
PaymentSuccessIndicatorsFailureResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsFailureResponseExample'
RetrievePaymentSuccessIndicatorsResponse:
description:
Successfully requested to retrieve a Payment Success Indicators score
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentSuccessIndicators'
examples:
PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsNoReasonsSuccessResponseExample'
PaymentSuccessIndicatorsSuccessResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsSuccessResponseExample'
PaymentSuccessIndicatorsInProgressResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsInProgressResponseExample'
PaymentSuccessIndicatorsFailureResponseExample:
$ref: '#/components/examples/PaymentSuccessIndicatorsFailureResponseExample'
RefreshCustomerAccountsResponse:
description: The account list was successfully refreshed
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccounts'
RefreshCustomerV2AccountsResponse:
description: The account list was successfully refreshed
DeleteCustomerAccountsByInstitutionLoginResponse:
description: Access to the customer accounts was successfully removed
DeleteCustomerAccountResponse:
description: Access to the customer account was successfully removed
LoadHistoricTransactionsForCustomerAccountResponse:
description:
Historic transactions have been loaded successfully. The transactions
are now available by calling the Get Customer Account Transactions API.
GetCustomerAccountResponse:
description: The account was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccount'
GetAccountOwnerResponse:
description: The account owner was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AccountOwner'
MFAChallengeNeededResponse:
description:
The request was unsuccessful due to a required Multi-Factor
Authentication (MFA) challenge. There is no further action that can be
taken to resolve this error.
RegisterAppResponse:
description: The app registration was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/RegisteredApplication'
SetCustomerAppIDResponse:
description: The app was successfully assigned
ModifyAppRegistrationResponse:
description: The app registration was updated
content:
application/json:
schema:
$ref: '#/components/schemas/RegisteredApplication'
GetAppRegistrationStatusResponse:
description: The app registration statuses were returned
content:
application/json:
schema:
$ref: '#/components/schemas/AppStatuses'
MigrateInstitutionLoginAccountsResponse:
description: The migration succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccounts'
GetCertifiedInstitutionsResponse:
description: Institutions were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CertifiedInstitutions'
GetCertifiedInstitutionsWithRssdResponse:
description: Institutions were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/CertifiedInstitutionsWithRssd'
GetInstitutionResponse:
description: Institution was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionWrapper'
GetInstitutionsResponse:
description: Institutions were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Institutions'
GetInstitutionsByRoutingNumberResponse:
description: >-
Successful response will contain institution connections that were
associated with the provided routing number.
content:
application/json:
schema:
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
createdDate:
$ref: '#/components/schemas/UnixDate'
institutions:
description: List of institutions with matching routing numbers
type: array
items:
$ref: '#/components/schemas/InstitutionsWithRoutingNumber'
GetInstitutionBrandingResponse:
description: Institution branding was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/BrandingWrapper'
GenerateVOEPayrollReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/PayrollReportAck'
examples:
GenerateVOEPayrollReportResponseExample:
$ref: '#/components/examples/GenerateVOEPayrollReportResponseExample'
RefreshVOIEPayrollReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/PayrollReportAck'
examples:
RefreshVOIEPayrollReportResponseExample:
$ref: '#/components/examples/RefreshVOIEPayrollReportResponseExample'
GenerateTransactionsReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsReportAck'
examples:
GenerateTransactionsReportResponseExample:
$ref: '#/components/examples/GenerateTransactionsReportResponseExample'
GenerateVOAReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOAReportAck'
examples:
GenerateVOAReportResponseExample:
$ref: '#/components/examples/GenerateVOAReportResponseExample'
GetCustomerAccountsMultipleStatementResponse:
description: The account statements were successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccountMultipleStatements'
GenerateVOAWithIncomeReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOAWithIncomeReportAck'
examples:
GenerateVOAWithIncomeReportResponseExample:
$ref: '#/components/examples/GenerateVOAWithIncomeReportResponseExample'
GeneratePrequalificationCRAReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/PrequalificationReportAck'
examples:
GeneratePrequalificationCRAReportResponseExample:
$ref: '#/components/examples/GeneratePrequalificationCRAReportResponseExample'
GeneratePrequalificationNonCRAReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/PrequalificationReportAck'
examples:
GeneratePrequalificationNonCRAReportResponseExample:
$ref: '#/components/examples/GeneratePrequalificationNonCRAReportResponseExample'
GenerateVOIReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOIReportAck'
examples:
GenerateVOIReportResponseExample:
$ref: '#/components/examples/GenerateVOIReportResponseExample'
GenerateBalanceAnalyticsReportResponse:
description: >-
The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status.
headers:
Location:
schema:
type: string
description: >-
Please Check the Report status at URL
/decisioning/v4/consumers/{consumer_id}/reports/{report_id}
/decisioning/v4/customers/{customer_id}/reports/{report_id}
example: '/decisioning/v4/customers/567890/reports/sd1j45yn37wr-barpnoncra'
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportAck'
examples:
GenerateBalanceBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateBalanceBusinessCraAnalyticsReportResponseExample'
GenerateBalanceBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateBalanceBusinessNonCraAnalyticsReportResponseExample'
GenerateBalanceBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateBalanceBusinessFtcAnalyticsReportResponseExample'
GenerateBalancePersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateBalancePersonalCraAnalyticsReportResponseExample'
GenerateBalancePersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateBalancePersonalNonCraAnalyticsReportResponseExample'
GenerateCashflowAnalyticsReportResponse:
description: >-
The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status.
headers:
Location:
schema:
type: string
description: >-
Please Check the Report status at URL
/decisioning/v4/consumers/{consumer_id}/reports/{report_id}
/decisioning/v4/customers/{customer_id}/reports/{report_id}
example: '/decisioning/v4/customers/567890/reports/sd1j45yn37wr-cfrpnoncra'
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportAck'
examples:
GenerateCashflowBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateCashflowBusinessCraAnalyticsReportResponseExample'
GenerateCashflowBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateCashflowBusinessNonCraAnalyticsReportResponseExample'
GenerateCashflowBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateCashflowBusinessFtcAnalyticsReportResponseExample'
GenerateCashflowPersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateCashflowPersonalCraAnalyticsReportResponseExample'
GenerateCashflowPersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GenerateCashflowPersonalNonCraAnalyticsReportResponseExample'
GeneratePaymentHistoryReportResponse:
description: >-
The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status.
headers:
Location:
schema:
type: string
description: >-
Please Check the Report status at URL
/decisioning/v3/customers/{customer_id}/reports/{report_id}
/decisioning/v3/consumers/{consumer_id}/reports/{report_id}
example: '/decisioning/v3/customers/567890/reports/sd1j45yn37wr-phrbcra'
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsReportAck'
examples:
GeneratePaymentHistoryBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessCraAnalyticsReportResponseExample'
GeneratePaymentHistoryBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessNonCraAnalyticsReportResponseExample'
GeneratePaymentHistoryBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/GeneratePaymentHistoryBusinessFtcAnalyticsReportResponseExample'
SecurityFreezeErrorResponse:
description: 'The active security freeze for this consumer exists.'
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityFreezeErrorMessage'
examples:
SecurityFreezeErrorExample:
$ref: '#/components/examples/SecurityFreezeErrorExample'
DisputeStatementErrorResponse:
description: 'The active dispute statement for this consumer exists.'
content:
application/json:
schema:
$ref: '#/components/schemas/DisputeStatementErrorMessage'
examples:
SecurityFreezeErrorExample:
$ref: '#/components/examples/DisputeStatementErrorExample'
GetReportResponse:
description: The report was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
examples:
ForesightAnalyticsNonCraReportResponseExample:
$ref: '#/components/examples/ForesightAnalyticsNonCraReportResponseExample'
BalanceBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessCraAnalyticsReportResponseExample'
BalanceBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessNonCraAnalyticsReportResponseExample'
BalanceBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessFtcAnalyticsReportResponseExample'
BalancePersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalancePersonalCraAnalyticsReportResponseExample'
BalancePersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalancePersonalNonCraAnalyticsReportResponseExample'
CashflowBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessCraAnalyticsReportResponseExample'
CashflowBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessNonCraAnalyticsReportResponseExample'
CashflowBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessFtcAnalyticsReportResponseExample'
CashflowPersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowPersonalCraAnalyticsReportResponseExample'
CashflowPersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowPersonalNonCraAnalyticsReportResponseExample'
CashFlowPersonalReportExample:
$ref: '#/components/examples/CashFlowPersonalReportExample'
CashFlowBusinessReportExample:
$ref: '#/components/examples/CashFlowBusinessReportExample'
PrequalificationCRAReportExample:
$ref: '#/components/examples/PrequalificationCRAReportExample'
PrequalificationNonCRAReportExample:
$ref: '#/components/examples/PrequalificationNonCRAReportExample'
PaymentHistoryBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessCraAnalyticsReportResponseExample'
PaymentHistoryBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessNonCraAnalyticsReportResponseExample'
PaymentHistoryBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessFtcAnalyticsReportResponseExample'
PayStatementReportExample:
$ref: '#/components/examples/PayStatementReportExample'
StatementReportExample:
$ref: '#/components/examples/StatementReportExample'
TransactionsReportExample:
$ref: '#/components/examples/TransactionsReportExample'
TransactionNONCRAExample:
$ref: '#/components/examples/TransactionNONCRAExample'
VOAReportExample:
$ref: '#/components/examples/VOAReportExample'
VOAWithIncomeReportExample:
$ref: '#/components/examples/VOAWithIncomeReportExample'
VOIEWithStatementReportExample:
$ref: '#/components/examples/VOIEWithStatementReportExample'
VOEPayrollReportExample:
$ref: '#/components/examples/VOEPayrollReportExample'
VOETransactionsReportExample:
$ref: '#/components/examples/VOETransactionsReportExample'
VOIReportExample:
$ref: '#/components/examples/VOIReportExample'
VOIEPayrollReportExample:
$ref: '#/components/examples/VOIEPayrollReportExample'
VOIEPaystubReportExample:
$ref: '#/components/examples/VOIEPaystubReportExample'
VOIEPaystubWithTXVerifyReportExample:
$ref: '#/components/examples/VOIEPaystubWithTXVerifyReportExample'
GetReportWithFirstThirdPartyResponse:
description: The report was successfully retrieved
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Report'
- $ref: '#/components/schemas/ReportWithFirstThirdParty'
examples:
ForesightAnalyticsNonCraReportResponseExample:
$ref: '#/components/examples/ForesightAnalyticsNonCraReportResponseExample'
ForesightAnalyticsFirstThirdPartyNonCraReportResponseExample:
$ref: '#/components/examples/ForesightAnalyticsFirstThirdPartyNonCraReportResponseExample'
BalanceBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessCraAnalyticsReportResponseExample'
BalanceBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessNonCraAnalyticsReportResponseExample'
BalanceBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/BalanceBusinessFtcAnalyticsReportResponseExample'
BalancePersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalancePersonalCraAnalyticsReportResponseExample'
BalancePersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/BalancePersonalNonCraAnalyticsReportResponseExample'
CashFlowBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessCraAnalyticsReportResponseExample'
CashFlowBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessNonCraAnalyticsReportResponseExample'
CashFlowBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowBusinessFtcAnalyticsReportResponseExample'
CashFlowPersonalCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowPersonalCraAnalyticsReportResponseExample'
CashFlowPersonalNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/CashflowPersonalNonCraAnalyticsReportResponseExample'
CashFlowPersonalReportExample:
$ref: '#/components/examples/CashFlowPersonalReportExample'
CashFlowBusinessReportExample:
$ref: '#/components/examples/CashFlowBusinessReportExample'
SbcaRetailSalesAnalyticsReportExample:
$ref: '#/components/examples/GenerateRetailSalesAnalyticsReportExample'
SbcaRetailSalesBenchmarksReportExample:
$ref: '#/components/examples/GenerateRetailSalesBenchmarksReportExample'
PrequalificationCRAReportExample:
$ref: '#/components/examples/PrequalificationCRAReportExample'
PrequalificationNonCRAReportExample:
$ref: '#/components/examples/PrequalificationNonCRAReportExample'
PaymentHistoryBusinessCraAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessCraAnalyticsReportResponseExample'
PaymentHistoryBusinessNonCraAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessNonCraAnalyticsReportResponseExample'
PaymentHistoryBusinessFtcAnalyticsReportResponseExample:
$ref: '#/components/examples/PaymentHistoryBusinessFtcAnalyticsReportResponseExample'
PayStatementReportExample:
$ref: '#/components/examples/PayStatementReportExample'
StatementReportExample:
$ref: '#/components/examples/StatementReportExample'
TransactionsReportExample:
$ref: '#/components/examples/TransactionsReportExample'
VOAReportExample:
$ref: '#/components/examples/VOAReportExample'
VOAWithIncomeReportExample:
$ref: '#/components/examples/VOAWithIncomeReportExample'
VOEPayrollReportExample:
$ref: '#/components/examples/VOEPayrollReportExample'
VOETransactionsReportExample:
$ref: '#/components/examples/VOETransactionsReportExample'
VOIReportExample:
$ref: '#/components/examples/VOIReportExample'
VOIEPayrollReportExample:
$ref: '#/components/examples/VOIEPayrollReportExample'
VOIEPaystubReportExample:
$ref: '#/components/examples/VOIEPaystubReportExample'
VOIEPaystubWithTXVerifyReportExample:
$ref: '#/components/examples/VOIEPaystubWithTXVerifyReportExample'
GetReportsResponse:
description: The reports summaries were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ReportSummaries'
GetBillingResellerReportResponse:
description: Get the reseller as well as own reports.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingResellerReport'
examples:
GetBillingResellerReportExample:
$ref: '#/components/examples/BillingResellerReportExample'
GetAssetByCustomerIDResponse:
description: The asset was successfully downloaded
content:
application/octet-stream:
schema:
type: string
format: binary
GetCustomerAccountStatementResponse:
description: The statement was successfully downloaded as a PDF file
content:
application/octet-stream:
schema:
type: string
format: binary
StoreCustomerPayStatementResponse:
description: The pay statement was successfully uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
GenerateVOETransactionsReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOETransactionsReportAck'
examples:
GenerateVOETransactionsReportResponseExample:
$ref: '#/components/examples/GenerateVOETransactionsReportResponseExample'
GeneratePayStatementReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/PayStatementReportAck'
examples:
GeneratePayStatementReportResponseExample:
$ref: '#/components/examples/GeneratePayStatementReportResponseExample'
GenerateCashFlowReportBusinessResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/CashFlowReportAck'
examples:
GenerateCashFlowReportBusinessResponseExample:
$ref: '#/components/examples/GenerateCashFlowReportBusinessResponseExample'
GenerateCashFlowReportPersonalResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/CashFlowReportAck'
examples:
GenerateCashFlowReportPersonalResponseExample:
$ref: '#/components/examples/GenerateCashFlowReportPersonalResponseExample'
GenerateVOIEPaystubWithTXVerifyReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOIEPaystubWithTXVerifyReportAck'
examples:
GenerateVOIEPaystubWithTXVerifyReportResponseExample:
$ref: '#/components/examples/GenerateVOIEPaystubWithTXVerifyReportResponseExample'
GenerateVOIEPaystubReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/VOIEPaystubReportAck'
examples:
GenerateVOIEPaystubReportResponseExample:
$ref: '#/components/examples/GenerateVOIEPaystubReportResponseExample'
GenerateStatementReportResponse:
description:
"The report is being generated. When finished, a notification will be
sent to the specified callback URL (Report Listener Service) and the
report can be fetched using Get Report APIs. If you don't use a callback
URL, Get Report returns a minimal report with the following status:
'inProgress'. Repeat the call every 20 seconds until Get Report returns
a different status."
content:
application/json:
schema:
$ref: '#/components/schemas/StatementReportAck'
examples:
GenerateStatementReportResponseExample:
$ref: '#/components/examples/GenerateStatementReportResponseExample'
GetCustomerTransactionsResponse:
description: The transactions were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
GetCustomerTransactionResponse:
description: The transaction was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
GetAccountACHDetailsResponse:
description: Account ACH details were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ACHDetails'
GetAvailableBalanceResponse:
description: The balance was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AvailableBalance'
GetAvailableBalanceLiveResponse:
description: The live balance was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AvailableBalance'
GetLoanPaymentDetailsResponse:
description: The loan payment details were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/LoanPaymentDetails'
GetPortfolioByCustomerResponse:
description: The portfolio was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioSummary'
GetPortfolioByConsumerResponse:
description: The portfolio was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioWithConsumerSummary'
DeleteTxPushSubscriptionResponse:
description: The subscription was successfully deleted
DisableTxPushNotificationsResponse:
description: Subscriptions were successfully deleted for the given account
SubscribeToTxPushNotificationsResponse:
description: The subscription was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/TxPushSubscriptions'
CreateTxPushTestTransactionResponse:
description: The test notification was successfully sent
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedTestTxPushTransaction'
AuthenticationUnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check Partner ID,
Partner Secret or Finicity-App-Key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFinicityAppKeyExample:
$ref: '#/components/examples/MissingFinicityAppKeyExample'
InvalidCredentialsExample:
$ref: '#/components/examples/InvalidCredentialsExample'
UnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check
"Finicity-App-Key" or "Finicity-App-Token".
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ExpiredTokenExample:
$ref: '#/components/examples/ExpiredTokenExample'
MissingFinicityAppKeyExample:
$ref: '#/components/examples/MissingFinicityAppKeyExample'
MissingFinicityAppTokenExample:
$ref: '#/components/examples/MissingFinicityAppTokenExample'
InvalidFinicityAppTokenExample:
$ref: '#/components/examples/InvalidFinicityAppTokenExample'
ExpiredFinicityAppTokenExample:
$ref: '#/components/examples/ExpiredFinicityAppTokenExample'
BadCredentialsExample:
$ref: '#/components/examples/BadCredentialsExample'
text/plain:
schema:
type: string
example: 'Invalid (Finicity-App-Key)'
ExternalSwitchesUnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check
"Finicity-App-Key" or "Finicity-App-Token".
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFinicityAppKeyExample:
$ref: '#/components/examples/MissingFinicityAppKeyExample'
text/plain:
schema:
type: string
example: 'Invalid (Finicity-App-Key)'
BadRequestErrorTransactionResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
GenericBadRequestError:
$ref: '#/components/examples/GenericBadRequestError'
GeneralBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
GenericBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
BadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
PermissiblePurposeCodeExample:
$ref: '#/components/examples/PermissiblePurposeCodeExample'
InvalidForesightReportRequestExample:
$ref: '#/components/examples/InvalidForesightReportRequestExample'
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
InvalidFieldExample:
$ref: '#/components/examples/InvalidFieldExample'
InvalidExperienceFieldExample:
$ref: '#/components/examples/InvalidExperienceFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
AccountTypeNotSupportedExample:
$ref: '#/components/examples/AccountTypeNotSupportedExample'
ResellerPartnerNotAuthorizedExample:
$ref: '#/components/examples/ResellerPartnerNotAuthorizedExample'
ResellerInvalidDateRangeExample:
$ref: '#/components/examples/ResellerInvalidDateRangeExample'
ResellerInvalidDateRangeLessThanZeroExample:
$ref: '#/components/examples/ResellerInvalidDateRangeLessThanZeroExample'
ResellerInvalidDateRangeGreaterThanEndDateExample:
$ref: '#/components/examples/ResellerInvalidDateRangeGreaterThanEndDateExample'
ResellerInvalidDateRangeGreaterThan31DaysExample:
$ref: '#/components/examples/ResellerInvalidDateRangeGreaterThan31DaysExample'
CustomerReportLimitExceedExample:
$ref: '#/components/examples/CustomerReportLimitExceedExample'
InvalidValue:
$ref: '#/components/examples/InvalidValueExample'
InitiateMicroEntriesBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InvalidMemoExample:
$ref: '#/components/examples/InvalidMemoExample'
InvalidRoutingNumberExample:
$ref: '#/components/examples/InvalidRoutingNumberExample'
InvalidAccountNameExample:
$ref: '#/components/examples/InvalidAccountNameExample'
InvalidAccountNumberExample:
$ref: '#/components/examples/InvalidAccountNumberExample'
AccountAlreadyExistsExample:
$ref: '#/components/examples/AccountAlreadyExistsExample'
MicrodepositsInitiationFailedExample:
$ref: '#/components/examples/MicrodepositsInitiationFailedExample'
MicrodepositsProcessingFailedExample:
$ref: '#/components/examples/MicrodepositsProcessingFailedExample'
TooManyRequestsExample:
$ref: '#/components/examples/TooManyRequestsExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
TooManyRequestsErrorResponse:
description:
The service can't accept more requests or is not available from the Test
Drive.
GetAssetNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
AssetNotFoundExample:
$ref: '#/components/examples/AssetNotFoundExample'
ResourceNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ConsumerNotFoundExample:
$ref: '#/components/examples/ConsumerNotFoundExample'
NoAccountForInstitutionLoginIdExample:
$ref: '#/components/examples/NoAccountForInstitutionLoginIdExample'
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
NoConsumerForCustomerExample:
$ref: '#/components/examples/NoConsumerForCustomerExample'
ResourceNotFoundExample:
$ref: '#/components/examples/ResourceNotFoundExample'
NoRegisteredApplicationExample:
$ref: '#/components/examples/NoRegisteredApplicationExample'
ResellerNoDataForPartnerExample:
$ref: '#/components/examples/ResellerNoDataForPartnerExample'
ResellerNoReportForPartnerExample:
$ref: '#/components/examples/ResellerNoReportForPartnerExample'
ForbiddenErrorResponse:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ForbiddenErrorResponseExample:
$ref: '#/components/examples/ForbiddenErrorResponseExample'
NotAllowedErrorResponse:
description: Not allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NotAllowedErrorResponseExample:
$ref: '#/components/examples/NotAllowedErrorResponseExample'
GetApplicationRegistrationStatusResourceNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ApplicationIdNotFoundExample:
$ref: '#/components/examples/ApplicationIdNotFoundExample'
ApplicationRegistrationStatusNotFoundExample:
$ref: '#/components/examples/ApplicationRegistrationStatusNotFoundExample'
ConflictErrorResponse:
description: The resource already exists
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ConsumerExistsConflictExample:
$ref: '#/components/examples/ConsumerExistsConflictExample'
AddCustomerConflictErrorResponse:
description: The resource already exists
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
UsernameNotAvailableExample:
$ref: '#/components/examples/UsernameNotAvailableExample'
InitiateMicroAmountDepositsResponse:
description: Micro entries were successfully initiated
content:
application/json:
schema:
$ref: '#/components/schemas/InitiatedMicroDeposit'
VerifyMicroAmountDepositsResponse:
description: Micro entries were successfully verified
content:
application/json:
schema:
$ref: '#/components/schemas/VerifiedMicroDeposit'
VerifyMicroAmountDepositsBadRequestErrorResponse:
description:
Micro entries verification failed. status field could be any except
"Verified" and "Completed".
content:
application/json:
schema:
$ref: '#/components/schemas/MicroDepositVerificationError'
examples:
InvalidAmountFormatExample:
$ref: '#/components/examples/InvalidAmountFormatExample'
MicrodepositStatusErrorExample:
$ref: '#/components/examples/MicrodepositStatusErrorExample'
MicrodepositVerificationAttemptsExample:
$ref: '#/components/examples/MicrodepositVerificationAttemptsExample'
MicrodepositAmountsDidNotMatchExample:
$ref: '#/components/examples/MicrodepositAmountsDidNotMatchExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
GetMicroDepositsDetailsResponse:
description: Micro entries were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/MicroDepositDetails'
GetAccountACHDetailsBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
InvalidFieldExample:
$ref: '#/components/examples/InvalidFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
AccountTypeNotSupportedExample:
$ref: '#/components/examples/AccountTypeNotSupportedExample'
GetAvailableBalanceLiveBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
InvalidFieldExample:
$ref: '#/components/examples/InvalidFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
AccountTypeNotSupportedExample:
$ref: '#/components/examples/AccountTypeNotSupportedExample'
GetAvailableBalanceBadRequestErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
InvalidFieldExample:
$ref: '#/components/examples/InvalidFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
AccountTypeNotSupportedExample:
$ref: '#/components/examples/AccountTypeNotSupportedExample'
GetApplicationsStatusBadErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InvalidStartValueExample:
$ref: '#/components/examples/InvalidStartValueExample'
InvalidLimitValueExample:
$ref: '#/components/examples/InvalidLimitValueExample'
LimitValueExceededExample:
$ref: '#/components/examples/LimitValueExceededExample'
InvalidQueryParametersExample:
$ref: '#/components/examples/InvalidQueryParametersExample'
InvalidQueryParametersValueExample:
$ref: '#/components/examples/InvalidQueryParametersValueExample'
GetApplicationsRegistrationStatusBadErrorResponse:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InvalidStartValueExample:
$ref: '#/components/examples/InvalidStartValueExample'
InvalidLimitValueExample:
$ref: '#/components/examples/InvalidLimitValueExample'
LimitValueExceededExample:
$ref: '#/components/examples/LimitValueExceededExample'
CustomerAuthorizationDetails:
description:
Successfully retrieved customer authorization details by institution
login id.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAuthorizationDetails'
examples:
CustomerAuthorizationDetailsExample:
$ref: '#/components/examples/CustomerAuthorizationDetailsExample'
GenerateThirdPartyAccessKeyResponse:
description: The third party access key was successfully generated
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyAccessKeyReceiptData'
UpdateThirdPartyAccessKeyResponse:
description: The third party access key was successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdPartyAccessKeyReceiptData'
RevokeThirdPartyAccessKeyResponse:
description: The third party access key was successfully revoked
GetAccountOwnerDetailsResponse:
description: The account owner was successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/AccountOwnerHolders'
GetAccountPaymentInstructionDetailsResponse:
description: Account ACH details were successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstructions'
examples:
ACHDetailsV3Example:
$ref: '#/components/examples/ACHDetailsV3Example'
ACHDetailsWithoutRTPDetailsV3Example:
$ref: >-
#/components/examples/ACHDetailsWithoutRTPDetailsV3Example
ACHDetailsExampleWithoutFedNowV3Example:
$ref: >-
#/components/examples/ACHDetailsExampleWithoutFedNowV3Example
ACHDetailsExampleWithoutFedNowAndWithoutRTPV3Example:
$ref: >-
#/components/examples/ACHDetailsExampleWithoutFedNowAndWithoutRTPV3Example
CustomerAuthorizationDetailsExample:
$ref: '#/components/examples/CustomerAuthorizationDetailsExample'
GetCustomerAuthorizationDetailsNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InstitutionLoginIdNotFoundErrorResponseExample:
$ref: '#/components/examples/InstitutionLoginIdNotFoundErrorResponseExample'
InstitutionLoginIdDetailsNotFoundErrorResponseExample:
$ref: '#/components/examples/InstitutionLoginIdDetailsNotFoundErrorResponseExample'
GetAccountPaymentInstructionBadRequestErrorResponse:
description: The request was rejected due to validation failures
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InstitutionLoginIdNotFoundErrorResponseExample:
$ref: '#/components/examples/InstitutionLoginIdNotFoundErrorResponseExample'
InstitutionLoginIdDetailsNotFoundErrorResponseExample:
$ref: '#/components/examples/InstitutionLoginIdDetailsNotFoundErrorResponseExample'
MissingFieldExample:
$ref: '#/components/examples/MissingFieldExample'
InvalidFieldExample:
$ref: '#/components/examples/InvalidFieldExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
AccountTypeNotSupportedExample:
$ref: '#/components/examples/AccountTypeNotSupportedExample'
GetAllExperienceResponse:
description: Successful response. Returns all retrieved Experience.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Experiences'
BadRequestResponse:
description: The request was rejected.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
BadRequest:
$ref: '#/components/examples/BadRequest'
GetExternalSwitchesBadRequestResponse:
description: The request was rejected.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NoMatchingExternalIdFoundErrorResponseExample:
$ref: '#/components/examples/NoMatchingExternalIdFoundErrorResponseExample'
ResourceNotFoundResponse:
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ResourceNotFoundRequest:
$ref: '#/components/examples/ResourceNotFoundRequest'
ExternalSwitchesResourceNotFoundResponse:
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ResourceNotFoundRequest:
$ref: '#/components/examples/GetExternalSwitchesResourceNotFoundErrorExample'
DepositSwitchesSummary:
description: Deposit switches performed by the customer
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchesSummary'
examples:
SwitchesSummaryExample:
$ref: '#/components/examples/SwitchesSummaryExample'
ExternalDepositSwitchesSummary:
description: In-branch deposit switches performed by the external ID
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDepositSwitchesSummary'
examples:
SwitchesSummaryExample:
$ref: '#/components/examples/ExternalSwitchesSummaryExample'
DepositSwitchDetails:
description: Deposit switch details
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchDetails'
examples:
DepositSwitchDetailsSuccessExample:
$ref: '#/components/examples/DepositSwitchDetailsSuccessExample'
DepositSwitchDetailsFailureExample:
$ref: '#/components/examples/DepositSwitchDetailsFailureExample'
PaySwitchesSummary:
description: Pay switches performed by the customer
content:
application/json:
schema:
$ref: '#/components/schemas/PaySwitchesSummary'
examples:
PaySwitchesSummaryExample:
$ref: '#/components/examples/SwitchesSummaryExample'
PaySwitchDetails:
description: Pay switch details
content:
application/json:
schema:
$ref: '#/components/schemas/PaySwitchDetails'
examples:
PaySwitchDetailsCardSuccessExample:
$ref: '#/components/examples/PaySwitchDetailsCardSuccessExample'
PaySwitchDetailsAccountSuccessExample:
$ref: '#/components/examples/PaySwitchDetailsAccountSuccessExample'
PaySwitchDetailsFailureExample:
$ref: '#/components/examples/PaySwitchDetailsFailureExample'
SwitchDetailsNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
SwitchDetailsNotFoundExample:
$ref: '#/components/examples/SwitchDetailsNotFoundExample'
ResourceNotFoundExample:
$ref: '#/components/examples/ResourceNotFoundExample'
ObwmsUnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check "App-Key" or
"App-Token".
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorWrapper'
examples:
ExpiredTokenExample:
$ref: '#/components/examples/ObwmsExpiredTokenExample'
MissingAppKeyExample:
$ref: '#/components/examples/MissingAppKeyExample'
ObwmsResourceNotFounderrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorWrapper'
examples:
ResourceNotFoundExample:
$ref: '#/components/examples/ObmwsResourceNotFoundExample'
ObwmsBadRequestErrorResponse:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorWrapper'
examples:
BadRequestErrorResponseExample:
$ref: '#/components/examples/BadRequestErrorResponseExample'
SubscriptionCreatedResponse:
description: Subscription created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionDetail'
examples:
SubscriptionCreatedResponseExample:
$ref: '#/components/examples/SubscriptionCreatedResponseExample'
SubscriptionUpdatedResponse:
description: Subscription updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionDetail'
examples:
SubscriptionCreatedResponseExample:
$ref: '#/components/examples/SubscriptionCreatedResponseExample'
EventUpdatedResponse:
description: Event updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookEvent'
examples:
SubscriptionCreatedResponseExample:
$ref: '#/components/examples/EventUpdatedResponseExample'
EventStatusUpdatedResponse:
description: Event updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/EventStatusUpdate'
SubscriptionDeletedResponse:
description: Subscription deleted successfully
EventDeletedResponse:
description: Event deleted successfully
SubscriptionsResponse:
description:
List of all subscriptions with pagination and availability details.
content:
application/json:
schema:
$ref: '#/components/schemas/Subscriptions'
examples:
SubscriptionsResponseExample:
$ref: '#/components/examples/SubscriptionsResponseExample'
SubscriptionDetail:
description: Subscription detail by ID
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionDetail'
examples:
SubscriptionDetailExample:
$ref: '#/components/examples/SubscriptionDetailResponseExample'
MfaChallenge:
description: MFA challenges required to log in
content:
application/json:
schema:
type: array
items:
type: object
properties:
mfaChallenges:
type: array
minItems: 1
description:
The required MFA Challenges required in order to log in.
items:
type: object
required:
- id
- prompt
- mfaType
- choiceIds
- eventStreamId
properties:
id:
type: string
description: The unique identifier for the MFA challenge
format: uuid
example: 9082affa-d965-40be-a3ed-a320bb3467ff
minLength: 36
maxLength: 36
mfaType:
type: string
description: >-
The type of MFA challenge:
* TFA_TEXT: This challenge type will present a
single input box to the customer and is commonly used
for things like One-Time Passwords.
* TFA_CHOICE: The TFA_CHOICE object represents a
multiple choice question and answer selection.
* TFA_MULTI: The TFA_MULTI challenge type will
present the customer with multiple images to select
from.
* TFA_IMAGE: A TFA_IMAGE challenge will present a
captcha-style image the customer will need to
decipher.
example: TFA_TEXT
prompt:
type: string
description: The MFA prompt text
example: 'Which high school did you attend'
choiceIds:
type: array
description:
An array of unique identifiers for the MFA choices
items:
type: string
description: The unique identifier for the MFA choice
format: uuid
example: '9082affa-d965-40be-a3ed-a320bb3467ff'
minLength: 36
maxLength: 36
AvailableEventsResponse:
description: List of all available events.
content:
application/json:
schema:
type: object
required:
- events
properties:
events:
type: array
description: List of available events.
items:
$ref: '#/components/schemas/AvailableEvent'
examples:
AvailableEventsResponseExample:
$ref: '#/components/examples/AvailableEventsResponseExample'
TestWebhookSubscriptionResponse:
description: test subscription submitted successfully.
NoBody:
description: Empty Response Body
GenerateOAuthUrl:
description: >-
The returned oauth url, as well as a reference back to this resource in
case modifications are needed
content:
application/json:
schema:
type: object
description: The response object for requests to generate OAuth URLs
required:
- id
- url
- eventStreamId
example:
id: 8d9d8f5e-2c5f-4f49-bf9b-276a7df0367f
url: 'https://example.com'
eventStreamId: 208a1170-875e-4656-85d0-27dfc3ee7137
properties:
id:
type: string
format: uuid
example: 8d9d8f5e-2c5f-4f49-bf9b-276a7df0367f
minLength: 36
maxLength: 36
description: Unique reference to the login session
url:
type: string
format: uri
example: 'https://example.com'
minLength: 1
maxLength: 1024
description: The oauth url to direct the user to
eventStreamId:
$ref: '#/components/schemas/EventStreamId'
LoginForms:
description: Generate a new login form entry
content:
application/json:
schema:
type: object
description:
The data used by the calling application to render a login form
example:
id: 8d9d8f5e-2c5f-4f49-bf9b-276a7df0367f
eventStreamId: 208a1170-875e-4656-85d0-27dfc3ee7137
elements:
- id: 26410b1f-0347-4d57-bb03-f44d00e785e2
label: username
sortOrder: 0
- id: f2ce62c2-877f-4c26-9935-d1ab6084e6d0
label: password
sortOrder: 1
properties:
id:
type: string
minLength: 36
maxLength: 36
example: 8d9d8f5e-2c5f-4f49-bf9b-276a7df0367f
format: uuid
description:
The unique identifier associated with this session'ed form
eventStreamId:
$ref: '#/components/schemas/EventStreamId'
elements:
type: array
description: An array of elements that is to be rendered
items:
type: object
minProperties: 1
maxProperties: 10
properties:
id:
type: string
format: uuid
minLength: 36
maxLength: 36
example: 26410b1f-0347-4d57-bb03-f44d00e785e2
description:
The session specific identifier for the login form
element
label:
type: string
description: The human-readable name of the element
example: Username
minLength: 1
maxLength: 512
sortOrder:
type: integer
default: 0
example: 0
minimum: 0
maximum: 10
description:
A hint to indicate what order to render the elements in
required:
- id
- label
- sortOrder
required:
- id
- elements
- eventStreamId
Configuration:
description: An object used to modify the login behavior
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
Configurations:
description: Array of available configurations
content:
application/json:
schema:
type: array
description:
The array of configuration objects associated with this partner
items:
$ref: '#/components/schemas/Configuration'
Unauthorized:
description: >-
The request lacks valid authentication credentials. Check
"Finicity-App-Key" or "Finicity-App-Token".
content:
application/json:
schema:
$ref: '#/components/schemas/GoldStandardErrorMessage'
examples:
ExpiredTokenExample:
$ref: '#/components/examples/GoldStandardExpiredToken'
MissingFinicityAppKeyExample:
$ref: '#/components/examples/GoldStandardMissingFinicityAppKey'
BadRequest:
description: The request was rejected
content:
application/json:
schema:
$ref: '#/components/schemas/GoldStandardErrorMessage'
examples:
InvalidFieldExample:
$ref: '#/components/examples/GoldStandardInvalidField'
ResourceNotFound:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/GoldStandardErrorMessage'
examples:
ResourceNotFoundExample:
$ref: '#/components/examples/GoldStandardResourceNotFound'
EnrichedTransactions:
description: Enriched Transactions Response.
content:
application/json:
schema:
$ref: '#/components/schemas/EnrichedTransactions'
examples:
EnrichedTransactionsExample:
$ref: '#/components/examples/EnrichedTransactionsExample'
NotFoundErrorResponse:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
DataNotFoundError:
$ref: '#/components/examples/DataNotFoundError'
GetPaymentEnablementBundleResponse:
description: We successfully fetched the requested details
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentEnablementBundle'
examples:
PaymentEnablementBundleResponse:
$ref: '#/components/examples/PaymentEnablementBundleResponseExample'
PaymentEnablementBundleResponseWithError:
$ref: '#/components/examples/PaymentEnablementBundleWithErrorResponseExample'
GetPaymentEnablementBundleResourceNotFoundForAccountIdErrorResponse:
description: Customer ID or Account ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NoAccountForCustomerIdExample:
$ref: '#/components/examples/NoAccountForCustomerIdExample'
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
GetPaymentEnablementBundleResourceNotFoundForInstitutionLoginIdErrorResponse:
description: >-
The requested details do not match with the existing details or you
requested something we don't have or was deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
NoAccountForInstitutionLoginIdExample:
$ref: '#/components/examples/NoAccountForInstitutionLoginIdExamplePEB'
CustomerNotFoundExample:
$ref: '#/components/examples/CustomerNotFoundExample'
GetPaymentEnablementBundleBadRequestErrorResponse:
description: >-
We couldn't handle your request, see response payload for more
information.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
InvalidFieldParameterExample:
$ref: '#/components/examples/InvalidFieldParameterExample'
GenericBadRequestExample:
$ref: '#/components/examples/GenericBadRequestExample'
GenerateSBCAMetricsReportRequest:
description: >-
Request constraints to generate Small Business Credit Analytics report.
Based on parameter provided either of following report will be
generated:<\br> - Small Business Credit Analytics Report - Small
Business Credit Benchmark Report
content:
application/json:
schema:
$ref: '#/components/schemas/SBCAMetricsReportConstraints'
GenerateSBCAReportResponse:
description: >-
The report provides real-time transaction-based insights to build a
more complete view of business performance and creditworthiness, helping
them underwrite more businesses and reduce risk.
The report can also be fetched using Get Report APIs at later times.
content:
application/json:
schema:
description: >-
A generated report for Small Business Credit Analytics. Based
of report type either `retailSalesAnalyticsMetrics` or
`retailSalesBenchmarkMetrics` will be available in the report.
oneOf:
- $ref: '#/components/schemas/SBCAAnalyticsReport'
- $ref: '#/components/schemas/SBCABenchmarkReport'
examples:
GenerateRetailSalesAnalyticsReportExample:
$ref: '#/components/examples/GenerateRetailSalesAnalyticsReportExample'
GenerateRetailSalesBenchmarksReportExample:
$ref: '#/components/examples/GenerateRetailSalesBenchmarksReportExample'
SBCABadRequestErrorResponse:
description:
The request was rejected to Generate Small Business Credit Analytics
report
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingSBCAMandatoryDataExample:
$ref: '#/components/examples/MissingSBCAMandatoryDataExample'
InvalidSBCADataExample:
$ref: '#/components/examples/InvalidSBCADataExample'
InvalidSBCADataCombinationExample:
$ref: '#/components/examples/InvalidSBCADataCombinationExample'
SmallBusinessReportBadRequestErrorResponse:
description:
The request is rejected to Generate Small Business Credit Analytics
report
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MissingSBCAMandatoryDataExample:
$ref: '#/components/examples/MissingMandatoryDataSmallBusinessReportExample'
InvalidSBCADataExample:
$ref: '#/components/examples/InvalidDataSmallBusinessReportExample'
InvalidLocationIdExample:
$ref: '#/components/examples/InvalidLocationIdSmallBusinessReportExample'
InvalidBusinessIdSmallBusinessReportExample:
$ref: '#/components/examples/InvalidBusinessIdSmallBusinessReportExample'
InvalidCountryCodeSmallBusinessReportExample:
$ref: '#/components/examples/InvalidCountryCodeSmallBusinessReportExample'
InvalidPhoneCodeSmallBusinessReportExample:
$ref: '#/components/examples/InvalidPhoneCodeSmallBusinessReportExample'
SBCAUnauthorizedErrorResponse:
description: >-
The request lacks valid authentication credentials. Check
`Finicity-App-Key` or `Finicity-App-Token`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
ExpiredTokenExample:
$ref: '#/components/examples/ExpiredTokenExample'
MissingFinicityAppKeyExample:
$ref: '#/components/examples/MissingFinicityAppKeyExample'
InvalidFinicityAppKeyExample:
$ref: '#/components/examples/InvalidFinicityAppKeyExample'
ExpiredFinicityAppTokenExample:
$ref: '#/components/examples/ExpiredFinicityAppTokenExample'
MissingFinicityAppTokenExample:
$ref: '#/components/examples/MissingFinicityAppTokenExample'
SBCAResourceNotFoundErrorResponse:
description: The resource doesn't exist
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
examples:
MetricsNotFoundExample:
$ref: '#/components/examples/MetricsNotFoundExample'
examples:
LocationMatchesResponseExample:
value:
locationMatches:
- locationId: a1b2c3d4-0000-1234-abcd-000000000001
matchRank: 1
merchantName: Artisan Emporium
streetAddress: 2000 Purchase St
city: Purchase
state: NY
postalCode: 10577
countryCode: USA
NoLocationMatchFoundExample:
value:
code: '10100'
message: 'No potential location matches found.'
MissingSbcaMandatoryDataExample:
value:
code: '10020'
status: '400'
message: 'Data missing : MerchantName, streetAddress.'
user_message: >-
One or more of the fields are missing. Please ensure you have entered
the correct data.
InvalidSbcaDataExample:
value:
code: '10025'
status: '400'
message: 'Invalid data: IdType, IdValue.'
user_message: The data provided in one or more fields is invalid.
InvalidSbcaDataCombinationExample:
value:
code: '10030'
status: '400'
message: 'Invalid data combination.'
user_message: >-
Both Idtype/Idvalue and Merchant name/Address data combinations are
present in the input.
TransactionNotFoundExample:
value:
code: 24553
message: Transaction not found.
GenerateForesightAnalyticsNonCraReportRequestExample:
value:
fromDate: 1580558400
accountIds: '1000535275 1000535276'
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 26
GenerateForesightAnalyticsFirstThirdPartyNonCraReportRequestExample:
value:
customerId: 1001483250
externalCustomerId: 1234abcd
fromDate: 1580558400
accountIds: '1000535275 1000535276'
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 26
GenerateForesightAnalyticsNonCraReportResponseExample:
value:
id: 247th25xwyhd-farpbfnoncra
customerType: testing
customerId: 1001483250
requestId: y3pic4xhda
requesterName: Intuit Facade Demo (KEEP)
createdDate: 1739824892
title: Mastercard Open Banking Foresight Analytics
reportPin: XYeyLA
type: farpbfnoncra
status: inProgress
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 26
GenerateForesightAnalyticsFirstThirdPartyNonCraReportResponseExample:
value:
id: 247th25xwyhd-farpbfnoncra
customerType: testing
customerId: 1001483250
externalCustomerId: 1234abcd
requestId: y3pic4xhda
requesterName: Intuit Facade Demo (KEEP)
createdDate: 1739824892
title: Mastercard Open Banking Foresight Analytics
reportPin: XYeyLA
type: farpbfnoncra
status: inProgress
constraints:
customerId: 1001483250
externalCustomerId: 1234abcd
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 26
TimedOutRequestErrorMessage:
value:
code: '10030'
status: '408'
title: Request timed out.
level: error
message: Please try again at a later time.
IdMatchBadRequestErrorMessage:
value:
code: '14020'
status: '400'
title: Bad Request
level: error
message: Bad Request While Calling Identity Matching api
AOV3BadRequestErrorMessage:
value:
code: '14020'
status: '400'
title: Bad Request
level: error
message: Bad Request While Calling AOV3 api
AccountOwnerVerificationMissingField:
value:
code: '15001'
status: '400'
title: Missing required field
level: error
message: One of the specified fields is missing or blank.
AccountsDetailsNotFound:
value:
code: '12017'
status: '404'
title: No Account Owners Details Found.
level: error
message: No Account Owners Details Found.
BusinessIdNotFound:
value:
code: 10003
message: Business ID was not found.
status: '404'
title: Business ID was not found.
user_message: Business ID was not found.
CustomerIdNotFound:
value:
code: 10002
message: Customer ID was not found.
status: '404'
title: Customer ID was not found.
user_message: Customer ID was not found.
MissingFinicityAppKeyExample:
value:
code: 10026
message: Missing parameter (Finicity-App-Key)
MissingFinicityAppTokenExample:
value:
code: 10024
message: Missing parameter (Finicity-App-Token)
InvalidFinicityAppKeyExample:
value:
code: '10027'
message: Invalid parameter (Finicity-App-Key)
InvalidFinicityAppTokenExample:
value:
code: 10022
message: Invalid (Finicity-App-Token)
ExpiredFinicityAppTokenExample:
value:
code: 10023
message: Expired (Finicity-App-Token)
InvalidCredentialsExample:
value:
code: 10001
message: Invalid credentials
GenericBadRequestExample:
value:
code: 14020
message: Bad request.
GenericBadRequestError:
value:
code: 14020
message: Bad request.
externalTransactionId: MAC1005061234
ResellerPartnerNotAuthorizedExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Partner is not authorized to access
resellerBilling reports for partnerId 2445583947903'
ResellerNoDataForPartnerExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Reports not found 2445583947903
resellerBilling reports'
ResellerNoReportForPartnerExample:
value:
code: 10100
message: 'Cannot find resellerBilling reports with id 2445581559892.'
ResellerInvalidDateRangeExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Invalid date range - start or end date is
empty or null'
ResellerInvalidDateRangeLessThanZeroExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Invalid date range - start or end date less
than or equal to zero'
ResellerInvalidDateRangeGreaterThanEndDateExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Invalid date range - startDate is
greaterThan endDate'
ResellerInvalidDateRangeGreaterThan31DaysExample:
value:
code: 10100
message:
'RESELLER_BILLING_REPORT: Invalid date range - It is more than 31 days'
CustomerReportLimitExceedExample:
value:
code: 20400
message:
'The max report generation limit was exceeded for this customer.'
InvalidValueExample:
value:
code: 1618
message:
'Negative or invalid value entered. Please use positive numbers only.'
AccountTypeNotSupportedExample:
value:
code: 14020
message: 'Bad request. (Account type not supported).'
InvalidMemoExample:
value:
code: 3000003
message: 'Invalid memo'
InvalidRoutingNumberExample:
value:
code: 20024
message: 'Invalid routing number'
InvalidAccountNumberExample:
value:
code: 3000001
message: 'Invalid account number'
InvalidAccountIdExample:
value:
code: 38003
message:
customer does not have given account (customerId =
6018989036, accountId = [6024048234])
InvalidPurposeCodeExample:
value:
code: 10005
message: invalid purpose code
InvalidSettleByDateExample:
value:
code: 10006
message: settleByDate must not be in the past
IncorrectFieldTypeExample:
value:
code: 10007
message: '[FIELD] is the incorrect type'
AccountHasNoTransactionExample:
value:
code: 10008
message: account has no transactions
RequiredFieldParameterExample:
value:
code: 10009
message: '[FIELD] is a required parameter'
InactiveAccountExample:
value:
code: 10013
message:
Only active accounts can be used, please use a different account
MissingEmailExample:
value:
code: 12022
message: An email is required when registering a customer for PSI-FCRA
BadCredentialsExample:
value:
code: 24302
message: Bad credentials
AccountAlreadyExistsExample:
value:
code: 3100001
message: 'Account already exist'
MicrodepositsInitiationFailedExample:
value:
code: 3200001
message: 'Microdeposits initiation failed'
MicrodepositsProcessingFailedExample:
value:
code: 3000000
message:
Microdeposit initiation can't be processed at this time due to
technical difficulties. Please try after some time
InvalidAccountNameExample:
value:
code: 3100001
message: 'Account already exist'
InvalidAmountFormatExample:
value:
code: 3000003
message: 'Invalid amount format'
MicrodepositStatusErrorExample:
value:
code: 3200002
message: 'Microdeposit is in status'
MicrodepositVerificationAttemptsExample:
value:
code: 3200003
message: 'Microdeposit verification attempts exceeded'
MicrodepositAmountsDidNotMatchExample:
value:
code: 3200004
message: Microdeposit amounts didn't match
TooManyRequestsExample:
value:
code: 3300001
message: 'Too many request. Please try after some time'
MissingFieldExample:
value:
code: '10010'
status: '400'
message: '"partnerId" is required'
user_message: >-
One or more of the fields could not be validated. Please ensure you
have entered the correct data.
tags: ''
title: 'Incomplete submission'
PermissiblePurposeCodeExample:
value:
code: '10100'
status: '400'
message: 'Permissible Purpose Code is required'
InvalidForesightReportRequestExample:
value:
code: '10100'
message:
'At least one of customerId or externalCustomerId must be provided;
both are also allowed.'
DisputeStatementErrorExample:
value:
code: '10406'
status: '403'
message: 'The active dispute statement for this consumer exists.'
SecurityFreezeErrorExample:
value:
code: '10405'
status: '403'
message: 'The active security freeze for this consumer exists.'
InvalidFieldExample:
value:
code: '10010'
status: '400'
message: Customer ID does not exist or does not belong to this partner
user_message: >-
One or more of the fields could not be validated. Please ensure you
have entered the correct data.
tags: ''
InvalidExperienceFieldExample:
value:
code: '10010'
status: '400'
message: '"experience" must be a valid GUID'
user_message:
'One or more of the fields could not be validated. Please ensure you
have entered the correct data.'
tags: ''
InvalidStartValueExample:
value:
code: '3005'
status: '400'
message: 'Bad Request'
user_message: 'Invalid Start value'
InvalidLimitValueExample:
value:
code: '3006'
status: '400'
message: 'Bad Request'
user_message: 'Invalid Limit value'
LimitValueExceededExample:
value:
code: '3007'
status: '400'
message: 'Bad Request'
user_message:
'Requested Limit value is exceeded than allowed max Limit value'
InvalidQueryParametersExample:
value:
code: '3008'
status: '400'
message: 'Bad Request'
user_message:
'Known query parameters: [pre_app_id, application_id, status, name]
are allowed only'
InvalidQueryParametersValueExample:
value:
code: '3009'
status: '400'
message: 'Bad Request'
user_message:
'One/more of [pre_app_id, application_id, status, name] query
parameter values provided are invalid'
InvalidNewPartnerSecretExample:
value:
code: 24437
message: New password is not as per policy
ExpiredTokenExample:
value:
code: '10022'
status: '401'
message: Invalid authorization credentials
user_message:
Your connection timed out due to inactivity. Please log in again to
complete your account linking.
tags: ''
NoAccountForInstitutionLoginIdExample:
value:
code: '38007'
status: '404'
title: Connecting accounts error
user_message:
Customer does not have any accounts associated with
institutionLoginId.
tags: ''
level: 'error'
message:
'Customer does not have any accounts associated with
institutionLoginId.'
NoAccountForInstitutionLoginIdExamplePEB:
value:
code: 38007
message: >-
Customer does not have any accounts associated with
institutionLoginId.
ApplicationIdNotFoundExample:
value:
code: '3001'
status: '404'
message: 'Resource Not Found'
user_message: 'Requested Application Id is not found'
ApplicationRegistrationStatusNotFoundExample:
value:
code: '3002'
status: '404'
message: 'Resource Not Found'
user_message:
'Requested application registration status is not found against
financial institutions'
CustomerNotFoundExample:
value:
code: 14001
message: 'Customer not found.'
ConsumerNotFoundExample:
value:
code: 10100
message: 'Cannot find consumer with id 1234.'
NoConsumerForCustomerExample:
value:
code: 10100
message: 'Cannot find consumer for customer with id 5011115315."'
ResourceNotFoundExample:
value:
code: 14001
message: 'Resource not found.'
AssetNotFoundExample:
value:
code: 13002
message: 'Asset not found'
ForbiddenErrorResponseExample:
value:
code: 10405
status: '403'
message: 'An active security freeze for this customer exists.'
NotAllowedErrorResponseExample:
value:
code: 20000
status: '406'
message: "Only 'application/json' is supported."
NoRegisteredApplicationExample:
value:
code: 50051
message: 'No registered partner applications found.'
ConsumerExistsConflictExample:
value:
code: 11000
message: 'A consumer already exists for customer 4025024821'
UsernameNotAvailableExample:
value:
code: 110002
message: Username is not available.
AppResponseExample:
value:
found: 2
displaying: 2
moreAvailable: false
applications:
- preAppId: 13
applicationId: 234dsfdsf-535fdgdtrtr-546464564
status: A
name: Mvelopes
scopes: Account Info
note: Auto approved
createdDate: 2020-07-30T16:11:23Z
modifiedDate: 2020-07-30T16:11:23Z
submittedDate: 2020-07-30T16:11:23Z
- preAppId: 43
applicationId: 32edsfdsf-535dsdsrtr-546dsaes4
status: D
name: TestApp
scopes: Account Info
note: Auto approved
createdDate: 2020-07-30T16:11:23Z
modifiedDate: 2020-07-30T16:11:23Z
submittedDate: 2020-07-30T16:11:23Z
InstitutionResponseExample:
value:
found: 500
displaying: 2
moreAvailable: true
institutions:
- institutionId: 170881
institutionName: Citi
status: true
createdDate: 2020-07-30T16:11:23Z
modifiedDate: 2020-07-30T16:11:23Z
- institutionId: 102224
institutionName: Chase
status: true
createdDate: 2020-07-30T16:11:23Z
modifiedDate: 2020-07-30T16:11:23Z
LenderRequestExample:
value:
purpose: 31
GeneratePayrollReportRequestExample:
value:
payrollData:
ssn: '999990000'
dob: '315576000'
reportId: abcdefghijkl-voiepayroll
reportCustomFields:
- label: loanID
value: '12345'
shown: true
payStatementsFromDate: 1580558400
marketSegment: Mortgage
excludeEmpInfo: false
purpose: '31'
GenerateVOEPayrollReportResponseExample:
value:
id: 41h4nzppn47u-voepayroll
portfolioId: 9qud7dtuzbew-1-port
customerType: active
customerId: 1011140000
requestId: 7a7qyps2iy
type: voePayroll
reportStyle: directAPIPayroll
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Verification of Employment - Payroll
consumerId: 656cf7083c5c06e0c125a698579f0000
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
payrollData:
payrollDataRetrievalId: 'uvhjy7pwa1t5'
payrollAccountIds:
- 018bf5c9-b542-c2ba-8f92-c5c7be6be515
reportCustomFields:
- label: loanID
value: '12345'
shown: true
status: inProgress
RefreshVOIEPayrollReportResponseExample:
value:
id: 123456789012-voiepayroll
customerId: 1011140000
consumerId: 656cf7083c5c06e0c125a698579f0000
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 7a7qyps2iy
type: voiePayroll
reportStyle: credentialedPayroll
status: inProgress
createdDate: 1579819592
constraints:
payrollData:
payrollAccountIds:
- 018b8f10-fdf8-0ef7-ded5-34a17c34d86f
reportCustomFields:
- label: loanID
value: '12345'
shown: true
customerType: active
title:
Mastercard Open Banking Verification of Income and Employment -
Payroll
portfolioId: 9qud7dtuzbew-2-port
GeneratePayStatementReportRequestExample:
value:
paystatementReport:
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
GeneratePayStatementReportResponseExample:
value:
id: y0ejausptjg1-paystatement
portfolioId: spd8aehuw63i-10-port
customerType: active
customerId: 1003413624
requestId: 8wy5htqg8u
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Mastercard Open Banking Pay Statement Extraction Report
consumerId: 4089f408963dd6b90b28a935e9903c0e
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
paystatementReport:
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: paystatement
status: inProgress
GenerateStatementReportRequestExample:
value:
statementReportData:
accountId: 1000076901
statementIndex: 1
reportCustomFields:
- label: loanID
value: '123456'
shown: true
GenerateStatementReportResponseExample:
value:
id: 38dknche83oh-statement
portfolioId: sy7aa68w2ugx-1-port
customerType: active
customerId: 1010560999
requestId: ny7x32stfq
requesterName: Demo
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1596226182
title: Mastercard Open Banking Statement Report
consumerId: 555595ec74c8ec57adf44dadddb6a35
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
statementReportData:
accountId: 1000076901
statementIndex: 1
reportCustomFields:
- label: loanID
value: '123456'
shown: true
type: statement
status: inProgress
GenerateCashFlowReportRequestExample:
value:
accountIds: '1000535275'
incomeStreamConfidenceMinimum: 50
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
fromDate: 1580558400
GenerateCashFlowReportBusinessResponseExample:
value:
id: 383z55zudewm-cfrb
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Report - Business
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: cfrb
status: inProgress
GenerateCashFlowReportPersonalResponseExample:
value:
id: 383z51zurqwo-cfrp
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Report - Personal
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: cfrp
status: inProgress
GenerateTransactionsReportRequestExample:
value:
accountIds: 1027339038 1027339039
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
toDate: 1643720017
findTransaction:
findTransactionDescriptionMemo: 'Payment to PSC Finance'
findTransactionAmountFrom: 100.00
findTransactionAmountTo: 200.00
findTransactionCategory:
- 'Payment'
- 'Transfer'
GenerateBalanceBusinessCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateBalanceBusinessNonCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateBalanceBusinessFtcAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateBalancePersonalCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateBalancePersonalNonCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateCashflowBusinessCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateCashflowBusinessNonCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateCashflowBusinessFtcAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateCashflowPersonalCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateCashflowPersonalNonCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GeneratePaymentHistoryBusinessCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GeneratePaymentHistoryBusinessNonCraAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GeneratePaymentHistoryBusinessFtcAnalyticsReportRequestExample:
value:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds: '1000535275 1000535276'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
fromDate: 1580558400
GenerateTransactionsReportResponseExample:
value:
id: dnuru2ua2trs-transactions
portfolioId: hupvwpdzr9dq-16-port
customerType: testing
customerId: 1000018865
requestID: ky2nhsufhv
requesterName: Decisioning API Tests
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1594678007
title: Mastercard Open Banking Transactions Report
consumerId: a925b07c9e028c680ad9c1d18d2e7199
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000075473'
fromDate: 1578952809
toDate: 1594677609
includePending: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
findTransaction:
findTransactionDescriptionMemo: 'Payment to PSC Finance'
findTransactionAmountFrom: 100.01
findTransactionAmountTo: 200.00
findTransactionCategory:
- 'Payment'
- 'Transfer'
type: transactions
status: inProgress
GenerateVOAReportRequestExample:
value:
accountIds: '1000535275'
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
fromDate: 1580558400
GenerateVOAReportResponseExample:
value:
id: u4hstnnak45g
portfolioId: dyr6qvqd2yhb-1-port
customerType: active
customerId: 1000006677
requestId: sfb7xp439w
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Mastercard Open Banking Verification of Assets
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
showNsf: false
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: voa
status: inProgress
GenerateVOAWithIncomeReportRequestExample:
value:
accountIds: '1000535275'
fromDate: 1580558400
incomeFromDate: 1680518400
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
incomeStreamConfidenceMinimum: 50
GenerateVOAWithIncomeReportResponseExample:
value:
id: u4hstnyak45g
portfolioId: dyr6weqd2yhb-1-port
customerType: active
customerId: 1000006677
requestId: sfb7x1we9w
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Verification of Asset and Income - Transactions
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
fromDate: 1580558400
incomeFromDate: 1680518400
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
incomeStreamConfidenceMinimum: 50
type: voaHistory
status: inProgress
GeneratePrequalificationReportRequestExample:
value:
accountIds: '1000535275'
fromDate: 1580558400
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
GeneratePrequalificationCRAReportResponseExample:
value:
id: 88w4fbssrbja-prequalvoa
portfolioId: 0whcism47a34-5-port
customerType: active
customerId: 1000006677
requestId: sfb7xacr9w
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Asset Ready Report (CRA)
consumerId: cb619e10185177cd92271c4da2df3fa3
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
type: preQualVoa
status: inProgress
GeneratePrequalificationNonCRAReportResponseExample:
value:
id: rceiqx616awa-assetsummary
portfolioId: 0whcism47ttt-5-port
customerType: active
customerId: 1000006677
requestId: sfb7xp4iui
requesterName: Decisioning API
createdDate: 1588350269
title: Asset Ready Report (NON-CRA)
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
type: assetSummary
status: inProgress
GenerateVOETransactionsReportRequestExample:
value:
reportId: j7k8qbgwsa7d-voietxverify
accountIds: '123456789'
fromDate: 1580558400
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
incomeStreamConfidenceMinimum: 50
GenerateVOETransactionsReportResponseExample:
value:
id: u4hstny1k25g-voetransactions
portfolioId: dyr6weqd2yhb-2-port
customerType: active
customerId: 1000006677
requestId: sfb7x1we9w
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Mastercard Open Banking Verification Employment - Transactions
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
reportId: j7k8qbgwsa7d-voietxverify
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: voeTransactions
status: inProgress
GenerateVOIEPaystubReportRequestExample:
value:
voieWithStatementData:
assetIds:
- d50ed92f-543b-431c-8286-c8b8f6556679
reportCustomFields:
- label: loanID
value: '123456'
shown: true
- label: trackingID
value: '5555'
shown: true
GenerateVOIEPaystubReportResponseExample:
value:
id: 2f3z55zuwewm-voietxverify
portfolioId: 9qud7dtuzbew-13-port
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Verification of Income and Employment - Paystub
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
voieWithStatementData:
assetIds:
- d50ed92f-543b-431c-8286-c8b8f6556679
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '123456'
shown: true
- label: trackingID
value: '5555'
shown: true
type: voieTxVerify
status: inProgress
GenerateVOIEPaystubWithTXVerifyReportRequestExample:
value:
accountIds: '1028361677'
voieWithInterviewData:
txVerifyInterview:
- assetId: 7eb57060-6d98-4449-992d-4dd4490448f3-1236011097
reportCustomFields:
- label: loanID
value: '123456'
shown: true
GenerateVOIEPaystubWithTXVerifyReportResponseExample:
value:
id: 2f3z55zuwewm-voietxverify
customerId: 1275320
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 7a7qyps2iy
type: voieTxVerify
status: inProgress
createdDate: 1579819592
constraints:
accountIds:
- '1000535275'
voieWithInterviewData:
txVerifyInterview:
- assetId: 6f8fb0a0-e882-4f57-b672-cf53f1397581
accounts: []
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '123456'
shown: true
customerType: active
title:
Finicity Verification of Income and Employment - Paystub (with
TXVerify)
portfolioId: 9qud7dtuzbew-2-port
GenerateVOIReportRequestExample:
value:
accountIds: 1000535275 1000535276
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
incomeStreamConfidenceMinimum: 50
GenerateVOIReportResponseExample:
value:
id: u4hstnnaewetr-voi
portfolioId: dyr6qvqd2erw-1-port
customerType: active
customerId: 1000006677
requestId: sfb7xp4wer
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1588350269
title: Mastercard Open Banking Verification of Income
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: voi
status: inProgress
CashFlowPersonalReportExample:
summary: Cash Flow Report - Personal
value:
id: sd1j45yn37wr-cfrp
portfolioId: igi5kj6hh58y-1-port
customerType: testing
customerId: 5555
requestId: xtw6tjemt6
title: Mastercard Open Banking Cash Flow Report - Personal
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
consumerId: 555595ec74c8ec57adf44dadddb6a35
consumerSsn: '1111'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API Tests
type: cfrp
status: success
createdDate: 1575666823
startDate: 1512594823
endDate: 1575666823
days: 730
seasoned: true
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '6681984'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1575666823
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '100671406523'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
cashFlowBalance:
monthlyCashFlowBalances:
- month: 1551423600
minDailyBalance: -65894.54
maxDailyBalance: -62196.98
averageDailyBalance: -64594.87
standardDeviationOfDailyBalance: '1099'
numberOfDaysNegativeBalance: '28'
numberOfDaysPositiveBalance: '0'
minDailyBalance: 3479.39
maxDailyBalance: 3479.39
twelveMonthAverageDailyBalance: 3479.39
sixMonthAverageDailyBalance: 3479.39
twoMonthAverageDailyBalance: 3479.39
twelveMonthStandardDeviationOfDailyBalance: '20'
sixMonthStandardDeviationOfDailyBalance: '20'
twoMonthStandardDeviationOfDailyBalance: '20'
numberDaysNegativeBalance: '6'
numberOfDaysPositiveBalance: '0'
cashFlowCredit:
monthlyCashFlowCredits:
- month: 1551423600
numberOfCredits: '3'
totalCreditsAmount: 5000.29
largestCredit: 2182.34
numberOfCreditsLessTransfers: '3'
totalCreditsAmountLessTransfers: 5000.29
averageCreditAmount: 1666.76
estimatedNumberOfLoanDeposits: '0'
estimatedLoanDepositAmount: 0
twelveMonthCreditTotal: 1200
twelveMonthCreditTotalLessTransfers: 1000
sixMonthCreditTotal: 750
sixMonthCreditTotalLessTransfers: 500
twoMonthCreditTotal: 150
twoMonthCreditTotalLessTransfers: 100
cashFlowDebit:
monthlyCashFlowDebits:
- month: 1551423600
numberOfDebits: '12'
totalDebitsAmount: -2063.43
largestDebit: -953.73
numberOfDebitsLessTransfers: '12'
totalDebitsAmountLessTransfers: -2063.43
averageDebitAmount: -171.95
twelveMonthDebitTotal: 1200
twelveMonthDebitTotalLessTransfers: 1000
sixMonthDebitTotal: 750
sixMonthDebitTotalLessTransfers: 500
twoMonthDebitTotal: 150
twoMonthDebitTotalLessTransfers: 100
cashFlowCharacteristic:
monthlyCashFlowCharacteristics:
- month: 1551423600
totalCreditsLessTotalDebits: 2936.86
totalCreditsLessTotalDebitsLessTransfers: 2936.86
averageTransactionAmount: 195.79
averageMonthlyNet: 2350
averageMonthlyNetLessTransfers: 1000
twelveMonthTotalNet: 12500
twelveMonthTotalNetLessTransfers: 12400
sixMonthAverageTotalCreditsLessTotalDebits: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
twoMonthAverageTotalCreditsLessTotalDebits: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
cashFlowBalanceSummary:
monthlyCashFlowBalanceSummaries:
- month: 1551423600
minDailyBalance: -65894.54
maxDailyBalance: -62196.98
averageDailyBalance: -64594.87
standardDeviationOfDailyBalance: '1099'
numberOfDaysNegativeBalance: '28'
numberOfDaysPositiveBalance: '0'
minDailyBalance: 3479.39
maxDailyBalance: 3479.39
twelveMonthAverageDailyBalance: 3479.39
sixMonthAverageDailyBalance: 3479.39
twoMonthAverageDailyBalance: 3479.39
twelveMonthStandardDeviationOfDailyBalance: '20'
sixMonthStandardDeviationOfDailyBalance: '20'
twoMonthStandardDeviationOfDailyBalance: '20'
numberOfDaysNegativeBalance: '6'
numberOfDaysPositiveBalance: '11'
cashFlowCreditSummary:
monthlyCashFlowCreditSummaries:
- month: 1551423600
numberOfCredits: '3'
totalCreditsAmount: 5000.29
largestCredit: 2182.34
numberOfCreditsLessTransfers: '3'
totalCreditsAmountLessTransfers: 5000.29
averageCreditAmount: 1666.76
estimatedNumberOfLoanDeposits: '0'
estimatedLoanDepositAmount: 0
twelveMonthCreditTotal: 1200
twelveMonthCreditTotalLessTransfers: 1000
sixMonthCreditTotal: 750
sixMonthCreditTotalLessTransfers: 500
twoMonthCreditTotal: 150
twoMonthCreditTotalLessTransfers: 100
cashFlowDebitSummary:
monthlyCashFlowDebitSummaries:
- month: 1551423600
numberOfDebits: '12'
totalDebitsAmount: -2063.43
largestDebit: -953.73
numberOfDebitsLessTransfers: '12'
totalDebitsAmountLessTransfers: -2063.43
averageDebitAmount: -171.95
twelveMonthDebitTotal: -1200
twelveMonthDebitTotalLessTransfers: -1000
sixMonthDebitTotal: -750
sixMonthDebitTotalLessTransfers: -500
twoMonthDebitTotal: -150
twoMonthDebitTotalLessTransfers: -100
cashFlowCharacteristicsSummary:
monthlyCashFlowCharacteristicSummaries:
- month: 1551423600
totalCreditsLessTotalDebits: 2936.86
totalCreditsLessTotalDebitsLessTransfers: 2936.86
averageTransactionAmount: 195.79
averageMonthlyNet: 1250
averageMonthlyNetLessTransfers: 1000
twelveMonthTotalNet: 12500
twelveMonthTotalNetLessTransfers: 12400
sixMonthAverageTotalCreditsLessTotalDebits: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
twoMonthAverageTotalCreditsLessTotalDebits: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
possibleLoanDeposits:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '6681984'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1614880526
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '100671406523'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
CashFlowBusinessReportExample:
summary: Cash Flow Report - Business
value:
id: sd1j45yn37wr-cfrb
customerType: testing
customerId: 5555
requestId: xtw6tjemt6
title: Mastercard Open Banking Cash Flow Report - Business
requesterName: Decisioning API Tests
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
type: cfrb
status: success
createdDate: 1575666823
startDate: 1512594823
endDate: 1575666823
days: 730
seasoned: true
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '6681984'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1614880526
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '100671406523'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
cashFlowBalance:
monthlyCashFlowBalances:
- month: 1551423600
minDailyBalance: -65894.54
maxDailyBalance: -62196.98
averageDailyBalance: -64594.87
standardDeviationOfDailyBalance: '1099'
numberOfDaysNegativeBalance: '28'
numberOfDaysPositiveBalance: '0'
minDailyBalance: 3479.39
maxDailyBalance: 3479.39
twelveMonthAverageDailyBalance: 3479.39
sixMonthAverageDailyBalance: 3479.39
twoMonthAverageDailyBalance: 3479.39
twelveMonthStandardDeviationOfDailyBalance: '20'
sixMonthStandardDeviationOfDailyBalance: '20'
twoMonthStandardDeviationOfDailyBalance: '20'
numberDaysNegativeBalance: '6'
numberOfDaysPositiveBalance: '0'
cashFlowCredit:
monthlyCashFlowCredits:
- month: 1551423600
numberOfCredits: '3'
totalCreditsAmount: 5000.29
largestCredit: 2182.34
numberOfCreditsLessTransfers: '3'
totalCreditsAmountLessTransfers: 5000.29
averageCreditAmount: 1666.76
estimatedNumberOfLoanDeposits: '0'
estimatedLoanDepositAmount: 0
twelveMonthCreditTotal: 1200
twelveMonthCreditTotalLessTransfers: 1000
sixMonthCreditTotal: 750
sixMonthCreditTotalLessTransfers: 500
twoMonthCreditTotal: 150
twoMonthCreditTotalLessTransfers: 100
cashFlowDebit:
monthlyCashFlowDebits:
- month: 1551423600
numberOfDebits: '12'
totalDebitsAmount: -2063.43
largestDebit: -953.73
numberOfDebitsLessTransfers: '12'
totalDebitsAmountLessTransfers: -2063.43
averageDebitAmount: -171.95
twelveMonthDebitTotal: 1200
twelveMonthDebitTotalLessTransfers: 1000
sixMonthDebitTotal: 750
sixMonthDebitTotalLessTransfers: 500
twoMonthDebitTotal: 150
twoMonthDebitTotalLessTransfers: 100
cashFlowCharacteristic:
monthlyCashFlowCharacteristics:
- month: 1551423600
totalCreditsLessTotalDebits: 2936.86
totalCreditsLessTotalDebitsLessTransfers: 2936.86
averageTransactionAmount: 195.79
averageMonthlyNet: 2350
averageMonthlyNetLessTransfers: 1000
twelveMonthTotalNet: 12500
twelveMonthTotalNetLessTransfers: 12400
sixMonthAverageTotalCreditsLessTotalDebits: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
twoMonthAverageTotalCreditsLessTotalDebits: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
cashFlowBalanceSummary:
monthlyCashFlowBalanceSummaries:
- month: 1551423600
minDailyBalance: -65894.54
maxDailyBalance: -62196.98
averageDailyBalance: -64594.87
standardDeviationOfDailyBalance: '1099'
numberOfDaysNegativeBalance: '28'
numberOfDaysPositiveBalance: '0'
minDailyBalance: 3479.39
maxDailyBalance: 3479.39
twelveMonthAverageDailyBalance: 3479.39
sixMonthAverageDailyBalance: 3479.39
twoMonthAverageDailyBalance: 3479.39
twelveMonthStandardDeviationOfDailyBalance: '20'
sixMonthStandardDeviationOfDailyBalance: '20'
twoMonthStandardDeviationOfDailyBalance: '20'
numberOfDaysNegativeBalance: '6'
numberOfDaysPositiveBalance: '11'
cashFlowCreditSummary:
monthlyCashFlowCreditSummaries:
- month: 1551423600
numberOfCredits: '3'
totalCreditsAmount: 5000.29
largestCredit: 2182.34
numberOfCreditsLessTransfers: '3'
totalCreditsAmountLessTransfers: 5000.29
averageCreditAmount: 1666.76
estimatedNumberOfLoanDeposits: '0'
estimatedLoanDepositAmount: 0
twelveMonthCreditTotal: 1200
twelveMonthCreditTotalLessTransfers: 1000
sixMonthCreditTotal: 750
sixMonthCreditTotalLessTransfers: 500
twoMonthCreditTotal: 150
twoMonthCreditTotalLessTransfers: 100
cashFlowDebitSummary:
monthlyCashFlowDebitSummaries:
- month: 1551423600
numberOfDebits: '12'
totalDebitsAmount: -2063.43
largestDebit: -953.73
numberOfDebitsLessTransfers: '12'
totalDebitsAmountLessTransfers: -2063.43
averageDebitAmount: -171.95
twelveMonthDebitTotal: -1200
twelveMonthDebitTotalLessTransfers: -1000
sixMonthDebitTotal: -750
sixMonthDebitTotalLessTransfers: -500
twoMonthDebitTotal: -150
twoMonthDebitTotalLessTransfers: -100
cashFlowCharacteristicsSummary:
monthlyCashFlowCharacteristicSummaries:
- month: 1551423600
totalCreditsLessTotalDebits: 2936.86
totalCreditsLessTotalDebitsLessTransfers: 2936.86
averageTransactionAmount: 195.79
averageMonthlyNet: 1250
averageMonthlyNetLessTransfers: 1000
twelveMonthTotalNet: 12500
twelveMonthTotalNetLessTransfers: 12400
sixMonthAverageTotalCreditsLessTotalDebits: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
twoMonthAverageTotalCreditsLessTotalDebits: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers: 55555
possibleLoanDeposits:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '6681984'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1614880526
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '100671406523'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
PaymentSuccessIndicatorExample:
value:
customerId: '453752752892'
accountId: '453752772892'
payReqId: '484265782033818817'
settleByDate: '2023-06-07'
settlementAmount: 10.05
availableBalance: 823.32
indicatorsByDay:
- potentialSettlementDate: '2023-06-07'
compositeScore: 7
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2023-06-08'
compositeScore: 6
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2023-06-09'
compositeScore: 5
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
PaymentSuccessIndicatorWarningExample:
value:
code: '2000'
message:
'Successful Warning - settlement amount exceeds available balance'
customerId: '453752752892'
accountId: '453752772892'
payReqId: '484265782033818817'
settleByDate: '2023-06-07'
settlementAmount: 102.05
availableBalance: 82.32
indicatorsByDay:
- potentialSettlementDate: '2023-06-07'
compositeScore: 7
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2023-06-08'
compositeScore: 6
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2023-06-09'
compositeScore: 5
scoreIndicator: Less Likely to Settle
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
MissingSettleByDateExample:
summary: Missing parameter (settleByDate)
value:
code: 10009
message: Missing parameter (settleByDate)
MissingSettlementAmountExample:
summary: Missing parameter (settlementAmount)
value:
code: 10009
message: Missing parameter (settlementAmount)
PSIAccountErrorBadRequestExample:
summary: PSI Bad Request
value:
code: 1001
message: Account Error - use different account
PaymentSuccessIndicatorsInProgressResponseExample:
value:
payRequestId: '476412776235977427'
status: 'IN PROGRESS'
customerId: '1005061234'
accountId: '20050961233'
requestDate: '2025-04-24'
transaction:
settleByDate: '2025-04-25'
amount: 12.98
PaymentSuccessIndicatorsFailureResponseExample:
value:
payRequestId: '476412776235977427'
status: 'FAILURE'
customerId: '1005061234'
accountId: '20050961233'
requestDate: '2025-04-24'
transaction:
settleByDate: '2025-04-25'
amount: 12.98
nsfReturnRisk:
error:
code: 185
status: '500'
message: 'MFA Required'
unauthorizedReturnRisk:
error:
code: 185
status: '500'
message: 'MFA Required'
PaymentSuccessIndicatorsNoReasonsSuccessResponseExample:
value:
payRequestId: '476412776235977427'
status: 'SUCCESS'
customerId: '1005061234'
accountId: '20050961233'
requestDate: '2025-04-24'
transaction:
settleByDate: '2025-04-25'
amount: 12.98
nsfReturnRisk:
result:
availableBalance: 82.32
dailyResults:
- potentialSettlementDate: '2024-04-24'
score: 7
indicator: 'High Risk'
- potentialSettlementDate: '2024-04-25'
score: 6
indicator: 'High Risk'
- potentialSettlementDate: '2024-04-26'
score: 8
indicator: 'High Risk'
unauthorizedReturnRisk:
score: 89
indicator: 'Low Risk'
PaymentSuccessIndicatorsSuccessResponseExample:
value:
payRequestId: '476412776235977427'
status: 'SUCCESS'
customerId: '1005061234'
accountId: '20050961233'
requestDate: '2025-04-24'
transaction:
settleByDate: '2025-04-25'
amount: 12.98
nsfReturnRisk:
result:
availableBalance: 82.32
dailyResults:
- potentialSettlementDate: '2024-04-24'
score: 7
indicator: 'High Risk'
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2024-04-25'
score: 6
indicator: 'High Risk'
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
- potentialSettlementDate: '2024-04-26'
score: 8
indicator: 'High Risk'
reasons:
recentBalance: 12
balanceHistory: 23
nsfHistory: 40
recentNsfHistory: 78
recurringNsf: 34
spendHistory: 44
depositHistory: 10
transactionAmount: 65
unauthorizedReturnRisk:
score: 89
indicator: 'Low Risk'
PrequalificationCRAReportExample:
summary: Prequalification CRA Report
value:
id: 88w4fbssrbja-prequalvoa
customerId: 1000006677
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: sfb7xacr9w
type: preQualVoa
status: success
createdDate: 1588350269
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
customerType: active
title: Asset Ready Report (CRA)
startDate: 1572625469
endDate: 1588350269
days: 230
seasoned: true
consolidatedAvailableBalance: 1929.57
portfolioId: 0whcism47a34-5-port
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1588350276
name: Checking
type: checking
aggregationStatusCode: 0
balance: 501.24
balanceDate: 1588350276
averageMonthlyBalance: 501.02
totNumberInsufficientFundsFeeDebitTxAccount: 0
totNumberInsufficientFundsFeeDebitTxOver6MonthsAccount: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount: 120
transactions: []
asset:
type: checking
availableBalance: 1000
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 1000
assets:
currentBalance: 1000
availableBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
PrequalificationNonCRAReportExample:
summary: Prequalification Non-CRA Report
value:
id: rceiqx616awa-assetsummary
customerId: 1000006677
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: sfb7xp4iui
type: assetSummary
status: success
createdDate: 1588350269
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
customerType: active
title: Asset Ready Report (non-CRA)
startDate: 1572625469
endDate: 1588350269
days: 230
seasoned: true
consolidatedAvailableBalance: 1929.57
portfolioId: 0whcism47ttt-5-port
institutions:
- id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
- id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress:
'924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1588350276
name: Checking
type: checking
availableBalance: 0
aggregationStatusCode: 0
balance: 501.24
balanceDate: 1588350276
averageMonthlyBalance: 501.02
totNumberInsufficientFundsFeeDebitTxAccount: 0
totNumberInsufficientFundsFeeDebitTxOver6MonthsAccount: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount: 120
transactions: []
asset:
type: checking
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 1000
assets:
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
PayStatementReportExample:
summary: Pay Statement Report
value:
id: y0ejausptjg1-paystatement
customerId: 1003413624
consumerId: 4089f408963dd6b90b28a935e9903c0e
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 8wy5htqg8u
type: paystatement
status: success
createdDate: 1588350269
constraints:
paystatementReport:
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
customerType: active
title: Mastercard Open Banking Pay Statement Extraction Report
startDate: 1572625469
endDate: 1588350269
portfolioId: spd8aehuw63i-10-port
reportStyle: paystatement
numberOfBillableAssets: 1
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
payStatementTxVerifyDaoList:
payPeriod: LastPayPeriod
billable: true
assetId: 6f8fb0a0-e882-4f57-b672-cf53f1397581
payDate: 1559241000
startDate: 1557513000
endDate: 1558722600
netPayCurrent: 1802.22
netPayYTD: 36000
grossPayCurrent: 24200
grossPayYTD: 72600
payrollProvider: Finicity
employer:
name: Rocket Surgery
employee:
name: Patrick Purchaser
payStat:
name: regular 1
type: regular
description: regular income
amountCurrent: 6000
amountYTD: 18000
deductions:
- name: '401'
description: 401k
amountCurrent: 1744.61
amountYTD: 1744.6
type: 401 Deductions
directDeposits:
- financialInstitutionName: America First
accountType: Checking
amountCurrent: 1744.61
accountLastFour: XX34
description: Payroll
StatementReportExample:
summary: Statement Report
value:
id: 38dknche83oh-statement
customerType: active
customerId: 1000262464
requestId: nd4b55a4bg
title: Mastercard Open Banking Statement Report
consumerId: d15ff15ed0c8627eae61c452928d7fc3
consumerSsn: '1111'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Demo
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
constraints:
statementReportData:
accountId: 1000076901
statementIndex: 1
reportCustomFields:
- label: loanID
value: '123456'
shown: true
type: statement
status: success
createdDate: 1586189339
assetId: aaaa3be2-6f1a-4aac-a360-4ad240aa652d
TransactionsReportExample:
summary: Transactions Report
value:
id: '1000075473'
title: Mastercard Open Banking Transactions Report
customerType: testing
customerId: 1000018865
consumerId: a925b07c9e028c680ad9c1d18d2e7199
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
type: transactions
status: success
createdDate: 1594678007
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
constraints:
accountIds:
- '1000075473'
fromDate: 1578952809
toDate: 1594677609
includePending: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
findTransaction:
findTransactionDescriptionMemo: Payment to PSC Finance
findTransactionAmountFrom: -100.01
findTransactionAmountTo: 200.00
findTransactionCategory:
- Payment
- Transfer
startDate: 1579348800
endDate: 1594382400
days: 174
seasoned: false
portfolioId: wqbh0r2kbv5g-4-port
institutions:
- id: 102105
name: FinBank Profiles - A
urlHomeApp: http://www.finbank.com
accounts:
- id: 1000075473
number: '5015'
name: Super Checking
type: checking
availableBalance: 1000
aggregationStatusCode: 0
balance: 1000
balanceDate: 1594676289
transactionsCount: 2
transactions:
- id: 100001490719
amount: -99
postedDate: 1594382400
description: ACH Withdrawal AMERICA FIRST CR
normalizedPayee: America First Cr
institutionTransactionId: '0000000000'
category: Transfer
memo: Payment to PSC Finance
- id: 100001490897
amount: 199.7
postedDate: 1594123200
description: Payment to PSC Finance
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Payment
memo: TMOBILE debit
TransactionNONCRAExample:
summary: Transaction NON CRA Report Example
value:
id: 0nzekfhcexxh-txnnoncra
gseEnabled: true
customerType: testing
customerId: 1000885874
requestId: zjc6kdjkjj
title: Mastercard Open Banking Transactions Non CRA
requesterName: Intuit Facade Demo (KEEP)
constraints:
fromDate: 1650715226
toDate: 1713873626
includePending: false
findTransaction:
findTransactionAmountFrom: -100.01
findTransactionAmountTo: 200.00
findTransactionCategory:
- Payment
- Transfer
type: txnNonCra
status: success
createdDate: 1713873626
startDate: 1672401600
endDate: 1713614400
days: 477
seasoned: true
institutions:
- id: 102105
name: FinBank Profiles - A
urlHomeApp: https://finbank.stg.fini.city/FinBankProfiles/login.jsp
accounts:
- id: 1002509340
number: '8888'
name: Savings
type: savings
currency: USD
availableBalance: 10000
aggregationStatusCode: 0
balance: 10000
balanceDate: 1713873628
oldestTransactionDate: 1672401600
averageMonthlyBalance: -516.45
transactionsCount: 3
transactions:
- id: 100298184206
amount: 60
postedDate: 1713614400
description:
Payment deposit CAPITAL1 P2P Bob Jones Bob Jones
normalizedPayee: Capital1 Bob Jones
institutionTransactionId: '0000000000'
category: Payment
- id: 100298184180
amount: 200
postedDate: 1712923200
description: Online banking xfer withdrawal from ...8888
normalizedPayee: Online Banking
institutionTransactionId: '0000000000'
category: Payment
- id: 100298184155
amount: -158.11
postedDate: 1712923200
description: Online banking xfer withdrawal from ...8888
normalizedPayee: Online Banking
institutionTransactionId: '0000000000'
category: Transfer
details:
interestMarginBalance:
availableCashBalance:
vestedBalance:
currentLoanBalance:
availableBalanceAmount: 10000
- id: 1002509341
number: '7777'
name: Checking
type: checking
currency: USD
availableBalance: 10000
aggregationStatusCode: 0
balance: 10000
balanceDate: 1713873630
oldestTransactionDate: 1672401600
averageMonthlyBalance: -516.45
transactionsCount: 3
transactions:
- id: 100298184308
amount: 60
postedDate: 1713614400
description:
Payment deposit CAPITAL1 P2P Bob Jones Bob Jones
normalizedPayee: Capital1 Bob Jones
institutionTransactionId: '0000000000'
category: Payment
- id: 100298184282
amount: -30
postedDate: 1712923200
description: Online banking xfer withdrawal from ...7777
normalizedPayee: Online Banking
institutionTransactionId: '0000000000'
category: Transfer
- id: 100298184257
amount: -138.11
postedDate: 1712923200
description: Online banking xfer withdrawal from ...7777
normalizedPayee: Online Banking
institutionTransactionId: '0000000000'
category: Transfer
details:
interestMarginBalance:
availableCashBalance:
vestedBalance:
currentLoanBalance:
availableBalanceAmount: 10000
VOAReportExample:
summary: VOA Report
value:
id: u4hstnnak45g
customerId: 1000006677
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: sfb7xp439w
type: voa
status: success
createdDate: 1588350269
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
customerType: active
title: Mastercard Open Banking Verification of Assets
startDate: 1572625469
endDate: 1588350269
days: 180
seasoned: false
consolidatedAvailableBalance: 2345
portfolioId: dyr6qvqd2yhb-1-port
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1588350276
name: Checking
type: checking
availableBalance: 501.24
aggregationStatusCode: 0
balance: 501.24
balanceDate: 1588350276
averageMonthlyBalance: 501.02
totNumberInsufficientFundsFeeDebitTxAccount: 0
totNumberInsufficientFundsFeeDebitTxOver2MonthsAccount: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount: 120
transactions:
- id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
memo: Finicity amount credit
investmentTransactionType: dividend
normalizedPayee: Finicity
institutionTransactionId: '100000000'
category: Paycheck
bestRepresentation: FINICITY INC PAYROLL
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 1000
marginBalance: 100.00
currentBalance: 1000.00
position:
- id: 637054
currency: USD
symbol: MCD
securityName: Common Stock
units: 5
marketValue: 1403.55
currentPrice: 280.71
securityType: Stock
asset:
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
assets:
type: checking
availableBalance: 1000
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
VOAWithIncomeReportExample:
summary: VOA With Income Report
value:
id: u4hstnyak45g
portfolioId: dyr6weqd2yhb-1-port
customerType: active
customerId: 1000006677
requestId: sfb7x1we9w
title:
Mastercard Open Banking Verification of Asset and Income -
Transactions
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
constraints:
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1577986990
incomeFromDate: 1577986990
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
showNsf: false
type: voaHistory
status: success
createdDate: 1588350269
startDate: 1572625469
endDate: 1588350269
days: 230
seasoned: true
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
id: 6001966289
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1652114265
name: Checking
type: checking
currency: USD
aggregationStatusCode: 0
balance: 509.37
balanceDate: 1652114265
averageMonthlyBalance: 507.37
totNumberInsufficientFundsFeeDebitTxAccount: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount: 0
transactions:
id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
memo: Finicity amount credit
investmentTransactionType: dividend
normalizedPayee: Finicity
institutionTransactionId: '100000000'
category: Paycheck
asset:
type: checking
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 1000
marginBalance: 100.00
currentBalance: 1000.00
position:
- id: 637054
currency: USD
symbol: MCD
securityName: Common Stock
units: 5
marketValue: 1403.55
currentPrice: 280.71
securityType: Stock
incomeStreams:
id: dens28i3vsch-voah
name: none
status: ACTIVE
estimateInclusion: MODERATE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 14
netMonthly:
- month: 1522562400
net: 2004.77
netAnnual: 110475.7
projectedNetAnnual: 0
estimatedGrossAnnual: 0
projectedGrossAnnual: 151609
averageMonthlyIncomeNet: 9206.31
incomeStreamMonths: 18
transactions:
- id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
normalizedPayee: Finicity
institutionTransactionId: '100000000'
category: Paycheck
assets:
currentBalance: 1000
twoMonthAverage: -1865.96
sixMonthAverage: -7616.01
beginningBalance: -17795.6
consolidatedAvailableBalance: 2345
VOIEWithStatementReportExample:
summary: VOIE With Statement Report
value:
id: cniwx4y891fb-voietxverify
portfolioId: 1sei090j3wmc-8-port
gseEnabled: true
customerType: testing
customerId: 1000834291
consumerId: fbedccb8378ea2ea9017e0f083d04c3b
consumerSsn: '0001'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
requesterName: Intuit Facade Demo (KEEP)
requestId: yfx7exq2d8
type: voieTxVerify
status: success
createdDate: 1711008839
title:
Mastercard Open Banking Verification of Income and Employment -
Paystub
reportStyle: voieWithStatement
constraints:
voieWithStatementData:
assetIds:
- a96cb546-41f1-4edd-bf2f-ea0840596a4e-1287200036
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
assetIds:
- a96cb546-41f1-4edd-bf2f-ea0840596a4e-1287200036
numberOfBillableAssets: 1
payStatements:
- payPeriod: Latest
billable: true
assetId: a96cb546-41f1-4edd-bf2f-ea0840596a4e-1287200036
payDate: 1541030399
startDate: 1538352000
endDate: 1541030399
netPayCurrent: 120
netPayYTD: 12345
grossPayCurrent: 342
grossPayYTD: 4223
payrollProvider:
employer:
name: John Homeowner
address1: 222 Street
address2: 345 Street
city: City
state: State
zip: '80001'
employee:
name: Acme Ltd
address1: 123 Main St
address2: Suite 100
city: City
state: State
zip: '80001'
payStat:
- name: regular statement
type: REGULAR
description: regular income
rate: 8
units: 40
amountCurrent: 320
amountYTD: 750.79
- name: ot statement
type: OVERTIME
description: OT income
rate: 10
units: 40
amountCurrent: 400
amountYTD: 1000.78
- name: Commission statement
type: Commission
description: Commission income
rate: 11
units: 40
amountCurrent: 440
amountYTD: 2435.54
deductions: []
directDeposits: []
monthlyIncome:
estimatedMonthlyBasePay: -922.94
estimatedMonthlyOvertimePay: 564.94
estimatedMonthlyCommissionPay: 200
estimatedMonthlyBonusPay: 41.67
estimatedMonthlyTotalPay: -116.33
institutions: []
VOEPayrollReportExample:
summary: VOE - Payroll Report
value:
id: 41h4nzppn47u-voepayroll
portfolioId: 9qud7dtuzbew-1-port
gseEnabled: true
createdDate: 1579819592
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 7a7qyps2iy
customerType: active
customerId: 1275320
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
disputeStatement: 'Invalid data present.'
type: voePayroll
reportStyle: credentialedPayroll
title: Mastercard Open Banking Verification of Employment - Payroll
status: success
constraints:
payrollData:
payrollAccountIds:
- 018d3f0e-6c1c-fa13-7e50-0003acfcfdae
payrollAggregatorResponseId: '4baxktu9wdda'
employmentHistory:
- asOfDate: 1596175200
employmentId: zgk6wh3urqr0gtxv
employerName: ACME INC
payrollSource: argyle
payrollProvider: Paychex
employee:
name: John Doe Smith
givenName: John
middleName: Doe
familyName: Smith
address:
- address1: Address 1
city: City
state: TX
zip: '99999'
employment:
employerName: ACME INC
legalEntityId: '752760000'
originalHireDate: 1527832800
latestHireDate: 1527832800
latestPayDate: 1596175200
daysSinceLastPay: 10
numberPayCadenceWithoutPay: 1
employmentEndDate: 1527832800
employmentDuration: P1Y6M0D
employerAddress:
- address1: Address 1
city: City
state: TX
zip: '99999'
employmentStatusCode: A
employmentStatusName: Active
workLevelCode: FT
workLevelName: Full Time-Regular
latestPayPeriodEndDate: 1699747200
derivedEmploymentStatus: false
workLevelStatus: Full Time
positionTitle: Shift Supervisor
positionDuration: P1Y6M0D
income:
payFrequency: Weekly
VOETransactionsReportExample:
summary: VOE - Transactions Report
value:
id: n1rndg1iz8yy-voetransactions
portfolioId: dyr6weqd2yhb-2-port
customerType: active
customerId: 1000006677
requestId: sfb7x1we9w
title: Mastercard Open Banking Verification of Employment - Transactions
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
constraints:
reportId: j7k8qbgwsa7d-voietxverify
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
incomeStreamConfidenceMinimum: 50
type: voeTransactions
status: success
createdDate: 1588350269
startDate: 1572625469
endDate: 1588350269
days: 120
seasoned: true
institutions:
- id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
- id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress:
'924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1652114265
name: Checking
type: checking
aggregationStatusCode: 0
incomeStreams:
- id: u4hstnyak45g1
name: none
status: ACTIVE
estimateInclusion: MODERATE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 14
daysSinceLastTransaction: 15
nextExpectedTransactionDate: 1698788820
incomeStreamMonths: 18
transactions:
- id: 100000527471
postedDate: 1582286400
description: FINICITY INC PAYROLL
normalizedPayee: Finicity
institutionTransactionId: '100000000'
category: Paycheck
VOIReportExample:
summary: VOI Report
value:
id: u4hstnnaewetr-voi
customerId: 1000006677
consumerId: ac39e237c7619a4ecf014b8d399c0696
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: sfb7xp4wer
type: voi
status: success
createdDate: 1588350269
customerType: active
title: Mastercard Open Banking Verification of Income
startDate: 1572625469
endDate: 1588350269
days: 200
seasoned: true
portfolioId: dyr6qvqd2erw-1-port
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1577986990
name: Checking
type: checking
aggregationStatusCode: 0
incomeStreams:
id: dens28i3vsch-voi1
name: none
status: ACTIVE
estimateInclusion: MODERATE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 14
netMonthly:
- month: 1522562400
net: 2004.77
netAnnual: 110475.7
projectedNetAnnual: 0
estimatedGrossAnnual: 0
projectedGrossAnnual: 151609
averageMonthlyIncomeNet: 9206.31
incomeStreamMonths: 18
transactions:
- id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
memo: Finicity amount credit
institutionTransactionId: '100000000'
category: Paycheck
balance: 714.16
averageMonthlyBalance: 720.75
transactions: []
availableBalance: 714.16
currentBalance: 714.16
beginningBalance: 714.77
miscDeposits:
- id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
memo: Finicity amount credit
institutionTransactionId: '100000000'
category: Paycheck
income:
- confidenceType: MODERATE
netMonthly:
- month: 1522562400
net: 2004.77
incomeEstimate:
netAnnual: 1000.12
projectedNetAnnual: 1500.23
estimatedGrossAnnual: 2000.12
projectedGrossAnnual: 2500.23
VOIEPayrollReportExample:
summary: VOIE - Payroll Report
value:
id: 41h4nzppn37u-voiepayroll
portfolioId: 9qud7dtuzbew-1-port
gseEnabled: true
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
type: voiePayroll
reportStyle: credentialedPayroll
status: success
createdDate: 1579819592
title:
Mastercard Open Banking Verification of Income and Employment -
Payroll
constraints:
payrollData:
payrollAccountIds:
- 018b8f10-fdf8-0ef7-ded5-34a17c34d86f
payrollAggregatorResponseId: '4baxktu9wdda'
reportCustomFields:
label: loanID
value: '12345'
shown: true
employmentHistory:
asOfDate: 1596175200
employmentId: vkvxszcy7nc9c19d
employerName: ACME INC
payrollSource: argyle
payrollProvider: Paychex
employee:
name: John Doe Smith
givenName: John
middleName: Doe
familyName: Smith
address:
- address1: Address 1
city: City
state: TX
zip: '99999'
employment:
employerName: ACME INC
legalEntityId: '752760000'
originalHireDate: 1527832800
latestHireDate: 1527832800
latestPayDate: 1596175200
daysSinceLastPay: 10
numberPayCadenceWithoutPay: 1
employmentEndDate: 1527832800
employmentDuration: P1Y6M0D
employerAddress:
- address1: Address 1
city: City
state: TX
zip: '99999'
employmentStatusCode: A
employmentStatusName: Active
workLevelCode: FT
workLevelName: Full Time-Regular
workLevelStatus: Full Time
positionTitle: Shift Supervisor
positionDuration: P1Y6M0D
income:
payFrequency: Weekly
payType: Hourly
basePayRate: 27.5
annualIncome:
- year: '2021'
grossPayAmountYTD: 73925.12
netPayAmountYTD: 73925.12
basePayAmountYTD: 73925.12
overtimePayAmountYTD: 100.01
- year: '2020'
grossPayAmountYTD: 73925.12
netPayAmountYTD: 73925.12
basePayAmountYTD: 73925.12
overtimePayAmountYTD: 100.01
- year: '2019'
grossPayAmountYTD: 73925.12
netPayAmountYTD: 73925.12
basePayAmountYTD: 73925.12
overtimePayAmountYTD: 100.01
monthlyIncome:
estimatedMonthlyBasePay: 2000
estimatedMonthlyOvertimePay: 100
directPayStatements:
- payrollPayHistoryId: cy1a742k28
lastPayPeriodIndicator: true
mainPayStatementFields:
payDate: 1596175200
startDate: 1595138400
endDate: 1595656800
payPeriodHours: 40
payFrequency: Weekly
payType: Hourly
grossPayAmount: 1888.75
grossPayAmountYTD: 73925
netPayAmount: 1401.95
netPayAmountYTD: 73925
earnings:
- name: basePayAmount
type: base
rate: 27.5
amount: 1100
amountYTD: 5500
deductions:
- type: Federal tax
amount: 143.45
- type: State tax
amount: 12.5
VOIEPaystubReportExample:
summary: VOIE - Paystub Report
value:
id: 2f3z55zuwewm-voietxverify
portfolioId: 9qud7dtuzbew-13-port
customerType: active
customerId: 1275320
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 7a7qyps2iy
type: voieTxVerify
status: success
createdDate: 1579819592
title: Verification of Income and Employment - Paystub
reportStyle: voieWithStatement
constraints:
voieWithStatementData:
assetIds:
- d50ed92f-543b-431c-8286-c8b8f6556679
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
numberOfBillableAssets: 1
payStatements:
payPeriod: LastPayPeriod
billable: true
assetId: 6f8fb0a0-e882-4f57-b672-cf53f1397581
payDate: 1559241000
startDate: 1557513000
endDate: 1558722600
netPayCurrent: 1802.22
netPayYTD: 36000
grossPayCurrent: 24200
grossPayYTD: 72600
employer:
name: Rocket Surgery
employee:
name: Patrick Purchaser
payStat:
name: regular 1
type: regular
description: regular income
amountCurrent: 6000
amountYTD: 18000
directDeposits:
- amountCurrent: 1744.61
accountLastFour: '1234'
monthlyIncome:
estimatedMonthlyBasePay: 2000
estimatedMonthlyOvertimePay: 50
estimatedMonthlyBonusPay: 20
estimatedMonthlyCommissionPay: 50
institutions: []
VOIEPaystubWithTXVerifyReportExample:
summary: VOIE - Paystub With TXVerify Report
value:
id: 2f3z55zuwewm-voietxverify
customerId: 1275320
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '6789'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
requestId: 7a7qyps2iy
type: voieTxVerify
status: success
createdDate: 1579819592
title: Verification of Income and Employment - Paystub (with TXVerify)
constraints:
accountIds:
- '1000535275'
- '6001966284'
fromDate: 1620322948
voieWithInterviewData:
txVerifyInterview:
- assetId: 6f8fb0a0-e882-4f57-b672-cf53f1397581
accounts: []
extractEarnings: true
extractDeductions: false
extractDirectDeposit: true
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
incomeStreamConfidenceMinimum: 50
customerType: active
portfolioId: 9qud7dtuzbew-13-port
numberOfBillableAssets: 1
reportStyle: voieWithInterview
assetIds:
- 6f8fb0a0-e882-4f57-b672-cf53f1397581
payStatements:
payPeriod: LastPayPeriod
billable: true
assetId: 6f8fb0a0-e882-4f57-b672-cf53f1397581
payDate: 1559241000
startDate: 1557513000
endDate: 1558722600
netPayCurrent: 1802.22
netPayYTD: 36000
grossPayCurrent: 24200
grossPayYTD: 72600
matchType: NET_PAY_MATCH
employer:
name: Rocket Surgery
employee:
name: Patrick Purchaser
payStat:
name: regular 1
type: regular
description: regular income
amountCurrent: 6000
amountYTD: 18000
directDeposits:
- fiName: America First
accountType: Checking
amountCurrent: 1744.61
description: Payroll
monthlyIncome:
estimatedMonthlyBasePay: 2000
estimatedMonthlyOvertimePay: 50
estimatedMonthlyBonusPay: 20
estimatedMonthlyCommissionPay: 50
estimatedMonthlyOtherPay: 150
estimatedMonthlyTotalPay: 2120
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
id: 1000023996
number: '1111'
ownerName: 'JOHN DOE'
ownerAsOfDate: 1577986990
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
name: Checking
type: checking
availableBalance: 123.45
aggregationStatusCode: 0
balance: 123.45
balanceDate: 1588350276
averageMonthlyBalance: 301.45
transactions: []
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 2000
incomeStream:
id: dens28i3vsch-voitxverify2
name: none
status: ACTIVE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 180
netAnnual: 110475.7
projectedNetAnnual: 0
estimatedGrossAnnual: 0
projectedGrossAnnual: 151609
incomeStreamMonths: 24
averageMonthlyIncomeNet: 9206.31
transactions:
- id: 100000527471
amount: 1802.22
postedDate: 1559241000
description: FINICITY INC PAYROLL
memo: Finicity amount credit
institutionTransactionId: '100000000'
category: Paycheck
payStatementMatchTypes:
- DATE
- NET_AMOUNT
- DIRECT_DEPOSIT_AMOUNT
- EMPLOYER_NAME
- INCOME_STREAM_PAYCHECK
incomeStreams:
- id: dens28i3vsch-voitxverify2
name: none
status: ACTIVE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 180
netAnnual: 110475.7
projectedNetAnnual: 0
estimatedGrossAnnual: 0
projectedGrossAnnual: 151609
incomeStreamMonths: 24
averageMonthlyIncomeNet: 9206.31
transactions:
- id: 100000527471
amount: 1802.22
postedDate: 1559241000
description: FINICITY INC PAYROLL
memo: Finicity amount credit
institutionTransactionId: '100000000'
category: Paycheck
payStatementMatchTypes:
- DATE
- NET_AMOUNT
- DIRECT_DEPOSIT_AMOUNT
- EMPLOYER_NAME
- INCOME_STREAM_PAYCHECK
institutions:
id: 101732
name: FinBank
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
- id: 1000023996
ownerName: 'JOHN DOE'
ownerAddress: '924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518'
ownerAsOfDate: 1577986990
name: Checking
number: '1111'
type: checking
aggregationStatusCode: 0
incomeStreams:
- id: dens28i3vsch-voietxverify
name: none
status: ACTIVE
confidence: 70
cadence:
startDate: 1577986990
stopDate: 1587986990
days: 180
netMonthly:
- month: 1522562400
net: 2004.77
netAnnual: 110475.7
projectedNetAnnual: 0
estimatedGrossAnnual: 0
projectedGrossAnnual: 151609
averageMonthlyIncomeNet: 9206.31
incomeStreamMonths: 24
transactions:
- id: 100000527471
amount: 1802.22
postedDate: 1559241000
description: FINICITY INC PAYROLL
memo: Finicity amount credit
institutionTransactionId: '100000000'
category: Paycheck
balance: 123.45
averageMonthlyBalance: 301.45
transactions:
- id: 100000527471
amount: 22.21
postedDate: 1582286400
description: FINICITY INC PAYROLL
memo: Finicity amount credit
investmentTransactionType: dividend
normalizedPayee: Finicity
institutionTransactionId: '100000000'
category: Paycheck
bestRepresentation: FINICITY INC PAYROLL
details:
interestMarginBalance: -50000
availableCashBalance: 1500
vestedBalance: 300000
currentLoanBalance: 0
availableBalanceAmount: 1000
marginBalance: 100.00
currentBalance: 1000.00
BillingResellerReportExample:
value:
pageable:
totalPages: 1
totalElements: 2
last: true
sort:
sorted: false
unsorted: true
empty: true
size: 0
number: 0
numberOfElements: 2
first: true
empty: false
content:
- reseller: 'resellerName'
resellerProvider: 'resellerProvider'
platformProvider: 'platformProvider'
customerId: 889079
consumerId: '3569a3ec3315e458e61f3c37ef9a3df4'
consumerSsn: '1111'
firstName: 'BarkFirst'
lastName: 'BarkLast'
lastFourReportId: 'twxe'
reportId: 'abcdeftwxe-voieTxVerify'
createdDate: 1560244594
reportType: 'voieTxVerify'
status: 'failure'
reportCustomFields:
- label: 'Loan_ID'
value: 'asdf123lkj124j59fkfj'
shown: false
- label: 'trackingNumber'
value: 'asdf123lkj124j59fkfj'
shown: false
- reseller: ''
resellerProvider: ''
platformProvider: 'provider'
customerId: 889079
lastFourReportId: '7gg5'
reportId: 'abcdef7gg5-voi'
createdDate: 1560244594
reportType: voi
status: 'failure'
reportCustomFields:
- label: 'Loan_ID'
value: 'asdf123lkj124j59fkfj'
shown: false
GenerateBalanceBusinessCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Balance Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbcra
status: inProgress
GenerateBalanceBusinessNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Balance Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbnoncra
status: inProgress
GenerateBalanceBusinessFtcAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbftc
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Balance Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbftc
status: inProgress
GenerateBalancePersonalCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barpcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Balance Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
constraints:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barpcra
status: inProgress
GenerateBalancePersonalNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barpnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Balance Analytics
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barpnoncra
status: inProgress
GenerateCashflowBusinessCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-cfrbcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbcra
status: inProgress
GenerateCashflowBusinessNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-cfrbnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbnoncra
status: inProgress
GenerateCashflowBusinessFtcAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-cfrbftc
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barbftc
status: inProgress
GenerateCashflowPersonalCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-cfrpcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
constraints:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barpcra
status: inProgress
GenerateCashflowPersonalNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-cfrpnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Cash Flow Analytics
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: trackingID
value: '5555'
shown: true
- label: loanType
value: car
shown: false
- label: vendorID
value: 1613aa23
shown: true
- label: vendorName
value: PSC Finance
shown: false
type: barpnoncra
status: inProgress
GeneratePaymentHistoryBusinessCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '1-801-443-7288'
email: 'customerservice@example.com'
url: 'example.com'
createdDate: 1579819592
title: Mastercard Open Banking Payment History Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: loanType
value: car
shown: false
- label: vendorName
value: PSC Finance
shown: false
type: phrbcra
status: inProgress
GeneratePaymentHistoryBusinessNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Payment History Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: loanType
value: car
shown: false
- label: vendorName
value: PSC Finance
shown: false
type: phrbnoncra
status: inProgress
GeneratePaymentHistoryBusinessFtcAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbftc
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
createdDate: 1579819592
title: Mastercard Open Banking Payment History Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
accountIds:
- '1000535275'
- '1000535276'
fromDate: 1673034682
reportCustomFields:
- label: loanID
value: '12345'
shown: true
- label: loanType
value: car
shown: false
- label: vendorName
value: PSC Finance
shown: false
type: phrbftc
status: inProgress
ForesightAnalyticsNonCraReportResponseExample:
value:
id: 247th25xwyhd-farpbfnoncra
customerType: testing
customerId: 1001483250
requestId: y3pic4xhda
requesterName: Intuit Facade Demo (KEEP)
createdDate: 1739824892
title: Mastercard Open Banking Foresight Analytics
reportPin: XYeyLA
type: farpbfnoncra
status: success
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 25
startDate: 1676666492
endDate: 1739824892
days: 731
institutions:
- id: 101732
name: FinBank
urlHomeApp: 'https://finbank.prod.fini.city/CCBankImageMFA/login.jsp'
accounts:
- id: 1005179748
name: Credit Card
number: '7777'
type: creditCard
aggregationStatusCode: 0
currentBalance: 217.41
balanceDate: 1739824918
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
- id: 1005179749
name: Savings
number: '2222'
type: savings
aggregationStatusCode: 0
currentBalance: 217.42
availableBalance: 217.42
balanceDate: 1739824929
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
- id: 1005179750
name: Checking
number: '1111'
type: checking
aggregationStatusCode: 0
currentBalance: 217.42
availableBalance: 217.42
balanceDate: 1739824938
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
oauthEnabled: false
customerAnalytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -260.61
percentageDifferenceToCohort: -213.07
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -122.31
transactionIds:
- '1'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -180.55
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -89.14
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -14.09
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -159.09
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -84.48
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -22.39
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -110.58
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: 171.57
percentageDifferenceToCohort: 67.42
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -254.49
transactionIds:
- '2'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -996.25
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -87.78
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -34.61
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -183.85
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -332.33
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -513.38
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -149.45
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -382.92
percentageDifferenceToCohort: null
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: 0
transactionIds:
- '1'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -82.92
percentageDifferenceToCohort: null
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: 0
transactionIds:
- '2'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
gseEnabled: true
ForesightAnalyticsFirstThirdPartyNonCraReportResponseExample:
value:
id: 247th25xwyhd-farpbfnoncra
customerType: testing
customerId: 1001483250
externalCustomerId: 1005061234
requestId: y3pic4xhda
requesterName: Intuit Facade Demo (KEEP)
createdDate: 1739824892
title: Mastercard Open Banking Foresight Analytics
reportPin: XYeyLA
type: farpbfnoncra
status: success
constraints:
customerId: 1001483250
externalCustomerId: 1005061234
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
segments:
geolocation:
- label: POSTAL_CODE
value: 84123
analytics:
- benchmarking
- forecasting
income: 1000
age: 25
startDate: 1676666492
endDate: 1739824892
days: 731
institutions:
- id: 101732
name: FinBank
urlHomeApp: 'https://finbank01.stg.fini.city/FinBank/greetings.jsp'
accounts:
- id: 1005179748
name: Credit Card
number: '7777'
type: creditCard
aggregationStatusCode: 0
currentBalance: 217.41
balanceDate: 1739824918
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
- id: 1005179749
name: Savings
number: '2222'
type: savings
aggregationStatusCode: 0
currentBalance: 217.42
availableBalance: 217.42
balanceDate: 1739824929
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
- id: 1005179750
name: Checking
number: '1111'
type: checking
aggregationStatusCode: 0
currentBalance: 217.42
availableBalance: 217.42
balanceDate: 1739824938
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
- id: 41
name: Decisioning API Tests
accounts:
- id: 1005179748
type: savings
analytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '1'
projectedValues: []
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues: []
transactionIds:
- '2'
projectedValues: []
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
currency: USD
oauthEnabled: false
customerAnalytics:
transactionalAttributes:
- attributeName: ACCOMMODATION_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -260.61
percentageDifferenceToCohort: -213.07
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -122.31
transactionIds:
- '1'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: ENTERTAINMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -180.55
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: FUEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -89.14
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: BOOKS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -14.09
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: COMMUNICATION_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -159.09
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: CONSUMER_ELECTRONICS_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -84.48
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: PHARMACY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -22.39
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: EATING_PLACES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -110.58
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: CLOTHING_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: 171.57
percentageDifferenceToCohort: 67.42
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -254.49
transactionIds:
- '2'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: FINANCIAL_SERVICES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -996.25
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: GROCERIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -87.78
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: HEALTH_BEAUTY_MEDICAL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -34.61
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: HOME_IMPROVEMENT_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -183.85
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -332.33
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: TRAVEL_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -513.38
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: UTILITIES_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: null
count: 0
mean: null
median: null
min: null
max: null
standardDeviation: null
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: -149.45
transactionIds: []
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -382.92
count: 1
mean: -382.92
median: -382.92
min: -382.92
max: -382.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -382.92
percentageDifferenceToCohort: null
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: 0
transactionIds:
- '1'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
sum: -82.92
count: 1
mean: -82.92
median: -82.92
min: -82.92
max: -82.92
standardDeviation: null
comparedToCohorts:
- cohortType: POSTAL_CODE
totalDifferenceToCohort: -82.92
percentageDifferenceToCohort: null
cohortBenchmarkPeriods:
- startDate: '2023-04-25'
endDate: '2023-05-01'
cohortValues:
- cohortType: POSTAL_CODE
value: 0
transactionIds:
- '2'
projectedValues:
- timeUnit: MONTHS
timeValue: 3
projectionValue: -20
- timeUnit: MONTHS
timeValue: 6
projectionValue: -40
- timeUnit: MONTHS
timeValue: 9
projectionValue: -60
- timeUnit: MONTHS
timeValue: 12
projectionValue: -80
streamIds: []
streamConfidences: null
stateAttributes: []
streams:
- id: d5740963-b2d7-4ac9-a5a2-7ba323bfa14b
payor: Account Owner (Name Unavailable)
payee: td ameritrade
cadence: 0
status: inactive
recency: 639
earliestObservedDate: '2023-04-25T07:12:33'
latestObservedDate: '2023-05-01T07:12:33'
count: 2
sum: -465.84
min: -382.92
max: -82.92
mean: -232.92
median: -232.92
standardDeviation: 212.13203435596427
minimumCadence: null
maximumCadence: null
medianCadence: null
modeCadence: null
standardDeviationCadence: null
transactionIds:
- '1'
- '2'
gseEnabled: true
BalanceBusinessCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
title: Mastercard Open Banking Balance Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
type: barbcra
status: success
createdDate: 1579819592
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000003'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000004'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000007'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000008'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
customerAnalytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
BalanceBusinessNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
title: Mastercard Open Banking Balance Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
type: barbnoncra
status: success
createdDate: 1579819592
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000003'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000004'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000007'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000008'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
customerAnalytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
BalanceBusinessFtcAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barbftc
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
title: Mastercard Open Banking Balance Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
reportPin: '2398jk'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
type: barbftc
status: success
createdDate: 1579819592
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000003'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000004'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000007'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000008'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
customerAnalytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
BalancePersonalCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barpcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
title: Mastercard Open Banking Balance Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
constraints:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
type: barpcra
status: success
createdDate: 1579819592
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000003'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000004'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000007'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000008'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
customerAnalytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '6010290887'
- '6010290914'
BalancePersonalNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-barpnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '555-2106'
email: 'customerservice@example.com'
url: 'example.com'
title: Mastercard Open Banking Balance Analytics
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
type: barpnoncra
status: success
createdDate: 1579819592
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000003'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000004'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1577986990
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000007'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000008'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
customerAnalytics:
transactionalAttributes: []
stateAttributes:
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: MONTHLY_CALENDAR
periods:
- startDate: '2023-02-05'
endDate: '2023-02-28'
sum: 75517.99999999997
count: 24
mean: 3146.583333333333
median: 3145.2
min: 3145.2
max: 3178.4
standardDeviation: 6.776921621700182
beginningValue: 3145.2
endingValue: 3178.4
- startDate: '2023-03-01'
endDate: '2023-03-31'
sum: 95350.54000000005
count: 31
mean: 3075.823870967742
median: 3178.4
min: 2946.3
max: 3329.22
standardDeviation: 132.58604314877732
beginningValue: 3178.4
endingValue: 3329.22
streams:
- id: 2b96f6d4-4882-4db2-96c6-f89530a68f1c
payor: TD AMERITRADE
payee: John Smith
cadence: 15
recency: 124
transactionIds:
- '00000003'
- '00000004'
- '00000001'
- id: dafc9b5d-762d-4f91-a429-f80573944bcd
payor: John Smith
payee: TD AMERITRADE
cadence: 0
recency: 139
transactionIds:
- '00000002'
- id: b838ffb3-2549-43b3-a1b1-50bc13438e0f
payor: John Smith
payee: Whole Foods
cadence: 0
recency: 124
transactionIds:
- '00000005'
- '00000008'
- id: 54214633-39d7-43f4-9314-bae2ce3b6af9
payor: John Smith
payee: Walmart
cadence: 0
recency: 139
transactionIds:
- '00000006'
- '00000007'
CashflowBusinessCraAnalyticsReportResponseExample:
value:
id: iuvend2k7jir-cfrbcra
customerType: testing
customerId: 3011077785
requestId: ykmrghjeb3
requesterName: Open Banking API Tests
createdDate: 1721816826
title: Mastercard Open Banking Cash Flow Analytics
consumerId: 8d510370aae83d459da0b905ee59e714
consumerSsn: '1147'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: Invalid data present.
type: cfrbcra
status: success
businessDetails:
businessId: '48599'
name: ABC Tires Inc - 1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: US
postalCode: '84116'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
startDate: 1658658426
endDate: 1721816826
days: 731
institutions:
- id: 102105
name: FinBank Profiles - A
urlHomeApp: http://www.finbank.com
accounts:
- id: 3027530345
ownerName: BOB JONES
ownerAddress: 123 MAIN ST AUSTIN, TX 78754
ownerAsOfDate: 1577986990
name: Checking
number: '7777'
type: checking
aggregationStatusCode: 0
currentBalance: 10000
availableBalance: 10000
balanceDate: 1721813307
transactions: []
analytics: null
currency: USD
- id: 3027530346
name: Checking
number: '9999'
type: checking
aggregationStatusCode: 0
currentBalance: 10000
availableBalance: 10000
balanceDate: 1721813305
transactions:
- id: 101402235165
amount: 258
postedDate: 1694001600
description: ACH deposit CAPITAL1 P2P Bob Jones Bob Jones
normalizedPayee: Capital1 Bob Jones
institutionTransactionId: '0000000000'
category: Deposit
- id: 101402235110
amount: 3.79
postedDate: 1693483200
description: IOD INTEREST PAID
normalizedPayee: Iod Paid
institutionTransactionId: '0000000000'
category: Interest Income
- id: 101402235081
amount: -2179
postedDate: 1693224000
description: Online banking xfer withdrawal from ...9999
normalizedPayee: Online Banking
institutionTransactionId: '0000000000'
category: Transfer
- id: 101402235162
amount: 5.49
postedDate: 1672401600
description: IOD INTEREST PAID
normalizedPayee: Iod Paid
institutionTransactionId: '0000000000'
category: Interest Income
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 2
endDate: '2023-01-31'
max: -4361.6
mean: -4564.700000000001
median: -4564.700000000001
min: -4767.8
standardDeviation: 287.22677451797546
startDate: '2023-01-01'
sum: -9129.400000000001
- count: 2
endDate: '2024-06-30'
max: -300
mean: -829.055
median: -829.055
min: -1358.11
standardDeviation: 748.1967562412977
startDate: '2024-06-01'
sum: -1658.11
- count: 2
endDate: '2024-07-24'
max: -300
mean: -829.055
median: -829.055
min: -1358.11
standardDeviation: 748.1967562412977
startDate: '2024-07-01'
sum: -1658.11
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 675f5d35-8ce2-442e-a213-f6a3d9a5696b
- 7b54c715-db4e-4eed-ad00-d5e09dec7245
transactionIds:
- '101402235156'
- '101402235115'
- '101402235144'
- '101402235116'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-12-31'
max: 5.49
mean: 5.49
median: 5.49
min: 5.49
startDate: '2022-12-30'
sum: 5.49
- count: 4
endDate: '2023-01-31'
max: 60
mean: 31.6125
median: 31.87
min: 2.71
standardDeviation: 32.781758520046886
startDate: '2023-01-01'
sum: 126.45
- count: 3
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 583.123771881522
startDate: '2024-06-01'
sum: 1190
- count: 3
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 583.123771881522
startDate: '2024-07-01'
sum: 1190
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 489cf368-4697-4ea8-b975-b1d17843def7
- dab60ad6-3c4f-46e7-a408-c99e7db87789
- 3e61d882-dd74-4866-a494-8dfbff1a3a17
transactionIds:
- '101402235175'
- '101402235186'
- '101402235151'
- '101402235125'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-12-31'
max: 5.49
mean: 5.49
median: 5.49
min: 5.49
startDate: '2022-12-30'
sum: 5.49
- count: 6
endDate: '2023-01-31'
max: 60
mean: -1500.4916666666668
median: 3.225
min: -4767.8
standardDeviation: 2377.1344632259797
startDate: '2023-01-01'
sum: -9002.95
- count: 5
endDate: '2024-06-30'
max: 1070
mean: -93.62199999999999
median: 60
min: -1358.11
standardDeviation: 872.1721988346109
startDate: '2024-06-01'
sum: -468.1099999999999
- count: 5
endDate: '2024-07-24'
max: 1070
mean: -93.62199999999999
median: 60
min: -1358.11
standardDeviation: 872.1721988346109
startDate: '2024-07-01'
sum: -468.1099999999999
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 675f5d35-8ce2-442e-a213-f6a3d9a5696b
- dab60ad6-3c4f-46e7-a408-c99e7db87789
- 3e61d882-dd74-4866-a494-8dfbff1a3a17
- 7b54c715-db4e-4eed-ad00-d5e09dec7245
transactionIds:
- '101402235186'
- '101402235156'
- '101402235135'
- '101402235114'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2023-02-28'
startDate: '2023-02-01'
- count: 0
endDate: '2023-03-31'
startDate: '2023-03-01'
- count: 0
endDate: '2023-04-30'
startDate: '2023-04-01'
- count: 0
endDate: '2023-05-31'
startDate: '2023-05-01'
- count: 0
endDate: '2023-06-30'
startDate: '2023-06-01'
- count: 0
endDate: '2023-07-31'
startDate: '2023-07-01'
- count: 0
endDate: '2023-08-31'
startDate: '2023-08-01'
- count: 0
endDate: '2023-09-30'
startDate: '2023-09-01'
- count: 0
endDate: '2023-10-31'
startDate: '2023-10-01'
- count: 0
endDate: '2023-11-30'
startDate: '2023-11-01'
- count: 0
endDate: '2023-12-31'
startDate: '2023-12-01'
- count: 0
endDate: '2024-01-31'
startDate: '2024-01-01'
- count: 0
endDate: '2024-02-29'
startDate: '2024-02-01'
- count: 0
endDate: '2024-03-31'
startDate: '2024-03-01'
- count: 0
endDate: '2024-04-30'
startDate: '2024-04-01'
- count: 0
endDate: '2024-05-31'
startDate: '2024-05-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 170
mean: 139.57142857142858
median: 170
min: 99
standardDeviation: 37.95109635156426
startDate: '2022-07-24'
sum: 977
- count: 40
endDate: '2022-08-31'
max: 688
mean: 199.2625
median: 144
min: 36
standardDeviation: 162.26367381439258
startDate: '2022-08-01'
sum: 7970.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 818430df-5f14-40ec-af3d-cde2ada40087
- cceef475-c1b4-4648-9113-d73d3c01aa40
- f7f8bb8b-8820-4a94-b9ac-f88f0d859dd1
- fcbc00c3-63f5-48d1-8302-13018a4eccea
transactionIds:
- '101402245116'
- '101402245119'
- '101402245133'
- '101402245135'
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 5.49
count: 2
endDate: '2022-12-31'
endingValue: 0
max: 5.49
mean: 2.745
median: 2.745
min: 0
standardDeviation: 3.882016228714146
startDate: '2022-12-30'
sum: 5.49
- beginningValue: 0
count: 31
endDate: '2023-01-31'
endingValue: 3.74
max: 60
mean: -290.4177419354839
median: 0
min: -4767.8
standardDeviation: 1142.3378998343987
startDate: '2023-01-01'
sum: -9002.95
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 1130
mean: -15.603666666666664
median: 0
min: -1658.11
standardDeviation: 372.43488390342935
startDate: '2024-06-01'
sum: -468.1099999999999
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 1130
mean: -19.50458333333333
median: 0
min: -1658.11
standardDeviation: 418.1064188226347
startDate: '2024-07-01'
sum: -468.1099999999999
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 489cf368-4697-4ea8-b975-b1d17843def7
payee: Account Owner (Name Unavailable)
payor: capital1 bob jones
recency: 4
transactionIds:
- '101402235094'
- '101402235119'
- '101402235109'
- '101402235143'
- cadence: 37
id: 7b54c715-db4e-4eed-ad00-d5e09dec7245
payee: capital one
payor: Account Owner (Name Unavailable)
recency: 247
transactionIds:
- '101402235091'
- '101402235156'
currency: USD
oauthEnabled: false
customerAnalytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 2
endDate: '2023-01-31'
max: -4361.6
mean: -4564.700000000001
median: -4564.700000000001
min: -4767.8
standardDeviation: 287.22677451797546
startDate: '2023-01-01'
sum: -9129.400000000001
- count: 2
endDate: '2024-06-30'
max: -300
mean: -829.055
median: -829.055
min: -1358.11
standardDeviation: 748.1967562412977
startDate: '2024-06-01'
sum: -1658.11
- count: 2
endDate: '2024-07-24'
max: -300
mean: -829.055
median: -829.055
min: -1358.11
standardDeviation: 748.1967562412977
startDate: '2024-07-01'
sum: -1658.11
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 675f5d35-8ce2-442e-a213-f6a3d9a5696b
- 7b54c715-db4e-4eed-ad00-d5e09dec7245
transactionIds:
- '101402235156'
- '101402235115'
- '101402235144'
- '101402235116'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-12-31'
max: 5.49
mean: 5.49
median: 5.49
min: 5.49
startDate: '2022-12-30'
sum: 5.49
- count: 4
endDate: '2023-01-31'
max: 60
mean: 31.6125
median: 31.87
min: 2.71
standardDeviation: 32.781758520046886
startDate: '2023-01-01'
sum: 126.45
- count: 3
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 583.123771881522
startDate: '2024-06-01'
sum: 1190
- count: 3
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 583.123771881522
startDate: '2024-07-01'
sum: 1190
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 489cf368-4697-4ea8-b975-b1d17843def7
- dab60ad6-3c4f-46e7-a408-c99e7db87789
- 3e61d882-dd74-4866-a494-8dfbff1a3a17
transactionIds:
- '101402235175'
- '101402235186'
- '101402235151'
- '101402235125'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-12-31'
max: 5.49
mean: 5.49
median: 5.49
min: 5.49
startDate: '2022-12-30'
sum: 5.49
- count: 6
endDate: '2023-01-31'
max: 60
mean: -1500.4916666666668
median: 3.225
min: -4767.8
standardDeviation: 2377.1344632259797
startDate: '2023-01-01'
sum: -9002.95
- count: 5
endDate: '2024-06-30'
max: 1070
mean: -93.62199999999999
median: 60
min: -1358.11
standardDeviation: 872.1721988346109
startDate: '2024-06-01'
sum: -468.1099999999999
- count: 5
endDate: '2024-07-24'
max: 1070
mean: -93.62199999999999
median: 60
min: -1358.11
standardDeviation: 872.1721988346109
startDate: '2024-07-01'
sum: -468.1099999999999
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 675f5d35-8ce2-442e-a213-f6a3d9a5696b
- dab60ad6-3c4f-46e7-a408-c99e7db87789
- 3e61d882-dd74-4866-a494-8dfbff1a3a17
- 7b54c715-db4e-4eed-ad00-d5e09dec7245
transactionIds:
- '101402235186'
- '101402235156'
- '101402235135'
- '101402235114'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2023-02-28'
startDate: '2023-02-01'
- count: 0
endDate: '2023-03-31'
startDate: '2023-03-01'
- count: 0
endDate: '2023-04-30'
startDate: '2023-04-01'
- count: 0
endDate: '2023-05-31'
startDate: '2023-05-01'
- count: 0
endDate: '2023-06-30'
startDate: '2023-06-01'
- count: 0
endDate: '2023-07-31'
startDate: '2023-07-01'
- count: 0
endDate: '2023-08-31'
startDate: '2023-08-01'
- count: 0
endDate: '2023-09-30'
startDate: '2023-09-01'
- count: 0
endDate: '2023-10-31'
startDate: '2023-10-01'
- count: 0
endDate: '2023-11-30'
startDate: '2023-11-01'
- count: 0
endDate: '2023-12-31'
startDate: '2023-12-01'
- count: 0
endDate: '2024-01-31'
startDate: '2024-01-01'
- count: 0
endDate: '2024-02-29'
startDate: '2024-02-01'
- count: 0
endDate: '2024-03-31'
startDate: '2024-03-01'
- count: 0
endDate: '2024-04-30'
startDate: '2024-04-01'
- count: 0
endDate: '2024-05-31'
startDate: '2024-05-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-30'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 170
mean: 139.57142857142858
median: 170
min: 99
standardDeviation: 37.95109635156426
startDate: '2022-07-24'
sum: 977
- count: 40
endDate: '2022-08-31'
max: 688
mean: 199.2625
median: 144
min: 36
standardDeviation: 162.26367381439258
startDate: '2022-08-01'
sum: 7970.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 818430df-5f14-40ec-af3d-cde2ada40087
- cceef475-c1b4-4648-9113-d73d3c01aa40
- f7f8bb8b-8820-4a94-b9ac-f88f0d859dd1
- fcbc00c3-63f5-48d1-8302-13018a4eccea
transactionIds:
- '101402245116'
- '101402245119'
- '101402245133'
- '101402245135'
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 5.49
count: 2
endDate: '2022-12-31'
endingValue: 0
max: 5.49
mean: 2.745
median: 2.745
min: 0
standardDeviation: 3.882016228714146
startDate: '2022-12-30'
sum: 5.49
- beginningValue: 0
count: 31
endDate: '2023-01-31'
endingValue: 3.74
max: 60
mean: -290.4177419354839
median: 0
min: -4767.8
standardDeviation: 1142.3378998343987
startDate: '2023-01-01'
sum: -9002.95
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 1130
mean: -15.603666666666664
median: 0
min: -1658.11
standardDeviation: 372.43488390342935
startDate: '2024-06-01'
sum: -468.1099999999999
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 1130
mean: -19.50458333333333
median: 0
min: -1658.11
standardDeviation: 418.1064188226347
startDate: '2024-07-01'
sum: -468.1099999999999
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 489cf368-4697-4ea8-b975-b1d17843def7
payee: Account Owner (Name Unavailable)
payor: capital1 bob jones
recency: 4
transactionIds:
- '101402235094'
- '101402235119'
- '101402235109'
- '101402235143'
- cadence: 37
id: 7b54c715-db4e-4eed-ad00-d5e09dec7245
payee: capital one
payor: Account Owner (Name Unavailable)
recency: 247
transactionIds:
- '101402235091'
- '101402235156'
gseEnabled: true
CashflowBusinessNonCraAnalyticsReportResponseExample:
value:
id: x9j6c6kdkzzf-cfrbnoncra
customerType: testing
customerId: 3011077785
requestId: ib6mjb9cxr
requesterName: Open Banking API Tests
createdDate: 1721818584
title: Mastercard Open Banking Cash Flow Analytics
type: cfrbnoncra
status: success
businessDetails:
businessId: '48599'
name: ABC Tires Inc - 1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: US
postalCode: '84116'
constraints:
analyticsReportData:
forCraPurpose: false
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- MONTHLY_CALENDAR
startDate: 1658660184
endDate: 1721818584
days: 731
institutions:
- id: 170681
name: FinBank P
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
- id: 3027530342
ownerName: JNC PROPERTIES LLC
ownerAddress: 1944 JAKETOWN RD DONNELLSON IL 62019
ownerAsOfDate: 1721818584
name: Business Investment
number: '1101'
type: investment
aggregationStatusCode: 0
currentBalance: 100000
balanceDate: 1721818586
transactions: []
analytics: null
currency: USD
- id: 3027530343
ownerName: NSF USER
ownerAddress: 123 VINE ST MURRAY, UT 84123
ownerAsOfDate: 1721818584
name: NSF Checking
number: '0111'
type: checking
aggregationStatusCode: 0
currentBalance: 37700.65
availableBalance: 38000.45
balanceDate: 1721818587
transactions:
- id: 101402234950
amount: -30
postedDate: 1721131200
description: Insufficient Funds Charge
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234940
amount: -34
postedDate: 1662206400
description: INSUFFICIENT FUNDS FEE FOR A $32
memo: '.46 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234865
amount: -90
postedDate: 1661688000
description: NON-SUFFICIENT FUNDS CHARGE;Branch Transaction
normalizedPayee: Non-sufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234891
amount: -30
postedDate: 1660651200
description: CHK# AMT $. NSF CHARGE
memo: CHK# 00 AMT $188.83 NSF CHARGE
normalizedPayee: Nsf Charge
institutionTransactionId: '0000000000'
category: Low Balance
analytics:
transactionalAttributes:
- aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: REVENUE
streamIds: []
transactionIds: []
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- fdf7f804-2273-41f8-8916-299e764c6209
- 35528ad9-4102-4383-900f-d7fae5e62022
transactionIds:
- '101402234898'
- '101402234868'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- b319af86-4675-4a8b-a93c-9b1dc8f6850f
- 8b06140a-e3f3-4169-afa8-806a097f0109
transactionIds:
- '101402234916'
- '101402234906'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 8e77ae76-6405-4137-a3ec-7748d2baa66c
- b319af86-4675-4a8b-a93c-9b1dc8f6850f
transactionIds:
- '101402234881'
- '101402234939'
- '101402234876'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 8e77ae76-6405-4137-a3ec-7748d2baa66c
- 18f37c62-6783-4061-9c57-0d8a6b494c84
- 35528ad9-4102-4383-900f-d7fae5e62022
transactionIds:
- '101402234950'
- '101402234871'
- '101402234914'
- '101402234900'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 34
count: 4
endDate: '2022-07-31'
endingValue: 0
max: 34
mean: 8.5
median: 0
min: 0
standardDeviation: 17
startDate: '2022-07-28'
sum: 34
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: 0
max: 0
mean: -6.870967741935484
median: 0
min: -90
standardDeviation: 20.144051124312725
startDate: '2022-08-01'
sum: -213
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: -4.141
median: 0
min: -34
standardDeviation: 10.804814492016813
startDate: '2024-06-01'
sum: -124.23
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: -3.8333333333333335
median: 0
min: -34
standardDeviation: 10.3992753370719
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 8e77ae76-6405-4137-a3ec-7748d2baa66c
payee: insufficient
payor: NSF USER
recency: 8
transactionIds:
- '101402234950'
- '101402234913'
- cadence: 0
id: b319af86-4675-4a8b-a93c-9b1dc8f6850f
payee: NSF USER
payor: clark energy (return)
recency: 118
transactionIds:
- '101402234916'
currency: USD
- id: 3027530339
ownerName: Roberta Prohaska
ownerAddress: Salt Lake City
ownerAsOfDate: 1721818584
name: Checking
number: '001111'
type: checking
aggregationStatusCode: 0
currentBalance: 724.1
availableBalance: 165
balanceDate: 1721815841
transactions:
- id: 101402235536
amount: -6.99
postedDate: 1695297600
description: 'SONIC #4017'
memo: PURCHASE 09/19 EDGEWATER CO CARD 9268
normalizedPayee: Sonic
institutionTransactionId: '10190'
category: Fast Food
- id: 101402235535
amount: -203.45
postedDate: 1695297600
description: FSI*XCEL ENERGY PM
memo: PURCHASE 09/20 800-895-4999 CO CARD 9268
normalizedPayee: Xcel Energy
institutionTransactionId: '10189'
category: Utilities
- id: 101402235424
amount: -37.86
postedDate: 1658664000
description: THE HOME DEPOT 1550
memo: PURCHASE 07/22 LAKEWOOD CO CARD 9268
normalizedPayee: Home Depot
institutionTransactionId: '10041'
category: Home Improvement
- id: 101402235423
amount: -21.05
postedDate: 1658664000
description: KING SOOP 1725 SHERIDA
memo: PURCHASE 07/22 EDGEWATER CO CARD 9268
normalizedPayee: Soop
institutionTransactionId: '10040'
category: Groceries
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 9
endDate: '2022-07-31'
max: -5.24
mean: -29.672222222222224
median: -21.05
min: -92.95
standardDeviation: 30.24118912087361
startDate: '2022-07-24'
sum: -267.05
- count: 24
endDate: '2022-08-31'
max: -1.67
mean: -113.86583333333333
median: -23.865
min: -1150
standardDeviation: 297.5267452050636
startDate: '2022-08-01'
sum: -2732.78
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 14a1be06-6ef8-4685-808c-a033ae2e27aa
- 8617b764-f1db-4f38-9e24-b6a6c64e156f
- ff2e773c-bc91-4343-88dd-3445aa3adede
- dbac0ee8-faff-4d2d-9f78-fec2721f4420
transactionIds:
- '101402235485'
- '101402244994'
- '101402235495'
- '101402244988'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 4
endDate: '2022-07-31'
max: 261
mean: 188.5
median: 197
min: 99
standardDeviation: 70.40123104984268
startDate: '2022-07-24'
sum: 754
- count: 6
endDate: '2022-08-31'
max: 293
mean: 166.08333333333334
median: 171.75
min: 36
standardDeviation: 92.03826197113169
startDate: '2022-08-01'
sum: 996.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ae2b5252-f1fb-4ba1-8d88-e13129cd627d
- 33798f11-680c-4a1b-b48a-e6efb7d3e7a7
- 6488c9b2-9aa3-41c6-beb3-44047988d8c2
transactionIds:
- '101402245000'
- '101402245004'
- '101402235457'
- '101402244970'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 13
endDate: '2022-07-31'
max: 261
mean: 37.457692307692305
median: -7.98
min: -92.95
standardDeviation: 113.28363364830818
startDate: '2022-07-24'
sum: 486.95
- count: 30
endDate: '2022-08-31'
max: 293
mean: -57.876
median: -18.72
min: -1150
standardDeviation: 290.928854635133
startDate: '2022-08-01'
sum: -1736.28
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 9bbd2a04-60dd-4baf-a095-ba83f5dcd9c9
- 20fc33d4-53c2-4bed-813f-1fa836aa5dc2
- ecb3ee6a-a320-4b00-9666-28b0c4599652
- d6d69f39-d941-4c93-9626-246ea390ce93
transactionIds:
- '101402245002'
- '101402244983'
- '101402235428'
- '101402235513'
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 2
endDate: '2022-07-31'
max: 170
mean: 134.5
median: 134.5
min: 99
standardDeviation: 50.204581464244875
startDate: '2022-07-24'
sum: 269
- count: 4
endDate: '2022-08-31'
max: 293
mean: 168.125
median: 171.75
min: 36
standardDeviation: 107.42002839321911
startDate: '2022-08-01'
sum: 672.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ae2b5252-f1fb-4ba1-8d88-e13129cd627d
transactionIds:
- '101402245004'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 1
endDate: '2022-08-31'
max: -35
mean: -35
median: -35
min: -35
startDate: '2022-08-01'
sum: -35
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds:
- '101402244981'
- '101402235478'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -143.14000000000001
count: 8
endDate: '2022-07-31'
endingValue: 0
max: 477.02
mean: 60.86875
median: 0
min: -143.14000000000001
standardDeviation: 188.17233176285887
startDate: '2022-07-24'
sum: 486.95
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: -21.82
max: 293
mean: -56.009032258064515
median: 0
min: -1160.88
standardDeviation: 296.6524763799648
startDate: '2022-08-01'
sum: -1736.28
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-06-01'
sum: 0
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-07-01'
sum: 0
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 190
id: 14a1be06-6ef8-4685-808c-a033ae2e27aa
payee: sonic
payor: Roberta Prohaska
recency: 307
transactionIds:
- '101402235507'
- '101402235523'
- '101402235536'
- cadence: 0
id: 0505c1e8-56ed-4911-8097-f466dab0cbbc
payee: xcel energy
payor: Roberta Prohaska
recency: 307
transactionIds:
- '101402235535'
currency: USD
oauthEnabled: false
customerAnalytics:
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -207.26
count: 8
endDate: '2022-07-31'
endingValue: -347.03999999999996
max: 931.73
mean: 44.493750000000006
median: 0
min: -347.03999999999996
standardDeviation: 394.7503333550569
startDate: '2022-07-24'
sum: 355.95000000000005
- beginningValue: 321
count: 31
endDate: '2022-08-31'
endingValue: -21.82
max: 680.61
mean: -6.811290322580643
median: 0
min: -1187.86
standardDeviation: 374.42814628659113
startDate: '2022-08-01'
sum: -211.14999999999992
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 3390
mean: -50.952
median: 0
min: -4974.33
standardDeviation: 1117.177412711036
startDate: '2024-06-01'
sum: -1528.56
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 3390
mean: -62.34708333333333
median: 0
min: -4974.33
standardDeviation: 1254.1757580473845
startDate: '2024-07-01'
sum: -1496.33
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 8e77ae76-6405-4137-a3ec-7748d2baa66c
payee: insufficient
payor: NSF USER
recency: 8
transactionIds:
- '101402234950'
- '101402234913'
- cadence: 0
id: 7f7eade6-3fca-4c4e-890b-f967cc9b75bf
payee: Roberta Prohaska
payor: buy
recency: 434
transactionIds:
- '101402235188'
- '101402244844'
- cadence: 15
id: 2c136d57-2810-45c3-a40e-64adc9e274fb
payee: Roberta Prohaska
payor: buy other
recency: 437
transactionIds:
- '101402244845'
- '101402250223'
transactionalAttributes:
- aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 170
mean: 129.42857142857142
median: 99
min: 99
standardDeviation: 37.95109635156426
startDate: '2022-07-24'
sum: 906
- count: 43
endDate: '2022-08-31'
max: 688
mean: 192.03488372093022
median: 144
min: 36
standardDeviation: 159.56348174483338
startDate: '2022-08-01'
sum: 8257.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: REVENUE
streamIds:
- bf1a9f5f-b81a-47fc-a9cf-0a3665ce8d42
- d78f6528-75ed-450e-ac06-6f4d425ee68a
transactionIds:
- '101402250300'
- '101402250301'
- '101402250308'
- '101402250315'
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 24
endDate: '2022-07-31'
max: -2.47
mean: -38.21041666666667
median: -21.68
min: -167.86
standardDeviation: 52.73374305262789
startDate: '2022-07-24'
sum: -917.05
- count: 52
endDate: '2022-08-31'
max: -2.5
mean: -72.04788461538462
median: -23.494999999999997
min: -1150
standardDeviation: 206.50877599294435
startDate: '2022-08-01'
sum: -3746.49
- count: 10
endDate: '2024-06-30'
max: -26.23
mean: -509.856
median: -300
min: -1358.11
standardDeviation: 597.0070650838229
startDate: '2024-06-01'
sum: -5098.5599999999995
- count: 9
endDate: '2024-07-24'
max: -28
mean: -562.9255555555555
median: -300
min: -1358.11
standardDeviation: 607.6863589079302
startDate: '2024-07-01'
sum: -5066.33
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 8e77ae76-6405-4137-a3ec-7748d2baa66c
- 174e1055-dd41-40e6-9ea9-d16784453a31
transactionIds:
- '101402235474'
- '101402235001'
- '101402235435'
- '101402235430'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 261
mean: 181.85714285714286
median: 224
min: 34
standardDeviation: 86.55138853388117
startDate: '2022-07-24'
sum: 1273
- count: 19
endDate: '2022-08-31'
max: 688
mean: 186.07052631578946
median: 144
min: 17.5
standardDeviation: 144.9797808306648
startDate: '2022-08-01'
sum: 3535.34
- count: 9
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-06-01'
sum: 3570
- count: 9
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-07-01'
sum: 3570
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 783d86ff-60a4-4f36-900f-d37fd3e7b36f
- 897ddd86-9186-45fd-8975-9e16dadfa432
transactionIds:
- '101402235060'
- '101402235099'
- '101402235248'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 31
endDate: '2022-07-31'
max: 261
mean: 11.48225806451613
median: -9.99
min: -167.86
standardDeviation: 111.26009301660913
startDate: '2022-07-24'
sum: 355.95
- count: 71
endDate: '2022-08-31'
max: 688
mean: -2.9739436619718314
median: -14.99
min: -1150
standardDeviation: 222.97999178324034
startDate: '2022-08-01'
sum: -211.15000000000003
- count: 19
endDate: '2024-06-30'
max: 1070
mean: -80.45052631578946
median: -26.23
min: -1358.11
standardDeviation: 712.6092459208832
startDate: '2024-06-01'
sum: -1528.5599999999997
- count: 18
endDate: '2024-07-24'
max: 1070
mean: -83.12944444444443
median: 16
min: -1358.11
standardDeviation: 733.1695588612839
startDate: '2024-07-01'
sum: -1496.3299999999997
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 4f7409b8-638f-4c19-8681-9e6ed1bcec59
- ed22b1d7-35d6-4be1-8ac2-f6ceb3c0c58a
- 331de02f-1cf2-4284-99ac-d440faaa309a
- 240eff24-af2f-40ba-9e20-055db232a0ca
transactionIds:
- '101402234890'
- '101402235243'
- '101402235108'
- '101402235513'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 2
endDate: '2022-07-31'
max: -35
mean: -35
median: -35
min: -35
standardDeviation: 0
startDate: '2022-07-24'
sum: -70
- count: 9
endDate: '2022-08-31'
max: -24
mean: -39.22222222222222
median: -35
min: -90
standardDeviation: 19.40217628114033
startDate: '2022-08-01'
sum: -353
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 8e77ae76-6405-4137-a3ec-7748d2baa66c
- 18f37c62-6783-4061-9c57-0d8a6b494c84
- 35528ad9-4102-4383-900f-d7fae5e62022
transactionIds:
- '101402245099'
- '101402235478'
- '101402244981'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
gseEnabled: true
CashflowBusinessFtcAnalyticsReportResponseExample:
value:
id: hp3d33xki9x2-cfrbftc
customerType: testing
customerId: 3011077785
requestId: pjng034x2z
requesterName: Open Banking API Tests
createdDate: 1721817480
title: Mastercard Open Banking Cash Flow Analytics
type: cfrbftc
status: success
businessDetails:
businessId: '48599'
name: ABC Tires Inc - 1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: US
postalCode: '84116'
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- MONTHLY_CALENDAR
startDate: 1658659080
endDate: 1721817480
days: 731
institutions:
- id: 102105
name: FinBank Profiles - A
urlHomeApp: http://www.finbank.com
accounts:
- id: 3027530342
ownerName: JNC PROPERTIES LLC
ownerAddress: 1944 JAKETOWN RD DONNELLSON IL 62019
ownerAsOfDate: 1721818584
name: Business Investment
number: '1101'
type: investment
aggregationStatusCode: 0
currentBalance: 100000
balanceDate: 1721813305
transactions: []
analytics:
currency: USD
- id: 3027530343
ownerName: NSF USER
ownerAddress: 123 VINE ST MURRAY, UT 84123
ownerAsOfDate: 1721818584
name: NSF Checking
number: '0111'
type: checking
aggregationStatusCode: 0
currentBalance: 37700.65
availableBalance: 38000.45
balanceDate: 1721813306
transactions:
- id: 101402234950
amount: -30
postedDate: 1721131200
description: Insufficient Funds Charge
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234871
amount: -34
postedDate: 1721044800
description: INSUFFICIENT FUNDS FEE FOR A $35
memo: '.16 CARD PURCHASE WITH PIN - DET'
normalizedPayee:
insufficient funds fee for card purchase with pin det
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234897
amount: -28
postedDate: 1720008000
description: PAID NSF FEE
memo: Fee
normalizedPayee: Paid Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234903
amount: -34
postedDate: 1719576000
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '0.68 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234931
amount: -26.23
postedDate: 1718712000
description: NSF/OD FEE PD ITEM INSUFFICIENT
memo: NSF/OD FEE PD ITEM INSUFFICIENT FUNDS
normalizedPayee: Nsf Od
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234855
amount: -30
postedDate: 1717761600
description: Insufficient Funds Fee ($30)
memo: Insufficient Funds Fee ($30)
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234879
amount: -34
postedDate: 1717416000
description: INSUFFICIENT FUNDS FEE FOR A $11
memo: '.33 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234938
amount: -34
postedDate: 1716897600
description: INSUFFICIENT FUNDS FEE FOR A $15
memo: '4.96 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234864
amount: -30
postedDate: 1716033600
description: Insufficient Funds (NSF) Fee; NSF Fee
normalizedPayee: Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234888
amount: -34
postedDate: 1715083200
description: INSUFFICIENT FUNDS FEE FOR A $51
memo: '.25 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234908
amount: -34
postedDate: 1714737600
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '.00 ITEM - DETAILS: PAYPAL'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234935
amount: -20
postedDate: 1713787200
description: WITHDRAWAL NSF Fee SEARS ONLINE
normalizedPayee: Sears
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234860
amount: -34
postedDate: 1713528000
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '.99 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234884
amount: -24
postedDate: 1713441600
description: Insufficient Funds Fee
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234890
amount: -34
postedDate: 1712145600
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: 0.00 WITHDRAWAL
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234916
amount: 120
postedDate: 1711627200
description: RETURNED ITEM INSUFFICIENT FUNDS
memo:
RETURNED ITEM INSUFFICIENT FUNDS Clark Energy Coo WEB PMTS
Z2DSR7
normalizedPayee: Clark Energy
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234939
amount: -34
postedDate: 1711454400
description: INSUFFICIENT FUNDS FEE FOR A $7.
memo: '94 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234902
amount: -34
postedDate: 1710763200
description: INSUFFICIENT FUNDS FEE FOR A $17
memo: '6.53 ITEM - DETAILS: GCS 800-398'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234927
amount: -35
postedDate: 1709467200
description: EOD NSF FEE
memo: Processed
normalizedPayee: Eod Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234952
amount: -34
postedDate: 1709121600
description: INSUFFICIENT FUNDS FEE FOR A $32
memo: '.08 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234875
amount: -18
postedDate: 1709121600
description: NSF Fee not paid
memo: 'Fee Withdrawal: NSF Fee not paid'
normalizedPayee: Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234899
amount: -34
postedDate: 1708776000
description: INSUFFICIENT FUNDS FEE FOR A $12
memo: '.07 ITEM - DETAILS: ALLSTATE INS'
normalizedPayee: Allstate
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234924
amount: -34
postedDate: 1706961600
description: INSUFFICIENT FUNDS FEE FOR A $21
memo: '.50 ITEM - DETAILS: HK Paymt'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234948
amount: -34
postedDate: 1706443200
description: INSUFFICIENT FUNDS FEE FOR A $18
memo: '.60 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234873
amount: -18
postedDate: 1705924800
description: NSF Fee not paid
memo: 'Fee Withdrawal: NSF Fee not paid'
normalizedPayee: Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234881
amount: -34
postedDate: 1704456000
description: INSUFFICIENT FUNDS FEE FOR A $17
memo: 8.63 CARD PURCHASE W/CASH - DETA
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234905
amount: -34
postedDate: 1704283200
description: INSUFFICIENT FUNDS FEE FOR A $6.
memo: '71 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234858
amount: -34
postedDate: 1703764800
description: INSUFFICIENT FUNDS FEE FOR A $80
memo: '.39 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234889
amount: -34
postedDate: 1703678400
description: INSUFFICIENT FUNDS FEE FOR A $12
memo: '1.00 ITEM - DETAILS: CAPITAL ONE'
normalizedPayee: Insufficient One
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234912
amount: -34
postedDate: 1702468800
description: INSUFFICIENT FUNDS FEE FOR A $14
memo: 5.57 RECURRING CARD PURCHASE - D
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234936
amount: -34
postedDate: 1701604800
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#1263 IN THE AMOUNT OF $110.87'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234863
amount: 35
postedDate: 1701172800
description: REVERSAL OF NSF RETURN ITEM FEE
memo:
FOR A TRANSACTION RECEIVED ON 10/21 $114.31 FIRSTFIN PMT
RETRY PYMT 113024160525 748 LUCIA GONZALEZ
normalizedPayee: Of
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234886
amount: -34
postedDate: 1700654400
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '.00 ITEM - DETAILS: PAYPAL'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234910
amount: 34
postedDate: 1700222400
description: 'Reversal: INSUFFICIENT FUNDS FEE'
memo: FOR A $15.98
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234934
amount: -34
postedDate: 1699012800
description: INSUFFICIENT FUNDS FEE FOR A $15
memo: '.00 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234862
amount: -34
postedDate: 1697716800
description: INSUFFICIENT FUNDS FEE FOR A $12
memo: '.40 ITEM - DETAILS: PAYPAL'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234917
amount: -34
postedDate: 1697544000
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#3598 IN THE AMOUNT OF $34.52'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234866
amount: -30
postedDate: 1697544000
description: FEE
memo:
RETURNED DEPOSITED CHECK 1010 $300.00 - NSF RETURNED
DEPOSIT FEE - UNCOLLECTIBLE $30.00
normalizedPayee: Returned Deposited
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234942
amount: -34
postedDate: 1696334400
description: INSUFFICIENT FUNDS FEE FOR A $65
memo: '.27 ITEM - DETAILS: PAYPAL'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234878
amount: -28
postedDate: 1695902400
description: PAID NSF FEE
memo: Fee
normalizedPayee: Paid Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234892
amount: -34
postedDate: 1695816000
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#1569 IN THE AMOUNT OF $50.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234918
amount: -34
postedDate: 1695556800
description: INSUFFICIENT FUNDS FEE FOR A $31
memo: '2.49 ITEM - DETAILS: INSIGHTS SV'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234943
amount: 34
postedDate: 1694865600
description: INSUFFICIENT FUNDS FEE REFUND
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234868
amount: -34
postedDate: 1693742400
description: INSUFFICIENT FUNDS FEE FOR A $8.
memo: '25 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234895
amount: -34
postedDate: 1693224000
description: INSUFFICIENT FUNDS FEE FOR A $48
memo: '.05 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234921
amount: -34
postedDate: 1692187200
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#927 IN THE AMOUNT OF $25.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234946
amount: -34
postedDate: 1692100800
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '.00 CARD PURCHASE WITH PIN - DET'
normalizedPayee:
insufficient funds fee for card purchase with pin det
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234887
amount: -30
postedDate: 1691064000
description: Insufficient Funds Charge
memo: Fee, Processed
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234911
amount: -34
postedDate: 1690545600
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#1001 IN THE AMOUNT OF $25.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234937
amount: -34
postedDate: 1689508800
description: INSUFFICIENT FUNDS FEE FOR A $69
memo: '.00 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234857
amount: -34
postedDate: 1689422400
description: INSUFFICIENT FUNDS FEE FOR A $47
memo: '5.00 ITEM - DETAILS: FLASHADV'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234882
amount: -34
postedDate: 1688385600
description: INSUFFICIENT FUNDS FEE FOR A $46
memo: '.45 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234906
amount: 34
postedDate: 1687953600
description: REFUND OF INSUFFICIENT FUNDS FEE
memo: CHARGED ON 08/16/2016
normalizedPayee: Insufficient Charged
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234932
amount: -32
postedDate: 1687089600
description: NSF - ITE
memo: 'Fee W/D: NSF - ITE 000505'
normalizedPayee: Nsf Ite
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234859
amount: -34
postedDate: 1686139200
description: INSUFFICIENT FUNDS FEE FOR A $38
memo: '.60 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234883
amount: -26.25
postedDate: 1685793600
description: NSF/OD FEE RTND ITEM INSUFFICIEN
memo: NSF/OD FEE RTND ITEM INSUFFICIENT FUNDS
normalizedPayee: Nsf Od
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234907
amount: -34
postedDate: 1685275200
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#4836 IN THE AMOUNT OF $695.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234951
amount: -30
postedDate: 1684411200
description: Insufficient Funds Fee Paid
normalizedPayee: Insufficient Paid
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234877
amount: -34
postedDate: 1683460800
description: INSUFFICIENT FUNDS FEE FOR A $33
memo: 9.78 RECURRING CARD PURCHASE - D
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234901
amount: -34
postedDate: 1683115200
description: INSUFFICIENT FUNDS FEE FOR A $25
memo: '.00 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234928
amount: -32
postedDate: 1682164800
description: NSF Fee Item Ret INSUFFICIENT FU
memo: NSF Fee Item Ret INSUFFICIENT FUNDS
normalizedPayee: Nsf Item Ret Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234941
amount: -34
postedDate: 1681905600
description: INSUFFICIENT FUNDS FEE FOR A $9.
memo: '73 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234867
amount: 44
postedDate: 1681819200
description: RETURNED ITEM INSUFFICIENT FUNDS
memo:
RETURNED ITEM INSUFFICIENT FUNDS PAYPAL ECHECK EBAY INC
normalizedPayee: Returned Item Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234893
amount: -34
postedDate: 1680523200
description: INSUFFICIENT FUNDS FEE FOR A $76
memo: '.32 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234919
amount: 34
postedDate: 1680004800
description: INSUFFICIENT FUNDS FEE REFUND
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234944
amount: -18
postedDate: 1679832000
description: NSF Fee not paid
memo: 'Fee Withdrawal: NSF Fee not paid'
normalizedPayee: Nsf
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234869
amount: -34
postedDate: 1679140800
description: INSUFFICIENT FUNDS FEE FOR A $64
memo: '.64 ITEM - DETAILS: UI WEB PAYME'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234926
amount: -34
postedDate: 1677844800
description: INSUFFICIENT FUNDS FEE FOR A $40
memo: '2.23 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234949
amount: -34
postedDate: 1677585600
description: INSUFFICIENT FUNDS FEE FOR A $34
memo: '.63 ITEM - DETAILS: NORDSTROM'
normalizedPayee: Insufficient Nordstrom
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234874
amount: 34
postedDate: 1677585600
description: INSUFFICIENT FUNDS FEE REFUND
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234896
amount: -34
postedDate: 1677240000
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#6891 IN THE AMOUNT OF $850.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234922
amount: -34
postedDate: 1675425600
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#197 IN THE AMOUNT OF $80.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234945
amount: -34
postedDate: 1674907200
description: INSUFFICIENT FUNDS FEE FOR A $50
memo: '.24 ITEM - DETAILS: NAVI ED SER'
normalizedPayee: Navi Ed
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234870
amount: -34
postedDate: 1674388800
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#7003 IN THE AMOUNT OF $125.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234894
amount: -30
postedDate: 1672920000
description: Insufficient Funds Charge
memo: Fee, Processed
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234920
amount: -25
postedDate: 1672747200
description: Withdrawal Draft# (.) IN
memo: Withdrawal Draft#1246 (89.34) INSUFFICIENT DRAFT FEE
normalizedPayee: Draft Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234947
amount: 0
postedDate: 1672228800
description: '[No description provided by institution]'
normalizedPayee: Institution_Transaction
institutionTransactionId: '0000000000'
category: Uncategorized
- id: 101402234872
amount: -34
postedDate: 1672142400
description: INSUFFICIENT FUNDS FEE FOR A $68
memo: '.00 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234898
amount: -28
postedDate: 1670932800
description: Insufficient Funds Charge VZ
memo: WIRELESS VW 800-350-2830 - VZW WEBPAY
normalizedPayee: Verizon
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234925
amount: -34
postedDate: 1670068800
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#1049 IN THE AMOUNT OF $325.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234930
amount: -34
postedDate: 1669636800
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: 7.61 CARD PURCHASE W/CASH - DETA
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234856
amount: -34
postedDate: 1669118400
description: INSUFFICIENT FUNDS FEE FOR A $20
memo: '.01 CARD PURCHASE WITH PIN - DET'
normalizedPayee:
insufficient funds fee for card purchase with pin det
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234880
amount: -34
postedDate: 1668686400
description: INSUFFICIENT FUNDS FEE FOR A $22
memo: '3.85 CARD PURCHASE - DETAILS:'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234904
amount: 15.74
postedDate: 1667476800
description: WEB PAYPAL INST XFER
memo: RETURNED ACH DEBIT NSF
normalizedPayee: Paypal
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234929
amount: -30
postedDate: 1666180800
description: CHK# AMT $., NSF CHARGE
memo: CHK# 00 AMT $195.73, NSF CHARGE
normalizedPayee: Nsf Charge
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234913
amount: -30
postedDate: 1666008000
description: Insufficient Funds Charge
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234854
amount: -34
postedDate: 1666008000
description: INSUFFICIENT FUNDS FEE FOR A $75
memo: '.00 ITEM - DETAILS: CAPITAL ONE'
normalizedPayee: Insufficient One
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234933
amount: -34
postedDate: 1664798400
description: INSUFFICIENT FUNDS FEE FOR A $22
memo: '0.49 ITEM - DETAILS: PROG DIRECT'
normalizedPayee: Insufficient Details Prog
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234861
amount: -34
postedDate: 1664366400
description: INSUFFICIENT FUNDS FEE FOR A $10
memo: '.00 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234885
amount: -34
postedDate: 1664280000
description: INSUFFICIENT FUNDS FEE FOR A $36
memo: '4.00 ITEM - DETAILS: F&A FED CRE'
normalizedPayee: Insufficient Cre
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234909
amount: -34
postedDate: 1664020800
description: INSUFFICIENT FUNDS FEE FOR A $12
memo: '.98 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234915
amount: -35
postedDate: 1663329600
description: OD PAID ITEM FEE INSUFFICIENT FU
memo: OD PAID ITEM FEE INSUFFICIENT FUNDS
normalizedPayee: Od Paid Item
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234940
amount: -34
postedDate: 1662206400
description: INSUFFICIENT FUNDS FEE FOR A $32
memo: '.46 RECURRING CARD PURCHASE - DE'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234865
amount: -90
postedDate: 1661688000
description: NON-SUFFICIENT FUNDS CHARGE;Branch Transaction
normalizedPayee: Non-sufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234891
amount: -30
postedDate: 1660651200
description: CHK# AMT $. NSF CHARGE
memo: CHK# 00 AMT $188.83 NSF CHARGE
normalizedPayee: Nsf Charge
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234914
amount: -34
postedDate: 1660564800
description: INSUFFICIENT FUNDS FEE FOR CHECK
memo: '#5339 IN THE AMOUNT OF $50.00'
normalizedPayee: Amount
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234900
amount: -35
postedDate: 1659528000
description: OVERDRAFT FEE NONSUFFICIENT FUND
memo: OVERDRAFT FEE NONSUFFICIENT FUNDS
normalizedPayee: Overdraft
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234876
amount: -24
postedDate: 1659528000
description: Insufficient Funds Fee
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234923
amount: 34
postedDate: 1659009600
description: INSUFFICIENT FUNDS FEE REFUND
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- b8dfd96c-ba60-4945-8d76-b58518d828ae
- 5dac07a5-2fa6-4677-859f-cb29f488fc13
- 0b539443-c411-4afb-a239-13fa0fed8ac5
- cdb7a88b-9713-477d-b261-ec89250db8b5
transactionIds:
- '101402234876'
- '101402234935'
- '101402234880'
- '101402234868'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- f76d6419-a5e5-4eec-8472-2736f5176d4d
- fe4177c9-1e79-4451-92f1-9ef7031170d6
transactionIds:
- '101402234919'
- '101402234943'
- '101402234916'
- '101402234906'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 0b539443-c411-4afb-a239-13fa0fed8ac5
- cdb7a88b-9713-477d-b261-ec89250db8b5
transactionIds:
- '101402234944'
- '101402234942'
- '101402234876'
- '101402234935'
- '101402234868'
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- b8dfd96c-ba60-4945-8d76-b58518d828ae
- 5dac07a5-2fa6-4677-859f-cb29f488fc13
- cdb7a88b-9713-477d-b261-ec89250db8b5
transactionIds:
- '101402234915'
- '101402234914'
- '101402234900'
- '101402234876'
- aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: NSF_FEE_REVERSALS
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 34
count: 4
endDate: '2022-07-31'
endingValue: 0
max: 34
mean: 8.5
median: 0
min: 0
standardDeviation: 17
startDate: '2022-07-28'
sum: 34
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: 0
max: 0
mean: -6.870967741935484
median: 0
min: -90
standardDeviation: 20.144051124312725
startDate: '2022-08-01'
sum: -213
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: -4.141
median: 0
min: -34
standardDeviation: 10.804814492016813
startDate: '2024-06-01'
sum: -124.23
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: -3.8333333333333335
median: 0
min: -34
standardDeviation: 10.3992753370719
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: b8dfd96c-ba60-4945-8d76-b58518d828ae
payee: insufficient
payor: NSF USER
recency: 8
transactionIds:
- '101402234950'
- '101402234913'
- cadence: 0
id: f76d6419-a5e5-4eec-8472-2736f5176d4d
payee: NSF USER
payor: clark energy (return)
recency: 118
transactionIds:
- '101402234916'
- cadence: 0
id: fe4177c9-1e79-4451-92f1-9ef7031170d6
payee: NSF USER
payor: payment facilitator (return)
recency: 463
transactionIds:
- '101402234904'
- '101402234867'
- cadence: 0
id: 4b1811c1-2dff-4a07-86a9-558af48c50cb
payee: institution_transaction
payor: NSF USER
recency: 574
transactionIds:
- '101402234947'
- cadence: 0
id: 5dac07a5-2fa6-4677-859f-cb29f488fc13
payee: verizon
payor: NSF USER
recency: 589
transactionIds:
- '101402234898'
- cadence: 0
id: 0b539443-c411-4afb-a239-13fa0fed8ac5
payee: nsf charge
payor: NSF USER
recency: 644
transactionIds:
- '101402234929'
- '101402234891'
- cadence: 0
id: cdb7a88b-9713-477d-b261-ec89250db8b5
payee: non-sufficient
payor: NSF USER
recency: 696
transactionIds:
- '101402234865'
currency: USD
- id: 3027530339
ownerName: Roberta Prohaska
ownerAddress: Salt Lake City
ownerAsOfDate: 1721818584
name: Checking
number: '001111'
type: checking
aggregationStatusCode: 0
currentBalance: 724.1
availableBalance: 165
balanceDate: 1721815841
transactions:
- id: 101402235536
amount: -6.99
postedDate: 1695297600
description: 'SONIC #4017'
memo: PURCHASE 09/19 EDGEWATER CO CARD 9268
normalizedPayee: Sonic
institutionTransactionId: '10190'
category: Fast Food
- id: 101402235535
amount: -203.45
postedDate: 1695297600
description: FSI*XCEL ENERGY PM
memo: PURCHASE 09/20 800-895-4999 CO CARD 9268
normalizedPayee: Xcel Energy
institutionTransactionId: '10189'
category: Utilities
- id: 101402235424
amount: -37.86
postedDate: 1658664000
description: THE HOME DEPOT 1550
memo: PURCHASE 07/22 LAKEWOOD CO CARD 9268
normalizedPayee: Home Depot
institutionTransactionId: '10041'
category: Home Improvement
- id: 101402235423
amount: -21.05
postedDate: 1658664000
description: KING SOOP 1725 SHERIDA
memo: PURCHASE 07/22 EDGEWATER CO CARD 9268
normalizedPayee: Soop
institutionTransactionId: '10040'
category: Groceries
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 9
endDate: '2022-07-31'
max: -5.24
mean: -29.672222222222224
median: -21.05
min: -92.95
standardDeviation: 30.24118912087361
startDate: '2022-07-24'
sum: -267.05
- count: 24
endDate: '2022-08-31'
max: -1.67
mean: -113.86583333333333
median: -23.865
min: -1150
standardDeviation: 297.5267452050636
startDate: '2022-08-01'
sum: -2732.78
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 14a1be06-6ef8-4685-808c-a033ae2e27aa
- 8617b764-f1db-4f38-9e24-b6a6c64e156f
- ff2e773c-bc91-4343-88dd-3445aa3adede
- dbac0ee8-faff-4d2d-9f78-fec2721f4420
transactionIds:
- '101402235485'
- '101402244994'
- '101402235495'
- '101402244988'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 4
endDate: '2022-07-31'
max: 261
mean: 188.5
median: 197
min: 99
standardDeviation: 70.40123104984268
startDate: '2022-07-24'
sum: 754
- count: 6
endDate: '2022-08-31'
max: 293
mean: 166.08333333333334
median: 171.75
min: 36
standardDeviation: 92.03826197113169
startDate: '2022-08-01'
sum: 996.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ae2b5252-f1fb-4ba1-8d88-e13129cd627d
- 33798f11-680c-4a1b-b48a-e6efb7d3e7a7
- 6488c9b2-9aa3-41c6-beb3-44047988d8c2
transactionIds:
- '101402245000'
- '101402245004'
- '101402235457'
- '101402244970'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 13
endDate: '2022-07-31'
max: 261
mean: 37.457692307692305
median: -7.98
min: -92.95
standardDeviation: 113.28363364830818
startDate: '2022-07-24'
sum: 486.95
- count: 30
endDate: '2022-08-31'
max: 293
mean: -57.876
median: -18.72
min: -1150
standardDeviation: 290.928854635133
startDate: '2022-08-01'
sum: -1736.28
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 9bbd2a04-60dd-4baf-a095-ba83f5dcd9c9
- 20fc33d4-53c2-4bed-813f-1fa836aa5dc2
- ecb3ee6a-a320-4b00-9666-28b0c4599652
- d6d69f39-d941-4c93-9626-246ea390ce93
transactionIds:
- '101402245002'
- '101402244983'
- '101402235428'
- '101402235513'
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 2
endDate: '2022-07-31'
max: 170
mean: 134.5
median: 134.5
min: 99
standardDeviation: 50.204581464244875
startDate: '2022-07-24'
sum: 269
- count: 4
endDate: '2022-08-31'
max: 293
mean: 168.125
median: 171.75
min: 36
standardDeviation: 107.42002839321911
startDate: '2022-08-01'
sum: 672.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ae2b5252-f1fb-4ba1-8d88-e13129cd627d
transactionIds:
- '101402245004'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 1
endDate: '2022-08-31'
max: -35
mean: -35
median: -35
min: -35
startDate: '2022-08-01'
sum: -35
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds:
- '101402244981'
- '101402235478'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -143.14000000000001
count: 8
endDate: '2022-07-31'
endingValue: 0
max: 477.02
mean: 60.86875
median: 0
min: -143.14000000000001
standardDeviation: 188.17233176285887
startDate: '2022-07-24'
sum: 486.95
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: -21.82
max: 293
mean: -56.009032258064515
median: 0
min: -1160.88
standardDeviation: 296.6524763799648
startDate: '2022-08-01'
sum: -1736.28
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-06-01'
sum: 0
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-07-01'
sum: 0
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 190
id: 14a1be06-6ef8-4685-808c-a033ae2e27aa
payee: sonic
payor: Roberta Prohaska
recency: 307
transactionIds:
- '101402235507'
- '101402235523'
- '101402235536'
- cadence: 0
id: 0505c1e8-56ed-4911-8097-f466dab0cbbc
payee: xcel energy
payor: Roberta Prohaska
recency: 307
transactionIds:
- '101402235535'
currency: USD
oauthEnabled: false
customerAnalytics:
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -278.97
count: 8
endDate: '2022-07-31'
endingValue: -164.7
max: 678.71
mean: 38.540000000000006
median: -26.450000000000003
min: -278.97
standardDeviation: 320.23035561474006
startDate: '2022-07-24'
sum: 308.32000000000005
- beginningValue: 321
count: 31
endDate: '2022-08-31'
endingValue: -21.82
max: 498.44000000000005
mean: -38.651290322580635
median: 0
min: -1198.74
standardDeviation: 344.1010097315606
startDate: '2022-08-01'
sum: -1198.1899999999998
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 3390
mean: -50.952
median: 0
min: -4974.33
standardDeviation: 1117.177412711036
startDate: '2024-06-01'
sum: -1528.56
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 3390
mean: -62.34708333333333
median: 0
min: -4974.33
standardDeviation: 1254.1757580473845
startDate: '2024-07-01'
sum: -1496.33
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 73
id: 4e54a37c-25a3-4cf5-ad4a-537de1afeaeb
payee: jo ann store purchase lakewood co card
payor: Roberta Prohaska
recency: 366
transactionIds:
- '101402235316'
- cadence: 0
id: 3978fe35-2037-45d1-9764-f2303699d5f1
payee: Roberta Prohaska
payor: buy
recency: 434
transactionIds:
- '101402235188'
- '101402244844'
transactionalAttributes:
- aggregatedByTimePeriods:
- periods:
- count: 22
endDate: '2022-07-31'
max: -2.47
mean: -39.71272727272727
median: -22.575
min: -167.86
standardDeviation: 48.44036404072815
startDate: '2022-07-24'
sum: -873.6800000000001
- count: 51
endDate: '2022-08-31'
max: -1.67
mean: -68.74882352941177
median: -24
min: -1150
standardDeviation: 207.0556947649309
startDate: '2022-08-01'
sum: -3506.19
- count: 10
endDate: '2024-06-30'
max: -26.23
mean: -509.856
median: -300
min: -1358.11
standardDeviation: 597.0070650838229
startDate: '2024-06-01'
sum: -5098.5599999999995
- count: 9
endDate: '2024-07-24'
max: -28
mean: -562.9255555555555
median: -300
min: -1358.11
standardDeviation: 607.6863589079302
startDate: '2024-07-01'
sum: -5066.33
timeIntervalType: MONTHLY_CALENDAR
attributeName: CASH_OUTFLOW
streamIds:
- 9a7aaee1-f131-4ac3-a2f7-b3fa9705a52a
- a59100dc-9c3e-4c7b-93ed-48cc47be5b6e
- 2e5e2363-1f48-4d28-a3d7-5b16da06c0bf
- 4e273dfb-e4cc-4b16-bc1e-95e4abbfcaa7
transactionIds:
- '101402235167'
- '101402234914'
- '101402234830'
- '101402234774'
- aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 261
mean: 168.85714285714286
median: 170
min: 34
standardDeviation: 79.20527880435868
startDate: '2022-07-24'
sum: 1182
- count: 13
endDate: '2022-08-31'
max: 321
mean: 177.53846153846155
median: 199.5
min: 36
standardDeviation: 94.35073342288283
startDate: '2022-08-01'
sum: 2308
- count: 9
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-06-01'
sum: 3570
- count: 9
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-07-01'
sum: 3570
timeIntervalType: MONTHLY_CALENDAR
attributeName: CASH_INFLOW
streamIds:
- 6488c9b2-9aa3-41c6-beb3-44047988d8c2
transactionIds:
- '101402234787'
- '101402235108'
- '101402235513'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 29
endDate: '2022-07-31'
max: 261
mean: 10.631724137931034
median: -9.99
min: -167.86
standardDeviation: 106.55717590198653
startDate: '2022-07-24'
sum: 308.32
- count: 64
endDate: '2022-08-31'
max: 321
mean: -18.72171875
median: -15.62
min: -1150
standardDeviation: 213.7644749804459
startDate: '2022-08-01'
sum: -1198.19
- count: 19
endDate: '2024-06-30'
max: 1070
mean: -80.45052631578946
median: -26.23
min: -1358.11
standardDeviation: 712.6092459208832
startDate: '2024-06-01'
sum: -1528.5599999999997
- count: 18
endDate: '2024-07-24'
max: 1070
mean: -83.12944444444443
median: 16
min: -1358.11
standardDeviation: 733.1695588612839
startDate: '2024-07-01'
sum: -1496.3299999999997
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 4e273dfb-e4cc-4b16-bc1e-95e4abbfcaa7
transactionIds:
- '101402235108'
- '101402235513'
- attributeName: REVENUE
aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 170
mean: 139.57142857142858
median: 170
min: 99
standardDeviation: 37.95109635156426
startDate: '2022-07-24'
sum: 977
- count: 40
endDate: '2022-08-31'
max: 688
mean: 199.2625
median: 144
min: 36
standardDeviation: 162.26367381439258
startDate: '2022-08-01'
sum: 7970.5
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ae2b5252-f1fb-4ba1-8d88-e13129cd627d
- f5bd445f-f5b6-46f8-9602-4202e56cd945
transactionIds:
- '101402235303'
- '101402245133'
- '101402245135'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 4
endDate: '2022-07-31'
max: -35
mean: -35
median: -35
min: -35
standardDeviation: 0
startDate: '2022-07-24'
sum: -140
- count: 9
endDate: '2022-08-31'
max: -24
mean: -39.22222222222222
median: -35
min: -90
standardDeviation: 19.40217628114033
startDate: '2022-08-01'
sum: -353
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- b8dfd96c-ba60-4945-8d76-b58518d828ae
- 5dac07a5-2fa6-4677-859f-cb29f488fc13
- cdb7a88b-9713-477d-b261-ec89250db8b5
transactionIds:
- '101402234950'
- '101402244981'
- '101402235478'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
gseEnabled: true
CashflowPersonalCraAnalyticsReportResponseExample:
value:
id: n1siaxtrn1ni-cfrpcra
customerType: testing
customerId: 1011077785
requestId: m8ks9vjq2u
requesterName: Open Banking API Tests
endUser:
name: ABC Apartments
address: 123 Main St
city: Murray
state: UT
zip: '84123'
phone: 555-2106
email: customerservice@example.com
url: example.com
title: Mastercard Open Banking Cash Flow Analytics
consumerId: 8d510370aae83d459da0b905ee59e714
consumerSsn: '1147'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: Invalid data present.
type: cfrpcra
status: success
constraints:
analyticsReportData:
forCraPurpose: true
timeIntervalTypes:
- MONTHLY_CALENDAR
createdDate: 1721813301
startDate: 1658654901
endDate: 1721813301
days: 730
institutions:
- id: 102105
name: FinBank Profiles - A
urlHomeApp: http://www.finbank.com
accounts:
- id: 3027530342
ownerName: JNC PROPERTIES LLC
ownerAddress: 1944 JAKETOWN RD DONNELLSON IL 62019
ownerAsOfDate: 1721818584
name: Business Investment
number: '1101'
type: investment
aggregationStatusCode: 0
currentBalance: 100000
balanceDate: 1721813305
transactions: []
analytics: null
currency: USD
- id: 3027530343
ownerName: NSF USER
ownerAddress: 123 VINE ST MURRAY, UT 84123
ownerAsOfDate: 1721813301
name: NSF Checking
number: '0111'
type: checking
aggregationStatusCode: 0
currentBalance: 37700.65
availableBalance: 38000.45
balanceDate: 1721813306
transactions:
- id: 101402234899
amount: -34
postedDate: 1708776000
description: INSUFFICIENT FUNDS FEE FOR A $12
memo: '.07 ITEM - DETAILS: ALLSTATE INS'
normalizedPayee: Allstate
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234924
amount: -34
postedDate: 1706961600
description: INSUFFICIENT FUNDS FEE FOR A $21
memo: '.50 ITEM - DETAILS: HK Paymt'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234869
amount: -34
postedDate: 1679140800
description: INSUFFICIENT FUNDS FEE FOR A $64
memo: '.64 ITEM - DETAILS: UI WEB PAYME'
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
- id: 101402234923
amount: 34
postedDate: 1659009600
description: INSUFFICIENT FUNDS FEE REFUND
normalizedPayee: Insufficient
institutionTransactionId: '0000000000'
category: Low Balance
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 68bdc784-89d6-4704-9ded-d3e0f706f9e1
transactionIds:
- '101402234901'
- '101402234939'
- '101402234879'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 3dfd89be-33cc-484d-acbf-69587a0c44e6
transactionIds:
- '101402234943'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: 34
mean: 34
median: 34
min: 34
startDate: '2022-07-28'
sum: 34
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- bb12a859-09b7-4021-8ac5-522e01d00159
transactionIds:
- '101402234901'
- '101402234883'
- '101402234928'
- '101402234879'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 5
endDate: '2022-08-31'
max: -24
mean: -42.6
median: -34
min: -90
standardDeviation: 26.847718711279736
startDate: '2022-08-01'
sum: -213
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 68bdc784-89d6-4704-9ded-d3e0f706f9e1
transactionIds:
- '101402234891'
- '101402234914'
- '101402234900'
- '101402234876'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-28'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 34
count: 4
endDate: '2022-07-31'
endingValue: 0
max: 34
mean: 8.5
median: 0
min: 0
standardDeviation: 17
startDate: '2022-07-28'
sum: 34
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: 0
max: 0
mean: -6.870967741935484
median: 0
min: -90
standardDeviation: 20.144051124312725
startDate: '2022-08-01'
sum: -213
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: -4.141
median: 0
min: -34
standardDeviation: 10.804814492016813
startDate: '2024-06-01'
sum: -124.23
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: -3.8333333333333335
median: 0
min: -34
standardDeviation: 10.3992753370719
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 68bdc784-89d6-4704-9ded-d3e0f706f9e1
payee: non-sufficient
payor: NSF USER
recency: 696
transactionIds:
- '101402234865'
currency: USD
oauthEnabled: false
customerAnalytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 18
endDate: '2022-07-31'
max: -2.47
mean: -53.702222222222225
median: -22.965
min: -167.86
standardDeviation: 58.32137067254321
startDate: '2022-07-24'
sum: -966.64
- count: 37
endDate: '2022-08-31'
max: -2.5
mean: -62.64945945945946
median: -27.39
min: -1150
standardDeviation: 185.22983467912306
startDate: '2022-08-01'
sum: -2318.03
- count: 10
endDate: '2024-06-30'
max: -26.23
mean: -509.856
median: -300
min: -1358.11
standardDeviation: 597.0070650838229
startDate: '2024-06-01'
sum: -5098.5599999999995
- count: 9
endDate: '2024-07-24'
max: -28
mean: -562.9255555555555
median: -300
min: -1358.11
standardDeviation: 607.6863589079302
startDate: '2024-07-01'
sum: -5066.33
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- bb12a859-09b7-4021-8ac5-522e01d00159
- d0bbf017-2c98-4eb1-835c-66dbe0998b02
- e19e1671-19a1-42b3-91f0-277c0a9dba89
- 68bdc784-89d6-4704-9ded-d3e0f706f9e1
transactionIds:
- '101402234822'
- '101402234883'
- '101402235089'
- '101402234758'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 2
endDate: '2022-07-31'
max: 224
mean: 129
median: 129
min: 34
standardDeviation: 134.35028842544403
startDate: '2022-07-24'
sum: 258
- count: 12
endDate: '2022-08-31'
max: 522
mean: 243.70833333333334
median: 224
min: 130
standardDeviation: 104.15274149347228
startDate: '2022-08-01'
sum: 2924.5
- count: 9
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-06-01'
sum: 3570
- count: 9
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-07-01'
sum: 3570
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 6c3fb158-b6c2-44f7-a528-28ebd60d4eb1
transactionIds:
- '101402235114'
- '101402234793'
- '101402235014'
- '101402235455'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 20
endDate: '2022-07-31'
max: 224
mean: -35.432
median: -22.63
min: -167.86
standardDeviation: 84.59117856210726
startDate: '2022-07-24'
sum: -708.64
- count: 49
endDate: '2022-08-31'
max: 522
mean: 12.376938775510204
median: -21.82
min: -1150
standardDeviation: 214.3270055138106
startDate: '2022-08-01'
sum: 606.47
- count: 19
endDate: '2024-06-30'
max: 1070
mean: -80.45052631578946
median: -26.23
min: -1358.11
standardDeviation: 712.6092459208832
startDate: '2024-06-01'
sum: -1528.5599999999997
- count: 18
endDate: '2024-07-24'
max: 1070
mean: -83.12944444444443
median: 16
min: -1358.11
standardDeviation: 733.1695588612839
startDate: '2024-07-01'
sum: -1496.3299999999997
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 3136487d-d9a7-4f89-a1f0-6e9415e053e7
- 3efccc82-01b9-497b-bf3f-27f215db2d96
transactionIds:
- '101402234891'
- '101402234747'
- '101402234831'
- '101402235000'
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 2
endDate: '2022-07-31'
max: -35
mean: -35
median: -35
min: -35
standardDeviation: 0
startDate: '2022-07-24'
sum: -70
- count: 6
endDate: '2022-08-31'
max: -24
mean: -41.333333333333336
median: -34.5
min: -90
standardDeviation: 24.21294419657937
startDate: '2022-08-01'
sum: -248
- count: 5
endDate: '2022-09-30'
max: -34
mean: -34.2
median: -34
min: -35
standardDeviation: 0.4472135954999579
startDate: '2022-09-01'
sum: -171
- count: 3
endDate: '2022-10-31'
max: -30
mean: -32.666666666666664
median: -34
min: -34
standardDeviation: 2.309401076758503
startDate: '2022-10-01'
sum: -98
- count: 3
endDate: '2022-11-30'
max: -34
mean: -34
median: -34
min: -34
standardDeviation: 0
startDate: '2022-11-01'
sum: -102
- count: 3
endDate: '2022-12-31'
max: -28
mean: -32
median: -34
min: -34
standardDeviation: 3.4641016151377544
startDate: '2022-12-01'
sum: -96
- count: 3
endDate: '2023-01-31'
max: -30
mean: -32.666666666666664
median: -34
min: -34
standardDeviation: 2.309401076758503
startDate: '2023-01-01'
sum: -98
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- bb12a859-09b7-4021-8ac5-522e01d00159
- d0bbf017-2c98-4eb1-835c-66dbe0998b02
- 68bdc784-89d6-4704-9ded-d3e0f706f9e1
transactionIds:
- '101402234952'
- '101402235803'
- '101402235249'
- '101402235478'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -220.48000000000002
count: 8
endDate: '2022-07-31'
endingValue: -329.4
max: 201.69
mean: -88.58
median: -84.805
min: -329.4
standardDeviation: 169.11989534055417
startDate: '2022-07-24'
sum: -708.64
- beginningValue: 321
count: 31
endDate: '2022-08-31'
endingValue: -43.64
max: 646
mean: 19.563548387096777
median: 0
min: -923.38
standardDeviation: 251.584474289762
startDate: '2022-08-01'
sum: 606.47
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 3390
mean: -50.952
median: 0
min: -4974.33
standardDeviation: 1117.177412711036
startDate: '2024-06-01'
sum: -1528.56
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 3390
mean: -62.34708333333333
median: 0
min: -4974.33
standardDeviation: 1254.1757580473845
startDate: '2024-07-01'
sum: -1496.33
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: d0bbf017-2c98-4eb1-835c-66dbe0998b02
payee: verizon
payor: NSF USER
recency: 589
transactionIds:
- '101402234898'
- cadence: 5
id: '0139e287-041d-4c45-b51d-108d204c05e2'
payee: Account Owner (Name Unavailable)
payor: capital1 bob jones
recency: 4
transactionIds:
- '101402235180'
- cadence: 73
id: 071c8894-460c-4b55-a0dd-783d420be32d
payee: murphy express
payor: Roberta Prohaska
recency: 307
transactionIds:
- '101402235534'
- cadence: 122
id: 649504d3-f9ef-4476-9743-ebf45563158d
payee: renttrk-inco
payor: Roberta Prohaska
recency: 322
transactionIds:
- '101402235506'
gseEnabled: true
CashflowPersonalNonCraAnalyticsReportResponseExample:
value:
id: '08kiq24ub8b1-cfrpnoncra'
customerType: testing
customerId: 3011077785
requestId: xqgvgxf0ia
requesterName: Open Banking API Tests
createdDate: 1721815835
title: Mastercard Open Banking Cash Flow Analytics
type: cfrpnoncra
status: success
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- MONTHLY_CALENDAR
startDate: 1658657435
endDate: 1721815835
days: 731
institutions:
- id: 170681
name: FinBank P
urlHomeApp: https://finbank.prod.fini.city/CCBankImageMFA/login.jsp
accounts:
- id: 3027530332
ownerName: Roberta Prohaska
ownerAddress: Salt Lake City
ownerAsOfDate: 1721813301
name: Auto Loan
number: '008888'
type: loan
aggregationStatusCode: 0
currentBalance: -724.1
balanceDate: 1721815841
transactions:
- id: 101402235559
amount: -35
postedDate: 1658750400
description: OVERDRAFT FEE FOR A TRANSACTION
memo: POSTED ON 07/24 $6.00 PURCHASE BANK CHECK OR DRAFT
normalizedPayee: Overdraft
institutionTransactionId: '10054'
category: Low Balance
- id: 101402244897
amount: -37.65
postedDate: 1658664000
description: SZECHUAN CHINESE R
memo: PURCHASE 07/20 LAKEWOOD CO CARD 9268
normalizedPayee: Szechuan Chinese
institutionTransactionId: '10047'
category: Restaurants
- id: 101402244895
amount: -5.24
postedDate: 1658664000
description: THE HOME DEPOT 1550
memo: PURCHASE 07/24 LAKEWOOD CO CARD 9268
normalizedPayee: Home Depot
institutionTransactionId: '10044'
category: Home Improvement
- id: 101402235557
amount: -9.99
postedDate: 1658664000
description: PAYPAL *KTONLINEMA
memo: PURCHASE 07/20 402-935-7733 CA CARD 9268
normalizedPayee: Paypal
institutionTransactionId: '10052'
category: Transfer
- id: 101402235552
amount: -2.47
postedDate: 1658664000
description: Wal-Mart Super Center
memo: PURCHASE 07/23 LAKEWOOD CO CARD 9268
normalizedPayee:
wal mart super center purchase lakewood co card
institutionTransactionId: '10045'
category: Shopping
analytics:
transactionalAttributes:
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 1
endDate: '2022-07-31'
max: -35
mean: -35
median: -35
min: -35
startDate: '2022-07-24'
sum: -35
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2022-09-30'
startDate: '2022-09-01'
- count: 0
endDate: '2022-10-31'
startDate: '2022-10-01'
- count: 0
endDate: '2022-11-30'
startDate: '2022-11-01'
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-01'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2023-02-28'
startDate: '2023-02-01'
- count: 0
endDate: '2023-03-31'
startDate: '2023-03-01'
- count: 0
endDate: '2023-04-30'
startDate: '2023-04-01'
- count: 0
endDate: '2023-05-31'
startDate: '2023-05-01'
- count: 0
endDate: '2023-06-30'
startDate: '2023-06-01'
- count: 0
endDate: '2023-07-31'
startDate: '2023-07-01'
- count: 0
endDate: '2023-08-31'
startDate: '2023-08-01'
- count: 0
endDate: '2023-09-30'
startDate: '2023-09-01'
- count: 0
endDate: '2023-10-31'
startDate: '2023-10-01'
- count: 0
endDate: '2023-11-30'
startDate: '2023-11-01'
- count: 0
endDate: '2023-12-31'
startDate: '2023-12-01'
- count: 0
endDate: '2024-01-31'
startDate: '2024-01-01'
- count: 0
endDate: '2024-02-29'
startDate: '2024-02-01'
- count: 0
endDate: '2024-03-31'
startDate: '2024-03-01'
- count: 0
endDate: '2024-04-30'
startDate: '2024-04-01'
- count: 0
endDate: '2024-05-31'
startDate: '2024-05-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: CASH_OUTFLOW
streamIds: []
transactionIds: []
- aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2022-09-30'
startDate: '2022-09-01'
- count: 0
endDate: '2022-10-31'
startDate: '2022-10-01'
- count: 0
endDate: '2022-11-30'
startDate: '2022-11-01'
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-01'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2023-02-28'
startDate: '2023-02-01'
- count: 0
endDate: '2023-03-31'
startDate: '2023-03-01'
- count: 0
endDate: '2023-04-30'
startDate: '2023-04-01'
- count: 0
endDate: '2023-05-31'
startDate: '2023-05-01'
- count: 0
endDate: '2023-06-30'
startDate: '2023-06-01'
- count: 0
endDate: '2023-07-31'
startDate: '2023-07-01'
- count: 0
endDate: '2023-08-31'
startDate: '2023-08-01'
- count: 0
endDate: '2023-09-30'
startDate: '2023-09-01'
- count: 0
endDate: '2023-10-31'
startDate: '2023-10-01'
- count: 0
endDate: '2023-11-30'
startDate: '2023-11-01'
- count: 0
endDate: '2023-12-31'
startDate: '2023-12-01'
- count: 0
endDate: '2024-01-31'
startDate: '2024-01-01'
- count: 0
endDate: '2024-02-29'
startDate: '2024-02-01'
- count: 0
endDate: '2024-03-31'
startDate: '2024-03-01'
- count: 0
endDate: '2024-04-30'
startDate: '2024-04-01'
- count: 0
endDate: '2024-05-31'
startDate: '2024-05-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: CASH_INFLOW
streamIds: []
transactionIds: []
- aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2022-09-30'
startDate: '2022-09-01'
- count: 0
endDate: '2022-10-31'
startDate: '2022-10-01'
- count: 0
endDate: '2022-11-30'
startDate: '2022-11-01'
- count: 0
endDate: '2022-12-31'
startDate: '2022-12-01'
- count: 0
endDate: '2023-01-31'
startDate: '2023-01-01'
- count: 0
endDate: '2023-02-28'
startDate: '2023-02-01'
- count: 0
endDate: '2023-03-31'
startDate: '2023-03-01'
- count: 0
endDate: '2023-04-30'
startDate: '2023-04-01'
- count: 0
endDate: '2023-05-31'
startDate: '2023-05-01'
- count: 0
endDate: '2023-06-30'
startDate: '2023-06-01'
- count: 0
endDate: '2023-07-31'
startDate: '2023-07-01'
- count: 0
endDate: '2023-08-31'
startDate: '2023-08-01'
- count: 0
endDate: '2023-09-30'
startDate: '2023-09-01'
- count: 0
endDate: '2023-10-31'
startDate: '2023-10-01'
- count: 0
endDate: '2023-11-30'
startDate: '2023-11-01'
- count: 0
endDate: '2023-12-31'
startDate: '2023-12-01'
- count: 0
endDate: '2024-01-31'
startDate: '2024-01-01'
- count: 0
endDate: '2024-02-29'
startDate: '2024-02-01'
- count: 0
endDate: '2024-03-31'
startDate: '2024-03-01'
- count: 0
endDate: '2024-04-30'
startDate: '2024-04-01'
- count: 0
endDate: '2024-05-31'
startDate: '2024-05-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
attributeName: ALL_CASH_FLOWS
streamIds: []
transactionIds: []
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: 0
count: 8
endDate: '2022-07-31'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2022-07-24'
sum: 0
- beginningValue: 0
count: 31
endDate: '2022-08-31'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2022-08-01'
sum: 0
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-06-01'
sum: 0
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 0
mean: 0
median: 0
min: 0
standardDeviation: 0
startDate: '2024-07-01'
sum: 0
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: 4bf25309-4b8b-4b6f-a29d-7e6626b51f1f
payee: capital one mobile
payor: Roberta Prohaska
recency: 315
transactionIds:
- '101402235642'
- cadence: 32
id: '0232939d-b220-4e95-aac2-0d788ebe813d'
payee: wal mart super center purchase lakewood co card
payor: Roberta Prohaska
recency: 317
transactionIds:
- '101402235607'
- '101402235618'
- cadence: 186
id: afd411e9-3358-42d3-a793-8fa0be74d397
payee: empire
payor: Roberta Prohaska
recency: 317
transactionIds:
- '101402235637'
currency: USD
- id: 3027530339
ownerName: Roberta Prohaska
ownerAddress: Salt Lake City
ownerAsOfDate: 1721813301
name: Checking
number: '001111'
type: checking
aggregationStatusCode: 0
currentBalance: 724.1
availableBalance: 165
balanceDate: 1721815841
transactions: []
analytics: null
currency: USD
oauthEnabled: false
customerAnalytics:
stateAttributes:
- attributeName: NET_CASH_FLOW
reportedByTimePeriods:
- periods:
- beginningValue: -278.97
count: 8
endDate: '2022-07-31'
endingValue: -164.7
max: 678.71
mean: 38.540000000000006
median: -26.450000000000003
min: -278.97
standardDeviation: 320.23035561474006
startDate: '2022-07-24'
sum: 308.32000000000005
- beginningValue: 321
count: 31
endDate: '2022-08-31'
endingValue: -21.82
max: 498.44000000000005
mean: -38.651290322580635
median: 0
min: -1198.74
standardDeviation: 344.1010097315606
startDate: '2022-08-01'
sum: -1198.1899999999998
- beginningValue: 0
count: 30
endDate: '2024-06-30'
endingValue: 0
max: 3390
mean: -50.952
median: 0
min: -4974.33
standardDeviation: 1117.177412711036
startDate: '2024-06-01'
sum: -1528.56
- beginningValue: 0
count: 24
endDate: '2024-07-24'
endingValue: 0
max: 3390
mean: -62.34708333333333
median: 0
min: -4974.33
standardDeviation: 1254.1757580473845
startDate: '2024-07-01'
sum: -1496.33
timeIntervalType: MONTHLY_CALENDAR
streams:
- cadence: 0
id: c62c9bd4-35c6-4b27-a62e-b1136b007eca
payee: chili lakewood purchase lakewood co card
payor: Roberta Prohaska
recency: 370
transactionIds:
- '101402235913'
- '101402244978'
- cadence: 36
id: 15f8e865-1643-4f5c-8827-eba02a60d513
payee: wm superc wal mart sup purchase wheat ridge co card
payor: Roberta Prohaska
recency: 351
transactionIds:
- '101402235582'
- cadence: 18
id: e9a96847-8c6e-4771-8d90-3f3d532d046a
payee: bradley
payor: Roberta Prohaska
recency: 317
transactionIds:
- '101402235380'
- '101402245042'
- '101402235762'
- '101402235517'
- '101402244948'
- '101402235519'
- '101402235397'
- '101402245043'
- '101402235280'
- '101402235742'
- '101402235498'
- '101402245036'
- '101402235625'
- '101402235396'
- '101402245131'
- '101402235723'
- '101402235477'
- '101402235848'
- '101402235266'
- '101402244873'
- '101402235884'
- '101402235246'
- cadence: 61
id: fd4f73c0-a6e1-426f-a2eb-a32446ce1687
payee: chili downtown purchase denver co card
payor: Roberta Prohaska
recency: 334
transactionIds:
- '101402235733'
- '101402235858'
- '101402245122'
transactionalAttributes:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- periods:
- count: 4
endDate: '2022-07-31'
max: -35
mean: -35
median: -35
min: -35
standardDeviation: 0
startDate: '2022-07-24'
sum: -140
- count: 9
endDate: '2022-08-31'
max: -24
mean: -39.22222222222222
median: -35
min: -90
standardDeviation: 19.40217628114033
startDate: '2022-08-01'
sum: -353
- count: 4
endDate: '2024-06-30'
max: -26.23
mean: -31.0575
median: -32
min: -34
standardDeviation: 3.7300435654292294
startDate: '2024-06-01'
sum: -124.23
- count: 3
endDate: '2024-07-24'
max: -28
mean: -30.666666666666668
median: -30
min: -34
standardDeviation: 3.0550504633038935
startDate: '2024-07-01'
sum: -92
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ecb47251-b1b4-43e3-8131-35f0ed4c218a
transactionIds:
- '101402234886'
- '101402234934'
- '101402244981'
- '101402235478'
- attributeName: NSF_FEE_REVERSALS
aggregatedByTimePeriods:
- periods:
- count: 0
endDate: '2022-07-31'
startDate: '2022-07-24'
- count: 0
endDate: '2022-08-31'
startDate: '2022-08-01'
- count: 0
endDate: '2024-06-30'
startDate: '2024-06-01'
- count: 0
endDate: '2024-07-24'
startDate: '2024-07-01'
timeIntervalType: MONTHLY_CALENDAR
streamIds: []
transactionIds: []
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- periods:
- count: 22
endDate: '2022-07-31'
max: -2.47
mean: -39.71272727272727
median: -22.575
min: -167.86
standardDeviation: 48.44036404072815
startDate: '2022-07-24'
sum: -873.6800000000001
- count: 51
endDate: '2022-08-31'
max: -1.67
mean: -68.74882352941177
median: -24
min: -1150
standardDeviation: 207.0556947649309
startDate: '2022-08-01'
sum: -3506.19
- count: 10
endDate: '2024-06-30'
max: -26.23
mean: -509.856
median: -300
min: -1358.11
standardDeviation: 597.0070650838229
startDate: '2024-06-01'
sum: -5098.5599999999995
- count: 9
endDate: '2024-07-24'
max: -28
mean: -562.9255555555555
median: -300
min: -1358.11
standardDeviation: 607.6863589079302
startDate: '2024-07-01'
sum: -5066.33
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- 1c5a5352-0364-4eb8-91cb-7ec8692d895c
- 98468b34-b1a8-423d-8de2-a0d2e17f0167
- 987dea29-9135-4db7-8f1b-d678ca253ee0
transactionIds:
- '101402234898'
- '101402235057'
- '101402235268'
- '101402245093'
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- periods:
- count: 7
endDate: '2022-07-31'
max: 261
mean: 168.85714285714286
median: 170
min: 34
standardDeviation: 79.20527880435868
startDate: '2022-07-24'
sum: 1182
- count: 13
endDate: '2022-08-31'
max: 321
mean: 177.53846153846155
median: 199.5
min: 36
standardDeviation: 94.35073342288283
startDate: '2022-08-01'
sum: 2308
- count: 9
endDate: '2024-06-30'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-06-01'
sum: 3570
- count: 9
endDate: '2024-07-24'
max: 1070
mean: 396.6666666666667
median: 60
min: 60
standardDeviation: 505
startDate: '2024-07-01'
sum: 3570
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- ed105d3e-063a-401a-a59d-851e223844af
- bcdd7d7d-b1ba-4e12-b33b-e3da7ed1ceaf
- 6a6c9438-01d4-4c51-801e-3a1020741ef7
transactionIds:
- '101402235054'
- '101402235009'
- '101402234787'
- '101402235108'
- '101402235513'
- attributeName: ALL_CASH_FLOWS
aggregatedByTimePeriods:
- periods:
- count: 29
endDate: '2022-07-31'
max: 261
mean: 10.631724137931034
median: -9.99
min: -167.86
standardDeviation: 106.55717590198653
startDate: '2022-07-24'
sum: 308.32
- count: 64
endDate: '2022-08-31'
max: 321
mean: -18.72171875
median: -15.62
min: -1150
standardDeviation: 213.7644749804459
startDate: '2022-08-01'
sum: -1198.19
- count: 19
endDate: '2024-06-30'
max: 1070
mean: -80.45052631578946
median: -26.23
min: -1358.11
standardDeviation: 712.6092459208832
startDate: '2024-06-01'
sum: -1528.5599999999997
- count: 18
endDate: '2024-07-24'
max: 1070
mean: -83.12944444444443
median: 16
min: -1358.11
standardDeviation: 733.1695588612839
startDate: '2024-07-01'
sum: -1496.3299999999997
timeIntervalType: MONTHLY_CALENDAR
streamIds:
- bedf7c84-a94c-4e85-a3e2-fa69a7927936
- 48729fb2-e3fe-49d9-b95a-7a032500f08e
transactionIds:
- '101402235066'
- '101402235207'
- '101402235108'
- '101402235513'
gseEnabled: true
PaymentHistoryBusinessCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbcra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
endUser:
name: 'ABC Apartments'
address: '123 Main St'
city: 'Murray'
state: 'UT'
zip: '84123'
phone: '1-801-443-7288'
email: 'customerservice@example.com'
url: 'example.com'
title: Mastercard Open Banking Payment History Analytics
consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4
consumerSsn: '1234'
consumerDetails:
id: '3f7ff2cf0ffb3d0cd59875e070c9b1d4'
firstName: 'John'
middleName: 'Doe'
lastName: 'Jane'
address: '123 Marple Street'
city: 'Anytown'
state: 'PA'
zip: '17101'
phone: '5551234567'
ssn: '1234'
email: 'john.doe@example.com'
disputeStatement: 'Invalid data present.'
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: true
timeIntervalTypes:
- HISTORICALLY
type: phrbcra
status: success
createdDate: 1579819592
reportRefreshNumber: 2
originalReportCreatedDate: 1607450357
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
customerAnalytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
- '45'
- '96'
- '95'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
PaymentHistoryBusinessNonCraAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbnoncra
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
title: Mastercard Open Banking Payment History Analytics
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: false
timeIntervalTypes:
- HISTORICALLY
type: phrbnoncra
status: success
createdDate: 1579819592
reportRefreshNumber: 2
originalReportCreatedDate: 1607450357
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
customerAnalytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
- '45'
- '96'
- '95'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
PaymentHistoryBusinessFtcAnalyticsReportResponseExample:
value:
id: sd1j45yn37wr-phrbftc
customerType: active
customerId: 1275320
requestId: 7a7qyps2iy
requesterName: Decisioning API
businessDetails:
id: 123
name: Name1
address:
addressLine1: 2020 State Street
addressLine2: Suite 301
city: Salt Lake City
state: Utah
country: USA
postalCode: 84116
constraints:
analyticsReportData:
forCraPurpose: true
applicantIsPersonalGuarantor: false
timeIntervalTypes:
- HISTORICALLY
type: phrbftc
status: success
createdDate: 1579819592
reportRefreshNumber: 2
originalReportCreatedDate: 1607450357
startDate: 1512594823
endDate: 1575666823
days: 730
institutions:
- id: '102105'
name: FinBank Profiles
urlHomeApp: http://www.finbank.com
accounts:
- id: '1111'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000001'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000002'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
- id: '2222'
ownerName: 'PATRICK & LORRAINE PURCHASER'
ownerAddress: '7195 BELMONT ST. PARLIN, NJ 08859'
ownerAsOfDate: 1579819592
name: Checking
number: XX1111
type: checking
aggregationStatusCode: '0'
currentBalance: 100000
availableBalance: 1000
balanceDate: 1614880526
transactions:
- id: '00000005'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
- id: '00000006'
amount: -81.7
postedDate: 1614859200
description: TMOBILE*AUTO PAY
normalizedPayee: T-Mobile
institutionTransactionId: '0000000000'
category: Mobile Phone
analytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
customerAnalytics:
transactionalAttributes:
- attributeName: CASH_OUTFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: CASH_INFLOW
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 5050
count: 100
mean: 50.5
median: 50.5
min: 1
max: 100
standardDeviation: 29.011491975882016
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds:
- '10'
- '72'
- '78'
- '16'
- '25'
- '67'
- '27'
- '15'
- '36'
- '75'
- '88'
- '57'
- '51'
- '30'
- '66'
- '87'
- '61'
- '6'
- '82'
- '48'
- '40'
- '45'
- '96'
- '95'
projectedValues: []
streamIds:
- e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
streamConfidences:
- attributeName: INSURANCE_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: TAX_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: DISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NONDISCRETIONARY_SPENDING
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_EXPENSES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: RECURRING_LOAN_PAYMENTS
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
- attributeName: NSF_FEE_CHARGES
aggregatedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum:
count: 0
mean:
median:
min:
max:
standardDeviation:
comparedToCohorts: []
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
transactionIds: []
projectedValues: []
streamIds: []
streamConfidences:
stateAttributes:
- attributeName: MISSED_RECURRING_EXPENSES
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: MISSED_RECURRING_LOAN_PAYMENTS
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 0
count: 732
mean: 0
median: 0
min: 0
max: 0
standardDeviation: 0
comparedToCohorts: []
beginningValue: 0
endingValue: 0
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: PAYMENT_RISK_SCORE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: 19825
count: 732
mean: 27.083333333333332
median: 24
min: -1
max: 46
standardDeviation: 8.739575902668523
comparedToCohorts: []
beginningValue: -1
endingValue: 24
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
- attributeName: ASSET_BALANCE
reportedByTimePeriods:
- timeIntervalType: HISTORICALLY
periods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
sum: -900726.9199999999
count: 732
mean: -1230.501256830601
median: -1192.56
min: -3804.56
max: 1234.44
standardDeviation: 1628.527991127309
comparedToCohorts: []
beginningValue: -3804.56
endingValue: 1234.44
cohortBenchmarkPeriods:
- startDate: '2022-09-18'
endDate: '2024-09-18'
cohortValues: []
projectedValues: []
streams:
- id: e6dd352d-67d3-4a6c-a7a0-68f1e994bb22
payor: '0'
payee: John Smith
cadence: 7
status: inactive
recency: 118
earliestObservedDate: '2022-09-18T00:00:00'
latestObservedDate: '2024-09-13T00:00:00'
count: 100
sum: 5050
min: 1
max: 100
mean: 50.5
median: 50.5
standardDeviation: 29.011491975882016
minimumCadence: 0
maximumCadence: 58
medianCadence: 4
modeCadence: 2
standardDeviationCadence: 9.261506907846133
transactionIds:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '3'
- '30'
ACHDetailsV3Example:
value:
paymentInstruction:
- type: ach
accountNumber: '1000001111'
tanEnabled: true
descriptors:
- type: routingNumber
value: '091000019'
- type: rtp
accountNumber: '1000001112'
tanEnabled: false
descriptors:
- type: routingNumber
value: '091000019'
transferInEnabled: true
transferOutEnabled: true
- type: fedNow
accountNumber: '1000001111'
tanEnabled: false
descriptors:
- type: routingNumber
value: '091009919'
transferInEnabled: true
transferOutEnabled: true
ACHDetailsWithoutRTPDetailsExample:
value:
paymentInstruction:
- type: ach
accountNumber: '1000001111'
tanEnabled: true
descriptors:
- type: routingNumber
value: '091000019'
ACHDetailsWithoutRTPDetailsV3Example:
value:
paymentInstruction:
- type: ach
accountNumber: '1000001111'
descriptors:
- type: routingNumber
value: '091000019'
- type: fedNow
accountNumber: '1000001111'
tanEnabled: false
descriptors:
- type: routingNumber
value: '091009919'
transferInEnabled: true
transferOutEnabled: true
ACHDetailsExampleWithoutFedNowAndWithoutRTPV3Example:
value:
paymentInstruction:
- type: ach
accountNumber: '1000001111'
descriptors:
- type: routingNumber
value: '091000019'
ACHDetailsExampleWithoutFedNowV3Example:
value:
paymentInstruction:
- type: ach
accountNumber: '1000001111'
descriptors:
- type: routingNumber
value: '091000019'
- type: rtp
accountNumber: '1000001115'
tanEnabled: false
descriptors:
- type: routingNumber
value: '091009910'
transferInEnabled: true
transferOutEnabled: true
CustomerAuthorizationDetailsExample:
value:
institutionLoginId: 7008461438
authorizationStartDate: 2024-01-01T16:11:23.20Z
authorizationEndDate: 2024-12-31T16:11:23.20Z
InstitutionLoginIdNotFoundErrorResponseExample:
value:
code: '3003'
status: '404'
message: Resource Not Found.
user_message: 'Institution Login Id is not found'
InstitutionLoginIdDetailsNotFoundErrorResponseExample:
value:
code: '3004'
status: '404'
message: Resource Not Found.
user_message: 'Institution Login Id details are not found'
BadRequest:
value:
code: 1000
status: '400'
message: field must be a number
user_message:
One or more of the fields could not be validated. Please ensure you
have entered the correct data.
NoMatchingExternalIdFoundErrorResponseExample:
value:
code: '1643'
status: '400'
message: No matching record found for external_id 123456789.
ResourceNotFoundRequest:
value:
code: '4004'
status: '404'
message:
The requested experience could not be found for the external app name.
user_message: The requested entity was not found.
GetExternalSwitchesResourceNotFoundErrorExample:
value:
code: '14001'
status: '404'
message: Resource not found
SwitchesSummaryExample:
value:
customerId: '1005061234'
customerType: testing
switches:
- id: 602414d84f9a1980cf5eafcc
status: completed
createdDate: '2024-01-10T11:18:27Z'
- id: 65cb40beec86d3bd0e8664cc
status: failed
failureReason: bad-credentials
createdDate: '2024-02-13T10:13:27Z'
ExternalSwitchesSummaryExample:
value:
externalId: '123456789'
switches:
- id: 602414d84f9a1980cf5eafcc
status: completed
createdDate: '2024-01-10T11:18:27Z'
- id: 65cb40beec86d3bd0e8664cc
status: failed
failureReason: bad-credentials
createdDate: '2024-02-13T10:13:27Z'
DepositSwitchDetailsSuccessExample:
value:
customerId: '1005061234'
customerType: testing
switchId: 602414d84f9a1980cf5eafcc
switchStatus: completed
createdDate: '2023-07-25T08:14:20Z'
updatedDate: '2023-07-25T08:30:20Z'
authenticated: true
provider:
id: 607e249736b9f053b536bde0
name: Paycom
distributions:
- type: percent
allocatedValue: 52
bankIdentifier: '110000000'
accountNumberEndsWith: '4126'
DepositSwitchDetailsFailureExample:
value:
customerId: '1005061234'
customerType: testing
switchId: 602414d84f9a1980cf5eafcc
switchStatus: failed
failureReason: distribution-not-supported
createdDate: '2023-07-25T08:14:20Z'
updatedDate: '2023-07-25T08:30:20Z'
authenticated: true
provider:
id: 607e249736b9f053b536bde0
name: Paycom
distributions:
- type: total
bankIdentifier: '110000000'
accountNumberEndsWith: '4125'
SwitchDetailsNotFoundExample:
value:
status: '404'
code: '1643'
message: No matching record found for switch_id 65d87d2d8c831ae0f3174ed6
PaySwitchDetailsCardSuccessExample:
value:
customerId: '1005061234'
customerType: testing
switchId: 602414d84f9a1980cf5eafcc
switchStatus: completed
createdDate: '2023-07-25T08:14:20Z'
updatedDate: '2023-07-25T08:30:20Z'
authenticated: true
provider:
id: 607e249736b9f053b536bde0
name: CashApp
paymentMethods:
- type: 'card'
title: 'Sample Card'
brand: 'Mastercard'
endsWith: '4126'
PaySwitchDetailsAccountSuccessExample:
value:
customerId: '1005061234'
customerType: testing
switchId: 602414d84f9a1980cf5eafcc
switchStatus: completed
createdDate: '2023-07-25T08:14:20Z'
updatedDate: '2023-07-25T08:30:20Z'
authenticated: true
provider:
id: 607e249736b9f053b536bde0
name: CashApp
paymentMethods:
- type: 'bank'
title: 'Sample Account'
bankIdentifier: '110000000'
accountNumberEndsWith: '4126'
PaySwitchDetailsFailureExample:
value:
customerId: '1005061234'
customerType: testing
switchId: 602414d84f9a1980cf5eafcc
switchStatus: failed
failureReason: connection-error
createdDate: '2023-07-25T08:14:20Z'
updatedDate: '2023-07-25T08:30:20Z'
authenticated: false
ObmwsResourceNotFoundExample:
value:
Errors:
Error:
- source: 'Event Subscription Service'
reasonCode: 1501
description: 'Resource not found.'
recoverable: false
details: null
BadRequestErrorResponseExample:
value:
Errors:
Error:
- source: 'Event Subscription Service'
reasonCode: 1502
description: 'Bad Request.'
recoverable: false
details: null
ObwmsExpiredTokenExample:
value:
Errors:
Error:
- source: 'Event Subscription Service'
reasonCode: 1503
description: 'Expired (App-Token)'
recoverable: false
details: null
MissingAppKeyExample:
value:
Errors:
Error:
- source: 'Event Subscription Service'
reasonCode: 1504
description: 'Missing parameter (App-Key)'
recoverable: false
details: null
SubscriptionRequestExample:
value:
url: 'https://example.com/example_webhook/expiry'
events:
- name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
- name: 'manage.txpush.account.created'
condition:
subscribeFor: 'accountId'
includes:
- '100010'
- '100011'
- '100012'
- url: 'https://example.com/overridden_webhookurl'
name: 'mastercard.openbanking.customer.consent'
UpdateEventRequestExample:
summary: Example of updating an event in a subscription
value:
name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
SubscriptionCreatedResponseExample:
value:
subscriptionId: '661f3c48-f596-423b-81f5-d275d4dd1345'
url: 'https://example.com/example_webhook'
events:
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1346'
name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
status: 'pending'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1347'
name: 'manage.txpush.account.created'
condition:
subscribeFor: 'accountId'
includes:
- '100010'
- '100011'
- '100012'
status: 'pending'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1348'
url: 'https://example.com/overridden_webhookurl'
name: 'mastercard.openbanking.customer.consent'
status: 'pending'
status: 'pending'
createdDate: '2024-03-16T06:06:20Z'
lastUpdatedDate: '2024-03-16T06:06:20Z'
EventUpdatedResponseExample:
value:
name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
SubscriptionsResponseExample:
value:
count: 3
offset: 0
limit: 10
total: 3
subscriptions:
- subscriptionId: '661f3c48-f596-423b-81f5-d275d4dd1345'
url: 'https://example.com/example_webhook/token'
events:
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1346'
name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
status: 'active'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1347'
name: 'manage.txpush.account.created'
condition:
subscribeFor: 'accountId'
includes:
- '100010'
- '100011'
status: 'active'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1348'
name: 'mastercard.openbanking.customer.consent'
status: 'active'
status: 'active'
createdDate: '2024-03-16T06:06:20Z'
lastUpdatedDate: '2024-03-16T06:06:20Z'
SubscriptionDetailResponseExample:
value:
subscriptionId: '661f3c48-f596-423b-81f5-d275d4dd1345'
url: 'https://example.com/example_webhook/token'
events:
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1346'
name: 'authorization.accesstoken.expiry'
condition:
subscribeFor: 'institutionId'
excludes:
- '170718'
- '170788'
- '188797'
status: 'active'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1347'
name: 'manage.txpush.account.created'
condition:
subscribeFor: 'accountId'
includes:
- '100010'
- '100011'
- '100012'
status: 'active'
- webhookEventId: '661f3c48-f596-423b-81f5-d275d4dd1348'
name: 'mastercard.openbanking.customer.consent'
status: 'active'
status: 'active'
createdDate: '2024-03-16T06:06:20Z'
lastUpdatedDate: '2024-03-16T06:06:20Z'
AvailableEventsResponseExample:
value:
events:
- name: 'manage.txpush.account.created'
description: 'notification will be sent when accounts are created'
conditionalSubscription:
applicable: true
fields: 'accountid,customerId'
mandatory: false
- name: 'mastercard.openbanking.customer.consent'
description: 'Customer consent information'
conditionalSubscription:
applicable: false
GoldStandardMissingFinicityAppKey:
value:
Errors:
Error:
- Source: Connect-Components,
ReasonCode: 10026,
Description: Missing parameter (Finicity-App-Key)
Recoverable: false,
Details: Missing parameter (Finicity-App-Key)
GoldStandardInvalidField:
value:
Errors:
Error:
- Source: Connect-Components,
ReasonCode: 10010,
Description:
All request parameters could not be validated. Ensure you are
sending the correct data in your headers, query parameters, and
request body.
Recoverable: false,
Details:
One or more of the fields could not be validated. Please ensure
you have entered the correct data.
GoldStandardExpiredToken:
value:
Errors:
Error:
- Source: Connect-Components,
ReasonCode: 10023,
Description: Expired (Finicity-App-Token),
Recoverable: false,
Details: Expired (Finicity-App-Token)
GoldStandardResourceNotFound:
value:
Errors:
Error:
- Source: Connect-Components,
ReasonCode: 4041,
Description: The requested entity was not found,
Recoverable: false,
Details: The requested entity was not found
DataNotFoundError:
value:
code: 14001
message: Resource not found.
EnrichTransactionsPayloadExample:
value:
transactions:
- externalCustomerId: '1005061234'
externalAccountId: '1005061234'
accountType: 'checking'
externalTransactionId: 'MAC1005061233'
postedTimestamp: '2024-07-26T11:00:00Z'
transactionTimestamp: '2024-07-26T11:00:00Z'
description: 'STARBUCKS STORE 06565 LITTLETON CO 07/26'
memo: 'debit'
amount: -13.26
transactionFee: 0.00
type: 'DEBIT'
directionIndicator: 'Debit'
additionalDetails:
key1: 'value1'
- externalCustomerId: '10050612345'
externalAccountId: '10050612345'
accountType: 'checking'
externalTransactionId: 'MAC1005061234'
postedTimestamp: '2024-07-26T11:00:00Z'
transactionTimestamp: '2024-07-26T11:00:00Z'
description: 'CHECKCARD 07/26 MCDONALDS F10649 CLINTON SC'
memo: 'debit'
amount: -37.52
transactionFee: 0.00
type: 'DEBIT'
directionIndicator: 'Debit'
additionalDetails:
key1: 'value1'
key2: 'value2'
cardAcceptorId: '006952800649MDF'
inputIsRecurringTransaction: false
inputMerchantInformation:
merchantDescriptor: 'MCDONALDS10649CLINTONSC'
name: 'McDonalds'
line1: '101 S Broad St'
city: 'Clinton'
state: 'SC'
postalCode: '29325'
country: 'US'
phoneNumber: '8648334816'
website: 'https://www.mcdonalds.com'
merchantCategoryCode: '5814'
merchantCategoryName: 'FAST FOOD RESTAURANTS'
EnrichedTransactionsExample:
value:
transactions:
- externalCustomerId: '1005061234'
externalAccountId: '1005061234'
accountType: 'checking'
externalTransactionId: 'MAC1005061233'
postedTimestamp: '2024-07-26T11:00:00Z'
transactionTimestamp: '2024-07-26T11:00:00Z'
description: 'STARBUCKS STORE 06565 LITTLETON CO 07/26'
memo: 'debit'
amount: -13.26
transactionFee: 0.00
transactionCategory: 'Coffee Shops'
transactionCategoryScore: 45.0
transactionCategoryGroup: 'Groceries & Dining'
type: 'DEBIT'
directionIndicator: 'Debit'
entities:
- id: 'MTc1ODA5NDU0MTYwNjM1OTA0MA== '
name: 'Starbucks'
category: 'Coffee Shops'
group: 'Cafe'
website: 'https://starbucks.com'
logoUrl: 'https://institution-branding-assets-cf.openbanking.mastercard.com/MTc1ODA5NDU0MTYwNjM1OTA0MA==/logo.svg'
entityStandardizationConfidenceScore: 91.0
address:
line1: '10278 W'
line2: 'Centennial Rd'
city: 'Littleton'
state: 'CO'
postalCode: '80127'
country: 'US'
latitude: 39.567229
longitude: -105.11126
phoneNumber: '8017339340'
additionalDetails:
key1: 'value1'
- externalCustomerId: '10050612345'
externalAccountId: '10050612345'
accountType: 'checking'
externalTransactionId: 'MAC1005061234'
postedTimestamp: '2024-07-26T11:00:00Z'
transactionTimestamp: '2024-07-26T11:00:00Z'
description: 'CHECKCARD 07/26 MCDONALDS F10649 CLINTON SC'
memo: 'debit'
amount: -37.52
transactionFee: 0.00
transactionCategory: 'Food & Dining'
transactionCategoryScore: 39.87
transactionCategoryGroup: 'Groceries & Dining'
type: 'DEBIT'
directionIndicator: 'Debit'
entities:
- id: 'MTc1ODA5Mzc1Mzc1MjQ4OTk4NA=='
name: "McDonald's"
category: 'Fast Food'
website: 'https://mcdonalds.com'
logoUrl: 'https://institution-branding-assets-cf.openbanking.mastercard.com/MTc1ODA5Mzc1Mzc1MjQ4OTk4NA==/logo.svg'
entityStandardizationConfidenceScore: 96.77
address:
line1: '101 S Broad St'
line2: ''
city: 'Clinton'
state: 'SC'
postalCode: '29325'
country: 'US'
latitude: 34.47237
longitude: -81.880344
phoneNumber: '8648334816'
additionalDetails:
key1: 'value1'
key2: 'value2'
cardAcceptorId: '006952800649MDF'
inputIsRecurringTransaction: false
inputMerchantInformation:
merchantDescriptor: 'MCDONALDS10649CLINTONSC'
name: 'McDonalds'
line1: '101 S Broad St'
city: 'Clinton'
state: 'SC'
postalCode: '29325'
country: 'US'
phoneNumber: '8648334816'
website: 'https://www.mcdonalds.com'
merchantCategoryCode: '5814'
merchantCategoryName: 'FAST FOOD RESTAURANTS'
isRecurringTransaction: false
locationId: 876875444777
isEcommerce: false
isBrickAndMortar: true
matchConfidenceScore: 97
PaymentEnablementBundleResponseExample:
value:
customerId: '5000902316'
errorCount: 0
accountCount: 1
accountIdentitySuccessCount: 1
balanceDetailsSuccessCount: 1
paymentInstructionSuccessCount: 1
accounts:
- id: '5011648377'
institutionId: '4222'
institutionName: FinBank
institutionLoginId: 1007302745
accountDetails:
id: '5011648377'
accountNumberDisplay: '8888'
realAccountNumberLast4: '5678'
name: Super Checking
type: checking
aggregationStatusCode: 0
status: active
aggregationSuccessDate: '2023-06-26T11:14:11Z'
aggregationAttemptDate: '2023-06-26T11:14:11Z'
createdDate: '2023-06-26T11:14:11Z'
currency: USD
displayPosition: 1
parentAccount: '5011648377'
balanceDetails:
id: 5011648377
realAccountNumberLast4: '5678'
availableBalance: 123.45
availableBalanceDate: '2023-06-26T11:14:11Z'
clearedBalance: 222.25
clearedBalanceDate: '2023-06-26T11:14:11Z'
aggregationStatusCode: 0
currency: USD
accountIdentity:
holders:
- relationship: AUTHORIZED_USER
ownerName: 'John Smith, PhD'
firstName: John
middleName: L
lastName: Smith
suffix: PhD
nameClassification: home
nameClassificationConfidenceScore: 100
addresses:
- ownerAddress: 434 W Ascension Way
type: Home
line1: 434 W Ascension Way
line2: 'Suite #200'
line3: UT 84123
city: Murray
country: USA
postalCode: '84123'
state: UT
emails:
- isPrimary: true
email: john@example.com
emailType: Personal
phones:
- type: HOME
country: '61'
phone: 1-555-184-4200
documentations:
- taxId: 123-45-7890
taxIdCountry: USA
governmentId: '123456789'
paymentInstruction:
type: ach
accountNumber: '124344454'
tanEnabled: true
descriptors:
- type: routingNumber
value: '2434345'
PaymentEnablementBundleWithErrorResponseExample:
value:
customerId: '5000902316'
errorCount: 2
accountCount: 1
accountIdentitySuccessCount: 0
balanceDetailsSuccessCount: 0
paymentInstructionSuccessCount: 1
accounts:
- id: '5011648377'
institutionId: '4222'
institutionName: 'TestBank'
institutionLoginId: 1007302745
accountDetails:
id: '5011648377'
accountNumberDisplay: '8888'
realAccountNumberLast4: '5678'
name: Super Checking
type: checking
aggregationStatusCode: 0
status: active
aggregationSuccessDate: '2023-06-26T11:14:11Z'
aggregationAttemptDate: '2023-06-26T11:14:11Z'
createdDate: '2023-06-26T11:14:11'
currency: USD
displayPosition: 1
parentAccount: '5011648377'
paymentInstruction:
type: ach
accountNumber: '124344454'
tanEnabled: true
descriptors:
- type: routingNumber
value: '2434345'
errors:
- fieldName: balanceDetails
code: '102'
description: FI Down for maintenance
- fieldName: accountIdentity
code: '102'
description: FI Down for maintenance
InvalidFieldParameterExample:
value:
code: 12019
message: >-
fields parameter value must be 'balanceDetails','paymentInstruction'
and 'accountIdentity'
NoAccountForCustomerIdExample:
value:
code: 38003
message: Customer does not have any accounts
GenerateRetailSalesAnalyticsReportExample:
value:
id: y3pic4xhda-sbcaanalyticsnoncra
customerType: testing
customerId: 1001483250
createdDate: 1739824892
requestId: y3pic4xhda
requestorName: ABC Partner
partnerName: ABC partner
type: sbcaanalyticsnoncra
title: Mastercard Open Banking Small Business Credit Analytics
constraints:
analyticsReportData:
sbcaParams:
hasConsent: true
metricFrequency: weekly
metricType: retail_sales_analytics
locationId: a1b2c3d4-0000-1234-abcd-000000000001
businessDetails:
name: ABC Tires Inc
personallyLiable: true
address:
addressLine1: 434 W Ascension Way
addressLine2: 'Suite #200'
city: Murray
state: UT
country: US
postalCode: '84123'
phoneNumber:
countryCode: '1'
phoneNo: '8042221111'
retailSalesAnalyticsMetrics:
- locationId: a1b2c3d4-0000-1234-abcd-000000000001
merchantCategoryCode: 478
naicsCode: 454113
industryName: Arts and Craft Stores
firstSeenTxnDate: '2008-08-14'
lastSeenTxnDate: '2023-02-18'
metricsFrequency: Weekly
metricsLists:
- periodStartDate: '2022-01-09'
periodEndDate: '2022-01-15'
year: 2022
metrics:
- name: txn_amt
value: 16198.060138
- name: txn_cnt
value: 238
- periodStartDate: '2022-02-13'
periodEndDate: '2022-02-19'
year: 2022
metrics:
- name: txn_amt
value: 19942.409207
- name: txn_cnt
value: 269
GenerateRetailSalesBenchmarksReportExample:
value:
id: y3pic4xhda-sbcabenchmarksnoncra
customerType: testing
customerId: 1001483250
createdDate: 1739824892
requestId: y3pic4xhda
requestorName: ABC Partner
partnerName: ABC partner
type: sbcabenchmarksnoncra
title: Mastercard Open Banking Small Business Credit Analytics
constraints:
analyticsReportData:
sbcaParams:
hasConsent: true
metricFrequency: monthly
metricType: retail_sales_benchmarks
locationId: a1b2c3d4-0000-1234-abcd-000000000001
businessDetails:
name: ABC Tires Inc
personallyLiable: true
address:
addressLine1: 434 W Ascension Way
addressLine2: 'Suite #200'
city: Murray
state: UT
country: USA
postalCode: '84123'
phoneNumber:
countryCode: '1'
phoneNo: '8042221111'
retailSalesBenchmarksMetrics:
- locationId: a1b2c3d4-0000-1234-abcd-000000000001
merchantCategoryCode: 478
naicsCode: 454113
industryName: Arts and Craft Stores
firstSeenTxnDate: '2008-08-14'
lastSeenTxnDate: '2023-02-18'
metricsFrequency: Monthly
metricsLists:
- periodStartDate: '2023-02-01'
periodEndDate: '2023-02-28'
year: 2023
metrics:
- name: txn_cnt_index
value: 118
- name: num_cards_index
value: 121
MissingSBCAMandatoryDataExample:
value:
code: '10020'
status: '400'
message: 'Data missing : MerchantName, streetAddress.'
user_message: >-
One or more of the fields are missing. Please ensure you have entered
the correct data.
MissingMandatoryDataSmallBusinessReportExample:
value:
code: '10020'
message:
'Data missing: analyticsReportData, analyticsReportData.sbcaParams,
analyticsReportData.businessDetails...'
InvalidDataSmallBusinessReportExample:
value:
code: '10025'
message: 'Invalid data: analyticsReportData.sbcaParams.hasConsent'
InvalidLocationIdSmallBusinessReportExample:
value:
code: '10003'
message:
'Missing or invalid request parameter(s) - locationId must be a valid
UUID'
InvalidBusinessIdSmallBusinessReportExample:
value:
code: '10003'
message: 'Missing or invalid request parameter(s) - businessId'
InvalidCountryCodeSmallBusinessReportExample:
value:
code: '10000'
message: 'Invalid country code provided.'
InvalidPhoneCodeSmallBusinessReportExample:
value:
code: '10000'
message: 'Invalid phone number provided.'
InvalidSBCADataExample:
value:
code: '10025'
status: '400'
message: 'Invalid data: IdType, IdValue.'
user_message: The data provided in one or more fields is invalid.
InvalidSBCADataCombinationExample:
value:
code: '10030'
status: '400'
message: 'Invalid data combination.'
user_message: >-
Both Idtype/Idvalue and Company name/Address data combinations are
present in the input.
MetricsNotFoundExample:
value:
code: '10100'
message: 'No potential merchant metrics found.'
parameters:
IdTypeParameter:
name: idType
in: query
description: The identifier type for finding the merchant.
required: false
schema:
$ref: '#/components/schemas/IdType'
example: MERCHANT_ID
IdValueParameter:
name: idValue
in: query
description: The identifier value pertaining to the identifier type.
required: false
schema:
$ref: '#/components/schemas/IdValue'
example: 106241230D01
MerchantNameParameter:
name: merchantName
in: query
description: The name of the merchant.
required: false
schema:
$ref: '#/components/schemas/MerchantName'
example: Artisan Emporium
StreetAddressParameter:
name: streetAddress
in: query
description: The full street address of the merchant.
required: false
schema:
$ref: '#/components/schemas/StreetAddress'
example: 123 Main St
CityParameter:
name: city
in: query
description: >-
The city name in the merchant's address. This is limited to alphanumeric
characters, spaces, single quotes, and commas.
required: false
schema:
$ref: '#/components/schemas/City'
example: Murray
StateProvinceRegionParameter:
name: stateProvinceRegion
in: query
description:
The state, province, department or region abbreviation in the merchant's
address will vary based on the country code.
required: false
schema:
$ref: '#/components/schemas/State'
example: UT
PostalCodeParameter:
name: postalCode
in: query
description:
The postal code in the merchant's address. Expected format will be
determined based on the country_code.
required: false
schema:
$ref: '#/components/schemas/PostalCode'
example: '84123'
AssetIdParameter:
description: The asset ID
name: assetId
in: path
required: true
schema:
$ref: '#/components/schemas/AssetId'
example: 097545c5-1c2a-4f20-a5ef-77f0820344c9-2018601178
BusinessIdParameter:
description: Unique identifier of the business
name: business_id
in: path
required: true
schema:
$ref: '#/components/schemas/BusinessId'
example: '192323'
PersonalUserTypeParameter:
description: >-
UserType indicates if the request is for a personal use case, Allowed
values: personal.
name: userType
in: path
required: true
schema:
$ref: '#/components/schemas/UserType'
example: personal
CustomerIdParameter:
description: A customer ID
name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/CustomerId'
example: '1005061234'
CustomerIdPathParameter:
description: Unique identifier of the customer
name: customer_id
in: path
required: true
schema:
$ref: '#/components/schemas/CustomerId'
example: '1005061234'
ExternalIdPathParameter:
description: Unique identifier of the external ID
name: external_id
in: path
required: true
schema:
$ref: '#/components/schemas/ExternalId'
example: '123456789'
AccountStatusParameter:
description: A filter to fetch account in the given status
name: status
in: query
required: false
schema:
$ref: '#/components/schemas/AccountStatus'
example: pending
WithInsightsParameter:
description: >-
If this parameter is true, Identity Insights data will be returned along
with the account owner information
name: withInsights
in: query
required: false
schema:
$ref: '#/components/schemas/WithInsights'
example: false
InsightsParameter:
description: >-
If this parameter is true, Identity Insights data will be returned along
with the account owner information
name: insights
in: query
required: false
schema:
$ref: '#/components/schemas/Insights'
example: false
MetaDataParameter:
name: Meta-Data
in: header
required: false
schema:
$ref: '#/components/schemas/MetaData'
description:
OBAO is a program that is being offered to Mastercard issuers where when
the new account is issued a Mastercard Debit or Prepaid account. OBAO
offered partners will not be charged for ACH, AOV, and Balance API.
example: program=OBAO
TransactionIdParameter:
description: A transaction ID
name: transactionId
in: path
required: true
schema:
$ref: '#/components/schemas/TransactionId'
example: 21284820852
IncludePendingParameter:
description: If pending transactions must be included
name: includePending
in: query
required: false
schema:
$ref: '#/components/schemas/IncludePending'
example: false
ShowDailyBalanceParameter:
description:
Request daily beginning and ending account balances for each day
transactions are recorded (query parameter)
name: showDailyBalance
in: query
required: false
schema:
$ref: '#/components/schemas/ShowDailyBalance'
example: false
AppIdPathParameter:
name: application_id
in: path
description:
The identifier is generated after the pre-app is approved. Pre-app is
the first stage of application registration. Partner first submits an
application registration request, then a Pre-app Id is generated for it,
and if all the details are correct, the sales team will approve it, and
then an application will be registered with the Application Id and
associated with the Pre-app. This Application Id is utilized throughout
the lifespan of an application.
required: true
schema:
type: string
example: 234dsfdsf-535fdgdtrtr-546464564
PreAppIdParameter:
name: pre_app_id
in: query
description:
The identifier is provided by Mastercard at the first stage of
application registration.
required: false
schema:
type: integer
example: 13
ApplicationLimitParameter:
name: limit
in: query
required: false
description: Maximum number of results per page
schema:
type: integer
format: int32
default: 50
minimum: 1
maximum: 100
example: 20
InstitutionLimitParameter:
name: limit
in: query
required: false
description: Maximum number of results per page
schema:
type: integer
format: int32
default: 25
minimum: 1
maximum: 1000
example: 25
ApplicationIdParameter:
name: application_id
in: query
description:
The identifier is generated after the pre-app is approved. Pre-app is
the first stage of application registration. Partner first submits an
application registration request, then a Pre-app Id is generated for it,
and if all the details are correct, the sales team will approve it, and
then an application will be registered with the Application Id and
associated with the Pre-app. This Application Id is utilized throughout
the lifespan of an application.
required: false
schema:
type: string
example: 00278431-b712-4f30-a044-b611f25e533d
AppNameParameter:
name: name
in: query
description: The application name provided by the partner.
required: false
schema:
type: string
example: Mvelopes
AppStatusParameter:
name: status
in: query
description:
The application registration status with Mastercard. ('A'=Approved,
'P'=Pending, 'D'=Deleted, 'R'=Rejected, 'S'=Skipped)
required: false
schema:
type: string
example: P
InstitutionIdPathParameter:
name: institution_id
in: path
description: The financial institution id at Mastercard.
required: true
schema:
type: integer
example: 170716
InstitutionIdQueryParameter:
name: institution_id
in: query
description: The financial institution id at Mastercard.
required: false
schema:
type: integer
example: 170716
ApplicationIdPathParameter:
description: The application ID
name: applicationId
in: path
required: true
schema:
$ref: '#/components/schemas/ApplicationId'
example: '00278431-b712-4f30-a044-b611f25e533d'
ApplicationIdQueryParameter:
description: The application ID
name: applicationId
in: query
required: false
schema:
$ref: '#/components/schemas/ApplicationId'
example: '00278431-b712-4f30-a044-b611f25e533d'
AppRegistrationStatusParameter:
description: Look up app registration requests by status
name: status
in: query
required: false
schema:
$ref: '#/components/schemas/AppRegistrationStatus'
example: P
ApplicationNameParameter:
description: Look up app registration requests by app name
name: appName
in: query
required: false
schema:
$ref: '#/components/schemas/ApplicationName'
example: Awesome Budget App
SubmittedDateParameter:
description:
Look up app registration requests by the date they were submitted
name: submittedDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1607450357
ModifiedDateParameter:
description:
Look up app registration requests by the date the request was updated.
This can be used to determine when a request was updated to "A" or "R".
name: modifiedDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1607450357
PreAppIdQueryParameter:
description: The application registration tracking ID
name: preAppId
in: query
required: false
schema:
$ref: '#/components/schemas/PreAppId'
example: '2581'
PreAppIdPathParameter:
description: The application registration tracking ID
name: preAppId
in: path
required: true
schema:
$ref: '#/components/schemas/PreAppId'
example: '2581'
CustomerSearchParameter:
name: search
in: query
required: false
description: >-
The text you wish to match. Leave this empty if you wish to return all
customers. Must be URL-encoded (see: [Handling Spaces in
Queries](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/)).
schema:
type: string
example: 'Search Value'
CustomerUsernameParameter:
name: username
in: query
required: false
description: Username for exact match (will return 0 or 1 record)
schema:
$ref: '#/components/schemas/CustomerUsername'
example: customerusername1
CustomerTypeParameter:
name: type
in: query
required: false
description: >-
"testing" or "active" to return only customers of that type, or leave
empty to return all customers
schema:
$ref: '#/components/schemas/CustomerType'
example: 'active'
AccountIdParameter:
description: The account ID
name: accountId
in: path
required: true
schema:
$ref: '#/components/schemas/AccountId'
example: '5011648377'
StatementIndexParameter:
name: index
in: query
required: false
description:
Request statements from 1-24. By default, 1 is the most recent
statement. Increase the index value to count back (by month) and
retrieve its most recent statement.
schema:
type: integer
format: int32
default: 1
example: 1
maximum: 24
SubscriptionIdParameter:
description: The subscription ID
name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/SubscriptionId'
example: 17554874
InstitutionLoginIdParameter:
description: The institution login ID
name: institutionLoginId
in: path
required: true
schema:
$ref: '#/components/schemas/InstitutionLoginId'
example: '1007302745'
InstitutionLoginIdParameterPEB:
description: The institution login ID
name: institutionLoginId
in: path
required: true
schema:
$ref: '#/components/schemas/NumericInstitutionLoginId'
example: 1007302745
InstitutionIdParameter:
description: The institution ID
name: institutionId
in: path
required: true
schema:
$ref: '#/components/schemas/NumericInstitutionId'
example: 4222
RoutingNumberParameter:
name: routing_number
in: path
required: true
example: 847392234
schema:
$ref: '#/components/schemas/RoutingNumberInteger'
description: Institution routing number
RequiredPurposeParameter:
name: purpose
in: query
required: true
description: >-
2-digit code from [Permissible Purpose
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/lend/report-handling/permissible-purpose-codes/),
specifying the reason for retrieving this report. Required for
retrieving some reports.
schema:
type: string
example: '3F'
PayPurposeCodeParameter:
description: >-
The 2-digit code (1P) assigned to indicate the intended purpose. 1P
represents the following permissible purpose: โDetermine whether a
consumers payment method may be accepted or authorizedโ, which falls
under the โLegitimate Business Needโ permissible purpose under section
604 of the FCRA.
name: purposeCode
in: query
required: true
schema:
$ref: '#/components/schemas/PayPurposeCode'
PayRequestIdParameter:
name: payRequestId
in: path
required: true
description: Unique identifier of the Payments request
schema:
$ref: '#/components/schemas/PayRequestId'
example: '476412776235977427'
IncludeReasonsParameter:
name: include_reasons
in: query
required: false
description:
If this parameter is true, the reasons codes will be provided in the
results. Otherwise, the reasons will be omitted.
schema:
type: boolean
example: true
allowEmptyValue: true
PurposeParameter:
name: purpose
in: query
required: false
description: >-
2-digit code from [Permissible Purpose
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/lend/report-handling/permissible-purpose-codes/),
specifying the reason for retrieving this report. Required for
retrieving some reports.
schema:
$ref: '#/components/schemas/PurposeCode'
example: '3F'
ReportIdParameter:
name: reportId
in: path
description: ID of the report
required: true
schema:
$ref: '#/components/schemas/ReportId'
example: u4hstnnak45g
OnBehalfOfParameter:
name: onBehalfOf
in: query
description:
The name of the entity you are retrieving the report on behalf of
required: false
schema:
type: string
example: 'Some entity'
ConsumerIdParameter:
description: The consumer ID
name: consumerId
in: path
required: true
schema:
$ref: '#/components/schemas/ConsumerId'
example: '0bf46322c167b562e6cbed9d40e19a4c'
StatementIndexesParameter:
name: index
in: query
required: false
description:
Request details of statements with comma-separated indexes between 1-24.
The default value is 1 which will return details of the most recent
statement. Increasing the index will return details of older statements,
for example, setting the index value to 6 will return data on the sixth
most recent statement.
schema:
type: string
default: '1'
example: '1,2,3,4,5,6'
PartnerIdParameter:
name: partnerId
in: path
description: ID of the report partner
required: true
schema:
type: string
example: 12314235356
PortfolioIdParameter:
description:
A portfolio ID with the portfolio version number. Using the portfolio
number without a version number will return the most recently generated
reports.
name: portfolioId
in: path
required: true
schema:
$ref: '#/components/schemas/PortfolioId'
example: y4zsgccj4xpw-6-port
StartParameter:
name: start
in: query
required: false
description: Index of the page of results to return
schema:
type: integer
format: int32
default: 1
example: 1
LimitParameter:
name: limit
in: query
required: false
description: Maximum number of results per page
schema:
type: integer
format: int32
default: 25
maximum: 1000
example: 1
SortParameter:
name: sort
in: query
required: false
description: 'Date sort order: "asc" for ascending, "desc" for descending'
schema:
type: string
default: 'desc'
example: 'desc'
ResultPageParameter:
name: page
in: query
required: false
description: Index of the page of results to return
schema:
type: integer
format: int32
default: 1
example: 1
ResultPageSizeParameter:
name: pageSize
in: query
required: false
description: Maximum number of results per page
schema:
type: integer
format: int32
default: 1
example: 20
SettlementAmountParameter:
description: The transaction amount in USD $.
name: settlementAmount
in: query
required: true
schema:
$ref: '#/components/schemas/SettlementAmount'
example: 10.05
SettleByDateParameter:
description: |-
The expected date that the funds, from the consumerโs account, will be moved to the receiving account.
`settleByDate` in ISO 8601 date format (YYYY-MM-DD).
`settleByDate` dictates the number of days the model responds with. The response can range from 3-10 days, including `day0`. Details explained below:
1. If `settleByDate` is 9 or more days out from today, the response includes 10 days of data, `day0` through `day9`.
2. If `settleByDate` is between 3 and 8 days out from today, the response includes 4-9 days of data, `day3-8`.
3. If `settleByDate` is between today and 2 days out from today, the response includes 3 days of data, `day0` through `day2`.
name: settleByDate
in: query
required: true
schema:
$ref: '#/components/schemas/SettleByDate'
example: '2023-03-30'
ProductTypesParameter:
name: type
in: query
description: The certified product type(s) to filter by. For example, if
โtype=voaโ, only institutions with the certified product type โvoaโ will
be returned (i.e. where โvoa=trueโ for that institution). Multiple types
may be specified. For example, โtype=voa,voi,achโ will only return
institutions certified for โvoaโ, โvoiโ, and โachโ.
Product types include "transAgg", "ach", "stateAgg", "voi", "voa",
"aha", "availBalance", and "accountOwner".
required: false
schema:
type: string
example: voa,voi
ProductTypeParameter:
name: type
in: query
description: The certified product type to filter by. For example, if
โtype=voaโ, only institutions with the certified product type โvoaโ will
be returned (i.e. where โvoa=trueโ for that institution).
Product types include "transAgg", "ach", "stateAgg", "voi", "voa",
"aha", "availBalance", and "accountOwner".
required: false
schema:
type: string
example: voa
SupportedCountriesParameter:
name: supportedCountries
in: query
description:
A two-letter country code, or a list of comma separated two-letter
country codes. This query parameter is used to ensure that all
institution search results are supported in the county specified. The
default is โ*โ for all countries.
required: false
schema:
type: string
pattern: ^(\*|[a-zA-Z]{2}(,[a-zA-Z]{2})*)$
example: us
style: form
explode: false
InstitutionSearchParameter:
name: search
in: query
description:
The institution name to search by. Fuzzy searching is used, therefore
the search term does not need to exactly match the institutionโs name
for it to be returned in the results.
required: false
schema:
type: string
example: finbank
RequiredFromDateParameter:
description: A start date
name: fromDate
in: query
required: true
schema:
$ref: '#/components/schemas/UnixDate'
example: 1607450357
RequiredToDateParameter:
description: A end date
name: toDate
in: query
required: true
schema:
$ref: '#/components/schemas/UnixDate'
example: 1670504017
ToDateParameterForRefreshAccounts:
description:
Transactions up to and including this date will be included. It should
be later than the fromDate.
name: toDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1670504017
FromDateParameterForRefreshAccounts:
description: Transactions starting from this date will be included.
name: fromDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1607450357
RequiredTransactionReportFromDateParameter:
description:
Transactions starting from this date will be included in the report.
name: fromDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1607450357
RequiredTransactionReportToDateParameter:
description:
Transactions up to and including this date will be incorporated into the
report. It should be later than the fromDate.
name: toDate
in: query
required: false
schema:
$ref: '#/components/schemas/UnixDate'
example: 1670504017
ReportCallbackUrlParameter:
name: callbackUrl
in: query
required: false
description:
A Report Listener URL to receive notifications. The webhook must respond
to the Finicity API with a 2xx HTTP status code.
schema:
type: string
example: 'https://finicity-test/webhook'
UserTypeParameter:
description: >-
UserType indicates if the request is for a business or personal use
case, Allowed values: business/personal.
name: userType
in: path
required: true
schema:
$ref: '#/components/schemas/UserType'
example: personal
ConsentReceiptIdParameter:
description: Third party access key receipt ID
name: consentReceiptId
in: path
required: true
schema:
$ref: '#/components/schemas/ConsentReceiptId'
example: cr_4pfI3r1X8aOHrDDwrwC01NHFxOXlT1
AccountTypeParameter:
description: >-
A filter to fetch accounts for the given type. Currently supported
types: "ava"
name: account_type
in: query
required: false
schema:
type: string
example: ava
ReferenceNumberParameter:
name: reference-number
in: query
required: false
description: Partner-provided reference number to correlate reports.
schema:
type: string
example: abc123
ProductCodeParam:
name: productCode
description:
Filter the results by product code (a unique billing code assigned to
each Open Finance product used). Specify either one single product or
multiple products separated by commas.
in: query
required: false
style: form
explode: false
example:
- ABC
schema:
type: array
items:
type: string
minLength: 1
maxLength: 10
AppNameParam:
name: appName
description:
Unique name of the application provided to Mastercard during app
registration.
in: query
required: true
schema:
type: string
example: test app
AllowedBalanceCacheIntervalParameter:
description: |-
`balance_cache_interval` (in minutes) is used to decide whether to return existing cached balance or retrieve from financial institution in real-time. Details explained below:
1. If the cached balance data at server is older than provided `balance_cache_interval` then live balance from financial institution will be retrieved.
2. If the cached balance data is within provided `balance_cache_interval` allowed interval then balance from cache will be returned.
3. If `balance_cache_interval` is 0 or not provided, then live balance from financial institution will be retrieved.
name: balance_cache_interval
in: query
required: false
schema:
$ref: '#/components/schemas/AllowedBalanceCacheInterval'
example: 1
InstitutionLoginIdPathParam:
name: institution_login_id
description: Institution login id of the customer.
in: path
required: true
schema:
type: integer
format: int64
example: 7008461438
SwitchIdPathParameter:
name: switch_id
description: Deposit Switch ID
in: path
required: true
schema:
type: string
example: 65cb40beec86d3bd0e8664cc
RequestIdHeader:
in: header
name: X-External-Request-Id
required: false
description: A unique identifier for the request.
schema:
type: string
example: 'f6250b41-8632-4fe1-9353-899f419ae67b'
SubscriptionIdPathParameter:
name: subscription_id
in: path
description: A unique UUID identifier of a webhook subscription.
required: true
schema:
type: string
example: '661f3c48-f596-423b-81f5-d275d4dd1345'
WebhookEventIdPathParameter:
name: webhook_event_id
in: path
description: A unique UUID identifier of a webhook event.
required: true
schema:
type: string
example: '661f3c48-f596-423b-81f5-d275d4dd1346'
ObwmsOffsetParameter:
name: offset
in: query
required: false
description: Index of the page of results to return.
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 1
ObwmsLimitParameter:
name: limit
in: query
required: false
description: Maximum number of results per page.
schema:
type: integer
format: int32
default: 10
minimum: 1
maximum: 100
example: 20
ConfigurationIdPathParameter:
name: configuration_id
in: path
required: true
schema:
type: string
format: uuid
example: 9082affa-d965-40be-a3ed-a320bb3467ff
minLength: 36
maxLength: 36
description: The unique identifier for a configuration object
IncludeParameter:
name: include
in: query
description: >-
If you do not require all API fields ( `balanceDetails`,
`accountIdentity` and `paymentInstruction`) then mention specific API
fields you are interested in.
For example, If you are interested in only `balanceDetails` and
`paymentInstruction`, then send query string as
include=`balanceDetails`,`paymentInstruction`
required: false
schema:
$ref: '#/components/schemas/Fields'
example: 'balanceDetails, paymentInstruction, accountIdentity'
PebAllowedBalanceCacheIntervalParameter:
description: |-
`balance_cache_interval` (in minutes) is used at server side to decide whether to return existing cached balance or retrieve from financial institution in real-time. Details explained below:
1. If the cached balance data at server is older than provided `balance_cache_interval` then live balance from financial institution will be retrieved.
2. If the cached balance data is within provided `balance_cache_interval` allowed interval then balance from cache will be returned.
3. If `balance_cache_interval` is not provided, then by default pre defined cache interval will be used to decide whether to return existing cached balance or retrieve from financial institution in real-time.
name: balance_cache_interval
in: query
required: false
schema:
$ref: '#/components/schemas/PebAllowedBalanceCacheInterval'
example: 1
schemas:
LocationMatches:
description: SBCA location match response data
type: object
properties:
locationMatches:
type: array
description: List of location details
items:
$ref: '#/components/schemas/LocationDetail'
LocationDetail:
description: A Location detail
type: object
properties:
locationId:
$ref: '#/components/schemas/LocationId'
matchRank:
$ref: '#/components/schemas/MatchRank'
merchantName:
$ref: '#/components/schemas/MerchantName'
streetAddress:
$ref: '#/components/schemas/StreetAddress'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
postalCode:
$ref: '#/components/schemas/ZipCode'
countryCode:
$ref: '#/components/schemas/Country'
IdType:
type: string
description: The identifier type for finding the merchant.
maxLength: 100
example: MERCHANT_ID
IdValue:
type: string
description: The identifier value pertaining to the identifier type.
maxLength: 100
example: 106241230D01
MatchRank:
type: integer
description: The rank of the match compared to other potential matches.
format: int32
example: 1
MerchantName:
type: string
description: Name of merchant.
maxLength: 250
example: Artisan Emporium
StreetAddress:
type: string
description: The full street address of the merchant.
maxLength: 250
example: 2000 Purchase St
PostalCode:
type: string
description: The postal code in the merchant's address.
example: 10577
RecurringTransactionsDetails:
description: Recurring transactions details
type: object
properties:
customerRecurringTransactions:
$ref: '#/components/schemas/CustomerRecurringTransactions'
accountRecurringTransactions:
type: array
items:
$ref: '#/components/schemas/AccountRecurringTransactions'
CustomerRecurringTransactions:
description: Recurring transactions for customer
type: object
properties:
recurringOutflows:
type: array
items:
$ref: '#/components/schemas/RecurringOutFlowTransaction'
recurringInflows:
type: array
items:
$ref: '#/components/schemas/RecurringInFlowTransaction'
RecurringOutFlowTransaction:
type: object
description: Debit recurring transaction stream.
properties:
normalizedPayeeName:
type: string
description: >-
A normalized payee, derived from the transaction's description and
memo fields
example: Netflix
transactionCategories:
type: array
items:
$ref: '#/components/schemas/Categories'
transactionIds:
type: array
items:
type: string
example: 21284820852
description:
List of transaction IDs associated with this debit stream
cadence:
type: integer
description: Mean number of days between transactions
example: 30
status:
type: string
description:
Indicates if the debit stream is currently active or inactive.
example: ACTIVE
expectedNextTransactionDate:
type: string
format: date
description: The estimated date of the next debit transaction
example: 2025-08-07
expectedNextTransactionAmount:
type: number
description: The estimated amount of the next debit transaction
example: -15.99
minimumHistoricalAmount:
type: number
description:
Minimum historical amount for this recurring debit transaction
example: -20.99
maximumHistoricalAmount:
type: number
description:
Maximum historical amount for this recurring debit transaction
example: -8.99
meanHistoricalAmount:
type: number
description:
Average historical amount for this recurring debit transaction
example: -15.99
medianHistoricalAmount:
type: number
description:
Median historical amount for this recurring debit transaction
example: -15.99
countOfTransactions:
type: integer
description:
Number of debit transactions identified within this stream
example: 1
AccountIds:
description: A list of account IDs
type: object
properties:
accountIds:
type: array
items:
$ref: '#/components/schemas/AccountId'
description: List of account IDs
RecurringInFlowTransaction:
type: object
description: Credit recurring transaction stream.
properties:
normalizedPayeeName:
type: string
description: >-
A normalized payee, derived from the transaction's description and
memo fields
example: Netflix
transactionCategories:
type: array
items:
$ref: '#/components/schemas/Categories'
transactionIds:
type: array
items:
type: string
example: 21284820851
description:
List of transaction IDs associated with this credit stream
cadence:
type: integer
description: Mean number of days between transactions
example: 30
status:
type: string
description:
Indicates if the credit stream is currently active or inactive.
example: ACTIVE
expectedNextTransactionDate:
type: string
format: date
description: The estimated date of the next credit transaction
example: 2025-08-07
expectedNextTransactionAmount:
type: number
description: The estimated amount of the next credit transaction
example: 1234.56
minimumHistoricalAmount:
type: number
description:
Minimum historical amount for this recurring credit transaction
example: 1055.22
maximumHistoricalAmount:
type: number
description:
Maximum historical amount for this recurring credit transaction
example: 1488.22
meanHistoricalAmount:
type: number
description:
Average historical amount for this recurring credit transaction
example: 1234.56
medianHistoricalAmount:
type: number
description:
Median historical amount for this recurring credit transaction
example: 1234.56
countOfTransactions:
type: integer
description:
Number of credit transactions identified within this stream
example: 1
AccountRecurringTransactions:
description: Recurring transactions for each account
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
recurringOutflows:
type: array
items:
$ref: '#/components/schemas/RecurringOutFlowTransaction'
recurringInflows:
type: array
items:
$ref: '#/components/schemas/RecurringInFlowTransaction'
GeoLocation:
type: array
items:
$ref: '#/components/schemas/GeoLocationItems'
description: Geolocation array of objects;
GeoLocationItems:
type: object
properties:
label:
type: string
description:
The name of the Geolocation details. Possible values are POSTAL_CODE
example: POSTAL_CODE
value:
type: string
description: The value of the Geolocation field
example: '85123'
AnalyticsType:
description: >-
Analytics type. Allowed Values are benchmarking and forecasting.
example: benchmarking
type: string
ForesightAnalyticsReportData:
description: Parameters supplied by the client requesting the analytics.
properties:
forCraPurpose:
type: boolean
description:
Field to indicate if the requested report is for CRA or NONCRA. For
small business lending or other similar business use cases, pass the
value as โtrueโ for purposes of this field.
example: true
segments:
type: object
description: >-
Requested segments for attribute values.
properties:
geolocation:
$ref: '#/components/schemas/GeoLocation'
analytics:
description: >-
Analytics information for the requested report. The allowed values
are benchmarking & forecasting. If it is null, default to
benchmarking and forecasting
example:
- benchmarking
- forecasting
minItems: 2
maxItems: 2
items:
$ref: '#/components/schemas/AnalyticsType'
type: array
timeIntervalTypes:
description: >-
Requested time interval for attribute values.
example:
- MONTHLY_CALENDAR
maxItems: 2
items:
$ref: '#/components/schemas/TimeIntervalType'
type: array
income:
$ref: '#/components/schemas/Income'
age:
$ref: '#/components/schemas/Age'
required:
- forCraPurpose
type: object
ForesightAnalyticsReportFirstThirdPartyConstraints:
allOf:
- $ref: '#/components/schemas/ForesightAnalyticsReportConstraints'
- type: object
properties:
customerId:
$ref: '#/components/schemas/NumericCustomerId'
externalCustomerId:
$ref: '#/components/schemas/ExternalCustomerId'
ForesightAnalyticsReportConstraints:
type: object
properties:
analyticsReportData:
$ref: '#/components/schemas/ForesightAnalyticsReportData'
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
fromDate:
$ref: '#/components/schemas/UnixDate'
GoldStandardErrorMessage:
required:
- Errors
type: object
properties:
Errors:
type: object
required:
- Error
properties:
Error:
description: Mastercard standard error message.
type: array
items:
type: object
properties:
Source:
type: string
description: The applications that generated the error.
ReasonCode:
type: string
description:
A unique constant identifying the error case encountered
during processing.
Description:
type: string
description: Short description of the ReasonCode field.
Recoverable:
type: boolean
description:
Indicates whether this error will always be returned for
this request, or retrying could change the outcome.
Details:
type: string
description:
Where appropriate, indicates detailed information about
data received and calculated during request processing, to
help the user with diagnosing errors.
ServiceAgreement:
description:
An object that contains the language the terms and conditions were
present in and the date the customer accepted the terms and conditions.
type: object
required:
- language
- acceptedDate
properties:
language:
description:
The language translation of the terms and conditions as presented to
the customer.
type: string
example: en
acceptedDate:
description:
The date the customer accepted the terms and conditions. Must be a
valid ISO-8601 date time.
type: string
format: date-time
example: '2024-11-28T18:25:32+00:00'
ConfigurationId:
description: Unique identifier of the configuration object
type: string
format: uuid
example: 605543e1-f507-48ad-8127-95c40566597b
minLength: 36
maxLength: 36
Configuration:
title: Configuration
type: object
description: Used to modify behavior during the login flow
properties:
id:
$ref: '#/components/schemas/ConfigurationId'
filterAccounts:
$ref: '#/components/schemas/FilterAccounts'
accountClassificationType:
$ref: '#/components/schemas/AccountClassificationType'
aoRequired:
$ref: '#/components/schemas/AoRequired'
EventStreamId:
type: string
format: uuid
description:
Unique reference to the event stream used to send events to the SDK
minLength: 36
maxLength: 36
example: 208a1170-875e-4656-85d0-27dfc3ee7137
FilterAccounts:
type: array
description: >-
An optional filter to apply during account activation with institutions
that support legacy login forms.
items:
type: string
example: Checking
minLength: 1
maxLength: 512
AccountClassificationType:
type: array
example:
- personal
- business
description: >-
An optional filter to apply during account activation with institutions
that support Oauth integration. Supported filters are: `personal`,
`business`, and `unknown`.
items:
type: string
example: personal
AoRequired:
type: boolean
description:
When set to true, the user must explicitly permission Account Owner
details at OAuth-supported institutions. If they do not, a [239] error
is returned, and the login attempt is blocked. Partners are responsible
for handling user re-attempt flows to ensure proper permissions are
granted
default: false
example: true
NameScore:
required:
- ownerName
description: List of account owner Identity Insights
type: object
properties:
ownerName:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input "name"
sub-attributes (firstName, middleName, lastName, suffix) along with
the account owner details fetch ownerName'
example: 0
firstName:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
middleName:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
lastName:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
suffix:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
AccountOwnerVerificationMatchingDetails:
required:
- ownerName
- nameClassification
- nameClassificationConfidenceScore
- nameScores
type: object
properties:
relationship:
$ref: '#/components/schemas/AccountOwnerRelationshipType'
ownerName:
$ref: '#/components/schemas/AccountOwnerName'
firstName:
$ref: '#/components/schemas/FirstName'
middleName:
$ref: '#/components/schemas/MiddleName'
lastName:
$ref: '#/components/schemas/LastName'
suffix:
$ref: '#/components/schemas/Suffix'
nameScores:
$ref: '#/components/schemas/NameScore'
nameClassification:
$ref: '#/components/schemas/NameClassificationType'
nameClassificationconfidencescore:
$ref: '#/components/schemas/ClassificationConfidenceScore'
addresses:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingAddresses'
emails:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingEmails'
phones:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingPhones'
documentations:
$ref: '#/components/schemas/AccountOwnerDocumentations'
identityInsights:
$ref: '#/components/schemas/AccountOwnerIdentityInsights'
description: Owner of a customer account
AccountOwnerVerificationMatchResults:
type: object
properties:
holders:
type: array
items:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingDetails'
encryptedValue:
type: string
example: 'eyJraWQiOiI3NjFiMDAzYzFlYWRlM(...)==.Y+oPYKZEMTKyYcSIVEgtQw=='
description: Encrypted response.
SingleLineAddress:
type: string
description: A street address
example: '434 W Ascension Way Suite #200 Murray UT 84123'
AccountOwnerVerificationMatchingAddresses:
description: List of addresses
type: array
items:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingAddress'
AccountOwnerVerificationMatchingAddress:
type: object
properties:
ownerAddress:
$ref: '#/components/schemas/SingleLineAddress'
line1:
$ref: '#/components/schemas/AddressLine1'
line2:
$ref: '#/components/schemas/AddressLine2'
line3:
$ref: '#/components/schemas/AddressLine3'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/CountryCode'
postalCode:
$ref: '#/components/schemas/ZipCode'
type:
type: string
description: 'The type of address (e.g. Home or Business).'
minLength: 1
maxLength: 50
example: 'Home'
addressScores:
$ref: '#/components/schemas/AddressScore'
AccountOwnerVerificationMatchingRequestName:
type: object
required:
- firstName
- lastName
properties:
firstName:
$ref: '#/components/schemas/FirstName'
middleName:
$ref: '#/components/schemas/MiddleName'
lastName:
$ref: '#/components/schemas/LastName'
suffix:
$ref: '#/components/schemas/Suffix'
AccountOwnerVerificationMatchingRequestAddress:
type: object
properties:
line1:
$ref: '#/components/schemas/AddressLine1'
line2:
$ref: '#/components/schemas/AddressLine2'
line3:
$ref: '#/components/schemas/AddressLine3'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/CountryCode'
postalCode:
$ref: '#/components/schemas/ZipCode'
type:
type: string
description: 'The type of address (e.g. Home or Business).'
minLength: 1
maxLength: 50
example: 'Home'
AccountOwnerVerificationMatchingRequest:
type: object
required:
- name
properties:
ownerName:
$ref: '#/components/schemas/AccountOwnerName'
name:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingRequestName'
address:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingRequestAddress'
phone:
type: string
description: 'A valid phone number. It may only include digits.'
maxLength: 10
pattern: '^\d+$'
example: '8005551234'
email:
$ref: '#/components/schemas/EmailAddress'
BusinessList:
type: array
minItems: 1
maxItems: 1
items:
$ref: '#/components/schemas/Business'
BusinessId:
type: string
description: Unique identifier of the business
minLength: 1
maxLength: 50
example: '1112'
Business:
allOf:
- $ref: '#/components/schemas/NewBusiness'
- type: object
properties:
businessId:
$ref: '#/components/schemas/BusinessId'
createdDate:
$ref: '#/components/schemas/NoZoneDateTime'
modifiedDate:
$ref: '#/components/schemas/NoZoneDateTime'
PhoneNumberFormat:
type: object
properties:
countryCode:
$ref: '#/components/schemas/CountryCodeNumber'
phoneNo:
$ref: '#/components/schemas/NewPhoneNumber'
NewPhoneNumber:
type: string
description: >-
A phone number ([E.164](https://en.wikipedia.org/wiki/E.164) format)
minLength: 7
maxLength: 12
example: '8042221111'
Lender:
type: object
properties:
purpose:
$ref: '#/components/schemas/PurposeCode'
NewBusiness:
type: object
required:
- name
- personallyLiable
- address
- phoneNumber
properties:
name:
type: string
description: The legal name of the business
minLength: 1
maxLength: 150
example: ABC Tires Inc
personallyLiable:
type: boolean
description: >-
Indicates whether a business owner is personally liable for a loan
example: true
address:
$ref: '#/components/schemas/NewAddress'
phoneNumber:
$ref: '#/components/schemas/PhoneNumberFormat'
url:
description: A URL for the business website
format: uri
maxLength: 2000
minLength: 0
type: string
example: 'https://www.finicity.com/'
email:
$ref: '#/components/schemas/EmailAddress'
type:
description: >-
The business type eg LLC, Corp, S Corp, C Corp, B Corp, Sole
Proprietorship, Nonprofit, etc.
maxLength: 150
minLength: 0
type: string
example: Nonprofit
taxId:
description: >-
Provide details of the tax id for the business
maxLength: 15
minLength: 9
type: string
example: 'A1234561Z'
ACHDetails:
required:
- routingNumber
- realAccountNumber
type: object
properties:
routingNumber:
type: string
description: >-
The routing number of the financial institution for specific
customer account
example: '123456789'
realAccountNumber:
type: string
description:
The account number for initiating ACH transfers for this account
example: '002345678901'
description:
The routing and account number information to initiate ACH transfers
AccountAnalytics:
description: Analytics calculated for one account in the report.
type: object
required:
- transactionalAttributes
- stateAttributes
- streams
properties:
transactionalAttributes:
description: List of calculated transactional attributes
items:
$ref: '#/components/schemas/TransactionalAttribute'
type: array
stateAttributes:
description: List of calculated state attributes
items:
$ref: '#/components/schemas/StateAttribute'
type: array
streams:
description: List of generated streams
items:
$ref: '#/components/schemas/StreamModel'
type: array
AccessToken:
required:
- token
type: object
description: >-
A temporary access token to be passed in the `Finicity-App-Token` HTTP
header of all subsequent API requests
properties:
token:
description: The access token value
type: string
example: YBh22Sb9Es6e66Q7lWdt
AccountDetails:
type: object
properties:
interestMarginBalance:
type: number
description: >-
Only available for investment accounts. Net interest earned after
deducting interest paid out.
example: -50000
availableCashBalance:
type: number
description: >-
Only available for investment accounts. Amount available for cash
withdrawal.
example: 1500
vestedBalance:
type: number
description:
Only available for investment accounts. Vested amount in account.
example: 300000
currentLoanBalance:
type: number
description:
Only available for investment accounts. Current loan balance.
example: 0
availableBalanceAmount:
type: number
description: The available balance for the account
example: 1000
AccountDetailsTxBased:
type: object
allOf:
- $ref: '#/components/schemas/AccountDetails'
- type: object
properties:
marginBalance:
type: number
description: Net interest earned after deducting interest paid out
example: 100.00
currentBalance:
type: number
description: Current balance
example: 1000.00
AccountId:
type: string
description: An account ID
example: '5011648377'
AccountNumberDisplay:
type: string
description: |-
Account identifier derived by Mastercard from the account number provided by the financial institution. The format varies depending on the institution. We recommend using this to identify accounts if available.
Below is a non-exhaustive list of examples for the `accountNumberDisplay` field.
* 5720
* 3539-259
* 1500-1
* 0824-S0050
example: '7528'
AccountNumberLast4:
type: string
description:
The last 4 digits of the account number, derived by Mastercard from the
account number provided by the financial institution. This is only
returned for ACH-enabled accounts.
example: '5678'
AccountOwner:
required:
- ownerName
- ownerAddress
type: object
properties:
ownerName:
type: string
description: >-
The name of the account owner. Can be multiple account owners in one
string. This is how the source data is returned from the
institution.
example: John Smith
ownerAddress:
$ref: '#/components/schemas/Address'
asOfDate:
$ref: '#/components/schemas/UnixDate'
description: Owner of a customer account
AddressScore:
properties:
ownerAddress:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input "address"
sub-attributes (line1,line2, line3, city, state, country,
postalCode) with the account owner details fetch ownerAddress'
example: 0
type:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
line1:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 34
line2:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
line3:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
city:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
country:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
postalCode:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
state:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
AccountOwnerVerificationAddress:
description: Account owner address
type: object
properties:
ownerAddress:
$ref: '#/components/schemas/Address'
type:
$ref: '#/components/schemas/AddressType'
line1:
$ref: '#/components/schemas/AddressLine1'
line2:
$ref: '#/components/schemas/AddressLine2'
line3:
$ref: '#/components/schemas/AddressLine3'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
postalCode:
$ref: '#/components/schemas/ZipCode'
country:
$ref: '#/components/schemas/Country'
addressScores:
$ref: '#/components/schemas/AddressScore'
AccountOwnerAddress:
description: Account owner address
type: object
properties:
ownerAddress:
$ref: '#/components/schemas/Address'
type:
$ref: '#/components/schemas/AddressType'
line1:
$ref: '#/components/schemas/AddressLine1'
line2:
$ref: '#/components/schemas/AddressLine2'
line3:
$ref: '#/components/schemas/AddressLine3'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
postalCode:
$ref: '#/components/schemas/ZipCode'
country:
$ref: '#/components/schemas/Country'
AccountOwnerAddresses:
description: List of addresses
type: array
items:
$ref: '#/components/schemas/AccountOwnerAddress'
AccountOwnerDetails:
required:
- ownerName
- nameClassification
- nameClassificationConfidenceScore
type: object
properties:
relationship:
$ref: '#/components/schemas/AccountOwnerRelationshipType'
ownerName:
$ref: '#/components/schemas/AccountOwnerName'
firstName:
$ref: '#/components/schemas/FirstName'
middleName:
$ref: '#/components/schemas/MiddleName'
lastName:
$ref: '#/components/schemas/LastName'
suffix:
$ref: '#/components/schemas/Suffix'
nameClassification:
$ref: '#/components/schemas/NameClassificationType'
nameClassificationconfidencescore:
$ref: '#/components/schemas/ClassificationConfidenceScore'
addresses:
$ref: '#/components/schemas/AccountOwnerAddresses'
emails:
$ref: '#/components/schemas/AccountOwnerEmails'
phones:
$ref: '#/components/schemas/AccountOwnerPhones'
documentations:
$ref: '#/components/schemas/AccountOwnerDocumentations'
identityInsights:
$ref: '#/components/schemas/AccountOwnerIdentityInsights'
description: Owner of a customer account
AccountOwnerDocumentation:
description: Account owner documentation
type: object
properties:
taxId:
$ref: '#/components/schemas/TaxId'
taxIdCountry:
$ref: '#/components/schemas/Country'
governmentId:
$ref: '#/components/schemas/GovernmentId'
AccountOwnerDocumentations:
description: List of account owner documentation
type: array
items:
$ref: '#/components/schemas/AccountOwnerDocumentation'
EmailScores:
properties:
email:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 100
AccountOwnerVerificationMatchingEmails:
description: List of emails
type: array
items:
$ref: '#/components/schemas/AccountOwnerVerificationMatchingEmail'
AccountOwnerVerificationMatchingEmail:
description: Account owner email
type: object
properties:
isPrimary:
$ref: '#/components/schemas/AccountOwnerEmailPrimary'
email:
$ref: '#/components/schemas/EmailAddress'
emailType:
$ref: '#/components/schemas/AccountOwnerEmailType'
emailScores:
$ref: '#/components/schemas/EmailScores'
AccountOwnerEmail:
description: Account owner email
type: object
properties:
isPrimary:
$ref: '#/components/schemas/AccountOwnerEmailPrimary'
email:
$ref: '#/components/schemas/EmailAddress'
emailType:
$ref: '#/components/schemas/AccountOwnerEmailType'
AccountOwnerEmailPrimary:
type: boolean
description: The email is primary.
example: true
AccountOwnerEmailType:
type: string
description: |-
The account owner's email type.
* "Personal"
* "Business"
example: Personal
AccountOwnerEmails:
description: List of emails
type: array
items:
$ref: '#/components/schemas/AccountOwnerEmail'
AccountOwnerHolders:
required:
- holders
type: object
properties:
holders:
type: array
items:
$ref: '#/components/schemas/AccountOwnerDetails'
description: List of account owners
AccountOwnerIdentityInsights:
description: List of account owner Identity Insights
type: object
properties:
requestRefId:
$ref: '#/components/schemas/RequestRefId'
isEmailValid:
$ref: '#/components/schemas/EmailValid'
emailFirstSeenDays:
$ref: '#/components/schemas/EmailFirstSeenDays'
emailDomainCreationDate:
$ref: '#/components/schemas/EmailDomainCreationDate'
emailToName:
$ref: '#/components/schemas/EmailToName'
ipRisk:
$ref: '#/components/schemas/IpRisk'
ipRiskScore:
$ref: '#/components/schemas/IpRiskScore'
ipLastSeenDays:
$ref: '#/components/schemas/IpLastSeenDays'
ipGeolocationCountryCode:
$ref: '#/components/schemas/IpGeolocationCountryCode'
ipGeolocationSubdivision:
$ref: '#/components/schemas/IpGeolocationSubdivision'
ipPhoneDistance:
$ref: '#/components/schemas/IpPhoneDistance'
ipAddressDistance:
$ref: '#/components/schemas/IpAddressDistance'
isPhoneValid:
$ref: '#/components/schemas/PhoneValid'
phoneLineType:
$ref: '#/components/schemas/PhoneLineType'
phoneCarrier:
$ref: '#/components/schemas/PhoneCarrier'
phoneCountryCode:
$ref: '#/components/schemas/PhoneCountryCode'
phoneLastSeenDays:
$ref: '#/components/schemas/PhoneLastSeenDays'
phoneEmailFirstSeenDays:
$ref: '#/components/schemas/PhoneEmailFirstSeenDays'
phoneToName:
$ref: '#/components/schemas/PhoneToName'
phoneToAddress:
$ref: '#/components/schemas/PhoneToAddress'
addressValidityLevel:
$ref: '#/components/schemas/AddressValidityLevel'
addressToName:
$ref: '#/components/schemas/AddressToName'
emailRisk:
$ref: '#/components/schemas/EmailRisk'
identityRiskScore:
$ref: '#/components/schemas/IdentityRiskScore'
device:
$ref: '#/components/schemas/DeviceInsights'
warnings:
type: array
items:
$ref: '#/components/schemas/Warnings'
alerts:
type: array
items:
$ref: '#/components/schemas/Alerts'
AccountOwnerName:
type: string
description: >-
The full name of the account owner. Multiple account owners are returned
in one string per the source data from the institution.
example: 'John Smith, PhD'
PhoneScores:
properties:
phone:
type: integer
minimum: 0
maximum: 100
description:
'This score represent the matching between user input with the
account owner details fetch'
example: 0
AccountOwnerVerificationPhone:
description: Consumer phone
type: object
properties:
type:
$ref: '#/components/schemas/AccountOwnerPhoneType'
country:
$ref: '#/components/schemas/PhoneCountry'
phone:
$ref: '#/components/schemas/PhoneNumber'
phoneScores:
$ref: '#/components/schemas/PhoneScores'
AccountOwnerPhone:
description: Consumer phone
type: object
properties:
type:
$ref: '#/components/schemas/AccountOwnerPhoneType'
country:
$ref: '#/components/schemas/PhoneCountry'
phone:
$ref: '#/components/schemas/PhoneNumber'
AccountOwnerPhoneType:
type: string
description: |-
The account owner's phone type:
* "HOME"
* "BUSINESS"
* "CELL"
* "FAX"
example: HOME
AccountOwnerPhones:
description: List of phones
type: array
items:
$ref: '#/components/schemas/AccountOwnerPhone'
AccountOwnerVerificationMatchingPhones:
description: List of phones
type: array
items:
$ref: '#/components/schemas/AccountOwnerVerificationPhone'
AccountOwnerRelationshipType:
type: string
description: |-
The type of relationship to the account:
* "AUTHORIZED_USER"
* "BUSINESS"
* "FOR_BENEFIT_OF_PRIMARY"
* "FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED"
* "FOR_BENEFIT_OF_SECONDARY"
* "FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED"
* "FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED"
* "POWER_OF_ATTORNEY"
* "PRIMARY_JOINT_TENANTS"
* "PRIMARY"
* "PRIMARY_BORROWER"
* "PRIMARY_JOINT"
* "SECONDARY"
* "SECONDARY_JOINT_TENANTS"
* "SECONDARY_BORROWER"
* "SECONDARY_JOINT"
* "SOLE_OWNER"
* "TRUSTEE"
* "UNIFORM_TRANSFER_TO_MINOR"
example: AUTHORIZED_USER
AccountStatus:
description: An account status
type: string
example: pending
AccountType:
type: string
description: >-
The list of supported account types.
* "checking": Standard checking
* "savings": Standard savings
* "cd": Certificates of deposit
* "moneyMarket": Money Market
* "creditCard": Standard credit cards
* "lineOfCredit": Home equity, line of credit
* "investment": Generic investment (no details)
* "investmentTaxDeferred": Generic tax-advantaged investment (no
details)
* "employeeStockPurchasePlan": ESPP, Employee Stock Ownership Plans
(ESOP), Stock Purchase Plans
* "ira": Individual Retirement Account (not Rollover or Roth)
* "401k": 401K Plan
* "roth": Roth IRA, Roth 401K
* "403b": 403B Plan
* "529plan": 529 Plan (True value is 529)
* "rollover": Rollover IRA
* "ugma": Uniform Gifts to Minors Act
* "utma": Uniform Transfers to Minors Act
* "keogh": Keogh Plan
* "457plan": 457 Plan (True value is 457)
* "401a": 401A Plan
* "brokerageAccount": Brokerage Account
* "educationSavings": Education Savings Account that is not a 529
* "healthSavingsAccount": HSA (Health Savings Accounts)
* "pension": Pension
* "profitSharingPlan": Profit Sharing Plan
* "roth401k": Roth 401K
* "sepIRA": Simplified Employee Pension IRA
* "simpleIRA": Simple IRA
* "thriftSavingsPlan": Thrift Savings Plan
* "variableAnnuity": Variable Annuity
* "cryptocurrency": Cryptocurrency Wallet, Cryptocurrency Account
* "mortgage": Standard Mortgages
* "loan": Auto loans, equity loans, other loans
* "studentLoan": Student Loan
* "studentLoanGroup": Student Loan Group
* "studentLoanAccount": Student Loan Account
example: checking
ActiveStatus:
description: 'Possible values: "ACTIVE", "INACTIVE"'
type: string
example: ACTIVE
CountryCodeNumber:
type: string
description:
The country code digit representing the phone number for specific
country
minLength: 1
maxLength: 3
example: '1'
CountryCode:
type: string
description: Two-letter ISO 3166-1 alpha-2 country code
minLength: 2
maxLength: 2
example: US
NewAddress:
type: object
properties:
addressLine1:
$ref: '#/components/schemas/AddressLine1'
addressLine2:
$ref: '#/components/schemas/AddressLine2'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/CountryCode'
postalCode:
$ref: '#/components/schemas/ZipCode'
Address:
type: string
description: A street address
example: '434 W Ascension Way Suite #200 Murray UT 84123'
AddressLine1:
type: string
description: Address line 1
example: 434 W Ascension Way
AddressLine2:
type: string
description: Address line 2
example: 'Suite #200'
AddressLine3:
type: string
description: Address line 3
example: UT 84123
AddressToName:
type: string
description: |-
The match status between the input name and the queried entity.
* not-found
* match
* no-match
example: match
AddressType:
type: string
description: |-
The type of address location:
* "Business"
* "Home"
* "Mailing"
example: Home
AddressValidityLevel:
type: string
description: >-
The most granular level to which the address could be validated. Ex. If
the address was only valid to the city level (but not to the house
level), it would return โvalid_to_cityโ.
* missing_address - An input address was not provided.
* invalid - The input address is not valid.
* valid - The input address is valid.
* valid_to_country - The input address could only be validated to the
country level. This means the country of the input address is valid, but
the other elements of the input address were unable to be confirmed as
valid or invalid.
* valid_to_city - The input address was validated to the city level.
This means the country, state, city, and postal code of the input
address are valid, but the street, house number, and subpremise of the
input address were unable to be confirmed as valid or invalid.
* valid_to_street - The input address was validated to the street
level. This means the country, state, city, postal code, and street of
the input address are valid, but the house number and subpremise of the
input address were unable to be confirmed as valid or invalid.
* valid_to_house_number - The input address was validated to the
street and house number level. This means the country, state, city,
postal code, street, and house number of the input address are valid,
but the subpremise of the input address was unable to be confirmed as
valid or invalid.
* valid_to_house_number_missing_apt - The input address was
validated to the street and house number level. This means the country,
state, city, postal code, street, and house number of the input address
are valid, but the subpremise of the input address was missing and thus
unable to be confirmed as valid or invalid.
example: valid
ForesightAnalyticsReport:
description: A Foresight Analytics Report
type: object
allOf:
- $ref: '#/components/schemas/ForesightAnalyticsReportAck'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
customerAnalytics:
$ref: '#/components/schemas/CustomerAnalytics'
ForesightAnalyticsFirstThirdPartyReport:
description: A Foresight Analytics Report
type: object
allOf:
- $ref: '#/components/schemas/ForesightAnalyticsFirstThirdPartyReportAck'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
customerAnalytics:
$ref: '#/components/schemas/CustomerAnalytics'
AFBalanceAnalyticsReport:
description: A Balance Analytics Report
type: object
allOf:
- $ref: '#/components/schemas/AnalyticsReportAck'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
customerAnalytics:
$ref: '#/components/schemas/CustomerAnalytics'
AFCashFlowAnalyticsReport:
description: A Cash Flow Analytics Report
type: object
allOf:
- $ref: '#/components/schemas/AnalyticsReportAck'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
customerAnalytics:
$ref: '#/components/schemas/CustomerAnalytics'
AFPaymentHistoryAnalyticsReport:
description: A Cash Flow Analytics Report
type: object
allOf:
- $ref: '#/components/schemas/AnalyticsReportAck'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
customerAnalytics:
$ref: '#/components/schemas/CustomerAnalytics'
AggregationStatus:
type: string
description: |-
"pending" during account discovery, always "active" following
successful account activation
example: active
CustomerAccountMultipleStatements:
description: A list of customer account statements
required:
- statements
type: object
properties:
statements:
type: array
items:
$ref: '#/components/schemas/CustomerAccountMultipleStatement'
description: List of customer account statements
example:
- index: '1'
id: 'a9e96186-2896-4a21-8759-450403dadf47-1063025272'
asOfDate: 1669036741
description: '08/28/2020 - 09/27/2020'
documentDate: '2020-09-27'
- index: '2'
asOfDate: 1669036741
code: '960'
message: 'statement not found.'
AggregationStatusCode:
type: integer
description: >-
The status of the most recent aggregation attempt (see [Aggregation
Status
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manage/account-aggregation/#aggregation-status-codes)).
Won't be present until you have run your first aggregation for the
account.
ForesightAnalyticsReportAck:
required:
- id
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- type
- status
- reportPin
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
reportPin:
$ref: '#/components/schemas/ReportPin'
constraints:
$ref: '#/components/schemas/ForesightAnalyticsReportConstraints'
ForesightAnalyticsFirstThirdPartyReportAck:
required:
- id
- requestId
- requesterName
- createdDate
- title
- type
- status
- reportPin
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
externalCustomerId:
$ref: '#/components/schemas/ExternalCustomerId'
reportPin:
$ref: '#/components/schemas/ReportPin'
constraints:
$ref: '#/components/schemas/ForesightAnalyticsReportFirstThirdPartyConstraints'
AnalyticsReportAck:
required:
- id
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
businessDetails:
$ref: '#/components/schemas/BusinessDetails'
reportPin:
$ref: '#/components/schemas/ReportPin'
AnalyticsReportsAccount:
required:
- id
- name
- number
- type
- currency
- transactions
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
number:
type: string
description: >-
The account number from the institution (obfuscated)
example: XX1111
type:
type: string
description: The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `unknown`
* `mortgage`
* `loan`
* `creditCard`
* `lineOfCredit`
* `payroll`
* `studentLoan`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
currentBalance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 100000
availableBalance:
type: number
description: Available balance
example: 1000
balanceDate:
type: integer
description: A timestamp showing when the `balance` was captured
format: int64
example: 1614880526
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
details:
$ref: '#/components/schemas/AccountDetails'
analytics:
$ref: '#/components/schemas/AccountAnalytics'
AnalyticsReportConstraints:
type: object
properties:
analyticsReportData:
$ref: '#/components/schemas/AnalyticsReportData'
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
AnalyticsReportConstraintsOut:
type: object
properties:
analyticsReportData:
$ref: '#/components/schemas/AnalyticsReportData'
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
AnalyticsReportData:
description: Parameters supplied by the client requesting the analytics.
properties:
forCraPurpose:
type: boolean
description:
Field to indicate if the requested report is for CRA or NONCRA. For
small business lending or other similar business use cases, pass the
value as โtrueโ for purposes of this field.
example: true
applicantIsPersonalGuarantor:
type: boolean
description: >-
Field to indicate if the business owner will personally guarantee
the loan. If true, a consumer record will be required.
example: true
timeIntervalTypes:
description: >-
Requested time interval for attribute values.
example:
- MONTHLY_CALENDAR
maxItems: 2
items:
$ref: '#/components/schemas/TimeIntervalType'
type: array
required:
- forCraPurpose
type: object
AnnualIncome:
required:
- year
- grossPayAmountYTD
type: object
properties:
year:
type: string
description:
The year for the amounts given in YTD totals for an employer
example: 2022
grossPayAmountYTD:
type: number
description:
Year to date (YTD) gross pay amount for the indicated year
example: 123.45
netPayAmountYTD:
type: number
description: Year to date (YTD) net pay amount for the indicated year
example: 123.45
basePayAmountYTD:
type: number
description: Year to date (YTD) base pay amount for the year indicated
example: 123.45
overtimePayAmountYTD:
type: number
description:
Year to date (YTD) overtime pay amount for the year indicated
example: 123.45
otherPayAmountYTD:
type: number
description: >-
Year to date (YTD) other pay amount for the indicated year. Other
pay is pay that is not categorized into one of the other categories.
example: 123.45
commissionPayAmountYTD:
type: number
description:
Year to date (YTD) commission pay amount for the indicated year
example: 123.45
AppFinancialInstitutionStatus:
description:
The registration status fields for each specific OAuth financial
institution
required:
- id
- decryptionKeyActivated
- createdDate
- lastModifiedDate
- status
type: object
properties:
id:
$ref: '#/components/schemas/NumericInstitutionId'
abbrvName:
type: string
description: The application's abbreviated name
example: VAEJ
logoUrl:
type: string
description: An URL to a logo file
example: >-
https://prod-direct-integration-client.s3.us-west-2.amazonaws.com/976521f99-7b36-4b3b-a3e0-faff9545836d/102224/90x90.png
decryptionKeyActivated:
type: boolean
description:
Status of decryption keys for financial institution app registration
example: false
createdDate:
$ref: '#/components/schemas/UnixDate'
lastModifiedDate:
$ref: '#/components/schemas/UnixDate'
status:
type: boolean
description: '"false" indicates registration is still pending'
example: true
AppRegistrationStatus:
description: >-
The status of an app registration request. "A" means approved. "P" means
pending which is the status when initially submitted or when the app is
modified and awaiting approval. "R" means rejected. If it is rejected
there will be a note with the rejected reason. "S" stands for "Skipped"
and indicates that app registration with the data provider will not be
required.
type: string
example: P
AppStatus:
description: Registration status details for the application
required:
- partnerId
- preAppId
- appName
- submittedDate
- modifiedDate
- status
type: object
properties:
partnerId:
$ref: '#/components/schemas/PartnerId'
preAppId:
$ref: '#/components/schemas/PreAppId'
note:
type: string
description: >-
A note on the registration. Typically used to indicate reasons for
rejected apps.
example: Approved
applicationId:
$ref: '#/components/schemas/ApplicationId'
appName:
$ref: '#/components/schemas/ApplicationName'
submittedDate:
$ref: '#/components/schemas/UnixDate'
modifiedDate:
$ref: '#/components/schemas/UnixDate'
status:
$ref: '#/components/schemas/AppRegistrationStatus'
scopes:
type: string
description: Indicates scopes of data accessible to the app
example: Account Info
institutionDetails:
type: array
items:
$ref: '#/components/schemas/AppFinancialInstitutionStatus'
description:
A list of the registration status for each FI for the application
App:
type: object
properties:
preAppId:
type: integer
description:
The Pre-app Id is generated after the partner submits the request to
create an application using the
/aggregation/v1/partners/applications API.
example: 13
applicationId:
type: string
description:
The Application Id is assigned to the pre-app after the pre-app
approval.
example: 234dsfdsf-535fdgdtrtr-546464564
status:
type: string
description:
The application registration status with Mastercard ('A'=Approved,
'P'=Pending, 'D'=Deleted, 'R'=Rejected, 'S'=Skipped)
example: A
name:
type: string
description: The name of the application submitted by the partner.
example: Mvelopes
scopes:
type: string
description: The scope of the application for the partner.
example: Account Number, Account Info
note:
type: string
description: The note for the pre-application status.
example: Approved
createdDate:
type: string
description:
The application creation date and time in ISO 8601 format.
example: 2020-06-02T06:00:00Z
modifiedDate:
type: string
description:
The application modification date and time are in ISO 8601 format.
example: 2020-06-02T06:00:00Z
submittedDate:
type: string
description:
The application submitted date and time in ISO 8601 format.
example: 2020-06-02T06:00:00Z
description: 'List of applications'
ApplicationResponse:
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
applications:
type: array
description: 'List of application details'
items:
$ref: '#/components/schemas/App'
CustomerAccountMultipleStatement:
description:
Statement represents the bank statements for a given customer's account
required:
- asOfDate
- index
type: object
properties:
id:
$ref: '#/components/schemas/AssetId'
description:
$ref: '#/components/schemas/Description'
asOfDate:
$ref: '#/components/schemas/UnixDate'
documentDate:
$ref: '#/components/schemas/DocumentDate'
index:
$ref: '#/components/schemas/Index'
code:
type: string
description: >-
Error code for the bank statement not generated
message:
type: string
description: >-
Error message for the bank statement not generated
AppStatuses:
description: >-
The response for the Get App Registration Status API returns an array of
status objects.
required:
- totalRecords
- totalPages
- pageNumber
- numberOfRecordsPerPage
- applications
type: object
properties:
totalRecords:
type: integer
description: The total number of results
format: int64
example: 50
totalPages:
type: integer
description: The total number of pages
format: int64
example: 5
pageNumber:
type: integer
description: The current page number
format: int64
example: 2
numberOfRecordsPerPage:
type: integer
description: The number of results per page
format: int64
example: 10
applications:
description: A list of applications with their statuses
type: array
items:
$ref: '#/components/schemas/AppStatus'
Description:
type: string
description: >-
Date range representing the period for when the statement data is
generated.
DocumentDate:
type: string
description: >-
The date when the statement was generated.
Index:
type: string
description: >-
The index for the statement. This can range from 1 to 24 statement
indexes.
Application:
required:
- appDescription
- appName
- appUrl
- ownerAddressLine1
- ownerAddressLine2
- ownerCity
- ownerCountry
- ownerName
- ownerPostalCode
- ownerState
- image
type: object
properties:
appDescription:
type: string
description: >-
A short description of the app. This will be visible to end users in
the FI interface.
example: The app that makes your budgeting experience awesome
appName:
$ref: '#/components/schemas/ApplicationName'
appUrl:
type: string
description: >-
An URL for the app. This will be visible to end users in the FI
interface.
example: 'https://www.finicity.com/'
ownerAddressLine1:
$ref: '#/components/schemas/AddressLine1'
ownerAddressLine2:
$ref: '#/components/schemas/AddressLine2'
ownerCity:
type: string
description: >-
City for the business entity that owns the app. Information for
registration purposes only and not given to the end user.
example: Murray
ownerCountry:
type: string
description: >-
Country for the business entity that owns the app. Information for
registration purposes only and not given to the end user.
example: USA
ownerName:
type: string
description: >-
Business name for the business entity that owns the app. Information
for registration purposes only and not given to the end user.
example: Finicity
ownerPostalCode:
type: string
description: >-
Zip code for the business entity that owns the app. Information for
registration purposes only and not given to the end user.
example: '84123'
ownerState:
type: string
description: >-
State for the business entity that owns the app. Information for
registration purposes only and not given to the end user.
example: UT
image:
type: string
description: >-
An app logo passed as a Base64 encoded image (1:1 SVG file, must be
less than 50KB)
example: >-
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcgICAKICAgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICB2ZXJzaW9uPSIxLjEiCiAgIHZpZXdCb3g9IjAgMCAwIDAiCiAgIGhlaWdodD0iMCIKICAgd2lkdGg9IjAiPgogICAgPGcvPgo8L3N2Zz4K
ApplicationId:
type: string
description: >-
`applicationId` value returned from the Get App Registration Status API
and the partner assign the customers to. This cannot be changed once
set. Only applicable in cases of partners with multiple registered
applications. If the partner only has one app, this can usually be
omitted. This field is populated after the app is in a status approved.
example: '00278431-b712-4f30-a044-b611f25e533d'
ApplicationName:
type: string
description: The name of the application assigned to the customer
example: Awesome Budget App
AsOfDate:
type: integer
description:
The last time the payroll data was updated in the payroll provider's
system
format: int64
example: 1596175200
Asset:
description: An asset
required:
- assetId
type: object
properties:
assetId:
$ref: '#/components/schemas/AssetId'
AssetId:
type: string
description: >-
An asset ID. Generated by Data Connect or by using the Store Customer
Pay Statement API.
example: 097545c5-1c2a-4f20-a5ef-77f0820344c9-2018601178
AvailableBalance:
required:
- id
- realAccountNumberLast4
- availableBalance
- availableBalanceDate
- clearedBalance
- clearedBalanceDate
- aggregationStatusCode
- currency
type: object
properties:
id:
$ref: '#/components/schemas/NumericCustomerId'
realAccountNumberLast4:
$ref: '#/components/schemas/AccountNumberLast4'
availableBalance:
type: number
description: The available balance of the account
example: 173.47
availableBalanceDate:
$ref: '#/components/schemas/UnixDate'
clearedBalance:
type: number
description: >-
The cleared balance of the account. Also referred as posted balance,
current balance, ledger balance
example: 222.25
clearedBalanceDate:
$ref: '#/components/schemas/UnixDate'
aggregationStatusCode:
$ref: '#/components/schemas/AggregationStatusCode'
currency:
$ref: '#/components/schemas/Currency'
BalanceAnalyticsAccountResult:
properties:
accountDetails:
$ref: '#/components/schemas/ObbAccountDetails'
accountId:
$ref: '#/components/schemas/NumericAccountId'
balanceAnalyticsMetrics:
$ref: '#/components/schemas/BalanceAnalyticsMetrics'
currentReportRequest:
$ref: '#/components/schemas/ObbCurrentReportRequestDetails'
historicDataAvailability:
$ref: '#/components/schemas/ObbDataAvailability'
required:
- accountId
- accountDetails
- historicDataAvailability
- currentReportRequest
type: object
BalanceAnalyticsBusinessSummary:
description:
Balance analytics summarized across all accounts in the report
properties:
balanceAnalyticsMetrics:
$ref: '#/components/schemas/BalanceAnalyticsMetrics'
currentReportRequest:
$ref: '#/components/schemas/ObbCurrentReportRequestDetails'
historicDataAvailability:
$ref: '#/components/schemas/ObbDataAvailability'
type: object
BalanceAnalyticsMetrics:
description: Balance analytics metrics and calculations
properties:
availableBalance:
description: Available Balance
example: 1000.01
type: number
availableBalanceDate:
description: Available Balance date
example: '2022-02-18T02:34:00-07:00'
type: string
minLength: 25
maxLength: 25
averageDailyBalanceByMonthForTheReportTimePeriod:
description:
Average daily ending balance each month over the report time period
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
averageDailyBalanceForTheReportTimePeriod:
description: Average Daily Balance
example: -10442.53
type: number
averageWeekdayBalanceForTheReportTimePeriod:
description: Average Weekday Balance
example: -10442.53
type: number
countDailyNegativeBalancesByMonthForTheReportTimePeriod:
description: >-
Number of negative daily ending balances each month over the report
time period
items:
$ref: '#/components/schemas/ObbDateRangeAndCount'
type: array
currentRunningBalance:
description: Current Running Balance Date
example: 1000.01
type: number
currentRunningBalanceDate:
description: Current Running Balance date
example: '2022-02-10T05:00:00-07:00'
type: string
minLength: 25
maxLength: 25
dailyBalancesByWeekdayForTheReportTimePeriod:
default: []
description: >-
Daily balance of the account during weekdays over the length of the
report
example:
- date: '2022-03-23'
dayOfWeek: Monday
endingBalance: 21527.3
items:
$ref: '#/components/schemas/ObbDailyBalance'
type: array
dailyBalancesForTheReportTimePeriod:
default: []
description:
Daily balance of the account over the length of the report
example:
- date: '2022-03-22'
dayOfWeek: Sunday
endingBalance: 21527.3
items:
$ref: '#/components/schemas/ObbDailyBalance'
type: array
historicNumberOfWeeksAverageBalanceIncreasing:
$ref: '#/components/schemas/ObbNumWeeksAverageBalanceIncreasing'
maximumDailyBalanceByMonthForTheReportTimePeriod:
description:
Maximum daily ending balance each month over the report time period
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
maximumRunningBalanceForTheReportTimePeriod:
description: Maximum Running Balance
example: -28749.44
type: number
minimumDailyBalanceByMonthForTheReportTimePeriod:
description:
Minimum daily ending balance each month over the report time period
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
minimumRunningBalanceForTheReportTimePeriod:
description: Minimum Running Balance
example: -28749.44
type: number
type: object
BalanceAnalyticsReport:
description: Balance analytics report data as JSON
properties:
accountResults:
description: Balance results per account
items:
$ref: '#/components/schemas/BalanceAnalyticsAccountResult'
type: array
businessId:
description: Business ID
example: 4444
type: integer
businessSummary:
$ref: '#/components/schemas/BalanceAnalyticsBusinessSummary'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
reportHeader:
$ref: '#/components/schemas/ObbReportHeader'
requesterName:
description: Name of requester
example: Mortgage ABC LLC
type: string
minLength: 0
maxLength: 255
title:
$ref: '#/components/schemas/ReportTitle'
required:
- customerId
- title
- reportHeader
type: object
BalanceAndCashFlowAnalyticsReportConstraints:
description: >-
Request parameters from the partner to control the customer accounts
included in the report, and the length of time to report on.
type: object
properties:
accountIds:
description: >-
The list of account IDs to include in the report. If omitted, all
accounts on record for the customer will be used.
type: array
items:
$ref: '#/components/schemas/NumericAccountId'
lengthOfReport:
description: >-
Number of days to search for transactions. Must be one of 30, 90,
180, 270, 365, or 730. If omitted, defaults to 2 years from current
time at which the request was received (730 days).
type: integer
example: 730
BaseReportAck:
description: Properties shared by all generated reports
type: object
properties:
id:
$ref: '#/components/schemas/ReportId'
customerType:
$ref: '#/components/schemas/CustomerType'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
requestId:
$ref: '#/components/schemas/ReportRequestId'
requesterName:
$ref: '#/components/schemas/PartnerName'
endUser:
$ref: '#/components/schemas/ConsumerEndUser'
createdDate:
$ref: '#/components/schemas/ReportCreatedDate'
title:
$ref: '#/components/schemas/ReportTitle'
consumerId:
$ref: '#/components/schemas/ConsumerId'
consumerSsn:
$ref: '#/components/schemas/SocialSecurityNumberLastDigits'
consumerDetails:
$ref: '#/components/schemas/ConsumerDetails'
disputeStatement:
$ref: '#/components/schemas/DisputeStatement'
type:
$ref: '#/components/schemas/ReportType'
status:
$ref: '#/components/schemas/ReportStatus'
constraints:
anyOf:
- $ref: '#/components/schemas/AnalyticsReportConstraintsOut'
- $ref: '#/components/schemas/ForesightAnalyticsReportConstraints'
- $ref: '#/components/schemas/CashFlowReportConstraintsOut'
- $ref: '#/components/schemas/VOIEWithTXVerifyReportConstraintsOut'
- $ref: '#/components/schemas/VOIEReportConstraints'
- $ref: '#/components/schemas/StatementReportConstraints'
- $ref: '#/components/schemas/TransactionsReportConstraintsOut'
- $ref: '#/components/schemas/VOAReportConstraintsOut'
- $ref: '#/components/schemas/VOAWithIncomeReportConstraintsOut'
- $ref: '#/components/schemas/PrequalificationReportConstraintsOut'
- $ref: '#/components/schemas/VOIReportConstraintsOut'
- $ref: '#/components/schemas/PayrollReportConstraintsOut'
- $ref: '#/components/schemas/VOETransactionsReportConstraintsOut'
- $ref: '#/components/schemas/PayStatementReportConstraints'
errors:
description: In case errors occurred during the report generation
type: array
items:
$ref: '#/components/schemas/ErrorMessage'
BaseReportAckWithPortfolioId:
description:
Properties shared by all generated reports having a portfolio ID
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
portfolioId:
$ref: '#/components/schemas/PortfolioId'
Birthday:
type: object
properties:
year:
type: integer
description: The birthday 4-digit year
format: int32
example: 1989
month:
type: integer
description: The birthday 2-digit month (1 is January)
format: int32
example: 8
dayOfMonth:
type: integer
description: The birthday 2-digit day-of-month
format: int32
example: 13
description: A birth date
Borrower:
required:
- customerId
- consumerId
- type
type: object
properties:
customerId:
$ref: '#/components/schemas/CustomerId'
consumerId:
$ref: '#/components/schemas/ConsumerId'
type:
$ref: '#/components/schemas/BorrowerType'
optionalConsumerInfo:
$ref: '#/components/schemas/ConsumerInfo'
BorrowerType:
description: '"primary" or "jointBorrower"'
type: string
example: primary
Borrowers:
type: array
items:
$ref: '#/components/schemas/Borrower'
description: >-
(MVS) Array of borrowers to pass the primary and joint borrower's
customer and consumer IDs
Branding:
type: object
properties:
logo:
type: string
description: >-
File path of the institution's logo. For white backgrounds designed
at 375 x 72, has built in spacing around it to normalize brand
sizing.
example: 'https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/logo.svg'
alternateLogo:
type: string
description: >-
File path of the institution's alternate logo. For colored
backgrounds designed at 375 x 72 has built in spacing around it to
normalize brand sizing.
example: >-
https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/alternateLogo.svg
icon:
type: string
description: >-
File path of the institution's icon. For search results designed at
40 x 40.
example: 'https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/icon.svg'
primaryColor:
type: string
description: Hex code for the institution's primary color
example: '#0167AE'
tile:
type: string
description: >-
File path of institution name logo. For popular banks designed at
160 x 72.
example: 'https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/tile.svg'
description:
All assets are SVGs so can be slightly resized without any issues.
BrandingWrapper:
required:
- branding
type: object
properties:
branding:
$ref: '#/components/schemas/Branding'
AFBusiness:
type: object
required:
- name
- address
properties:
name:
$ref: '#/components/schemas/BusinessName'
address:
type: object
properties:
addressLine1:
$ref: '#/components/schemas/AddressLine1'
addressLine2:
$ref: '#/components/schemas/AddressLine2'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/Country'
postalCode:
$ref: '#/components/schemas/ZipCode'
BusinessDetails:
allOf:
- $ref: '#/components/schemas/AFBusiness'
- type: object
properties:
businessId:
$ref: '#/components/schemas/BusinessId'
BusinessName:
type: string
description: The name of a business
example: ABC Tires Inc
CadenceDetails:
type: object
properties:
startDate:
type: integer
description: '`postedDate` of the first deposit transaction'
format: int64
example: 1577986990
stopDate:
type: integer
description: >-
`postedDate` of the final deposit transaction (omitted if status is
active)
format: int64
example: 1587986990
days:
type: integer
description: Number of days between the recurring deposits
format: int32
example: 14
CashFlowActivityDepositsCredits:
properties:
date:
description: Date the deposit transaction was posted
example: '2020-03-25'
type: string
minLength: 10
maxLength: 10
depositsCredits:
description: Amount of the deposit
example: 500
type: number
transactionDescription:
description: Description of transaction
example: VENMO CASHOUT
type: string
minLength: 0
maxLength: 255
required:
- date
- depositsCredits
type: object
CashFlowActivityWithdrawalsDebits:
properties:
date:
description: Date the withdrawal transaction was posted
example: '2020-03-25'
type: string
minLength: 10
maxLength: 10
transactionDescription:
description: Description of transaction
example: Payment to Chase card ending in
type: string
minLength: 0
maxLength: 255
withdrawalsDebits:
description: Amount of the withdrawal
example: 15.69
type: number
required:
- date
- withdrawalsDebits
type: object
CashFlowAnalyticsAccountResult:
properties:
accountDetails:
$ref: '#/components/schemas/ObbAccountDetails'
accountId:
$ref: '#/components/schemas/NumericAccountId'
cashflowAnalyticsMetrics:
$ref: '#/components/schemas/CashFlowAnalyticsMetrics'
currentReportRequest:
$ref: '#/components/schemas/ObbCurrentReportRequestDetails'
historicDataAvailability:
$ref: '#/components/schemas/ObbDataAvailability'
required:
- accountId
- accountDetails
- historicDataAvailability
- currentReportRequest
type: object
CashFlowAnalyticsBusinessSummary:
description:
Cash flow analytics summarized across all accounts in the report
properties:
cashflowAnalyticsMetrics:
$ref: '#/components/schemas/CashFlowAnalyticsMetrics'
currentReportRequest:
$ref: '#/components/schemas/ObbCurrentReportRequestDetails'
historicDataAvailability:
$ref: '#/components/schemas/ObbDataAvailability'
required:
- historicDataAvailability
- currentReportRequest
type: object
CashFlowAnalyticsMetrics:
description: Cash flow analytics metrics and calculations
properties:
inflow:
$ref: '#/components/schemas/CashFlowInflowAttributes'
negativeTriggers:
$ref: '#/components/schemas/CashFlowNegativeTriggers'
outflow:
$ref: '#/components/schemas/CashFlowOutflowAttributes'
revenueByMonthForTheReportTimePeriod:
description:
'Sum of all transactions categorized as revenue, split by months'
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
revenueForTheReportTimePeriod:
description: Sum of all transactions categorized as revenue
example: 43893.44
type: number
transactionAnalytics:
$ref: '#/components/schemas/CashFlowTransactionAnalyticsAttributes'
type: object
CashFlowCashFlowBalance:
required:
- monthlyCashFlowBalances
- minDailyBalance
- maxDailyBalance
- twelveMonthAverageDailyBalance
- sixMonthAverageDailyBalance
- twoMonthAverageDailyBalance
- twelveMonthStandardDeviationOfDailyBalance
- twoMonthStandardDeviationOfDailyBalance
- numberOfDaysPositiveBalance
type: object
properties:
monthlyCashFlowBalances:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowBalances'
description: List of attributes for each month
minDailyBalance:
type: number
description: Min daily balance across entire transaction history
example: 3479.39
maxDailyBalance:
type: number
description: Max Daily Balance across entire transaction history
example: 3479.39
twelveMonthAverageDailyBalance:
type: number
description:
Average Daily Balance across twelve months for the account
example: 3479.39
sixMonthAverageDailyBalance:
type: number
description: Average Daily Balance across six months for the account
example: 3479.39
twoMonthAverageDailyBalance:
type: number
description: Average Daily Balance across two months for the account
example: 3479.39
twelveMonthStandardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance across twelve months for the
account
example: '20'
sixMonthStandardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance across six months for the
account
example: '20'
twoMonthStandardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance across two months for the
account
example: '20'
numberDaysNegativeBalance:
type: string
description:
Number of Days Negative Balance over entire transaction history
example: '6'
numberOfDaysPositiveBalance:
type: string
description:
Number of Days positive balance over entire transaction history
example: '0'
CashFlowCashFlowBalanceSummary:
required:
- monthlyCashFlowBalanceSummaries
- minDailyBalance
- maxDailyBalance
- twelveMonthAverageDailyBalance
- sixMonthAverageDailyBalance
- twoMonthAverageDailyBalance
- twelveMonthStandardDeviationOfDailyBalance
- twoMonthStandardDeviationOfDailyBalance
- numberOfDaysNegativeBalance
- numberOfDaysPositiveBalance
type: object
properties:
monthlyCashFlowBalanceSummaries:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowBalanceSummaries'
description: List of attributes for each month
minDailyBalance:
type: number
description:
Min Daily Balance across entire transaction history for all
accounts
example: 3479.39
maxDailyBalance:
type: number
description:
Max Daily Balance across entire transaction history for all accounts
example: 3479.39
twelveMonthAverageDailyBalance:
type: number
description:
Average Daily Balance across twelve months for all accounts
example: 3479.39
sixMonthAverageDailyBalance:
type: number
description: Average Daily Balance across six months for all accounts
example: 3479.39
twoMonthAverageDailyBalance:
type: number
description: Average Daily Balance across two months for all accounts
example: 3479.39
twelveMonthStandardDeviationOfDailyBalance:
type: string
description: >-
Standard Deviation of Daily Balance across twelve months for all
accounts
example: '20'
sixMonthStandardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance across six months for all
accounts
example: '20'
twoMonthStandardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance across two months for all
accounts
example: '20'
numberOfDaysNegativeBalance:
type: string
description: >-
Number of Days Negative Balance over entire transaction history for
all accounts
example: '6'
numberOfDaysPositiveBalance:
type: string
description: >-
Number of Days Positive Balance over entire transaction history for
all accounts
example: '11'
CashFlowCashFlowCharacteristic:
required:
- monthlyCashFlowCharacteristics
- averageMonthlyNet
- averageMonthlyNetLessTransfers
type: object
properties:
monthlyCashFlowCharacteristics:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowCharacteristics'
description: List of attributes for each month
averageMonthlyNet:
type: number
description: Average (Total Credits - Total Debits) for the account
example: 2350
averageMonthlyNetLessTransfers:
type: number
description:
Average (Total Credits - Total Debits) without transfers for the
account
example: 1000
twelveMonthTotalNet:
type: number
description: >-
Sum of all monthly (Total Credits - Total Debits) each month for the
account
example: 12500
twelveMonthTotalNetLessTransfers:
type: number
description: >-
Sum of all monthly (Total Credits - Total Debits) without transfers
for the account
example: 12400
sixMonthAverageTotalCreditsLessTotalDebits:
type: number
description: 6 Month Average (Total Credits - Total Debits)
example: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers:
type: number
description:
6 Month Average (Total Credits - Total Debits) - (Without Transfers)
example: 55555
twoMonthAverageTotalCreditsLessTotalDebits:
type: number
description: 2 Month Average (Total Credits - Total Debits)
example: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers:
type: number
description:
2 Month Average (Total Credits - Total Debits) - (Without Transfers)
example: 55555
CashFlowCashFlowCharacteristicsSummary:
required:
- averageMonthlyNet
- averageMonthlyNetLessTransfers
- twelveMonthTotalNet
- twelveMonthTotalNetLessTransfers
- sixMonthAverageTotalCreditsLessTotalDebits
- sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers
- twoMonthAverageTotalCreditsLessTotalDebits
type: object
properties:
monthlyCashFlowCharacteristicsSummaries:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowCharacteristicsSummaries'
description: List of attributes for each month
averageMonthlyNet:
type: number
description: Average monthly net amount
example: 1250
averageMonthlyNetLessTransfers:
type: number
description: Average monthly net less transfers
example: 1000
twelveMonthTotalNet:
type: number
description: >-
Sum of all monthly (Total Credits - Total Debits) each month by the
account
example: 12500
twelveMonthTotalNetLessTransfers:
type: number
description: >-
Sum of all monthly (Total Credits - Total Debits) without transfers
by the account
example: 12400
sixMonthAverageTotalCreditsLessTotalDebits:
type: number
description:
6 Month Average (Total Credits - Total Debits) across all accounts
example: 55555
sixMonthAverageTotalCreditsLessTotalDebitsLessTransfers:
type: number
description: >-
6 Month Average (Total Credits - Total Debits) - (Without Transfers)
across all accounts
example: 55555
twoMonthAverageTotalCreditsLessTotalDebits:
type: number
description:
2 Month Average (Total Credits - Total Debits) across all accounts
example: 55555
twoMonthAverageTotalCreditsLessTotalDebitsLessTransfers:
type: number
description: >-
2 Month Average (Total Credits - Total Debits) - (Without Transfers)
across all accounts
example: 55555
CashFlowCashFlowCredit:
required:
- monthlyCashFlowCredits
type: object
properties:
monthlyCashFlowCredits:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowCredits'
description: List of attributes for each month
twelveMonthCreditTotal:
type: number
description: Sum of all credit transactions for each month by account
example: 1200
twelveMonthCreditTotalLessTransfers:
type: number
description:
Sum of all monthly credit transactions without transfers for the
account
example: 1000
sixMonthCreditTotal:
type: number
description: Sum of six month credit transactions
example: 750
sixMonthCreditTotalLessTransfers:
type: number
description: Sum of six month credit transactions without transfers
example: 500
twoMonthCreditTotal:
type: number
description: Sum of two month credit transactions
example: 150
twoMonthCreditTotalLessTransfers:
type: number
description: Sum of two month credit transactions without transfers
example: 100
CashFlowCashFlowCreditSummary:
required:
- monthlyCashFlowCreditSummaries
- twelveMonthCreditTotal
- twelveMonthCreditTotalLessTransfers
- sixMonthCreditTotal
- sixMonthCreditTotalLessTransfers
- twoMonthCreditTotal
- twoMonthCreditTotalLessTransfers
type: object
properties:
monthlyCashFlowCreditSummaries:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowCreditSummaries'
description: List of attributes for each month
twelveMonthCreditTotal:
type: number
description:
Sum of all credit transactions for each month for all accounts
example: 1200
twelveMonthCreditTotalLessTransfers:
type: number
description: >-
Sum of all monthly credit transactions without transfers for all
accounts
example: 1000
sixMonthCreditTotal:
type: number
description: Six month sum of all credit transactions
example: 750
sixMonthCreditTotalLessTransfers:
type: number
description: >-
Six month sum of all monthly credit transactions without transfers
for all accounts
example: 500
twoMonthCreditTotal:
type: number
description: Two month sum of all credit transactions
example: 150
twoMonthCreditTotalLessTransfers:
type: number
description: >-
Two month sum of all monthly credit transactions without transfers
for all accounts
example: 100
CashFlowCashFlowDebit:
required:
- monthlyCashFlowDebits
type: object
properties:
monthlyCashFlowDebits:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlycashflowDebits'
description: List of attributes for each month
twelveMonthDebitTotal:
type: number
description:
Sum of all monthly debit transactions for each month by account
example: 1200
twelveMonthDebitTotalLessTransfers:
type: number
description:
Sum of all monthly debit transactions without transfers for the
account
example: 1000
sixMonthDebitTotal:
type: number
description: Six month sum of all debit transactions
example: 750
sixMonthDebitTotalLessTransfers:
type: number
description: >-
Six month sum of all debit transactions without transfers for the
account
example: 500
twoMonthDebitTotal:
type: number
description: Two month sum of all debit transactions
example: 150
twoMonthDebitTotalLessTransfers:
type: number
description: >-
Two month sum of all debit transactions without transfers for the
account
example: 100
CashFlowCashFlowDebitSummary:
required:
- monthlyCashFlowDebitSummaries
- twelveMonthDebitTotal
- twelveMonthDebitTotalLessTransfers
- sixMonthDebitTotal
- sixMonthDebitTotalLessTransfers
- twoMonthDebitTotal
- twoMonthDebitTotalLessTransfers
type: object
properties:
monthlyCashFlowDebitSummaries:
type: array
items:
$ref: '#/components/schemas/CashFlowMonthlyCashFlowDebitSummaries'
description: List of attributes for each month
twelveMonthDebitTotal:
type: number
description:
Sum of all monthly debit transactions for each month by account
example: -1200
twelveMonthDebitTotalLessTransfers:
type: number
description:
Sum of all monthly debit transactions without transfers for the
account
example: -1000
sixMonthDebitTotal:
type: number
description: Six month sum of all debit transactions by account
example: -750
sixMonthDebitTotalLessTransfers:
type: number
description: >-
Six month sum of all debit transactions without transfers for the
account
example: -500
twoMonthDebitTotal:
type: number
description: Two month sum of all debit transactions by account
example: -150
twoMonthDebitTotalLessTransfers:
type: number
description: >-
Two month sum of all debit transactions without transfers for the
account
example: -100
CashFlowInflowAttributes:
description: Inflow Attributes
properties:
averageDepositByMonthForTheReportTimePeriod:
description: Average value of deposits during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
countDepositsByMonthForTheReportTimePeriod:
description: Count of all deposits during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndCount'
type: array
historicCountOfDepositTransactions:
description: >-
Count of ALL deposits over entire known history of the account (may
exceed requested length of report)
example: 20
type: integer
historicSumOfDeposits:
description: >-
Sum of ALL deposits over entire known history of the account (may
exceed requested length of report)
example: 389.22
type: number
maximumDepositByMonthForTheReportTimePeriod:
description: Maximum deposit value for different periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
minimumDepositByMonthForTheReportTimePeriod:
description: Minimum deposit value for different periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
sumDepositsByMonthForTheReportTimePeriod:
description: Sum of all deposits during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
required:
- minimumDepositByMonthForTheReportTimePeriod
- maximumDepositByMonthForTheReportTimePeriod
- sumDepositsByMonthForTheReportTimePeriod
- countDepositsByMonthForTheReportTimePeriod
- historicCountOfDepositTransactions
type: object
CashFlowInsufficientFundsFees:
description: Non-Sufficient Fund Fees
properties:
countOfTransactionsForTheReportTimePeriod:
description: Count of all NSF transactions during the report
example: 1
type: integer
sumOfTransactionsForTheReportTimePeriod:
description: Sum of all NSF transactions during the report
example: -1.65
type: number
transactions:
description: Transactions categorized as NSF
items:
$ref: '#/components/schemas/InsufficientFundsTransaction'
type: array
type: object
CashFlowMonthlyCashFlowBalanceSummaries:
required:
- month
- minDailyBalance
- maxDailyBalance
- averageDailyBalance
- numberOfDaysNegativeBalance
- numberOfDaysPositiveBalance
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
minDailyBalance:
type: number
description: Min Daily Balance for each month for all accounts
example: 3479.39
maxDailyBalance:
type: number
description: Max Daily Balance for each month for all accounts
example: 3479.39
averageDailyBalance:
type: number
description: Average Daily Balance for each month for all accounts
example: 3479.39
standardDeviationOfDailyBalance:
type: string
description:
Standard Deviation of Daily Balance for each month for all accounts
example: '20.45454545'
numberOfDaysNegativeBalance:
type: string
description:
Number of Days Negative Balance for each month for all accounts
example: '6'
numberOfDaysPositiveBalance:
type: string
description:
Number of Days Positive Balance for each month for all accounts
example: '0'
CashFlowMonthlyCashFlowBalances:
required:
- month
- minDailyBalance
- maxDailyBalance
- averageDailyBalance
- numberOfDaysNegativeBalance
- numberOfDaysPositiveBalance
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
minDailyBalance:
type: number
description: Min Daily Balance for each month
example: 3479.39
maxDailyBalance:
type: number
description: Max Daily Balance for each month
example: 3479.39
averageDailyBalance:
type: number
description: Average Daily Balance for each month
example: 3479.39
standardDeviationOfDailyBalance:
type: string
description: Standard Deviation of Daily Balance for each month
example: '20'
numberOfDaysNegativeBalance:
type: string
description: Number of Days Negative Balance for each month
example: '6'
numberOfDaysPositiveBalance:
type: string
description: Number of Days positive balance for each month
example: '0'
CashFlowMonthlyCashFlowCharacteristics:
required:
- month
- totalCreditsLessTotalDebits
- totalCreditsLessTotalDebitsLessTransfers
- averageTransactionAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
totalCreditsLessTotalDebits:
type: number
description: Total Credits - Total Debits by month
example: 15000
totalCreditsLessTotalDebitsLessTransfers:
type: number
description: Total Credits - Total Debits by month (Without Transfers)
example: 11000
averageTransactionAmount:
type: number
description: Average transaction amount by month
example: 10
CashFlowMonthlyCashFlowCharacteristicsSummaries:
required:
- month
- totalCreditsLessTotalDebits
- totalCreditsLessTotalDebitsLessTransfers
- averageTransactionAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
totalCreditsLessTotalDebits:
type: number
description: Total Credits - Total Debits by month across all accounts
example: 15000
totalCreditsLessTotalDebitsLessTransfers:
type: number
description: >-
Total Credits - Total Debits by month (Without Transfers) across all
accounts
example: 11000
averageTransactionAmount:
type: number
description: Average transaction amount across all accounts
example: 10
CashFlowMonthlyCashFlowCreditSummaries:
required:
- month
- numberOfCredits
- totalCreditsAmount
- largestCredit
- numberOfCreditsLessTransfers
- totalCreditsAmountLessTransfers
- averageCreditAmount
- estimatedNumberOfLoanDeposits
- estimatedLoanDepositAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
numberOfCredits:
type: string
description: Number of credits by month across all accounts
example: '57'
totalCreditsAmount:
type: number
description: Total amount of credits by month across all accounts
example: 3479.39
largestCredit:
type: number
description: Largest credit by month across all accounts
example: 3000.49
numberOfCreditsLessTransfers:
type: string
description:
Number of credits by month (less transfers) across all accounts
example: '5'
totalCreditsAmountLessTransfers:
type: number
description:
Total amount of credits by month (less transfers) across all
accounts
example: 25.46
averageCreditAmount:
type: number
description: The average credit amount
example: 500
estimatedNumberOfLoanDeposits:
type: string
description: The estimated number of loan deposits by month
example: '0'
estimatedLoanDepositAmount:
type: number
description: The estimated loan deposit amount by month
example: 0
CashFlowMonthlyCashFlowCredits:
required:
- month
- numberOfCredits
- totalCreditsAmount
- largestCredit
- numberOfCreditsLessTransfers
- totalCreditsAmountLessTransfers
- averageCreditAmount
- estimatedNumberOfLoanDeposits
- estimatedLoanDepositAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
numberOfCredits:
type: string
description: Number of credits by month
example: '3'
totalCreditsAmount:
type: number
description: Total amount of credits by month
example: 5000
largestCredit:
type: number
description: Largest credit by month
example: 2000
numberOfCreditsLessTransfers:
type: string
description: Number of credits by month (less transfers)
example: '2'
totalCreditsAmountLessTransfers:
type: number
description: Total amount of credits by month (less transfers)
example: 4000
averageCreditAmount:
type: number
description: The average credit amount
example: 500
estimatedNumberOfLoanDeposits:
type: string
description: The estimated number of loan deposits
example: '0'
estimatedLoanDepositAmount:
type: number
description: The estimated loan deposit amount
example: 0
CashFlowMonthlyCashFlowDebitSummaries:
required:
- month
- numberOfDebits
- totalDebitsAmount
- largestDebit
- numberOfDebitsLessTransfers
- totalDebitsAmountLessTransfers
- averageDebitAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
numberOfDebits:
type: string
description: Number of Debits by month across all accounts
example: '1500'
totalDebitsAmount:
type: number
description: Total Amount of Debits by month across all accounts
example: -12345.46
largestDebit:
type: number
description: Largest Debit by month
example: -20000
numberOfDebitsLessTransfers:
type: string
description: Number of Debits by month (less transfers)
example: '5'
totalDebitsAmountLessTransfers:
type: number
description: Total amount of debits by month (less transfers)
example: -2000
averageDebitAmount:
type: number
description: The average debit amount
example: 500
CashFlowMonthlycashflowDebits:
required:
- month
- numberOfDebits
- totalDebitsAmount
- largestDebit
- numberOfDebitsLessTransfers
- totalDebitsAmountLessTransfers
- averageDebitAmount
type: object
properties:
month:
type: integer
description:
One instance for each complete calendar month in the report
format: int64
example: 1512111600
numberOfDebits:
type: string
description: Number of Debits by month
example: '5'
totalDebitsAmount:
type: number
description: Total Amount of Debits by month
example: -12345
largestDebit:
type: number
description: Largest Debit by month
example: -2000
numberOfDebitsLessTransfers:
type: string
description: Number of Debits by month (less transfers)
example: '3'
totalDebitsAmountLessTransfers:
type: number
description: Total amount of debits by month (less transfers)
example: -2000
averageDebitAmount:
type: number
description: The average debit amount
example: 500
CashFlowNegativeTriggers:
description:
Transactions that may be warning signs of bad creditworthiness
properties:
insufficientFundFees:
$ref: '#/components/schemas/CashFlowInsufficientFundsFees'
type: object
CashFlowNumWeeksZeros:
description:
Weeks with zero transactions during the known history of the account
properties:
historicNumberOfWeeksWithDataAvailable:
description: >-
Number of weeks during known history of account in which data was
available
example: 10
type: integer
historicNumberOfWeeksZeroTransactions:
description: >-
Number of weeks during known history of account where zero
transactions were posted
example: 5
type: integer
historicWeeksWithZeroTransactions:
description: List of weeks with zero reported transactions
items:
$ref: '#/components/schemas/ObbWeekOfYear'
type: array
required:
- historicNumberOfWeeksZeroTransactions
- historicNumberOfWeeksWithDataAvailable
- historicWeeksWithZeroTransactions
type: object
CashFlowOutflowAttributes:
description: Outflow attributes
properties:
averageWithdrawalByMonthForTheReportTimePeriod:
description: Average value of withdrawals during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
countWithdrawalsByMonthForTheReportTimePeriod:
description: Count of all withdrawals during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndCount'
type: array
historicCountOfWithdrawalTransactions:
description: >-
Count of ALL withdrawals over entire known history of the account
(may exceed requested length of report)
example: 20
type: integer
historicSumOfWithdrawals:
description: >-
Sum of ALL withdrawals over entire known history of the account (may
exceed requested length of report)
example: 925.66
type: number
maximumWithdrawalByMonthForTheReportTimePeriod:
description:
Maximum withdrawal value for different periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
minimumWithdrawalByMonthForTheReportTimePeriod:
description:
Minimum withdrawal value for different periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
sumWithdrawalsByMonthForTheReportTimePeriod:
description: Sum of all withdrawals during periods in the report
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
required:
- minimumWithdrawalByMonthForTheReportTimePeriod
- maximumWithdrawalByMonthForTheReportTimePeriod
- sumWithdrawalsByMonthForTheReportTimePeriod
- countWithdrawalsByMonthForTheReportTimePeriod
- historicCountOfWithdrawalTransactions
type: object
CashFlowPossibleLoanDeposits:
required:
- institutions
type: object
properties:
institutions:
description: 'A list of loan deposit institutions'
type: array
items:
$ref: '#/components/schemas/CashFlowPossibleLoanDepositsInstitutions'
CashFlowPossibleLoanDepositsAccount:
required:
- id
- ownerName
- ownerAddress
- name
- number
- type
- aggregationStatusCode
- currentBalance
- availableBalance
- balanceDate
- transactions
type: object
properties:
id:
type: string
description: Finicity account ID
example: '6681984'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
number:
type: string
description: >-
The account number from the institution (obfuscated)
example: XX1111
type:
type: string
description: >-
CFR: `ALL` (`checking` / `savings` / `loan` / `mortgage` / `credit
card` / `CD` / `MM` / `investment`...)
example: checking
aggregationStatusCode:
type: integer
description: >-
The status of the most recent aggregation attempt for this account
(non-zero means the account was not accessed successfully for this
report, and additional fields for this account may not be reliable)
example: 0
currentBalance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 100000
availableBalance:
type: number
description: Available balance
example: 1000
balanceDate:
type: integer
description: A timestamp showing when the `balance` was captured
format: int64
example: 1614880526
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
CashFlowPossibleLoanDepositsInstitutions:
required:
- id
- name
- urlHomeApp
- accounts
type: object
properties:
id:
type: string
description: Finicity institution ID
example: '102105'
name:
type: string
description: Finicity institution name
example: FinBank Profiles
urlHomeApp:
type: string
description: The URL of the Financial Institution
example: 'http://www.finbank.com'
accounts:
type: array
items:
$ref: '#/components/schemas/CashFlowPossibleLoanDepositsAccount'
description: A list of account records
CashFlowReport:
description: A Cash Flow report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 730
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
cashFlowBalanceSummary:
$ref: '#/components/schemas/CashFlowCashFlowBalanceSummary'
cashFlowCreditSummary:
$ref: '#/components/schemas/CashFlowCashFlowCreditSummary'
cashFlowDebitSummary:
$ref: '#/components/schemas/CashFlowCashFlowDebitSummary'
cashFlowCharacteristicsSummary:
$ref: '#/components/schemas/CashFlowCashFlowCharacteristicsSummary'
possibleLoanDeposits:
type: array
items:
$ref: '#/components/schemas/CashFlowPossibleLoanDeposits'
description: A possible loan deposits record
CashFlowReportAccount:
type: object
properties:
id:
type: integer
description: Finicity account ID
example: 6681984
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
number:
type: string
description: >-
The account number from the institution (obfuscated)
example: XX1111
type:
type: string
description: >-
The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `unknown`
* `mortgage`
* `loan`
* `creditCard`
* `lineOfCredit`
* `payroll`
* `studentLoan`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: >-
The status of the most recent aggregation attempt for this account
(non-zero means the account was not accessed successfully for this
report, and additional fields for this account may not be reliable)
example: 0
currentBalance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 100000
availableBalance:
type: number
description: Available balance
example: 1000
balanceDate:
type: integer
description: A timestamp showing when the `balance` was captured
format: int64
example: 1614880526
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
cashFlowBalance:
$ref: '#/components/schemas/CashFlowCashFlowBalance'
cashFlowCredit:
$ref: '#/components/schemas/CashFlowCashFlowCredit'
cashFlowDebit:
$ref: '#/components/schemas/CashFlowCashFlowDebit'
cashFlowCharacteristic:
$ref: '#/components/schemas/CashFlowCashFlowCharacteristic'
CashFlowReportAck:
required:
- id
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
constraints:
$ref: '#/components/schemas/CashFlowReportConstraintsOut'
CashFlowReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
CashFlowReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
CashFlowTransactionAnalyticsAttributes:
description: Transaction Analytics Attributes
properties:
activityDepositsCreditsForTheReportTimePeriod:
description: >-
List of all deposit transactions posted to the account during the
report period
items:
$ref: '#/components/schemas/CashFlowActivityDepositsCredits'
type: array
activityWithdrawalsDebitsForTheReportTimePeriod:
description: >-
List of all withdrawal transactions posted to the account during the
report period
items:
$ref: '#/components/schemas/CashFlowActivityWithdrawalsDebits'
type: array
averageTransactionValueByMonthForTheReportTimePeriod:
description: >-
Average value of transactions during periods in the report. Values
may be positive or negative
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
historicWeeksWithZeroTransactions:
$ref: '#/components/schemas/CashFlowNumWeeksZeros'
lastTransactionDate:
description: >-
Latest posted transaction(s) to the account. May be more than one if
they share the same timestamp
items:
properties:
date:
description: Date the deposit transaction was posted
example: '2020-03-25'
type: string
depositsCredits:
description: 'Amount of transaction if deposit, otherwise null'
example: 500
type: number
withdrawalsDebits:
description:
'Amount of transaction if withdrawal, otherwise null'
example: 500
type: number
zeroAmountTransaction:
description: 'Amount of transaction if zero, otherwise null'
example: 0
type: number
transactionDescription:
description: Description of transaction
example: VENMO CASHOUT
type: string
required:
- date
type: object
type: array
netCashFlowByMonthForTheReportTimePeriod:
description: Net cash flow for each month during the report period
items:
$ref: '#/components/schemas/ObbDateRangeAndAmount'
type: array
netCashFlowForTheReportTimePeriod:
description:
Net cash flow during the report period (may be positive or negative)
example: 1544.94
type: number
required:
- averageTransactionValueByMonthForTheReportTimePeriod
- activityWithdrawalsDebitsForTheReportTimePeriod
- activityDepositsCreditsForTheReportTimePeriod
type: object
Categories:
type: string
description: |-
The different categories for transactions.
* "ATM Fee"
* "Advertising"
* "Air Travel"
* "Alcohol & Bars"
* "Allowance"
* "Amusement"
* "Arts"
* "Auto & Transport"
* "Auto Insurance"
* "Auto Payment"
* "Baby Supplies"
* "Babysitter & Daycare"
* "Bank Fee"
* "Bills & Utilities"
* "Bonus"
* "Books"
* "Books & Supplies"
* "Business Services"
* "Buy"
* "Cash & ATM"
* "Charity"
* "Check"
* "Child Support"
* "Clothing"
* "Coffee Shops"
* "Credit Card Payment"
* "Dentist"
* "Deposit"
* "Dividend & Cap Gains"
* "Doctor"
* "Education"
* "Electronics & Software"
* "Entertainment"
* "Eyecare"
* "Fast Food"
* "Federal Tax"
* "Fees & Charges"
* "Finance Charge"
* "Financial"
* "Financial Advisor"
* "Food & Dining"
* "Furnishings"
* "Gas & Fuel"
* "Gift"
* "Gifts & Donations"
* "Groceries"
* "Gym"
* "Hair"
* "Health & Fitness"
* "Health Insurance"
* "Hobbies"
* "Home"
* "Home Improvement"
* "Home Insurance"
* "Home Phone"
* "Home Services"
* "Home Supplies"
* "Hotel"
* "Income"
* "Interest Income"
* "Internet"
* "Investments"
* "Kids"
* "Kids Activities"
* "Late Fee"
* "Laundry"
* "Lawn & Garden"
* "Legal"
* "Life Insurance"
* "Loan Fees and Charges"
* "Loan Insurance"
* "Loan Interest"
* "Loan Payment"
* "Loan Principal"
* "Loans"
* "Local Tax"
* "Low Balance"
* "Mobile Phone"
* "Mortgage & Rent"
* "Movies & DVDs"
* "Music"
* "Newspapers & Magazines"
* "Office Supplies"
* "Parking"
* "Paycheck"
* "Personal Care"
* "Pet Food & Supplies"
* "Pet Grooming"
* "Pets"
* "Pharmacy"
* "Printing"
* "Property Tax"
* "Public Transportation"
* "Reimbursement"
* "Rental Car & Taxi"
* "Restaurants"
* "Sales Tax"
* "Sell"
* "Service & Parts"
* "Service Fee"
* "Shipping"
* "Shopping"
* "Spa & Massage"
* "Sporting Goods"
* "Sports"
* "State Tax"
* "Streaming Services"
* "Student Loan"
* "Taxes"
* "Television"
* "Toys"
* "Trade Commissions"
* "Transfer"
* "Transfer for Cash Spending"
* "Travel"
* "Tuition"
* "Uncategorized"
* "Utilities"
* "Vacation"
* "Veterinary"
* "Internet / Broadband Charges"
example: Streaming Service
Categorization:
required:
- normalizedPayeeName
- category
- country
type: object
properties:
normalizedPayeeName:
type: string
description: >-
A normalized payee, derived from the transaction's description and
memo fields
example: Mad Science Research
category:
$ref: '#/components/schemas/Categories'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
postalCode:
$ref: '#/components/schemas/ZipCode'
country:
$ref: '#/components/schemas/Country'
bestRepresentation:
description: >-
Combines the `description` and `memo` data together, removing
duplicated information and numbers and special characters
type: string
example: VERIZON WIRELESS PAYMENTS
description: Categorization Record
CertifiedInstitution:
required:
- name
- id
- oauthEnabled
- productionStatus
type: object
properties:
id:
$ref: '#/components/schemas/NumericInstitutionId'
name:
$ref: '#/components/schemas/InstitutionName'
transAgg:
$ref: '#/components/schemas/InstitutionTransAgg'
ach:
$ref: '#/components/schemas/InstitutionAch'
stateAgg:
$ref: '#/components/schemas/InstitutionStateAgg'
voi:
$ref: '#/components/schemas/InstitutionVoi'
voa:
$ref: '#/components/schemas/InstitutionVoa'
aha:
$ref: '#/components/schemas/InstitutionAha'
availBalance:
$ref: '#/components/schemas/InstitutionAvailableBalance'
accountOwner:
$ref: '#/components/schemas/InstitutionAccountOwner'
studentLoanData:
$ref: '#/components/schemas/StudentLoanDataCertification'
loanPaymentDetails:
$ref: '#/components/schemas/LoanPaymentDetailCertification'
liabilityData:
$ref: '#/components/schemas/LiabilityDataCertification'
billPayData:
$ref: '#/components/schemas/BillPayDataCertification'
oauthEnabled:
$ref: '#/components/schemas/InstitutionOauthEnabled'
productionStatus:
$ref: '#/components/schemas/InstitutionProductionStatus'
CertifiedInstitutionsWithRssd:
description:
A list of financial institutions from the Get Certified Institutions
with RSSD API
required:
- found
- displaying
- moreAvailable
- requestedDate
- institutions
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
requestedDate:
$ref: '#/components/schemas/UnixDate'
institutions:
description: A list of institutions
maxItems: 1000
minItems: 0
type: array
items:
allOf:
- $ref: '#/components/schemas/CertifiedInstitution'
- type: object
properties:
rssd:
$ref: '#/components/schemas/Rssd'
childInstitutions:
description: An array of child financial institutions
minItems: 0
type: array
items:
$ref: '#/components/schemas/ChildInstitution'
CertifiedInstitutions:
description:
A list of financial institutions from the Get Certified Institutions API
required:
- found
- displaying
- moreAvailable
- requestedDate
- institutions
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
requestedDate:
$ref: '#/components/schemas/UnixDate'
institutions:
description: A list of institutions
maxItems: 1000
minItems: 0
type: array
items:
$ref: '#/components/schemas/CertifiedInstitution'
ChildInstitution:
required:
- rssd
- parentRSSD
- name
- institutionId
type: object
properties:
rssd:
$ref: '#/components/schemas/Rssd'
parentRSSD:
$ref: '#/components/schemas/Rssd'
name:
$ref: '#/components/schemas/InstitutionName'
institutionId:
$ref: '#/components/schemas/NumericInstitutionId'
City:
type: string
description: City
example: Murray
ClassificationConfidenceScore:
type: number
description: The confidence score 0 โ 1.0 of the name classification.
example: 0.90
minimum: 0
maximum: 1.0
ConnectEmailParameters:
required:
- partnerId
- customerId
- consumerId
- email
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
consumerId:
$ref: '#/components/schemas/ConsumerId'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
institutionSettings:
$ref: '#/components/schemas/InstitutionSettings'
email:
$ref: '#/components/schemas/EmailOptions'
experience:
$ref: '#/components/schemas/Experience'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
fromDate:
$ref: '#/components/schemas/ConnectFromDate'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
optionalConsumerInfo:
$ref: '#/components/schemas/ConsumerInfo'
ConnectEmailUrl:
required:
- link
- emailConfig
type: object
properties:
link:
$ref: '#/components/schemas/ConnectLink'
emailConfig:
$ref: '#/components/schemas/EmailOptions'
ConnectFromDate:
type: integer
description: >-
The `fromDate` parameter is used when experiences are associated with a
credit decisioning report and any other reports with transaction data.
The value is in epoch time and must be 10 digits. Example: 1494449017.
If it's greater than 10 digits, then the `fromDate` is set to the credit
decisioning report's default `fromDate`.
For an experience that generates multiple reports, the `fromDate` gets
passed to the reports that support it.
However, Data Connect doesn't pass this parameter to the following
reports:
* Pay Statement Extraction Report
* VOIE - Paystub (with TXVerify) Report
* Statement Report
* Verification of Income Report
* VOIE - Payroll Report
Note: this field isn't used if you're only collecting transaction data
without a report.
format: int64
example: 1607450357
ConnectJointBorrowerEmailParameters:
required:
- partnerId
- borrowers
- email
- experience
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
borrowers:
$ref: '#/components/schemas/Borrowers'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
institutionSettings:
$ref: '#/components/schemas/InstitutionSettings'
email:
$ref: '#/components/schemas/EmailOptions'
experience:
$ref: '#/components/schemas/Experience'
fromDate:
$ref: '#/components/schemas/ConnectFromDate'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
ConnectJointBorrowerParameters:
required:
- partnerId
- borrowers
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
borrowers:
$ref: '#/components/schemas/Borrowers'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
institutionSettings:
$ref: '#/components/schemas/InstitutionSettings'
experience:
$ref: '#/components/schemas/Experience'
fromDate:
$ref: '#/components/schemas/ConnectFromDate'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
ConnectLanguage:
description: |
By default, the Data Connect application is in English. You don't need to pass this parameter unless
you want to translate Data Connect into one of our supported languages.
* Spanish (United States): `es`
* French (Canada): `fr`
type: string
example: 'es'
ConnectLink:
type: string
description: A generated Connect URL
example: >-
https://connect2.finicity.com?customerId=5025024821&institutionId=102105&origin=url&partnerId=2445583925753&signature=b5667164db7a9a0007b59267785c996ca3bc9ce97f2e72c98099cead76edfad9×tamp=1648050761908&ttl=1648057961908&type=lite&webhookContentType=application%2Fjson
ConnectParameters:
required:
- partnerId
- customerId
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
consumerId:
$ref: '#/components/schemas/ConsumerId'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
optionalConsumerInfo:
$ref: '#/components/schemas/ConsumerInfo'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
experience:
$ref: '#/components/schemas/Experience'
institutionSettings:
$ref: '#/components/schemas/InstitutionSettings'
fromDate:
$ref: '#/components/schemas/ConnectFromDate'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
isHostedInMobileApp:
$ref: '#/components/schemas/isHostedInMobileApp'
isWebView:
$ref: '#/components/schemas/IsWebView'
ConnectUrl:
description: A Connect URL object
required:
- link
type: object
properties:
link:
$ref: '#/components/schemas/ConnectLink'
ConnectTransferBillPaySwitchLink:
type: object
description: contains url to launch connect session
properties:
link:
type: string
description: web url to launch a connect session
example: 'https://connect2.finicity.com?customerId=6007761187&origin=url&partnerId=2445582695152&signature=f4d278f9d0b4a54f6bc2e71aa00607900365a2625bdb5bc9ca0eaec1c4158de8×tamp=1660164260516&ttl=1660171460516type=transferBillPaySwitch'
ConnectTransferDepositSwitchLink:
type: object
description: contains url to launch connect session
properties:
link:
type: string
description: web url to launch a connect session
example: 'https://connect2.finicity.com?customerId=6007761187&origin=url&partnerId=2445582695152&signature=f4d278f9d0b4a54f6bc2e71aa00607900365a2625bdb5bc9ca0eaec1c4158de8×tamp=1660164260516&ttl=1660171460516type=transferDepositSwitch'
ConsentReceiptId:
type: string
description: >-
Third party access key receipt ID. Generated by generate third party
access key API.
example: 'cr_4pfI3r1X8aOHrDDwrwC01NHFxOXlT1'
ConsumerDetails:
description: A Consumer Details for Re-Issue CRA Report.
type: object
properties:
id:
$ref: '#/components/schemas/ConsumerId'
firstName:
$ref: '#/components/schemas/FirstName'
middleName:
$ref: '#/components/schemas/MiddleName'
lastName:
$ref: '#/components/schemas/LastName'
address:
$ref: '#/components/schemas/AddressLine1'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
zip:
$ref: '#/components/schemas/ZipCode'
phone:
$ref: '#/components/schemas/PhoneNumber'
ssn:
$ref: '#/components/schemas/SocialSecurityNumberLastDigits'
email:
$ref: '#/components/schemas/EmailAddress'
Consumer:
description: A Mastercard Open Finance consumer record
required:
- id
- firstName
- lastName
- customerId
- address
- city
- state
- zip
- phone
- ssn
- birthday
- email
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/ConsumerId'
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
address:
$ref: '#/components/schemas/Address'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
zip:
$ref: '#/components/schemas/ZipCode'
phone:
$ref: '#/components/schemas/PhoneNumber'
ssn:
$ref: '#/components/schemas/SocialSecurityNumberLastDigits'
birthday:
$ref: '#/components/schemas/Birthday'
email:
$ref: '#/components/schemas/EmailAddress'
createdDate:
$ref: '#/components/schemas/UnixDate'
suffix:
$ref: '#/components/schemas/Suffix'
endUser:
$ref: '#/components/schemas/ConsumerEndUser'
ConsumerDateOfBirth:
type: integer
description: >-
The consumer's date of birth in Unix epoch time (in seconds). See:
Handling Epoch Dates and Times. The timestamp should be set at the start
of day of birth.
format: int64
example: 1607450357
ConsumerId:
type: string
description:
A consumer ID. See Create Consumer API for how to create a consumer ID.
example: 0bf46322c167b562e6cbed9d40e19a4c
ConsumerInfo:
description: The SSN and date of birth of a consumer
required:
- ssn
type: object
properties:
ssn:
$ref: '#/components/schemas/SocialSecurityNumberNoHyphens'
dob:
$ref: '#/components/schemas/ConsumerDateOfBirth'
ConsumerUpdate:
type: object
properties:
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
address:
$ref: '#/components/schemas/Address'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
zip:
$ref: '#/components/schemas/ZipCode'
phone:
$ref: '#/components/schemas/PhoneNumber'
ssn:
$ref: '#/components/schemas/SocialSecurityNumber'
birthday:
$ref: '#/components/schemas/Birthday'
email:
$ref: '#/components/schemas/EmailAddress'
suffix:
$ref: '#/components/schemas/Suffix'
endUser:
$ref: '#/components/schemas/ConsumerEndUser'
ConvertToRepayment:
type: integer
description: >-
(Student Loan) The date the loan enters into repayment. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
Country:
type: string
description:
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length
3).
example: USA
CreatedConsumer:
description: A consumer that was just created
type: object
properties:
id:
$ref: '#/components/schemas/ConsumerId'
createdDate:
$ref: '#/components/schemas/UnixDate'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
CreatedCustomer:
description: A new customer that was just enrolled
required:
- id
- username
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/CustomerId'
username:
$ref: '#/components/schemas/CustomerUsername'
createdDate:
$ref: '#/components/schemas/UnixDate'
CreatedTestTxPushTransaction:
required:
- id
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/TransactionId'
createdDate:
$ref: '#/components/schemas/UnixDate'
description: Response for TxPush test transaction
Currency:
type: string
description: A currency code
example: USD
Customer:
description: A finicity customer record
required:
- id
- username
- type
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/CustomerId'
username:
$ref: '#/components/schemas/CustomerUsername'
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
phone:
$ref: '#/components/schemas/PhoneNumber'
email:
$ref: '#/components/schemas/EmailAddress'
type:
$ref: '#/components/schemas/CustomerType'
createdDate:
$ref: '#/components/schemas/StringUnixDate'
lastModifiedDate:
$ref: '#/components/schemas/StringUnixDate'
CompositeScore:
type: integer
format: int32
minimum: 0
maximum: 100
description: |-
A risk score from 0-100 that indicates the likelihood of return risk, where a higher score indicates a higher likelihood of settlement or lower likelihood of return.
example: 6
CustomerAccount:
description: >-
An account represents a bank account such as a checking or savings that
the customer has added via the Connect interface.
required:
- id
- accountNumberDisplay
- name
- accountNickname
- number
- type
- status
- customerId
- institutionId
- createdDate
- currency
- institutionLoginId
type: object
properties:
id:
$ref: '#/components/schemas/AccountId'
number:
type: string
deprecated: true
description: |-
Account number provided by the financial institution. The format varies depending on the institution. Some digits may be masked. If an ACH number is needed, call the ACH endpoints.
Below is a non-exhaustive list of examples for the `number` field.
* 8089258
* 103275057=01
* 2000004444
example: '201940541'
accountNumberDisplay:
$ref: '#/components/schemas/AccountNumberDisplay'
realAccountNumberLast4:
$ref: '#/components/schemas/AccountNumberLast4'
name:
$ref: '#/components/schemas/Name'
balance:
type: number
description: The cleared balance of the account as of `balanceDate`
example: 401.26
type:
$ref: '#/components/schemas/AccountType'
aggregationStatusCode:
$ref: '#/components/schemas/AggregationStatusCode'
status:
$ref: '#/components/schemas/AggregationStatus'
customerId:
$ref: '#/components/schemas/CustomerId'
institutionId:
$ref: '#/components/schemas/InstitutionId'
balanceDate:
$ref: '#/components/schemas/CustomerAccountBalanceDate'
aggregationSuccessDate:
$ref: '#/components/schemas/CustomerAccountAggregationSuccessDate'
aggregationAttemptDate:
$ref: '#/components/schemas/CustomerAccountAggregationAttemptDate'
createdDate:
$ref: '#/components/schemas/CustomerAccountCreatedDate'
lastUpdatedDate:
$ref: '#/components/schemas/CustomerLastUpdatedDate'
marketSegment:
$ref: '#/components/schemas/CustomerAccountMarketSegment'
currency:
$ref: '#/components/schemas/Currency'
lastTransactionDate:
$ref: '#/components/schemas/CustomerAccountLastTransactionDate'
oldestTransactionDate:
$ref: '#/components/schemas/CustomerAccountOldestTransactionDate'
institutionLoginId:
$ref: '#/components/schemas/NumericInstitutionLoginId'
detail:
$ref: '#/components/schemas/CustomerAccountDetail'
position:
type: array
items:
$ref: '#/components/schemas/CustomerAccountPosition'
description: Investment holdings
displayPosition:
$ref: '#/components/schemas/DisplayPosition'
parentAccount:
$ref: '#/components/schemas/CustomerAccountParentAccountId'
linkedAccountDate:
$ref: '#/components/schemas/LinkedAccountDate'
CustomerAccountAggregationAttemptDate:
type: integer
description: >-
A timestamp showing the last aggregation attempt, whether successful or
not. This will not be present until you have run your first aggregation
for the account. A date in Unix epoch time (in seconds). See: [Handling
Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountAggregationSuccessDate:
type: integer
description: >-
A timestamp showing the last successful aggregation of the account. This
will not be present until you have run your first aggregation for the
account. A date in Unix epoch time (in seconds). See: [Handling Epoch
Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountBalanceDate:
type: integer
description: >-
A timestamp showing when the balance was captured by the FI. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountCreatedDate:
type: integer
description: >-
A timestamp showing when the account record was created. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerLastUpdatedDate:
type: integer
description: >-
A timestamp showing when the account was last modified. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountMarketSegment:
type: string
description:
'The market segment of the account. Possible values: personal, business'
example: personal
CustomerAccountDetail:
description: >-
Additional customer account details. Not all data points will return for
each account type. You can see the account type that each data point
will return for in descriptions. The data point are also subject to
availability by the institution.
type: object
properties:
dateAsOf:
$ref: '#/components/schemas/DateAsOf'
availableBalanceAmount:
type: number
description: >-
(Checking/Savings/CD/MoneyMarket) and (Mortgage/Loan) The available
balance (typically the current balance with adjustments for any
pending transactions)
example: 5678.78
openDate:
$ref: '#/components/schemas/OpenDate'
periodStartDate:
$ref: '#/components/schemas/PeriodStartDate'
periodEndDate:
$ref: '#/components/schemas/PeriodEndDate'
periodInterestRate:
type: number
description: >-
(Checking/Savings/CD/MoneyMarket) The APY for the current period
interest rate
example: 13.245
periodDepositAmount:
type: number
description:
(Checking/Savings/CD/MoneyMarket) Amount deposited in period
example: 2356.56
periodInterestAmount:
type: number
description: >-
(Checking/Savings/CD/MoneyMarket) Interest accrued during the
current period
example: 1234.56
interestYtdAmount:
type: number
description:
(Checking/Savings/CD/MoneyMarket) Interest accrued year-to-date
example: 1056.67
interestPriorYtdAmount:
type: number
description:
(Checking/Savings/CD/MoneyMarket) Interest earned in prior year
example: 3056.79
maturityDate:
$ref: '#/components/schemas/MaturityDate'
interestRate:
type: string
description: >-
(Credit Card/Line Of Credit) and (Mortgage/Loan) The account's
current interest rate
example: '15.789'
creditAvailableAmount:
type: number
description: >-
(Credit Card/Line Of Credit) The available credit (typically the
credit limit minus the current balance)
example: 3000
creditMaxAmount:
type: number
description: (Credit Card/Line Of Credit) The account's credit limit
example: 7000
cashAdvanceAvailableAmount:
type: number
description:
(Credit Card/Line Of Credit) Currently available cash advance
example: 2000
cashAdvanceMaxAmount:
type: number
description: (Credit Card/Line Of Credit) Maximum cash advance amount
example: 3000
cashAdvanceBalance:
type: number
description:
(Credit Card/Line Of Credit) Balance of current cash advance
example: 1000
cashAdvanceInterestRate:
type: number
description:
(Credit Card/Line Of Credit) Interest rate for cash advances
example: 21.5
currentBalance:
type: number
description:
(Credit Card/Line Of Credit) and (Investment) Current balance
example: 5789.34
paymentMinAmount:
type: number
description:
(Credit Card/Line Of Credit) and (Mortgage/Loan) Minimum payment due
example: 456.78
paymentDueDate:
$ref: '#/components/schemas/PaymentDueDate'
previousBalance:
type: number
description:
(Credit Card/Line Of Credit) Prior balance in last statement
example: 1234.56
statementStartDate:
$ref: '#/components/schemas/StatementStartDate'
statementEndDate:
$ref: '#/components/schemas/StatementEndDate'
statementPurchaseAmount:
type: number
description:
(Credit Card/Line Of Credit) Purchase amount of statement period
example: 2345.9
statementFinanceAmount:
type: number
description:
(Credit Card/Line Of Credit) Finance amount of statement period
example: 156.78
statementCreditAmount:
type: number
description:
(Credit Card/Line Of Credit) Credit amount applied in statement
period
example: 345
rewardEarnedBalance:
type: number
description: (Credit Card/Line Of Credit) Earned reward balance
format: float
example: 500.2
pastDueAmount:
type: number
description:
(Credit Card/Line Of Credit) and (Mortgage/Loan) Balance past due
example: 3688.99
lastPaymentAmount:
type: number
description: >-
(Credit Card/Line Of Credit) and (Mortgage/Loan) The amount received
in the last payment
example: 567.89
lastPaymentDate:
$ref: '#/components/schemas/LastPaymentDate'
statementCloseBalance:
type: number
description:
(Credit Card/Line Of Credit) Balance of statement at close
example: 2456.69
termOfMl:
type: string
description: (Mortgage/Loan) Length of loan in months
example: '36'
mlHolderName:
type: string
description: (Mortgage/Loan) Holder of the mortgage or loan
example: John Smith
description:
type: string
description: (Mortgage/Loan) Description of loan
example: a description
lateFeeAmount:
type: number
description: (Mortgage/Loan) Late fee charged
example: 35
payoffAmount:
type: number
description: (Mortgage/Loan) The amount required to payoff the loan
example: 45567.98
payoffAmountDate:
$ref: '#/components/schemas/PayoffAmountDate'
originalMaturityDate:
$ref: '#/components/schemas/OriginalMaturityDate'
principalBalance:
type: number
description: (Mortgage/Loan) The principal balance
example: 45056.7
escrowBalance:
type: number
description: (Mortgage/Loan) The escrow balance
example: 2345.01
interestPeriod:
type: string
description: (Mortgage/Loan) Period of interest
example: monthly
initialMlAmount:
type: number
description: (Mortgage/Loan) Original loan amount
example: 65000
initialMlDate:
$ref: '#/components/schemas/InitialMlDate'
nextPaymentPrincipalAmount:
type: number
description: (Mortgage/Loan) Amount towards principal in next payment
example: 1256.67
nextPaymentInterestAmount:
type: number
description: (Mortgage/Loan) Amount of interest in next payment
example: 234.56
nextPayment:
type: number
description: (Mortgage/Loan) Minimum payment due
example: 1578
nextPaymentDate:
$ref: '#/components/schemas/NextPaymentDate'
lastPaymentDueDate:
$ref: '#/components/schemas/LastPaymentDueDate'
lastPaymentReceiveDate:
$ref: '#/components/schemas/LastPaymentReceiveDate'
lastPaymentPrincipalAmount:
type: number
description: (Mortgage/Loan) Amount towards principal in last payment
example: 1256.67
lastPaymentInterestAmount:
type: number
description: (Mortgage/Loan) Amount of interest in last payment
example: 234.56
lastPaymentEscrowAmount:
type: number
description: (Mortgage/Loan) Amount towards escrow in last payment
example: 456.78
lastPaymentLastFeeAmount:
type: number
description: (Mortgage/Loan) Amount of last fee in last payment
example: 150
lastPaymentLateCharge:
type: number
description: (Mortgage/Loan) Amount of late charge in last payment
example: 50
ytdPrincipalPaid:
type: number
description: (Mortgage/Loan) Principal paid year-to-date
example: 5432.01
ytdInterestPaid:
type: number
description: (Mortgage/Loan) Interest paid year-to-date
example: 3948.56
ytdInsurancePaid:
type: number
description: (Mortgage/Loan) Insurance paid year-to-date
example: 1345.89
ytdTaxPaid:
type: number
description: (Mortgage/Loan) Tax paid year-to-date
example: 1489
autoPayEnrolled:
type: string
description: (Mortgage/Loan) Enrolled in autopay (T/F or Y/N).
example: Y
marginAllowed:
type: boolean
description: Margin trading indicator (true / false)
example: true
cashAccountAllowed:
type: boolean
description: Cash account allowed indicator (true / false)
example: true
collateral:
type: string
description: (Mortgage/Loan) Collateral on loan
example: nissan sentra
currentSchool:
type: string
description: (Mortgage/Loan) Current school
example: utah valley university
firstPaymentDate:
$ref: '#/components/schemas/FirstPaymentDate'
firstMortgage:
type: boolean
description: (Mortgage/Loan) First mortgage (F/Y)
example: true
loanPaymentFreq:
type: string
description: '(Mortgage/Loan) Frequency of payments (monthly, etc.)'
example: monthly
originalSchool:
type: string
description: (Mortgage/Loan) Original school
example: Brigham young university
recurringPaymentAmount:
type: number
description: (Mortgage/Loan) Recurring payment amount
example: 456.23
lender:
type: string
description: (Mortgage/Loan) Owner of loan
example: utah community credit union
endingBalanceAmount:
type: number
description: (Mortgage/Loan) Ending balance
example: 234789.45
loanTermType:
type: string
description: (Mortgage/Loan) Type of loan term
example: fixed
paymentsMade:
type: integer
description: (Mortgage/Loan) Number of payments made
format: int32
example: 14
balloonAmount:
type: number
description: (Mortgage/Loan) Balloon payment amount
example: 1678.56
projectedInterest:
type: number
description: (Mortgage/Loan) Projected interest on the loan
example: 10456.78
interestPaidLtd:
type: number
description:
(Mortgage/Loan) Interest paid since inception of loan (life to date)
example: 56789.34
interestRateType:
type: string
description: (Mortgage/Loan) Type of interest rate
example: variable
loanPaymentType:
type: string
description: (Mortgage/Loan) Type of loan payment
example: principle
repaymentPlan:
type: string
description:
(Mortgage/Loan) Type of repayment plan for the student loan
example: 'Standard, Graduated, Extended, Pay As You Earn, and more.'
paymentsRemaining:
type: integer
description:
(Mortgage/Loan) Number of payments remaining before loan is paid off
format: int32
example: 45
marginBalance:
type: number
description:
(Investment) Net interest earned after deducting interest paid out
example: 456
shortBalance:
type: number
description: (Investment) Sum of short balance
example: 12456.89
availableCashBalance:
type: number
description: (Investment) Amount available for cash withdrawal
example: 3456.78
maturityValueAmount:
type: number
description: (Investment) amount payable to an investor at maturity
example: 34067.78
vestedBalance:
type: number
description: (Investment) Vested amount in account
example: 45000
empMatchAmount:
type: number
description: (Investment) Employer matched contributions
example: 256.99
empPretaxContribAmount:
type: number
description: (Investment) Employer pretax contribution amount
example: 450
empPretaxContribAmountYtd:
type: number
description:
(Investment) Employer pretax contribution amount year to date
example: 700
contribTotalYtd:
type: number
description: (Investment) Total year to date contributions
example: 2045
cashBalanceAmount:
type: number
description: (Investment) Cash balance of account
example: 2000
preTaxAmount:
type: number
description: (Investment) Pre-tax amount of total balance
example: 78564.99
afterTaxAmount:
type: number
description: (Investment) After-tax amount of total balance
example: 68564.99
matchAmount:
type: number
description: (Investment) Amount matched
example: 378
profitSharingAmount:
type: number
description: (Investment) Amount of balance for profit sharing
example: 34678.89
rolloverAmount:
type: number
description: >-
(Investment) Amount of balance rolled over from original account
(401k, etc.)
example: 101234.67
otherVestAmount:
type: number
description: (Investment) Other vested amount
example: 34000
otherNonvestAmount:
type: number
description: (Investment) Other nonvested amount
example: 26000
currentLoanBalance:
type: number
description: (Investment) Current loan balance
example: 345789.23
loanRate:
type: number
description: (Investment) Interest rate of loan
example: 3.275
buyPower:
type: number
description: (Investment) Money available to buy securities
example: 34567.89
rolloverLtd:
type: number
description: (Investment) Life to date of money rolled over
example: 23456.78
loanAwardId:
type: string
description: (Student Loan) The federal unique loan identifying number
example: '1234568'
originalInterestRate:
type: number
description: >-
(Student Loan) The original interest rate to which the loan was
disbursed, in APY
example: 12
guarantor:
type: string
description: >-
(Student Loan) The financial institution guarantor of the loan (who
will pay the loan amount to the owner if the borrower defaults)
example: FinBank
owner:
type: string
description: (Student Loan) Owner of the loan
example: FinBank
interestSubsidyType:
type: string
description: >-
(Student Loan) The indication of the presence of an interest subsidy
(i.e. subsidized)
example: Subsidy type
interestBalance:
type: number
description: (Student Loan) The total outstanding interest balance
example: 2000
remainingTermOfMl:
type: number
description:
(Student Loan) The number of months still outstanding on a loan
example: 2
initialInterestRate:
type: number
description: (Student Loan) Initial interest rate of loan
example: 34567.89
feesBalance:
type: number
description: (Student Loan) The total outstanding fees balance
example: 150
loanYtdInterestPaid:
type: number
description: (Student Loan) Loan interest paid year-to-date
example: 5623.23
loanYtdFeesPaid:
type: number
description: (Student Loan) Loan fees paid year-to-date
example: 5621.23
loanYtdPrincipalPaid:
type: number
description: (Student Loan) Loan principal paid year-to-date
example: 5621.23
loanStatus:
type: string
description: >-
(Student Loan) The repayment status phase (i.e. In School, Grace,
Repayment, Deferment, Forbearance)
example: Deferment
loanStatusStartDate:
$ref: '#/components/schemas/LoanStatusStartDate'
loanStatusEndDate:
$ref: '#/components/schemas/LoanStatusEndDate'
weightedInterestRate:
type: number
description: >-
(Student Loan) The interest rate of multiple interest rates and
balances at the group level, in APY
example: 12
repaymentPlanStartDate:
$ref: '#/components/schemas/RepaymentPlanStartDate'
repaymentPlanEndDate:
$ref: '#/components/schemas/RepaymentPlanEndDate'
expectedPayoffDate:
$ref: '#/components/schemas/ExpectedPayoffDate'
outOfSchoolDate:
$ref: '#/components/schemas/OutOfSchoolDate'
convertToRepayment:
$ref: '#/components/schemas/ConvertToRepayment'
daysDelinquent:
type: integer
description: >-
(Student Loan) The number of days past a due date that a payment
should have been made
format: int32
example: 5
totalPrincipalPaid:
type: number
description:
(Mortgage/Loan/Student Loan) The total amount paid towards the
principal balance
example: 15000
totalInterestPaid:
type: number
description:
(Mortgage/Loan/Student Loan) The total amount paid towards interest
example: 1125
totalAmountPaid:
type: number
description: (Student Loan) The total amount paid
example: 16125
statementCloseDate:
$ref: '#/components/schemas/StatementCloseDate'
loanTypeDesc:
type: string
description: (Mortgage/Loan) Description of the mortgage or loan type
example: Conventional 30-Year Mortgage
CustomerAccountLastTransactionDate:
type: integer
description: >-
The date of the latest transaction on the account. This will not be
present until you have run your first aggregation for the account. A
date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountOldestTransactionDate:
type: integer
description: >-
The date of the oldest transaction in the transactions for the account.
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
CustomerAccountParentAccountId:
type: string
description: >-
The assigned account ID for the account one level higher in the student
loan account hierarchy
example: '5011648377'
CustomerAccountPosition:
description: Details for investment account holdings
type: object
properties:
id:
type: integer
description: The ID of the investment position
format: int64
example: 454678080
description:
type: string
description: The description of the holding
example: DELTA AIR LINES INC
symbol:
type: string
description: The investment position's market ticker symbol
example: DAL
units:
type: number
description: The number of units of the holding
example: 6.537
currentPrice:
type: number
description: The current price of the investment holding
example: 41.585
securityName:
type: string
description: The security name for the investment holding
example: DELTA AIR LINES INC
transactionType:
type: string
description:
'The transaction type of the holding, such as cash, margin, and more'
example: Margin
marketValue:
type: number
description:
Market value of an investment position at the time of retrieval
example: 271.84
changePercent:
type: number
description: The percent change in value since the previous day
example: 170.02
dailyChange:
type: number
description: The value amount change since the previous day
example: 180.03
costBasis:
type: number
description: The total cost of acquiring the security
example: 190.01
holdType:
type: string
description: The type of the holding
example: INVESTMENT
invSecurityType:
type: string
description: The security type for the investment holding
example: OTHERINFO
status:
type: string
description: The status of the holding
example: A
currentPriceDate:
$ref: '#/components/schemas/UnixDate'
securityType:
type: string
description: Type of security for the investment position
example: Stock
mfType:
type: string
description: 'Type of mutual fund, such as open ended'
example: OPENEND
posType:
type: string
description: Fund type assigned by the FI (long or short)
example: Long
totalGLDollar:
type: number
description: >-
Total gain and loss of the position at the time of aggregation in
dollars
example: 162742.9
totalGLPercent:
type: number
description: >-
Total gain and loss of the position at the time of aggregation in
percentage
example: 68.89
optionStrikePrice:
type: number
description: The strike price of the option contract
example: 50
optionType:
type: string
description: The type of option contract (PUT or CALL)
example: PUT
optionSharesPerContract:
type: number
description: The number of shares per option contract
example: 100
optionExpireDate:
type: string
description: Expiration date of option
format: date
example: '1644994800'
fiAssetClass:
type: string
description: >-
Financial Institution (FI) defined asset class (COMMON STOCK,
COMNEQTY, EQUITY/STOCK, CMA-ISA, CONVERTIBLE PREFERREDS, CORPORATE
BONDS, OTHER MONEY FUNDS, ALLOCATION FUNDS, CMA-TAXABLE,
FOREIGNEQUITYADRS, COMMONSTOCK, PREFERRED STOCKS, STABLE VALUE,
FOREIGN EQUITY ADRS)
example: COMNEQTY
assetClass:
type: string
description: >-
An asset class is a grouping of comparable financial securities.
These include equities (stocks), fixed income (bonds), and cash
equivalent or money market instruments. (DOMESTICBOND, LARGESTOCK,
INTLSTOCK, MONEYMRKT, OTHER)
example: INTLSTOCK
currencyRate:
type: number
description: 'Currency rate, ratio of currency to original currency'
example: 1
securityId:
type: string
description: The security ID of the transaction
example: 25400W102
securityIdType:
$ref: '#/components/schemas/SecurityIdType'
costBasisPerShare:
type: number
description: The per share cost of acquiring the security
example: 13.38
subAccountType:
type: string
description: "The subaccount's type, such as cash"
example: CASH
securityCurrency:
type: string
description:
Symbol for the currency that the account is being converted into
example: USD
todayGLDollar:
type: number
description: >-
The current day's gain and loss of the position at the time of
aggregation in dollars
example: 16272.9
todayGLPercent:
type: number
description: >-
The current day's gain and loss of the position at the time of
aggregation in percentage
example: 18.89
CustomerAccountSimple:
description: >-
An account represents a bank account such as a checking or savings that
the customer has added via the Connect interface.
required:
- id
- accountNumberDisplay
- name
- type
- status
- customerId
- institutionId
- createdDate
- currency
- institutionLoginId
type: object
properties:
id:
$ref: '#/components/schemas/AccountId'
accountNumberDisplay:
$ref: '#/components/schemas/AccountNumberDisplay'
name:
$ref: '#/components/schemas/Name'
type:
$ref: '#/components/schemas/AccountType'
aggregationStatusCode:
$ref: '#/components/schemas/AggregationStatusCode'
status:
$ref: '#/components/schemas/AggregationStatus'
customerId:
$ref: '#/components/schemas/CustomerId'
institutionId:
$ref: '#/components/schemas/InstitutionId'
aggregationSuccessDate:
$ref: '#/components/schemas/UnixDate'
aggregationAttemptDate:
$ref: '#/components/schemas/UnixDate'
createdDate:
$ref: '#/components/schemas/UnixDate'
currency:
$ref: '#/components/schemas/Currency'
institutionLoginId:
$ref: '#/components/schemas/NumericInstitutionLoginId'
displayPosition:
$ref: '#/components/schemas/DisplayPosition'
parentAccount:
$ref: '#/components/schemas/AccountId'
linkedAccountDate:
$ref: '#/components/schemas/LinkedAccountDate'
CustomerAccounts:
description: A list of customer accounts
required:
- accounts
type: object
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/CustomerAccount'
description: List of customer accounts
CustomerAccountsSimple:
description: A list of accounts with basic information of a customer
required:
- accounts
type: object
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/CustomerAccountSimple'
description: A list of accounts with basic information of a customer
CustomerAnalytics:
type: object
required:
- transactionalAttributes
- stateAttributes
- streams
description: Analytics and attributes generated at a customer level
properties:
transactionalAttributes:
description: List of calculated transactional attributes
items:
$ref: '#/components/schemas/TransactionalAttribute'
type: array
stateAttributes:
description: List of calculated state attributes
items:
$ref: '#/components/schemas/StateAttribute'
type: array
streams:
description: List of generated streams
items:
$ref: '#/components/schemas/StreamModel'
type: array
CustomerId:
type: string
description:
A customer ID. See Add Customer API for how to create a customer ID.
example: '1005061234'
ExternalId:
type: string
description:
An external ID that was shared by the partner to distinguish switches.
For example, BranchID.
example: 'b73af28c-0878djs3'
CustomerType:
type: string
description:
The type of customer ("active" or "testing" or "" for all types)
example: active
CustomerUpdate:
description: Represent an update to customer fields
type: object
properties:
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
CustomerUsername:
type: string
description: >-
The customer's username, assigned by the partner (a unique identifier),
following these rules: minimum 6 characters maximum 255 characters any
mix of uppercase, lowercase, numeric, and non-alphabet special
characters ! @ . # $ % & * _ - + the use of email in this field is
discouraged it is recommended to use a unique non-email identifier. Use
of special characters may result in an error (e.g. รญ, รผ, etc.).
Usernames are unique. A username used in Test Drive can't be reused in
other plans.
example: customerusername1
CustomerWithAppData:
description: A finicity customer record with application info
required:
- id
- username
- firstName
- lastName
- type
- createdDate
- applicationId
- applicationName
allOf:
- $ref: '#/components/schemas/Customer'
- type: object
properties:
applicationId:
$ref: '#/components/schemas/ApplicationId'
applicationName:
$ref: '#/components/schemas/ApplicationName'
Customers:
description: A list of customers
required:
- displaying
- moreAvailable
- customers
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
customers:
type: array
items:
$ref: '#/components/schemas/Customer'
description: A list of customer records
DateAsOf:
type: integer
description: >-
(All Account Types) Most recent date of the following information. A
date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
DateTimeWithZone:
type: string
format: date-time
description: A date-time with time zone
example: '2022-03-10T06:06:20.042584549Z'
DecimalNumber:
type: number
format: float
description: Decimal number
example: 0.12
Deduction:
type: object
properties:
name:
type: string
description: >-
The normalized category of the deductions in the format
[type][number]. The number is the will be the iterating number of
the type's occurrence starting at one.
example: '401'
description:
type: string
description: The deduction line's deduction type description
example: 401k
amountCurrent:
type: number
description: >-
The amount for the deduction line deducted from employee's pay for
the specified pay period
example: 1744.61
amountYTD:
type: number
description: >-
The amount for the deduction line being deducted from the employee's
pay for the current pay year
example: 1744.6
type:
type: string
description: Categorization based on the deduction line's description
example: 401 Deductions
Deductions:
required:
- type
- amount
type: object
properties:
type:
type: string
description: >
Deduction types:
* `Federal tax`: Federal tax withholdings
* `State tax`: State tax withholdings
* `Local tax`: Local tax withholdings
* `Social security tax`: Social security tax withholdings
* `Medicare tax`: Medicare withholdings
* `SUI SDI VPDI tax`: SUI SDI VPDI tax
* Retirement deductions: Retirement withholdings
* `Benefit deductions`: Medical/Health benefits withholdings (i.e.
medical, dental, vision, insurance)
* `Garnishment deductions`: Garnishment withholdings, (i.e.
bankruptcy, student loan, state garnishments, tax levy garnishments,
child support)
* `Other deductions`: Other withholdings, includes any other
uncommon withholdings, pension plan, stock plans, etc.
example: State tax
amount:
type: number
description: Amount associated with deduction
example: 4.28
DirectDeposit:
type: object
properties:
fiName:
type: string
description: The name of the institution
example: FinBank
accountTypeCode:
type: string
description: >
Bank account type:
* `Checking`
* `Savings`
* `Loan`: Loan account employee choose to direct a portion of their
net pay to help pay off a loan
example: Savings
accountTypeName:
type: string
description: The name of the Account
example: Checking
description:
type: string
description: Description of deposit
example: Payroll
amount:
type: number
description: Direct deposit amount
example: 12.34
accountLastFour:
type: string
description: Last four digits of the deposit account number
example: 3337
routingNumber:
type: string
description: Routing number for the deposit account
example: 30207583
DirectDeposits:
type: object
properties:
accountTypeCode:
type: string
description: >
Bank account type:
* `Checking`
* `Savings`
* `Loan`: Loan account employee choose to direct a portion of their
net pay to help pay off a loan
example: Savings
amount:
type: number
description: Direct deposit amount
example: 12.34
accountLastFour:
type: string
description: Last four digits of the deposit account number
example: 3337
routingNumber:
type: string
description: Routing number for the deposit account
example: 30207583
DirectPayStatements:
required:
- payrollPayHistoryId
- lastPayPeriodIndicator
- mainPayStatementFields
- earnings
type: object
properties:
payrollPayHistoryId:
type: string
description:
An ID for the income and employment details for the given pay period
example: qsrt2hmjnf
lastPayPeriodIndicator:
type: boolean
description: Most recent available pay check
example: true
mainPayStatementFields:
$ref: '#/components/schemas/MainPayStatementFields'
earnings:
type: array
items:
$ref: '#/components/schemas/Earnings'
description: 'Categorization of pay, for the pay period'
deductions:
type: array
items:
$ref: '#/components/schemas/Deductions'
description: Deductions from the pay check
DisplayPosition:
type: integer
description: |-
Display position of the account at the financial institution, "1"
being the top listed account
format: int32
example: 2
DisplayingResults:
type: integer
description: The number of results returned
example: 1
Earnings:
required:
- type
- amount
type: object
properties:
name:
type: string
description:
'Where available, the employer description of earnings on the
paycheck'
example: bonusPayAmount
type:
type: string
description: |
Categorization of the earnings:
* `base`
* `bonus`
* `overtime`
* `commission`
* `tips`
* `other`
example: bonus
rate:
type: number
description: Rate of pay
example: 19
amount:
type: number
description: Earnings amount for each earning type
example: 589
amountYTD:
type: number
description: Earnings YTD amount if available
example: 14301.25
EmailAddress:
type: string
description: An email address
example: myname@mycompany.com
EmailDomainCreationDate:
type: string
description: Returns a date that the email domain was created.
example: '2011-06-29T00:00:00.000Z'
EmailFirstSeenDays:
type: number
description: >-
Count of days since the email was first observed in Ekata's Identity
Network. If the email has not been observed before, first_seen_days will
be 0.
example: 453
EmailOptions:
description: Configuration for the Data Connect email's sent to customers
required:
- to
type: object
properties:
to:
type: string
description:
The email address for the customer receiving the Data Connect email
example: bob@example.com
from:
type: string
description:
The name of a person or business sending the Data Connect email
example: test.lender@test.com
supportPhone:
type: string
description: The support phone number listed in the email
example: 800-555-5555
subject:
type: string
description: >-
The subject line of the email. The default is "Verify your Financial
Information".
example: Verify your income
firstName:
type: string
description: >-
The first name of the customer or both names of the customers for
joint borrowers. Example: "Marvin and Jenny".
example: Bob
institutionName:
type: string
description: The name of your company
example: Acme Lending
institutionAddress:
type: string
description:
The institution address to appear in the footer of the email
example: '222 Winnipeg Drive SLC UT, 84109'
signature:
type: array
items:
type: string
description: A signature for the email
example:
- Cindy Mayfield
- Senior Loan Officer
- Direct 123-456-7890
EmailToName:
type: string
description: |-
The match status between the input name and the queried entity.
* not found
* match
* no-match
example: not found
EmailRisk:
type: number
description: >-
Email Risk Score assesses the risk level of an email address by
leveraging features from our Identity Graph and Identity Network. It
provides the strongest indicator of a high-risk email.
example: 0.8
RequestRefId:
type: string
description: >-
The generated unique web transaction identifier.
example: be3ad617-04ad-43e1-a438-79425b6511b6
EmailValid:
type: boolean
description: True if the email address is valid.
example: true
Employee:
type: object
properties:
name:
type: string
description: The name of the employee
example: Patrick Purchaser
address1:
type: string
description:
Employee address as stated by the employer in the payroll system
example: Address 1
address2:
type: string
description:
Employee address as stated by the employer in the payroll system
example: Address 2
city:
type: string
description:
Employee city as stated by the employer in the payroll system
example: City
state:
type: string
description:
Employee state as stated by the employer in the payroll system
example: TX
zip:
type: string
description:
Employee zip code as stated by the employer in the payroll system
example: '99999'
Employer:
type: object
properties:
name:
type: string
description: The name of the employer
example: Rocket Surgery
address1:
type: string
description:
Employer address as stated by the employer in the payroll system
example: Address 1
address2:
type: string
description:
Employer address as stated by the employer in the payroll system
example: Address 2
city:
type: string
description:
Employer city as stated by the employer in the payroll system
example: City
state:
type: string
description:
Employer state as stated by the employer in the payroll system
example: TX
zip:
type: string
description:
Employer zip code as stated by the employer in the payroll system
example: '99999'
EmployerName:
type: string
description:
Name of the employer as stated by the employer in the payroll system
example: ACME INC
ErrorMessage:
required:
- code
type: object
properties:
code:
type: object
description: >-
An error code (can be returned as a number or a string). Useful
links: [Common API Status
Codes](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/#common-api-status-codes),
[Aggregation Status
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manage/account-aggregation/#aggregation-status-codes).
example: '10001'
status:
type: string
description: A status code
example: '401'
title:
type: string
description: A title for the error
example: Connecting accounts error
level:
type: string
description: An error level
example: error
message:
type: string
description: An error message
example: Invalid authorization credentials
user_message:
type: string
description: Some more details about the error
example: The session has expired or is invalid
assetId:
$ref: '#/components/schemas/AssetId'
accountId:
$ref: '#/components/schemas/AccountId'
externalTransactionId:
type: string
description:
A unique identifier for the transaction that assists in linking data
back to your systems.
example: 'MAC1005061234'
minLength: 1
maxLength: 100
tags:
type: string
description: Categories that the error belongs to
example: AGG
EstimateInclusion:
description: 'Possible values: "HIGH", "MODERATE", "LOW", "NO"'
type: string
example: HIGH
ExcludeEmpInfo:
type: boolean
description: >-
Only used on an exception basis for clients that need to exclude EmpInfo
data from the VOE-Payroll or VOIE-Payroll report. If true is passed
EmpInfo payroll provider's data will not be searched or returned.
example: false
ExpectedPayoffDate:
type: integer
description: >-
(Student Loan) The expected date of the payoff date. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
Card:
type: object
description: Structure of the user card
required:
- title
- number
- expiry
- cvv
properties:
title:
type: string
description: The user title for the card in use
example: 'Mastercard super card'
number:
type: string
description:
The card number used for bill payment. Should be between 15-19
digits
example: '4242424242424242'
minLength: 15
maxLength: 19
expiry:
type: string
description: The expiry date for the card in mm/yy format
example: '12/27'
cvv:
type: string
description: The CVV / CVC number associated to the card
example: '123'
minLength: 3
maxLength: 4
brand:
type: string
description:
The Brand of card in use. Possible values include mastercard, visa,
american-express, or discover.
example: 'Mastercard'
Experience:
type: string
description: >-
The `experience` field allows you to customize:
* Brand: color and logo
* Icon: displayed on the "Share your data" page
* Popular institutions: displayed on the Bank Search page
* Report: the credit decisioning report to send when Data Connect
completes.
* MVS modules: financial, payroll, paystub
Note: the Finicity sales engineers (SE) help you set up a default
experience for your company. For each additional experience you create
thereafter, they'll give you a unique ID. See [Configure the Connect
Experience](https://developer.mastercard.com/open-finance-us/documentation/connect/configure-connect-experience/).
Experience values options:
* "default": your default experience (must be defined)
* GUID: the code for a different experience
* Not defined: If you don't pass the experience parameter, then
Connect's out of the box default experience (add accounts but no
branding) is used, and the MVS modules will not run.
example: default
TransferExperience:
type: string
description: >-
The `experience` field allows you to customize:
* To toggle landing screen visibility
Note: the Finicity sales engineers (SE) help you set up a default
experience for your company. For each additional experience you
create
thereafter, they'll give you a unique ID. See [Configure the
Connect
Experience](https://developer.mastercard.com/open-finance-us/documentation/connect/configure-connect-experience/).
Experience values options:
* "default": your default experience (must be defined)
* GUID: the code for a different experience
example: '03099618-8a28-41f6-b891-83af336626d6'
ExtractDeductions:
type: boolean
description:
Field to indicate whether to extract the deductions on all pay
statements
default: false
example: true
ExtractDirectDeposit:
type: boolean
description: >-
Field to indicate whether to extract the direct deposits on all pay
statements
default: true
example: true
ExtractEarnings:
type: boolean
description:
Field to indicate whether to extract the earnings on all pay statements
default: true
example: true
FirstName:
type: string
description: The first name of the account holder
example: John
FirstPaymentDate:
type: integer
description: >-
(Mortgage/Loan) First payment due date. A date in Unix epoch time (in
seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
FixConnectParameters:
required:
- partnerId
- customerId
- institutionLoginId
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
institutionLoginId:
$ref: '#/components/schemas/InstitutionLoginId'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
experience:
$ref: '#/components/schemas/Experience'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
isHostedInMobileApp:
$ref: '#/components/schemas/isHostedInMobileApp'
isWebView:
$ref: '#/components/schemas/IsWebView'
FoundResults:
type: integer
description: The total number of results matching search criteria
example: 200
GovernmentId:
type: string
description: |-
A federal or state issued identification number in alphanumeric characters.
* **United States**:
* Passport: 6-9 digits.
* US Visa: 8 digits.
* Driver's license: 1-19 digits
* **Canada**:
* Passport: 8 digits
* Driver: 6-9 digits
example: '123456789'
GseEnabled:
type: boolean
description: >-
Mastercard Open Finance internal use only to flag reports that should
not be retrieved by the GSE's (Government-Sponsored Enterprise).
This is a mandatory field for VOE-payroll and VOIE-payroll report types.
example: true
IdentityRiskScore:
type: number
description: >-
Comprehensive identity risk score with a higher score indicating a
riskier account sign-up.
example: 275
Indicator:
type: object
properties:
potentialSettlementDate:
$ref: '#/components/schemas/PotentialSettlementDate'
compositeScore:
$ref: '#/components/schemas/CompositeScore'
scoreIndicator:
$ref: '#/components/schemas/ScoreIndicator'
reasons:
$ref: '#/components/schemas/ReasonItem'
required:
- potentialSettlementDate
- compositeScore
- scoreIndicator
- reasons
IndicatorsByDay:
type: array
description:
An Array of 3-10 days, providing the potentialSettlementDate,
compositeScore, scoreIndicator, and reasons.
items:
$ref: '#/components/schemas/Indicator'
minItems: 3
maxItems: 10
PaymentSuccessIndicator:
type: object
properties:
code:
type: string
description: PSI error code for this scenario
example: '10001'
message:
type: string
description: Detailed reason about the source of the error
example: Account Error - use different account
customerId:
$ref: '#/components/schemas/CustomerId'
accountId:
$ref: '#/components/schemas/AccountId'
payReqId:
type: string
description:
The unique ID that represents the response generated for that
specific, customer, account, and transaction.
example: '453752752892280957'
settleByDate:
$ref: '#/components/schemas/SettleByDate'
settlementAmount:
$ref: '#/components/schemas/SettlementAmount'
availableBalance:
type: number
description: >-
The available balance provided, by the consumerโs financial
institution, at the time of the request.
example: 315.01
indicatorsByDay:
$ref: '#/components/schemas/IndicatorsByDay'
required:
- customerId
- accountId
- payReqId
- settleByDate
- settlementAmount
- availableBalance
- indicatorsByDay
ReasonItem:
type: object
description:
A collection of 8 reason codes, with a score ranging from 0-100, that
explains the drivers that caused the score.
properties:
recentBalance:
description: Evaluates the available balance in an account.
type: integer
minimum: 0
maximum: 100
example: 78
balanceHistory:
description: Evaluates balance trends in the account.
type: integer
minimum: 0
maximum: 100
example: 23
nsfHistory:
description: Evaluates the number of NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 40
recentNsfHistory:
description: Evaluates the recent NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 34
recurringNsf:
description:
Evaluates the frequency of NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 34
spendHistory:
description: Evaluates the trends in spend activity in the account.
type: integer
minimum: 0
maximum: 100
example: 44
depositHistory:
description:
Evaluates the trends of the consumer's permissioned account deposit
over a period of time.
type: integer
minimum: 0
maximum: 100
example: 10
transactionAmount:
description: Evaluates the settlementAmount.
type: integer
minimum: 0
maximum: 100
example: 65
required:
- balanceHistory
- depositHistory
- nsfHistory
- recentBalance
- recentNsfHistory
- recurringNsf
- spendHistory
- transactionAmount
PotentialSettlementDate:
type: string
format: date
description: The date for all days included in the response.
example: '2023-03-30'
SettleByDate:
type: string
format: date
description: |-
The expected date that the funds, from the consumerโs account, will be moved to the receiving account.
`settleByDate` in ISO 8601 date format (YYYY-MM-DD).
`settleByDate` dictates the number of days the model responds with. The response can range from 3-10 days, including `day0`. Details explained below:
1. If `settleByDate` is 9 or more days out from today, the response includes 10 days of data, `day0` through `day9`.
2. If `settleByDate` is between 3 and 8 days out from today, the response includes 4-9 days of data, `day3-8`.
3. If `settleByDate` is between today and 2 days out from today, the response includes 3 days of data, `day0` through `day2`.
example: '2023-03-30'
PayRequestId:
description: Unique identifier of the Payments request
type: string
example: '476412776235977427'
minLength: 18
maxLength: 18
PaymentSuccessIndicatorsTransactionAmount:
description: The transaction amount
example: 12.45
type: number
minimum: 0
exclusiveMinimum: true
PaymentSuccessIndicatorsTransaction:
description: An object containing the requested transaction info.
type: object
properties:
settleByDate:
$ref: '#/components/schemas/SettleByDate'
amount:
$ref: '#/components/schemas/PaymentSuccessIndicatorsTransactionAmount'
required:
- settleByDate
- amount
PaymentSuccessIndicatorsAddress:
description: The customer's address
type: object
properties:
streetLine1:
description:
The first line of the street part in the structured address.
example: '434 Ascension Way'
type: string
minLength: 0
maxLength: 1000
streetLine2:
description:
The second line of the street part in the structured address.
example: 'Suite 200'
type: string
minLength: 0
maxLength: 1000
city:
description: The name of the city in the structured address.
example: 'Salt Lake City'
type: string
minLength: 0
maxLength: 500
state:
description:
The state/province/parent subdivision code of the structured
address.
example: 'UT'
type: string
minLength: 1
maxLength: 3
postalCode:
description: The postal code of the structured address.
example: '84124'
type: string
minLength: 0
maxLength: 100
country:
description: 'The ISO-3166 alpha-2 country code of the address.'
example: 'US'
type: string
pattern: ^[A-Za-z]+$
format: ISO-3166-2
minLength: 2
maxLength: 2
PaymentSuccessIndicatorsPhone:
description: The phone information
type: object
properties:
countryHint:
description: 'The ISO-3166 alpha-2 country code of the phone number.'
format: ISO-3166-2
example: 'US'
type: string
number:
description:
'The phone number in E.164 or local format. The default country
calling code is +1 (USA). Note: This field is required only if email
is not provided.'
example: '7785732875'
pattern: ^\+?[\d-]*(x\d*)?
type: string
PaymentSuccessIndicatorsUser:
description: The user's information
type: object
properties:
name:
description: The name provided by the customer for the transaction.
example: 'Jane Doe'
type: string
email:
description: The email provided by the customer for the transaction.
example: 'Jane.Doe@mastercard.com'
type: string
address:
$ref: '#/components/schemas/PaymentSuccessIndicatorsAddress'
phone:
$ref: '#/components/schemas/PaymentSuccessIndicatorsPhone'
PaymentSuccessIndicatorsProperties:
description: Properties to request a Payment Success Indicator score
type: object
properties:
transaction:
$ref: '#/components/schemas/PaymentSuccessIndicatorsTransaction'
user:
$ref: '#/components/schemas/PaymentSuccessIndicatorsUser'
required:
- transaction
FcraPaymentSuccessIndicators:
description:
A Payment Success Indicators score response, indicating how likely a
transaction is to be returned. NSF and Unauthorized return risks are
provided if the score has a status of SUCCESS, or the captured errors
are listed if the score has a status of FAILURE.
type: object
properties:
payRequestId:
$ref: '#/components/schemas/PayRequestId'
status:
description:
'Current status of the score generation. Possible values are "IN
PROGRESS", "SUCCESS", "FAILURE"'
type: string
example: 'IN PROGRESS'
customerId:
$ref: '#/components/schemas/CustomerId'
accountId:
$ref: '#/components/schemas/AccountId'
requestDate:
type: string
description: The ISO 8601 format (YYYY-MM-DD) date of the request.
example: '2024-04-01'
format: date
transaction:
$ref: '#/components/schemas/PaymentSuccessIndicatorsTransaction'
nsfReturnRisk:
$ref: '#/components/schemas/FcraNsfReturnRisk'
unauthorizedReturnRisk:
$ref: '#/components/schemas/UnauthorizedReturnRisk'
required:
- payRequestId
- status
- customerId
- accountId
- requestDate
- transaction
PaymentSuccessIndicators:
description:
A Payment Success Indicators score response, indicating how likely a
transaction is to be returned. NSF and Unauthorized return risks are
provided if the score has a status of SUCCESS, or the captured errors
are listed if the score has a status of FAILURE.
type: object
properties:
payRequestId:
$ref: '#/components/schemas/PayRequestId'
status:
description:
'Current status of the score generation. Possible values are "IN
PROGRESS", "SUCCESS", "FAILURE"'
type: string
example: 'IN PROGRESS'
customerId:
$ref: '#/components/schemas/CustomerId'
accountId:
$ref: '#/components/schemas/AccountId'
requestDate:
type: string
description: The ISO 8601 format (YYYY-MM-DD) date of the request.
example: '2024-04-01'
format: date
transaction:
$ref: '#/components/schemas/PaymentSuccessIndicatorsTransaction'
nsfReturnRisk:
$ref: '#/components/schemas/NsfReturnRisk'
unauthorizedReturnRisk:
$ref: '#/components/schemas/UnauthorizedReturnRisk'
required:
- payRequestId
- status
- customerId
- accountId
- requestDate
- transaction
FcraNsfReturnRisk:
description:
The result or error occurred during the execution of the nsf return risk
prediction
type: object
properties:
result:
$ref: '#/components/schemas/FcraNsfReturnRiskResult'
error:
$ref: '#/components/schemas/ErrorMessage'
NsfReturnRisk:
description:
The result or error occurred during the execution of the nsf return risk
prediction
type: object
properties:
result:
$ref: '#/components/schemas/NsfReturnRiskResult'
error:
$ref: '#/components/schemas/ErrorMessage'
FcraNsfReturnRiskResult:
description: The successful result of the execution of the nsf return risk
type: object
properties:
disputeStatement:
type: string
description:
A message mentioning if/what type of dispute exists for the
customer"
example: 'An active dispute exists'
availableBalance:
type: number
description: >-
The available balance provided, by the consumerโs financial
institution, at the time of the request.
example: 315.01
dailyResults:
$ref: '#/components/schemas/NsfDailyResults'
required:
- availableBalance
- dailyResults
NsfReturnRiskResult:
description: The successful result of the execution of the nsf return risk
type: object
properties:
availableBalance:
type: number
description: >-
The available balance provided, by the consumerโs financial
institution, at the time of the request.
example: 315.01
dailyResults:
$ref: '#/components/schemas/NsfDailyResults'
required:
- availableBalance
- dailyResults
NsfDailyResults:
type: array
description:
An Array of 3-10 days, providing the potentialSettlementDate, score,
indicator, and reasons.
items:
$ref: '#/components/schemas/NsfIndicator'
minItems: 3
maxItems: 10
NsfIndicator:
type: object
properties:
potentialSettlementDate:
type: string
description: The date for a potential settlement date
example: '2024-04-24'
format: date
score:
type: integer
description: |-
A risk score from 0-100 that indicates the likelihood of a nsf return risk, where a higher score indicates a higher likelihood of settlement or lower likelihood of return.
example: 6
minimum: 0
maximum: 100
format: int32
indicator:
type: string
description:
'`indicator` conveys the `score`, projecting 3 possible values: "Low
Risk", "Medium Risk", or "High Risk"'
example: Low Risk
minLength: 1
maxLength: 50
reasons:
$ref: '#/components/schemas/NsfReasonItem'
required:
- potentialSettlementDate
- score
- indicator
NsfReasonItem:
type: object
description:
A collection of 8 reason codes, with a score ranging from 0-100, that
explains the drivers that caused the nsf score.
properties:
recentBalance:
description: Evaluates the available balance in an account.
type: integer
minimum: 0
maximum: 100
example: 78
balanceHistory:
description: Evaluates balance trends in the account.
type: integer
minimum: 0
maximum: 100
example: 23
nsfHistory:
description: Evaluates the number of NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 40
recentNsfHistory:
description: Evaluates the recent NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 34
recurringNsf:
description:
Evaluates the frequency of NSF occurrences in the account.
type: integer
minimum: 0
maximum: 100
example: 34
spendHistory:
description: Evaluates the trends in spend activity in the account.
type: integer
minimum: 0
maximum: 100
example: 44
depositHistory:
description:
Evaluates the trends of the consumer's permissioned account deposit
over a period of time.
type: integer
minimum: 0
maximum: 100
example: 10
transactionAmount:
description: Evaluates the settlementAmount.
type: integer
minimum: 0
maximum: 100
example: 65
required:
- balanceHistory
- depositHistory
- nsfHistory
- recentBalance
- recentNsfHistory
- recurringNsf
- spendHistory
- transactionAmount
UnauthorizedReturnRisk:
description:
The result or error occurred during the execution of the unauthorized
return risk prediction
type: object
properties:
result:
description:
The result object containing the unauthorized return risk score
properties:
score:
description:
A risk score from 0-100 that indicates the likelihood of an
unauthorized return risk, where a higher score indicates a
higher likelihood of settlement or lower likelihood of return.
example: 89
type: integer
minimum: 0
maximum: 100
indicator:
description:
'`indicator` conveys the `score`, projecting 3 possible values:
"Low Risk", "Medium Risk", or "High Risk"'
example: 'Low Risk'
type: string
required:
- score
- indicator
type: object
error:
$ref: '#/components/schemas/ErrorMessage'
StatementCloseDate:
type: integer
description: >-
(Mortgage/Loan) Date the statement closed. A date in Unix epoch time (in
seconds). See: [Handling Epoch Dates and
Times](https://docs.finicity.com/endpoint-syntax-and-format/).
format: int64
example: 1607450357
SettlementAmount:
type: number
description: >-
The transaction amount in USD $.
example: 10.05
PayPurposeCode:
type: string
description: >-
The 2-digit code (1P) assigned to indicate the intended purpose. 1P
represents the following permissible purpose: โDetermine whether a
consumers payment method may be accepted or authorizedโ, which falls
under the โLegitimate Business Needโ permissible purpose under section
604 of the FCRA.
example: '1P'
DeviceDetails:
type: object
description: More granular details of the device insights.
properties:
id:
$ref: '#/components/schemas/DeviceID'
deviceInfo:
$ref: '#/components/schemas/DeviceInfo'
DeviceID:
type: object
description: This field contains device identification information.
properties:
uDeviceId:
$ref: '#/components/schemas/UDID'
DeviceInfo:
type: object
description:
This field contains information related to the consumer device used to
authorize with your product or service.
properties:
browser:
type: string
description:
The name of the browser used to authorize your product or service.
example: Safari
platform:
type: string
description:
The device platform used to authorize your product or service.
example: iOS
deviceType:
type: string
description:
The device type used to authorize your product or service.
example: iPhone
DeviceInsightEvent:
type: object
properties:
insightEvent:
description:
'Event label associated with specific insight, for example: AD.'
type: string
example: AD
insightLevel:
description: Insight level value between 0-5.
type: integer
example: '2'
insightSignals:
type: array
description: |-
During the insight evaluation, risk signals are generated when a request triggers either the rules or machine learning model. Each risk signal and it's associated definition is shown below.
* `account_carrier_unknown` - Carrier information for account is
unknown
* `account_carrier` - Carrier velocity attempts count more than or
equal to 50 within 4 hours
* `account_city_unknown` - City information for account is unknown
* `account_city` - Account has not been seen using the City
* `account_state_unknown` - State/Province information for account
is unknown
* `account_state` - Account has not been seen using the
State/Province
* `account_country_unknown` - Country information for account is
unknown
* `account_country` - Account has not been seen using the Country
* `account_ip` - Account has not been seen using the IP
* `account_ua` - Account has not been seen using the UA
* `device_velocity` - Device Fingerprint velocity attempts count
more than 100
* `ip_velocity` - Current IP velocity greater than 50 in the past
4 hours
* `login_failures` - High failure rate for account login in the
past 30 minutes
* `login_velocity` - The account has +30 login attempts in the
past 30 minutes (overall login attempts)
* `account_velocity` - Account logins have exceeded 10 attempts
* `ip_blocklist` - IP is in block list
These risk signals are informational but may be useful for a service provider to understand a detailed view of the associated risk present in a request.
items:
type: string
example: '[ "accountIp", "ipVelocity" ]'
DeviceInsightFactor:
type: integer
description: |-
The calculated device risk is represented numerically using a range from 1 (no/low risk) to 5 (high risk). Each numerical value and it's associated risk representation is shown below.
* `1` - Represents a no or low risk request.
* `2` - Represents a low risk request.
* `3` - Represents a medium risk request.
* `4` - Represents a high risk request.
* `5` - Represents a very high risk request.
The calculated risk score is typically used to identify scenarios where a service provider may want to introduce consumer friction on the authorization process to validate the identity of the consumer. Example usage by a service provider may be to implement controls such as multifactor authentication for calculated risk factors of `3` or `4` and request blocking for risk factors of `5`.
minimum: 0
maximum: 5
example: 2
DeviceInsights:
type: object
description: Insights generated by analyzing the provided device data.
properties:
scores:
$ref: '#/components/schemas/DeviceScores'
details:
$ref: '#/components/schemas/DeviceDetails'
DeviceRiskFactor:
type: integer
minimum: 1
maximum: 5
description: |-
The calculated risk factor is represented numerically using a range from 1 (no/low risk) to 5 (high risk). Each numerical value and it's associated risk representation is shown below.
* `1` - Represents a no or low risk request.
* `2` - Represents a low risk request.
* `3` - Represents a medium risk request.
* `4` - Represents a high risk request.
* `5` - Represents a very high risk request.
The calculated risk factor is typically used to identify scenarios where a service provider may want to introduce consumer friction on the authorization process to validate the identity of the consumer. Example usage by a service provider may be to implement controls such as multifactor authentication for calculated risk factors of `3` or `4` and request blocking for risk factors of `5`.
example: 5
DeviceRiskHistoryEvent:
type: object
properties:
riskEvent:
description:
'Event label associated with specific risk, for example: AD or ATO.'
type: string
example: AD
riskEventCount:
description:
The number of times the risk insight of the given type was detected.
type: integer
minimum: 1
example: '8'
riskLevel:
description: Risk level value between 0-5.
type: integer
example: '2'
lastEventDate:
description:
The day when the risk insight of the given type was detected last.
type: string
example: '2022-09-01'
riskSignals:
description: |-
During the insight evaluation, risk signals are generated when a request triggers either the rules or machine learning model. Each risk signal and it's associated definition is shown below.
* `account_carrier_unknown` - Carrier information for account is
unknown
* `account_carrier` - Carrier velocity attempts count more than or
equal to 50 within 4 hours
* `account_city_unknown` - City information for account is unknown
* `account_city` - Account has not been seen using the City
* `account_state_unknown` - State/Province information for account
is unknown
* `account_state` - Account has not been seen using the
State/Province
* `account_country_unknown` - Country information for account is
unknown
* `account_country` - Account has not been seen using the Country
* `account_ip` - Account has not been seen using the IP
* `account_ua` - Account has not been seen using the UA
* `device_velocity` - Device Fingerprint velocity attempts count
more than 100
* `ip_velocity` - Current IP velocity greater than 50 in the past
4 hours
* `login_failures` - High failure rate for account login in the
past 30 minutes
* `login_velocity` - The account has +30 login attempts in the
past 30 minutes (overall login attempts)
* `account_velocity` - Account logins have exceeded 10 attempts
* `ip_blocklist` - IP is in block list
These risk signals are informational but may be useful for a service provider to understand a detailed view of the associated risk present in a request.
type: array
items:
type: string
example: '[ "accountIp", "ipVelocity" ]'
DeviceScores:
type: object
description:
Scores that were calculated by analyzing the provided device data.
properties:
deviceRiskFactor:
$ref: '#/components/schemas/DeviceRiskFactor'
deviceInsightFactor:
$ref: '#/components/schemas/DeviceInsightFactor'
deviceTrustFactor:
$ref: '#/components/schemas/DeviceTrustFactor'
DeviceTrustFactor:
type: integer
description:
An integer between 1-5 (1 being no trust and 5 being high trust). The
trust factor value reflects the trustworthiness of the attributes
associated with this device.
minimum: 1
maximum: 5
example: 4
UDID:
type: string
description: The generated unique device identifier.
example: UDID-9284e12b85b0d2763c13d734c70b1d62
IncludePending:
type: boolean
description: If pending transactions must be included
example: true
default: false
IncomeStreamConfidenceMinimum:
type: integer
description: >-
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 confidence score of 50 or higher.
format: int32
example: 50
InitialMlDate:
type: integer
description: >-
(Mortgage/Loan) Original date of loan. A date in Unix epoch time (in
seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
InitiatedMicroDeposit:
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
status:
type: string
example: Pending
description: Micro entries successful initiation status
depositCount:
$ref: '#/components/schemas/MicroDepositCount'
statusDescription:
type: string
example: Micro entries successfully initiated
description: Micro entries successful initiation description
railType:
$ref: '#/components/schemas/RailType'
Institution:
description: A financial institution
required:
- id
- transAgg
- ach
- stateAgg
- voi
- voa
- aha
- availBalance
- accountOwner
- oauthEnabled
- currency
- status
type: object
properties:
id:
$ref: '#/components/schemas/NumericInstitutionId'
name:
$ref: '#/components/schemas/InstitutionName'
transAgg:
$ref: '#/components/schemas/InstitutionTransAgg'
ach:
$ref: '#/components/schemas/InstitutionAch'
stateAgg:
$ref: '#/components/schemas/InstitutionStateAgg'
voi:
$ref: '#/components/schemas/InstitutionVoi'
voa:
$ref: '#/components/schemas/InstitutionVoa'
aha:
$ref: '#/components/schemas/InstitutionAha'
availBalance:
$ref: '#/components/schemas/InstitutionAvailableBalance'
accountOwner:
$ref: '#/components/schemas/InstitutionAccountOwner'
studentLoanData:
$ref: '#/components/schemas/StudentLoanDataCertification'
loanPaymentDetails:
$ref: '#/components/schemas/LoanPaymentDetailCertification'
displayName:
$ref: '#/components/schemas/InstitutionDisplayName'
liabilityData:
$ref: '#/components/schemas/LiabilityDataCertification'
billPayData:
$ref: '#/components/schemas/BillPayDataCertification'
accountTypeDescription:
$ref: '#/components/schemas/InstitutionAccountTypeDescription'
phone:
$ref: '#/components/schemas/PhoneNumber'
urlHomeApp:
$ref: '#/components/schemas/InstitutionUrlHomeApp'
urlLogonApp:
$ref: '#/components/schemas/InstitutionUrlLogonApp'
oauthEnabled:
$ref: '#/components/schemas/InstitutionOauthEnabled'
urlForgotPassword:
$ref: '#/components/schemas/InstitutionUrlForgotPassword'
urlOnlineRegistration:
$ref: '#/components/schemas/InstitutionUrlOnlineRegistration'
class:
$ref: '#/components/schemas/InstitutionClass'
specialText:
$ref: '#/components/schemas/InstitutionSpecialText'
timeZone:
$ref: '#/components/schemas/InstitutionTimeZone'
specialInstructions:
$ref: '#/components/schemas/InstitutionSpecialInstructions'
specialInstructionsTitle:
$ref: '#/components/schemas/InstitutionSpecialInstructionsTitle'
address:
$ref: '#/components/schemas/InstitutionAddress'
currency:
$ref: '#/components/schemas/Currency'
email:
$ref: '#/components/schemas/EmailAddress'
status:
$ref: '#/components/schemas/InstitutionStatus'
newInstitutionId:
$ref: '#/components/schemas/NumericInstitutionId'
branding:
$ref: '#/components/schemas/Branding'
productionStatus:
$ref: '#/components/schemas/InstitutionProductionStatus'
oauthInstitutionId:
$ref: '#/components/schemas/NumericInstitutionId'
InstitutionAccountOwner:
type: boolean
description: |-
"true": The institution is certified for the Account Owner product
"false": The institution is decertified for the Account Owner product
example: true
InstitutionAch:
type: boolean
description: |-
"true": The institution is certified for the ACH product
"false": The institution is decertified for the ACH product
example: true
InstitutionAddress:
type: object
description: The address of a financial institution
properties:
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/Country'
postalCode:
$ref: '#/components/schemas/ZipCode'
addressLine1:
$ref: '#/components/schemas/AddressLine1'
addressLine2:
$ref: '#/components/schemas/AddressLine2'
InstitutionAha:
type: boolean
description: >-
"true": The institution is certified for the Account History Aggregation
product
"false": The institution is decertified for the Account History
Aggregation product
example: false
InstitutionAvailableBalance:
type: boolean
description: >-
"true": The institution is certified for the Account Balance Check (ABC)
product
"false": The institution is decertified for the Account Balance Check
(ABC) product
example: false
InstitutionId:
description: The ID of a financial institution
type: string
example: '4222'
InstitutionLoginId:
type: string
description: An institution login ID (from the account record)
example: '1007302745'
InstitutionName:
type: string
description: The name of the institution
example: FinBank
InstitutionSettings:
type: object
description: >-
Advanced options for configuration of which institutions to display in.
See [Institution
Settings](https://developer.mastercard.com/open-finance-us/documentation/connect/connect-institutions-settings/).
InstitutionStateAgg:
type: boolean
description: >-
"true": The institution is certified for the Statement Aggregation
product
"false": The institution is decertified for the Statement Aggregation
product
example: false
InstitutionTransAgg:
type: boolean
description: >-
"true": The institution is certified for the Transaction Aggregation
product
"false": The institution is decertified for the Transaction Aggregation
product
example: true
InstitutionVoa:
type: boolean
description: |-
"true": The institution is certified for the VOA product
"false": The institution is decertified for the VOA product
example: true
InstitutionVoi:
type: boolean
description: |-
"true": The institution is certified for the VOI product
"false": The institution is decertified for the VOI product
example: true
InstitutionWrapper:
type: object
required:
- institution
properties:
institution:
$ref: '#/components/schemas/Institution'
InstitutionConnectionHealth:
type: object
description: Health status and success rates for connection features.
properties:
overallHealth:
type: string
description: >-
Overall health status. Valid statuses are: Healthy, Degraded,
Unhealthy, Insufficient Data
minLength: 0
maxLength: 255
example: healthy
overallSuccessRate:
type: integer
format: int32
minimum: 0
maximum: 100
description: Overall success rate (0-100).
example: 92
durability:
type: integer
description: Durability metric for the connection.
accountLinkingHealth:
type: string
description: >-
Account linking health status. Valid statuses are: Healthy,
Degraded, Down, Insufficient Data.
example: Healthy
accountLinkingSuccessRate:
type: integer
description: >-
Account linking success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
transAggHealth:
type: string
description: >-
Trans agg health status. Valid statuses are: Healthy, Degraded,
Down, Insufficient Data.
example: Healthy
transAggSuccessRate:
type: integer
description: >-
Trans agg success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
accountOwnerHealth:
type: string
description: >-
Account owner health status. Valid statuses are: Valid statuses are:
Healthy, Degraded, Down, Insufficient Data.
example: healthy
accountOwnerSuccessRate:
type: integer
description: >-
Account owner success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
achHealth:
type: string
description: >-
Ach health status. Valid statuses are: Healthy, Degraded, Down,
Insufficient Data.
example: healthy
achSuccessRate:
type: integer
description: >-
ACH success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
availBalanceHealth:
type: string
description: >-
Available balance health status. Valid statuses are: Healthy,
Degraded, Down, Insufficient Data.
example: Healthy
availBalanceSuccessRate:
type: integer
description: >-
Available balance success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
stateAggHealth:
type: string
description: >-
Statement agg health status. Valid statuses are: Healthy, Degraded,
Down, Insufficient Data.
example: Healthy
stateAggSuccessRate:
type: integer
description: >-
Statement agg success rate (0-100).
format: int32
minimum: 0
maximum: 100
example: 92
InstitutionProductionStatus:
type: object
required:
- overallStatus
- transAgg
- voa
- voi
- stateAgg
- ach
- aha
properties:
overallStatus:
$ref: '#/components/schemas/InstitutionOverallStatus'
transAgg:
$ref: '#/components/schemas/InstitutionTransAgg_status'
stateAgg:
$ref: '#/components/schemas/InstitutionStateAgg_status'
voa:
$ref: '#/components/schemas/InstitutionVoa_status'
voi:
$ref: '#/components/schemas/InstitutionVoi_status'
ach:
$ref: '#/components/schemas/InstitutionAch_status'
aha:
$ref: '#/components/schemas/InstitutionAha_status'
Institutions:
description:
A list of financial institutions from the Get Institutions API
required:
- found
- displaying
- moreAvailable
- createdDate
- institutions
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
createdDate:
$ref: '#/components/schemas/UnixDate'
institutions:
description: A list of institutions
maxItems: 1000
minItems: 0
type: array
items:
$ref: '#/components/schemas/Institution'
InstitutionsWithRoutingNumber:
description: List of institutions with matching routing numbers
type: object
properties:
id:
$ref: '#/components/schemas/NumericInstitutionId'
name:
$ref: '#/components/schemas/InstitutionName'
transAgg:
$ref: '#/components/schemas/InstitutionTransAgg'
ach:
$ref: '#/components/schemas/InstitutionAch'
stateAgg:
$ref: '#/components/schemas/InstitutionStateAgg'
voi:
$ref: '#/components/schemas/InstitutionVoi'
voa:
$ref: '#/components/schemas/InstitutionVoa'
aha:
$ref: '#/components/schemas/InstitutionAha'
availBalance:
$ref: '#/components/schemas/InstitutionAvailableBalance'
accountOwner:
$ref: '#/components/schemas/InstitutionAccountOwner'
studentLoanData:
$ref: '#/components/schemas/StudentLoanDataCertification'
loanPaymentDetails:
$ref: '#/components/schemas/LoanPaymentDetailCertification'
paymentInitiation:
$ref: '#/components/schemas/PaymentInitiationCertification'
billPayData:
$ref: '#/components/schemas/BillPayDataCertification'
liabilityData:
$ref: '#/components/schemas/LiabilityDataCertification'
accountTypeDescription:
$ref: '#/components/schemas/InstitutionAccountTypeDescription'
phone:
$ref: '#/components/schemas/PhoneNumber'
urlHomeApp:
$ref: '#/components/schemas/InstitutionUrlHomeApp'
urlLogonApp:
$ref: '#/components/schemas/InstitutionUrlLogonApp'
oauthEnabled:
$ref: '#/components/schemas/InstitutionOauthEnabled'
urlForgotPassword:
$ref: '#/components/schemas/InstitutionUrlForgotPassword'
urlOnlineRegistration:
$ref: '#/components/schemas/InstitutionUrlOnlineRegistration'
class:
$ref: '#/components/schemas/InstitutionClass'
specialText:
$ref: '#/components/schemas/InstitutionSpecialText'
timeZone:
$ref: '#/components/schemas/InstitutionTimeZone'
specialInstructions:
$ref: '#/components/schemas/InstitutionSpecialInstructions'
specialInstructionsTitle:
$ref: '#/components/schemas/InstitutionSpecialInstructionsTitle'
address:
$ref: '#/components/schemas/InstitutionAddress'
currency:
$ref: '#/components/schemas/Currency'
email:
$ref: '#/components/schemas/EmailAddress'
status:
$ref: '#/components/schemas/InstitutionStatus'
newInstitutionId:
$ref: '#/components/schemas/NumericInstitutionId'
branding:
$ref: '#/components/schemas/Branding'
displayName:
$ref: '#/components/schemas/InstitutionDisplayName'
oauthInstitutionId:
$ref: '#/components/schemas/NumericInstitutionId'
countryCodes:
$ref: '#/components/schemas/InstitutionCountryCodes'
overallStatusTemp:
$ref: '#/components/schemas/InstitutionOverallStatusTemp'
transAgg_status:
$ref: '#/components/schemas/InstitutionTransAgg_status'
voa_status:
$ref: '#/components/schemas/InstitutionVoa_status'
voi_status:
$ref: '#/components/schemas/InstitutionVoi_status'
stateAgg_status:
$ref: '#/components/schemas/InstitutionStateAgg_status'
ach_status:
$ref: '#/components/schemas/InstitutionAch_status'
aha_status:
$ref: '#/components/schemas/InstitutionAha_status'
InstitutionResponse:
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailable'
institutions:
type: array
description: 'List of institution details for an application'
example:
- institutionId: 102224
institutionName: Chase
status: true
createdDate: 2020-07-30T16:11:23Z
modifiedDate: 2020-07-30T16:11:23Z
items:
$ref: '#/components/schemas/FinancialInstitution'
FinancialInstitution:
type: object
properties:
institutionId:
type: integer
description: The financial institution identification at Mastercard.
format: int64
example: 102224
institutionName:
type: string
description: The financial institution name.
example: Chase
status:
type: boolean
description:
Application registration status against the financial institution.
example: true
createdDate:
type: string
description:
The application creation date and time at financial institutions are
in ISO 8601 format.
example: 2020-07-30T16:11:23Z
modifiedDate:
type: string
description:
The application modification date and time at financial institutions
in ISO 8601 format.
example: 2020-07-30T16:11:23Z
InsufficientFundsTransaction:
properties:
amount:
description: Amount of the NSF transaction
example: -1.65
type: number
description:
description: Description of the transaction
example: OVERDRAFT FEE
type: string
minLength: 0
maxLength: 255
memo:
description: Transaction memo
example: NSF
type: string
minLength: 0
maxLength: 255
postedDate:
description: Posted date of the NSF transaction
example: '2022-12-19'
type: string
minLength: 10
maxLength: 10
transactionId:
description: Finicity transaction ID
example: 23092384290
type: integer
required:
- postedDate
- amount
- transactionId
type: object
InvestmentTransactionTypes:
type: string
description: >-
Keywords in the `description` and `memo` fields were used to translate
investment transactions into these types.
Possible values:
* "cancel"
* "purchaseToClose"
* "purchaseToCover"
* "contribution"
* "optionExercise"
* "optionExpiration"
* "fee"
* "soldToClose"
* "soldToOpen"
* "split"
* "transfer"
* "returnOfCapital"
* "income"
* "purchased"
* "sold"
* "dividendReinvest"
* "tax"
* "dividend"
* "reinvestOfIncome"
* "interest"
* "deposit"
* "otherInfo"
example: transfer
IpAddressDistance:
type: number
description:
The distance (in miles) between the IP address and the physical address.
example: 210
IpGeolocationCountryCode:
type: string
description: >-
The ISO-3166 alpha-2 country code associated with the geolocation of the
IP address.
example: US
IpGeolocationSubdivision:
type: string
description: More granular detail about the IP address location.
example: Oregon
IpLastSeenDays:
type: number
description: >-
Count of days since the IP address was last observed in Ekata's Identity
Network. If the IP address has not been observed before, IpLastSeenDays
will be 0.
example: 15
IpPhoneDistance:
type: number
description: >-
The distance (in miles) between the IP address and the closest physical
address associated with the phone number.
example: 200
IpRisk:
type: boolean
description: >-
True if the IP address is considered risky, based on multiple IP data
points and velocity calculations.
example: true
IpRiskScore:
type: number
description: >-
Comprehensive risk score associated with an IP address, with a higher
score indicating a riskier IP address. A number between 0 and 1 rounded
to three decimal places.
example: 0.123
isHostedInMobileApp:
description:
Indicates whether Data Connect is hosted in a web view / secure
container of the partner mobile app. It is only required for NON SDK
integrations.
type: boolean
example: false
IsWebView:
type: boolean
description: >-
"true": Indicates that the Data Connect Session will be displayed within
a WebView. When the `isWebView` parameter is `true` the `redirectUri`
parameter is required.
Note: This parameter is no longer recommended. We instead recommend
specifying a `redirectUrl` through our WebSDK. Please refer to the
following documentation:
-
[iOS](https://developer.mastercard.com/open-finance-us/documentation/connect/integrating/webviews/ios-webviews/)
-
[Android](https://developer.mastercard.com/open-finance-us/documentation/connect/integrating/webviews/android-webviews/)
example: true
LastName:
type: string
description: The last name of the account holder
example: Smith
LastPaymentDate:
type: integer
description: >-
(Credit Card/Line Of Credit) The date of the last payment. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
LastPaymentDueDate:
type: integer
description: >-
(Mortgage/Loan) Due date of last payment. A date in Unix epoch time (in
seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
LastPaymentReceiveDate:
type: integer
description: >-
(Mortgage/Loan) The date of the last payment. A date in Unix epoch time
(in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
LiteConnectParameters:
required:
- partnerId
- customerId
- institutionId
type: object
properties:
language:
$ref: '#/components/schemas/ConnectLanguage'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
institutionId:
$ref: '#/components/schemas/NumericInstitutionId'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
experience:
$ref: '#/components/schemas/Experience'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
isHostedInMobileApp:
$ref: '#/components/schemas/isHostedInMobileApp'
isWebView:
$ref: '#/components/schemas/IsWebView'
LoanPaymentDetailCertification:
type: boolean
description: |-
"true": The institution is certified for the Loan Payment Detail product
"false": The institution is decertified for the Loan Payment Detail product
example: true
LoanPaymentDetails:
description: Loan payment details for a customer account
required:
- loanNumber
- loanPaymentNumber
- loanPaymentAddress
type: object
properties:
loanNumber:
type: string
description: The number of the specific loan under the account.
example: '123456789'
loanPaymentNumber:
type: string
description: >-
The payment number given by the institution. This number is
typically for manual payments. This is not an ACH payment number.
example: '5231123456789'
loanPaymentAddress:
type: string
description: The payment address to send manual payments to
example: Heartland ECSI PO Box 718 Wexford PA 15090
accountDetail:
$ref: '#/components/schemas/LoanPaymentDetailsAccount'
LoanPaymentDetailsAccount:
required:
- accountId
- accountNumber
- accountPaymentNumber
- accountPaymentAddress
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
accountNumber:
type: string
description: Institution's ID of the Student Loan Account
example: '9876543210'
accountPaymentNumber:
type: string
description: >-
The payment number given by the institution. This number is
typically for manual payments. This is not an ACH payment number.
example: 00001234895413
accountPaymentAddress:
type: string
description:
The payment address to which send manual payments should be sent
example: 'P.O. Box 123 Sioux Falls, IA 51054'
accountFuturePayoffAmount:
type: number
description: The payoff amount for the account
example: 10000
accountFuturePayoffDate:
type: string
description: The date to which the "Future Payoff Amount" applies
format: date-time
example: '2022-01-01T00:00:00.000Z'
groupDetail:
description: Group details
type: array
items:
$ref: '#/components/schemas/LoanPaymentDetailsGroup'
loanDetail:
description: Loan details
type: array
items:
$ref: '#/components/schemas/LoanPaymentDetailsLoan'
LoanPaymentDetailsGroup:
description: Group details
required:
- accountId
- groupNumber
- groupPaymentNumber
- groupPaymentAddress
- groupLoanDetail
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
groupNumber:
type: string
description: Institution's ID of the Student Loan Group
example: 3210-Group A
groupPaymentNumber:
type: string
description: >-
The payment number given by the institution. This number is
typically for manual payments. This is not an ACH payment number.
example: 00001234895413-A
groupPaymentAddress:
type: string
description:
The payment address to which send manual payments should be sent
example: 'P.O. Box 123 Sioux Falls, IA 51054'
groupFuturePayoffAmount:
type: number
description: The payoff amount for the group
example: 7500
groupFuturePayoffDate:
type: string
description: The date to which the "Future Payoff Amount" applies
format: date-time
example: '2022-01-01T00:00:00.000Z'
groupLoanDetail:
type: array
items:
$ref: '#/components/schemas/LoanPaymentDetailsLoan'
LoanPaymentDetailsLoan:
description: Loan details
required:
- accountId
- loanNumber
- loanPaymentNumber
- loanPaymentAddress
type: object
properties:
accountId:
$ref: '#/components/schemas/AccountId'
loanNumber:
type: string
description: Institution's ID of the Student Loan
example: 3210-Group A-1
loanPaymentNumber:
type: string
description: >-
The payment number given by the institution. This number is
typically for manual payments. This is not an ACH payment number.
example: 00001234895413-A-1
loanPaymentAddress:
type: string
description:
The payment address to which send manual payments should be sent
example: 'P.O. Box 123 Sioux Falls, IA 51054'
loanFuturePayoffAmount:
type: number
description: The payoff amount for the loan
example: 5000
loanFuturePayoffDate:
type: string
description: The date to which the "Future Payoff Amount" applies
format: date-time
example: '2022-01-01T00:00:00.000Z'
LoanStatusEndDate:
type: integer
description: >-
(Student Loan) The end date of the current status. A date in Unix epoch
time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
LoanStatusStartDate:
type: integer
description: >-
(Student Loan) The start date of the current status. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
MainPayStatementFields:
required:
- payDate
- grossPayAmount
type: object
properties:
payDate:
type: integer
description: Pay date for the pay period
format: int64
example: 1607450357
startDate:
type: integer
description: Start date for the pay period
format: int64
example: 1607450357
endDate:
type: integer
description: End date for the pay period
format: int64
example: 1607450357
payPeriodHours:
type: number
description: Sum of all hours worked each week for the pay period
example: 39.75
payFrequency:
type: string
description: |
The current pay frequency, or how often a regular pay check is
distributed:
* `Daily`
* `Weekly`
* `Bi-Weekly`
* `Semi-Monthly`
* `Monthly`
* `Quarterly`
* `Semi-Annual`
* `Annual`
* `Every 2.6 wks`
* `Every 4 wks`
* `Every 5.2 wks`
* `Other`
example: Weekly
payType:
type: string
description: |
Current pay type:
* `Salary`
* `Hourly`
* `Daily`
example: Hourly
grossPayAmount:
type: number
description: Gross pay amount for the pay period
example: 755.25
grossPayAmountYTD:
type: number
description:
Year to date (YTD) gross pay amount at the time of payment
example: 4256
netPayAmount:
type: number
description: Net pay amount for a pay period
example: 608.77
netPayAmountYTD:
type: number
description: Year to date (YTD) net pay amount at the time of payment
example: 2345.99
MarketSegment:
title: Market Segment
type: string
description: >-
Use case for requesting the consumer's data. Current supported
enumerations are:
* `Auto`
* `Background`
* `Credit
Card`
* `Employment`
* `Government`
* `Identity`
* `KYC`
* `Mortgage`
* `Personal`
* `Tenant`
If
your usecase doesn't match one of these please reach out to your
technical point of contact.
example: Mortgage
MaturityDate:
type: integer
description: >-
(Checking/Savings/CD/MoneyMarket) Maturity date of account type. A date
in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
MicroDepositCallbackUrl:
type: string
format: uri
description: A callback URL where to receive micro deposit notifications
example: 'https://www.example.com/listener'
MicroDepositCount:
type: integer
format: int32
example: 2
description: Count of micro entries
MicroDepositDetails:
type: object
properties:
status:
$ref: '#/components/schemas/MicroDepositStatus'
statusDescription:
$ref: '#/components/schemas/MicroDepositStatusDescription'
creationDate:
$ref: '#/components/schemas/NoZoneDateTime'
routingNumber:
$ref: '#/components/schemas/RoutingNumber'
accountNumberLast4:
$ref: '#/components/schemas/AccountNumberLast4'
autoVerifiedAccount:
$ref: '#/components/schemas/AutoVerifiedAccount'
railType:
$ref: '#/components/schemas/RailType'
MicroDepositInitiation:
required:
- receiver
type: object
properties:
institutionLoginId:
$ref: '#/components/schemas/InstitutionLoginId'
receiver:
$ref: '#/components/schemas/Receiver'
callbackUrl:
$ref: '#/components/schemas/MicroDepositCallbackUrl'
MicroDepositStatus:
type: string
description: |-
The following values may be returned in the field of a status:
* "Pending" : Micro entries not yet deposited to customer's account
* "Completed": Micro entries deposited to customer's account
* "Verified": Micro entries got successfully verified
* "Rejected": Micro entries got rejected due to some reason
* "Returned": Micro entries got returned back
* "Failed": Micro entries got failed due to some reason
* "Expired": Micro entries got expired as they remains unverified for
certain defined days
example: Pending
MicroDepositStatusDescription:
type: string
example: Micro entries are in pending status
description: Micro entries status description
MicroDepositVerification:
description: A list of amounts
required:
- amounts
type: object
properties:
amounts:
description: The list of amounts to be verified
type: array
items:
$ref: '#/components/schemas/DecimalNumber'
example:
- 0.12
- 0.15
MicroDepositVerificationError:
type: object
properties:
status:
$ref: '#/components/schemas/MicroDepositStatus'
statusDescription:
$ref: '#/components/schemas/MicroDepositStatusDescription'
MicroEntryVerifyRequestParameter:
type: object
properties:
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
webhook:
$ref: '#/components/schemas/Webhook'
webhookContentType:
$ref: '#/components/schemas/WebhookContentType'
webhookData:
$ref: '#/components/schemas/WebhookData'
webhookHeaders:
$ref: '#/components/schemas/WebhookHeaders'
experience:
$ref: '#/components/schemas/Experience'
accountId:
$ref: '#/components/schemas/AccountId'
MiddleName:
type: string
description: The middle name of the account holder
example: L
MonthlyIncome:
required:
- estimatedMonthlyTotalPay
type: object
description: |-
Current estimated monthly pay for the employment.
This is a mandatory field only for VOIE-payroll report type.
properties:
estimatedMonthlyBasePay:
type: number
description: >-
Mastercard Open Finance estimated monthly base pay amount for the
employment
example: 123.45
estimatedMonthlyOvertimePay:
type: number
description: >-
Mastercard Open Finance estimated monthly overtime pay amount for
the employment
example: 123.45
estimatedMonthlyBonusPay:
type: number
description: >-
Mastercard Open Finance estimated monthly bonus pay amount for the
employment
example: 123.45
estimatedMonthlyOtherPay:
type: number
description: >-
Mastercard Open Finance estimated monthly other pay amount for the
employment
example: 123.45
estimatedMonthlyTotalPay:
type: number
description:
Sum of all Mastercard Open Finance estimated monthly pay amounts
example: 123.45
estimatedMonthlyCommissionPay:
type: number
description: >-
Mastercard Open Finance estimated monthly commission pay amount for
the employment
example: 123.45
MoreResultsAvailable:
type: boolean
description: >-
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:"...&start=6&limit=5"
example: true
MoreResultsAvailableForTransactions:
type: string
description: >-
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:"...&start=6&limit=5"
example: 'true'
Name:
type: string
description: The account name from the institution
example: Super Checking
NameClassificationType:
type: string
description: |-
The classification of the account holder:
* "person / personal / home"
* "business"
* "other"
example: person
NetMonthly:
required:
- month
- net
type: object
properties:
month:
type: integer
description: Timestamp for the first day of this month
format: int64
example: 1522562400
net:
type: number
description:
'Total income during the given month, across all income streams'
example: 2004.77
NewConsumer:
description: A new consumer to be created
required:
- firstName
- lastName
- address
- city
- state
- zip
- phone
- ssn
- birthday
type: object
properties:
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
address:
$ref: '#/components/schemas/Address'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
zip:
$ref: '#/components/schemas/ZipCode'
phone:
$ref: '#/components/schemas/PhoneNumber'
ssn:
$ref: '#/components/schemas/SocialSecurityNumber'
birthday:
$ref: '#/components/schemas/Birthday'
email:
$ref: '#/components/schemas/EmailAddress'
suffix:
$ref: '#/components/schemas/Suffix'
endUser:
$ref: '#/components/schemas/ConsumerEndUser'
NewCustomer:
description: A new customer to be enrolled
required:
- username
type: object
properties:
username:
$ref: '#/components/schemas/CustomerUsername'
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
applicationId:
$ref: '#/components/schemas/ApplicationId'
phone:
$ref: '#/components/schemas/PhoneNumber'
email:
$ref: '#/components/schemas/EmailAddress'
MetaData:
type: string
description:
OBAO is a program that is being offered to Mastercard issuers where when
the new account is issued a Mastercard Debit or Prepaid account. OBAO
offered partners will not be charged for ACH, AOV, and Balance API.
example: program=OBAO
NextPaymentDate:
type: integer
description: >-
(Mortgage/Loan) Due date for the next payment. A date in Unix epoch time
(in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
NoZoneDateTime:
type: string
description: A date-time without time zone
example: '2022-04-12T11:51:23'
NumericAccountId:
type: integer
format: int64
description: An account ID represented as a number
example: 5011648377
NumericCustomerId:
type: integer
format: int64
description: >-
A customer ID represented as a number. See Add Customer API for how to
create a customer ID.
example: 1005061234
ExternalCustomerId:
type: string
description:
External Customer ID is a unique identifier assigned to the customer by
the data holder. This field allows you to map the customer (and
transactions) back to your dataset and to provide the link to
Mastercard's dataset that was requested to be enriched. This ID must be
obfuscated through cryptographically strong hashing using SHA-2 or SHA-3
methods. Do not send plaintext ids to Mastercard. Provide this
identifier if you want the Mastercard enriched dataset to be used as
input to this report.
minLength: 1
maxLength: 100
example: '1005061234'
NumericInstitutionId:
description: 'The ID of a financial institution, represented as a number'
type: integer
format: int64
example: 4222
PaymentInitiationCertification:
description: Institution connection is certified for paymentInitiation
type: boolean
default: false
example: true
BillPayDataCertification:
description: billPayData is certified
type: boolean
default: false
example: true
LiabilityDataCertification:
description: liabilityData is certified
type: boolean
default: false
example: true
InstitutionAccountTypeDescription:
type: string
description: >-
Values: Banking, Investments, Credit Cards/Accounts, Workplace
Retirement, Mortgages and Loans, Insurance
example: Workplace Retirement
InstitutionUrlHomeApp:
type: string
description: The URL of the institution's primary home page
example: 'https://www.example.com/home'
InstitutionUrlLogonApp:
type: string
description: The URL of the institution's login page
example: 'https://www.example.com/login'
InstitutionOauthEnabled:
type: boolean
description: |-
"true": The institution is an OAuth connection
"false": The institution isn't an OAuth connection
example: true
InstitutionUrlForgotPassword:
type: string
description: Institution's forgot password page
example: 'https://www.example.com/forgotPassword.do'
InstitutionUrlOnlineRegistration:
type: string
description: Institution's signup page
example: 'https://www.example.com/signup'
InstitutionClass:
type: string
description: Institution's class
example: retirement
InstitutionSpecialText:
type: string
description: Special instructions given to customers for login
example: >-
Please enter your Principal Financial - Retirement (Personal) Username
and Password.
InstitutionTimeZone:
type: string
description: The time zone of the institution.
example: America/Denver
InstitutionSpecialInstructions:
type: array
items:
type: string
description: >-
Instructions given to the customer before they are sent to the
institution website to login for OAuth institutions.
Note: this helps the customer to provide the proper permission for data
needed for the application.
example:
- Account details
- Balances and transactions
- Personal and account ownership info
InstitutionSpecialInstructionsTitle:
type: string
description:
'The title of the special instructions, if one exists or is required.'
example: Special OAuth Login Instructions
InstitutionStatus:
type: string
description: >-
Status for the institution: "online", "offline", "maintenance",
"testing", "beta", "validated", "migrating"
example: online
InstitutionDisplayName:
description:
A version of the institution connection name that is more user friendly
type: string
minLength: 0
maxLength: 255
example: Finbank
InstitutionCountryCodes:
type: array
items:
description: Countries for which this connection is valid
type: object
properties:
countryCode:
description: 'Two character country code'
type: string
minLength: 2
maxLength: 2
example: US
InstitutionOverallStatusTemp:
description: |-
Beta Data - Can be ignored. Should use `status` field instead.
The overall status for the institution:
- online - Connection is active, financial institution is available and functioning
- offline - Connection is inactive due to an issue. Financial institution is not available in Data Connect search
- maintenance - Financial institution is undergoing planned maintenance and is not available at this time
- testing (Limited Availability) - A new connection with the financial institution is still undergoing development and is only available to some select partners
- investigating - Connection is new and/or under monitoring due to instability
type: string
example: online
InstitutionOverallStatus:
description: |-
Beta Data - Can be ignored.
The overall status for the institution:
- online - Connection is active, financial institution is available and functioning
- offline - Connection is inactive due to an issue. Financial institution is not available in Data Connect search
- maintenance - Financial institution is undergoing planned maintenance and is not available at this time
- testing (Limited Availability) - A new connection with the financial institution is still undergoing development and is only available to some select partners
- investigating - Connection is new and/or under monitoring due to instability
type: string
example: online
InstitutionTransAgg_status:
description: >-
Beta Data - Can be ignored. Should use `status` field instead. The
production status for the Transaction Aggregation product for the
institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is
being investigated
- offline - product is offline for the institution
type: string
example: online
InstitutionVoa_status:
description: |-
Beta Data - Can be ignored. Should use `status` field instead.
The production status for the VOA product for the institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is being investigated
- offline - product is offline for the institution
type: string
example: online
InstitutionVoi_status:
description: |-
Beta Data - Can be ignored. Should use `status` field instead.
The production status for the VOI product for the institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is being investigated
- offline - product is offline for the institution
type: string
example: online
InstitutionStateAgg_status:
description: >-
Beta Data - Can be ignored. Should use `status` field instead. The
production status for the Statement Aggregation product for the
institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is
being investigated
- offline - product is offline for the institution
type: string
example: online
InstitutionAch_status:
description: |-
Beta Data - Can be ignored. Should use `status` field instead.
The production status for the ACH product for the institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is being investigated
- offline - product is offline for the institution
type: string
example: online
InstitutionAha_status:
description: >-
Beta Data - Can be ignored. Should use `status` field instead. The
production status for the Account History Aggregation product for the
institution.
- online - product is functioning correctly for the institution
- investigating - product is degraded for the institution and is
being investigated
- offline - product is offline for the institution
type: string
example: online
NumericInstitutionLoginId:
type: integer
format: int64
description:
'An institution login ID (from the account record), represented as a
number'
example: 1007302745
NumericPreAppId:
type: integer
format: int64
description: >-
Identifier to track the application registration from the App
Registration and Get App Registration Status APIs, represented as a
number
example: 2581
ObbAccountDetails:
description: Details of the account and financial institution
properties:
accountNumberDisplay:
description:
The account number from a financial institution in truncated format
example: '8888'
type: string
minLength: 0
maxLength: 50
accountOwner:
$ref: '#/components/schemas/ObbAccountOwner'
aggregationAttemptDate:
description: >-
A timestamp showing the last aggregation attempt. This will not be
present until you have run your first aggregation for the account.
example: '2022-03-30T14:47:19-07:00'
type: string
minLength: 25
maxLength: 25
aggregationStatusCode:
description: >-
The status of the most recent aggregation attempt. This will not be
present until you have run your first aggregation for the account
example: 0
type: integer
aggregationSuccessDate:
description: >-
A timestamp showing the last successful aggregation of the account.
This will not be present until you have run your first aggregation
for the account.
example: '2022-03-30T14:47:19-07:00'
type: string
minLength: 25
maxLength: 25
currency:
description: The currency of the account
example: USD
type: string
minLength: 0
maxLength: 5
currentBalance:
description: Current reported balance of the account
example: 2239.22
type: number
id:
$ref: '#/components/schemas/NumericAccountId'
institution:
$ref: '#/components/schemas/ObbInstitution'
institutionLoginId:
$ref: '#/components/schemas/NumericInstitutionLoginId'
name:
description: The account name from the institution
example: Super Checking
type: string
minLength: 0
maxLength: 50
realAccountNumberLast4:
description: The last 4 digits of the ACH account number
example: 5678
type: integer
status:
description: >-
pending during account discovery, always active following successful
account activation
example: active
type: string
minLength: 0
maxLength: 50
type:
description: 'Account type, e.g. checking/saving'
example: checking
type: string
minLength: 0
maxLength: 50
required:
- id
- institution
- accountOwner
type: object
ObbAccountOwner:
description:
Who is on record as the owner of the account. May be the business name,
the business owner name, or otherwise.
properties:
address:
description: Address of the owner on record for the account
example: '123 Main St, Portland, OR 12345'
type: string
minLength: 0
maxLength: 255
name:
description: Name of the owner on record for the account
example: Johnny Appleseed
type: string
minLength: 0
maxLength: 255
required:
- name
- address
type: object
ObbAverageWeeklyBalance:
properties:
amount:
description: Average daily ending balance during the week
example: 679.07
type: number
fromDate:
description: Begin date of the week
example: '2020-01-01'
type: string
minLength: 10
maxLength: 10
toDate:
description: End date of the week
example: '2020-01-07'
type: string
minLength: 10
maxLength: 10
week:
description: >-
Week number, where the first week of each year begins on January 1st
and ends on January 7th. May be in the range [1, 53]
example: 1
type: integer
required:
- week
- fromDate
- toDate
- amount
type: object
ObbCurrentReportRequestDetails:
description: Requested attributes of the report
properties:
reportBeginDate:
description: Date from when the requested data is available
example: '2022-03-01'
type: string
minLength: 10
maxLength: 10
reportEndDate:
description: Date to which the requested data is available
example: '2022-03-30'
type: string
minLength: 10
maxLength: 10
reportRequestDate:
description: The date and time the report was requested
example: '2022-03-30T14:47:19-07:00'
type: string
minLength: 25
maxLength: 25
requestedDaysForReport:
description: Number of days requested for the report
example: 90
type: integer
requestedReportBeginDate:
description: >-
Date the report would have begun on if enough data was available for
which the partner requested
example: '2022-01-01'
type: string
minLength: 10
maxLength: 10
required:
- reportRequestDate
- requestedDaysForReport
- requestedReportBeginDate
type: object
ObbDailyBalance:
properties:
date:
description: Date of balance information
example: '2021-10-11'
type: string
minLength: 10
maxLength: 10
dayOfWeek:
description: Day of the week for which balance information available
example: Monday
type: string
minLength: 6
maxLength: 9
endingBalance:
description: End of day balance
example: 21527.3
type: number
required:
- date
- endingBalance
- dayOfWeek
type: object
ObbDataAvailability:
description:
Availability of historical data at the time the report was requested
properties:
historicAvailabilityBeginDate:
description: Begin date for data availability
example: '2022-03-01'
type: string
minLength: 10
maxLength: 10
historicAvailabilityEndDate:
description: End date for data availability
example: '2022-03-30'
type: string
minLength: 10
maxLength: 10
historicAvailableDays:
description: Days for which transaction details are available
example: 30
type: integer
historicDataAvailability:
description: Description of historic data availability
example: Data is available from 2022-03-01 to 2022-03-30
type: string
minLength: 0
maxLength: 255
required:
- historicAvailableDays
- historicDataAvailability
type: object
ObbDateRangeAndAmount:
properties:
amount:
description: Metric value for the given period
example: 890.99
type: number
period:
description: Period represented by this metric
example: last30to1
type: string
minLength: 8
maxLength: 12
periodBeginDate:
description: Begin date of the period being reported
example: '2022-03-01'
type: string
minLength: 10
maxLength: 10
periodEndDate:
description: End date of the period being reported
example: '2022-03-30'
type: string
minLength: 10
maxLength: 10
required:
- period
- periodBeginDate
- periodEndDate
type: object
ObbDateRangeAndCount:
properties:
count:
description: Count of occurrences for the given period
example: 5
type: integer
period:
description: Period represented by this metric
example: last30to1
type: string
minLength: 8
maxLength: 12
periodBeginDate:
description: Begin date of the period being reported
example: '2022-03-01'
type: string
minLength: 10
maxLength: 10
periodEndDate:
description: End date of the period being reported
example: '2022-03-30'
type: string
minLength: 10
maxLength: 10
required:
- period
- periodBeginDate
- periodEndDate
- count
type: object
ObbErrorMessage:
description: OBB Error response message
properties:
errorCode:
type: integer
description: Error code
example: 404
message:
type: string
description: Detailed reason about the source of the error
minLength: 0
maxLength: 255
example: 'Customer Id does not exist'
required:
- errorCode
- message
type: object
ObbInstitution:
description: Details of the financial institution this account is home to
properties:
institutionIconUrl:
description: URL of the institution logo icon for reporting
example: >-
https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg
type: string
minLength: 0
maxLength: 255
institutionId:
description: ID of the financial institution
example: 12345
type: integer
institutionName:
description: Name of the financial institution
example: Wells Fargo
type: string
minLength: 0
maxLength: 255
institutionPrimaryColor:
description:
'Primary branding color of the institution, in hex color format'
example: '#1B3E4A'
type: string
minLength: 7
maxLength: 7
required:
- institutionId
type: object
ObbNumWeeksAverageBalanceIncreasing:
description:
Report of average account balance week over week and count of weeks
where the average balance increased
properties:
historicAverageWeeklyBalances:
description: Average weekly balances over the known history
items:
$ref: '#/components/schemas/ObbAverageWeeklyBalance'
type: array
historicNumberOfWeeksAverageBalanceIncreasing:
description: >-
Number of weeks during the known history where the average balance
of the account increased week over week
example: 3
type: integer
historicNumberOfWeeksWithDataAvailable:
description:
Number of weeks during the history in which data was available
example: 4
type: integer
required:
- historicNumberOfWeeksAverageBalanceIncreasing
- historicNumberOfWeeksWithDataAvailable
- historicAverageWeeklyBalances
type: object
ObbReportHeader:
description:
Details about the business the report is generated for and metadata
about the report
properties:
businessAddress:
description: Business address line 1
example: 123 Main St
type: string
minLength: 0
maxLength: 255
businessCity:
description: Business address city
example: Portland
type: string
minLength: 0
maxLength: 255
businessName:
description: Name of the business
example: B&G Construction
type: string
minLength: 0
maxLength: 255
businessState:
description: Business address state
example: OR
type: string
minLength: 0
maxLength: 255
businessZip:
description: Business address zip
example: '12345'
type: string
minLength: 0
maxLength: 255
referenceNumber:
description: Partner-provided reference number
example: 32asdfaasd0823
type: string
minLength: 0
maxLength: 255
reportDate:
description: Date the report was requested
example: '2022-03-16T21:28:38-07:00'
type: string
minLength: 25
maxLength: 25
reportId:
description: Generated unique report ID
example: 8ff8b4b2-706f-45c3-8d66-857bdb516214
type: string
minLength: 0
maxLength: 255
required:
- reportId
- reportDate
type: object
ObbWeekOfYear:
properties:
fromDate:
description: Begin date of the week
example: '2020-01-01'
type: string
minLength: 10
maxLength: 10
toDate:
description: End date of the week
example: '2020-01-07'
type: string
minLength: 10
maxLength: 10
week:
description: >-
Week number, where the first week of each year begins on January 1st
and ends on January 7th. May be in the range [1, 53]
example: 1
type: integer
required:
- week
- fromDate
- toDate
type: object
OpenDate:
type: integer
description: >-
(Checking/Savings/CD/MoneyMarket) Date when account was opened. A date
in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
OriginalMaturityDate:
type: integer
description: >-
(Mortgage/Loan) Original date of loan maturity. A date in Unix epoch
time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
OriginalPayrollReportId:
type: string
description: >-
The report ID of the original payroll report for refresh use cases. If
used, only the employment records from the original report will be
included in the refreshed report response.
example: u4hstnnak45g-voiepayroll
OutOfSchoolDate:
type: integer
description: >-
(Student Loan) The date the borrower graduated or dropped below
half-time enrollment in school. A date in Unix epoch time (in seconds).
See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
PartnerCredentials:
required:
- partnerId
- partnerSecret
type: object
properties:
partnerId:
$ref: '#/components/schemas/PartnerId'
partnerSecret:
type: string
description: >-
Your Partner Secret displayed in the [Developer
Dashboard](https://developer.mastercard.com/account/log-in)
example: aqJ5Ic4SEVx2IgDQ6oR4
PartnerCredentialsWithNewSecret:
required:
- partnerId
- partnerSecret
- newPartnerSecret
type: object
allOf:
- $ref: '#/components/schemas/PartnerCredentials'
- type: object
properties:
newPartnerSecret:
type: string
description: A new value for the Partner Secret
example: OrU7tjiA3tIspCgb85xV
immediate:
type: boolean
description:
This is an optional flag, with a default value of true. This
flag should be passed as false when the partners want the 30-day
grace period to be activated.
example: true
PartnerId:
type: string
description: >-
Your Partner ID displayed in the [Developer
Dashboard](https://developer.mastercard.com/account/log-in)
example: '1234583871234'
DisputeStatementErrorMessage:
required:
- code
- message
type: object
properties:
code:
type: integer
description: >-
An error code for dispute statement. Useful links: [API
Errors](https://developer.mastercard.com/open-finance-us/documentation/errors/),
[Aggregation Status
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manage/aggregation-status-codes/).
format: int32
example: 10406
status:
type: string
description: A status code
example: '403'
message:
type: string
description: An error message
example: 'The active dispute statement for this consumer exists.'
SecurityFreezeErrorMessage:
required:
- code
- message
type: object
properties:
code:
type: integer
description: >-
An error code for security freeze. Useful links: [API
Errors](https://developer.mastercard.com/open-finance-us/documentation/errors/),
[Aggregation Status
Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manage/aggregation-status-codes/).
format: int32
example: 10405
status:
type: string
description: A status code
example: '403'
message:
type: string
description: An error message
example: 'The active security freeze for this consumer exists.'
PartnerName:
type: string
description: Name of a Finicity partner
example: Finicity Test API
PayFrequency:
type: string
description: |
The current pay frequency or how often a regular pay check is:
* `Daily`
* `Weekly`
* `Bi-Weekly`
* `Semi-Monthly`
* `Monthly`
* `Quarterly`
* `Semi-Annual`
* `Annual`
* `Every 2.6 wks`
* `Every 4 wks`
* `Every 5.2 wks`
* `Other`
* `Unknown`
example: Weekly
PayStat:
type: object
properties:
name:
type: string
description: >-
The normalized category of the earnings with a number appended. The
number is the will be the iterating number of the type's occurrence
starting at one.
example: regular 1
type:
$ref: '#/components/schemas/PayStatEarningsCategorizationType'
description:
type: string
description: The earnings line's pay type description
example: regular income
rate:
type: number
description: >-
The rate for the earning line paid out to the employee for the
specified pay period.
example: 10.00
units:
type: number
description: >-
The units for the earning line paid out to the employee for the
specified pay period.
example: 60.00
amountCurrent:
type: number
description: >-
The amount for the earning line paid out to the employee for the
specified pay period.
example: 6000
amountYTD:
type: number
description: >-
The amount for the earning line being paid out to the employee for
the current pay year.
example: 18000
PayStatEarningsCategorizationType:
type: string
description: |-
The categorization based on the earning line's description. Possible values:
* "bereavement"
* "bonus"
* "commission"
* "holiday"
* "jury duty"
* "overtime"
* "pension"
* "pto"
* "regular"
* "sick"
* "tips"
* "unknown"
* "vacation"
* "reimbursement"
* "stock"
* "benefit"
PayStatement:
description: A pay statement document and pay statement label
required:
- label
- statement
type: object
properties:
label:
type: string
description: >-
The label to be associated with the pay statement. This label will
allow the paystub to go through data extraction.
* `lastPayPeriod`: default label that should be used for the VOIE -
Paystub products
* `lastPayPeriodMinusOne`: the second most recent pay statement
* `lastPayPeriodMinusTwo`: the third most recent pay statement
* `previousYearLastPayPeriod` Last pay statement of the previous
calendar year
* `previousYear2LastPayPeriod`: last pay statement of the calendar
year 2 years prior
* `earliestPayPeriod`: the earliest pay statement
example: lastPayPeriod
statement:
type: string
description: >-
A Base64 encoded pay statement file. Finicity supports PDF, JPG, or
PNG files.
example: VGhpcyBtdXN0IGJlIGFuIGltYWdl
PayStatementData:
description: Data to be included within the pay statement report
required:
- assetIds
type: object
properties:
assetIds:
description: A list of pay statement asset IDs
type: array
items:
$ref: '#/components/schemas/AssetId'
extractEarnings:
$ref: '#/components/schemas/ExtractEarnings'
extractDeductions:
$ref: '#/components/schemas/ExtractDeductions'
extractDirectDeposit:
$ref: '#/components/schemas/ExtractDirectDeposit'
PayStatementReport:
description: A Pay Statement report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
reportStyle:
$ref: '#/components/schemas/ReportStyle'
numberOfBillableAssets:
type: integer
description:
Total number of billable pay statements included in the report
format: int32
example: 1
assetIds:
type: array
items:
$ref: '#/components/schemas/AssetId'
payStatements:
type: array
items:
$ref: '#/components/schemas/VOIEPayStatement'
description: Extracted pay statement details
PayStatementReportAck:
description: A Pay Statement report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/PayStatementReportConstraints'
PayStatementReportConstraints:
required:
- paystatementReport
type: object
properties:
paystatementReport:
$ref: '#/components/schemas/PayStatementData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
PayStatementsFromDate:
type: integer
description: >-
Limits the pay statement history in the VOIE - Payroll report income
record. Pay statements are only included if the payDate of the statement
is equal to or greater than the start date requested. Date should be in
Unix epoch time (in seconds). See: Handling Epoch Dates and Times.
format: int64
example: 1607450357
PaymentDueDate:
type: integer
description: >-
(Credit Card/Line Of Credit) Due date for the next payment. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
PayoffAmountDate:
type: integer
description: >-
(Mortgage/Loan) Date of final payment. A date in Unix epoch time (in
seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
PayrollData:
type: object
properties:
ssn:
$ref: '#/components/schemas/SSNPayroll'
dob:
$ref: '#/components/schemas/ConsumerDateOfBirth'
reportId:
$ref: '#/components/schemas/OriginalPayrollReportId'
payrollAccountIds:
type: array
items:
$ref: '#/components/schemas/PayrollAccountId'
PayrollDataOut:
type: object
properties:
payrollDataRetrievalId:
$ref: '#/components/schemas/PayrollDataRetrievalId'
payrollAggregatorResponseId:
$ref: '#/components/schemas/PayrollDataRetrievalId'
consentMethod:
type: string
description: >-
Client-collected consent payroll report tagging.
example: Written Generic - Finicity Set
employmentIds:
type: array
description: An array of employmentIds
items:
$ref: '#/components/schemas/EmploymentId'
payrollAccountIds:
type: array
description: An array of payrollAccountIds
items:
$ref: '#/components/schemas/PayrollAccountId'
reportId:
$ref: '#/components/schemas/ReportId'
PayrollDataRetrievalId:
type: string
description: >-
An ID to identify the data retrieved from the payroll providers for the
report.
example: hahvhe2k0000
PayrollAggregatorResponseId:
type: string
description: >-
This is an internal ID to track the retrieval of data from the internal
payroll aggregator service. This is not intended to be used by the
client.
example: ab1cd2ef3212
PayrollEmployeeAddress:
type: object
properties:
address1:
type: string
description:
Employee address as stated by the employer in the payroll system
example: Address 1
city:
type: string
description:
Employee city as stated by the employer in the payroll system
example: City
state:
type: string
description:
Employee state as stated by the employer in the payroll system
example: TX
zip:
type: string
description:
Employee zip code as stated by the employer in the payroll system
example: '99999'
PayrollEmployeeRecord:
required:
- name
type: object
properties:
name:
type: string
description:
'Full name of the employee: first, middle (if stated), and last name'
example: John Doe Smith
givenName:
type: string
description: First name of employee
example: John
middleName:
type: string
description: 'Middle name of employee, if stated'
example: Doe
familyName:
type: string
description: Last name of employee
example: Smith
address:
type: array
items:
$ref: '#/components/schemas/PayrollEmployeeAddress'
description: Array of addresses
PayrollEmployerAddress:
type: object
properties:
address1:
type: string
description:
Employer address as stated by the employer in the payroll system
example: Address 1
city:
type: string
description:
Employer city as stated by the employer in the payroll system
example: City
state:
type: string
description:
Employer state as stated by the employer in the payroll system
example: TX
zip:
type: string
description:
Employer zip code as stated by the employer in the payroll system
example: '99999'
PayrollProviderName:
type: string
description:
The name of the provider who provides payroll data to payroll source
example: Paychex
PayrollEmploymentHistoryVOE:
required:
- asOfDate
- employerName
- payrollSource
- employee
- employment
- income
type: object
properties:
asOfDate:
$ref: '#/components/schemas/AsOfDate'
employerName:
$ref: '#/components/schemas/EmployerName'
payrollSource:
type: string
description:
The name of the payroll source where the data was retrieved
example: finPayroll
payrollProvider:
$ref: '#/components/schemas/PayrollProviderName'
employee:
$ref: '#/components/schemas/PayrollEmployeeRecord'
employment:
$ref: '#/components/schemas/PayrollEmploymentRecord'
income:
$ref: '#/components/schemas/PayrollVOEIncomeRecord'
PayrollEmploymentHistoryVOIE:
required:
- asOfDate
- employerName
- payrollSource
- employee
- employment
- income
type: object
properties:
asOfDate:
$ref: '#/components/schemas/AsOfDate'
employmentId:
$ref: '#/components/schemas/EmploymentId'
employerName:
$ref: '#/components/schemas/EmployerName'
payrollSource:
type: string
description:
The name of the payroll source where the data was retrieved
example: finPayroll
payrollProvider:
$ref: '#/components/schemas/PayrollProviderName'
employee:
$ref: '#/components/schemas/PayrollEmployeeRecord'
employment:
$ref: '#/components/schemas/PayrollEmploymentRecord'
income:
$ref: '#/components/schemas/PayrollVOIEIncomeRecord'
PayrollEmploymentRecord:
required:
- employerName
- employmentStatusCode
- employmentStatusName
- workLevelStatus
type: object
properties:
employerName:
$ref: '#/components/schemas/EmployerName'
legalEntityId:
type: string
description: Employer identification number (EIN)
example: '752760000'
originalHireDate:
type: integer
description: The original hired date of an employee at the company
format: int64
example: 1527832800
latestHireDate:
type: integer
description: >-
If an employee leaves the company and returns later, then the
employer states the latest hire date at the company
format: int64
example: 1527832800
latestPayPeriodEndDate:
type: integer
description: The most recent pay periodโs end date.
format: int64
example: 1596175201
latestPayDate:
type: integer
description: The most recent pay date from an employer
format: int64
example: 1596175200
daysSinceLastPay:
type: integer
description: The number of days since an employee was last paid
format: int32
example: 10
numberPayCadenceWithoutPay:
type: integer
description: >-
The number of pay cadences an employee has not been paid; determined
by the pay frequency
format: int32
example: 1
employmentEndDate:
type: integer
description:
The date an employee ended their employment at the company
format: int64
example: 1527832800
employmentDuration:
type: string
description: >-
The length of time an employee has been employed with that employer
in ISO 8601 format (e.g. P1Y6M0D)
example: P1Y6M0D
employerAddress:
type: array
items:
$ref: '#/components/schemas/PayrollEmployerAddress'
description: Array of addresses
employmentStatusCode:
type: string
description: >-
'Status codes: `A` - Active, `NLE` - No Longer Employed, `L` -
Leave, `O` - Other', `I` - Inactive, `U` - Unknown'
example: A
employmentStatusName:
type: string
description:
"'Status name: `Active`, `No Longer Employed`, `Leave` or `Other`,
`Inactive`, or `Unknown`'"
example: Active
derivedEmploymentStatus:
type: boolean
description:
Describes the employment status - it will be true if it is not
directly stated by the employer, and false otherwise
example: true
workLevelCode:
type: string
description: >-
The abbreviate code for the employment level names (workLevelName)
that we receive from the employer
example: FT
workLevelName:
type: string
description: >-
The employment level name is whatever we receive from the employer,
such as full time, part time, temp, contractor, and more
example: Full Time-Regular
workLevelStatus:
type: string
description: >
The categorized work level status. Enumerations are:
* `Temporary`
* `Seasonal`
* `Retired`
* `Student`
* `Full Time`
* `Part Time`
* `Unspecified`
This is a new field, currently enabled only for testing reports. It
will be added for all reports in August 2021.
example: Full Time
positionTitle:
type: string
description: Employee job title
example: Shift Supervisor
positionDuration:
type: string
description: >-
The length of time an employee has been employed at their current or
latest position for this employment in ISO 8601 format (eg P1Y6M0D)
example: P1Y6M0D
PayrollReportAck:
description: A Payroll report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
reportStyle:
$ref: '#/components/schemas/ReportStyle'
constraints:
$ref: '#/components/schemas/PayrollReportConstraintsOut'
PayrollReportConstraints:
required:
- payrollData
type: object
properties:
payrollData:
$ref: '#/components/schemas/PayrollData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
payStatementsFromDate:
$ref: '#/components/schemas/PayStatementsFromDate'
marketSegment:
$ref: '#/components/schemas/MarketSegment'
excludeEmpInfo:
$ref: '#/components/schemas/ExcludeEmpInfo'
purpose:
$ref: '#/components/schemas/PurposeCode'
PayrollReportConstraintsOut:
required:
- payrollData
type: object
properties:
payrollData:
$ref: '#/components/schemas/PayrollDataOut'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
payStatementsFromDate:
$ref: '#/components/schemas/UnixDate'
PayrollVOEIncomeRecord:
type: object
properties:
payFrequency:
$ref: '#/components/schemas/PayFrequency'
PayrollVOIEIncomeRecord:
type: object
properties:
payFrequency:
$ref: '#/components/schemas/PayFrequency'
payType:
type: string
description: |
The current pay type:
* `Salary`
* `Hourly`
* `Daily`
example: Daily
basePayRate:
type: number
description: >-
The current base or regular pay rate. Please use in conjunction with
the `basePayRateUnit` field.
example: 1234.56
basePayRateUnit:
type: string
description: |
Unit for the base pay rate:
* `Hourly`
* `Daily`
* `Weekly`
* `Bi-Weekly`
* `Semi-Monthly`
* `Monthly`
* `Quarterly`
* `Semi-Annual`
* `Annual`
* `Every 2.6 wks`
* `Every 5.2 wks`
* `Other`
example: Annual
oldestPayStatementAvailable:
type: string
description: >-
The date of the oldest direct pay statement available from the
payroll source, as measured by the oldest `payDate` from all the pay
statements delivered.
example: 1527832900
annualIncome:
type: array
items:
$ref: '#/components/schemas/AnnualIncome'
description: |-
The annual pay for the current year, through prior year 2 (as available)
This is a mandatory field only for VOIE-payroll report type.
monthlyIncome:
$ref: '#/components/schemas/MonthlyIncome'
directPayStatements:
type: array
items:
$ref: '#/components/schemas/DirectPayStatements'
description: An array of payment histories for each available paycheck
PaystubMonthlyIncomeRecord:
type: object
properties:
estimatedMonthlyBasePay:
type: number
description: >-
The estimated monthly base pay amount for the employment from the
paystub, calculated by Finicity
example: 2000
estimatedMonthlyOvertimePay:
type: number
description: >-
The estimated monthly overtime pay amount for the employment from
the paystub, calculated by Finicity
example: 50
estimatedMonthlyBonusPay:
type: number
description: >-
The estimated monthly bonus pay amount for the employment from the
paystub, calculated by Finicity
example: 20
estimatedMonthlyCommissionPay:
type: number
description: >-
The estimated commission bonus pay amount for the employment from
the paystub, calculated by Finicity
example: 50
PaystubTxVerifyMonthlyIncomeRecord:
type: object
properties:
estimatedMonthlyBasePay:
type: number
description: >-
The estimated monthly base pay amount for the employment from the
paystub, calculated by Finicity
example: 2000
estimatedMonthlyOvertimePay:
type: number
description: >-
The estimated monthly overtime pay amount for the employment from
the paystub, calculated by Finicity
example: 50
estimatedMonthlyBonusPay:
type: number
description: >-
The estimated monthly bonus pay amount for the employment from the
paystub, calculated by Finicity
example: 20
estimatedMonthlyCommissionPay:
type: number
description: >-
The estimated commission bonus pay amount for the employment from
the paystub, calculated by Finicity
example: 50
estimatedMonthlyOtherPay:
type: number
description: >-
The estimated monthly other pay amount for the employment from the
paystub, calculated by Finicity
example: 150
estimatedMonthlyTotalPay:
type: number
description: >-
The estimated monthly total pay amount for the employment from the
paystub, calculated by Finicity
example: 2120
PeriodEndDate:
type: integer
description: >-
End date of period. A date in Unix epoch time (in seconds). See:
[Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
PeriodStartDate:
type: integer
description: >-
(Checking/Savings/CD/MoneyMarket) Start date of period. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
PhoneCarrier:
type: string
description: >-
The company that provides voice and/or data services for the phone
number. Carriers are returned at the MVNO level.
example: Vodafone UK ltd.
PhoneCountry:
type: string
description: >-
Country calling code of the phone number as defined by ITU-T E.123 and
E.164 international standards (max length 3)".
example: '61'
PhoneCountryCode:
type: string
description:
The ISO-3166 alpha-2 country code associated with the phone number.
example: UK
PhoneEmailFirstSeenDays:
type: number
description: >-
Count of days since the combination of phone and email was first
observed in Ekata's Identity Network. If that combination has not been
observed before, `phoneEmailFirstSeenDays` will be 0.
example: 54
PhoneLastSeenDays:
type: number
description: >-
Count of days since the phone was last observed in Ekata's Identity
Network. If the phone has not been observed before, `phoneLastSeenDays`
will be 0.
example: 42
PhoneLineType:
type: string
description: >-
The line type of the phone number.
* landline - traditional wired phone line.
* fixed-voip - VoIP-based fixed line phones.
* mobile - wireless phone line.
* voicemail - voicemail-only service.
* toll-free - callee pays for call.
* premium - caller pays a premium for the call-e.g., 976 area code.
* non-fixed-voip - Skype, for example * other - anything that does not
match the previous categories.
example: mobile
PhoneNumber:
type: string
description: A phone number (max length 15).
example: 1-801-984-4200
PhoneToAddress:
type: string
description: >-
The match status between the input phone and the queried entity.
* match - Phone location matches input address line 1, address line 2,
city, state, and postal code.
* postal-match - Phone location postal code matches input address postal
code.
* zip4-match - Phone location postal code zip+4 matches input address
postal code zip+4.
* city-state-match - Phone location city and state matches input address
city and state.
* metro-match - Phone location is in the same metro area as input
address.
* country-match - Phone location country matches input address country.
* no-match - Phone location does not match input address.
example: match
PhoneToName:
type: string
description: |-
The match status between the input name and the queried entity.
* not-found
* match
* no-match
example: match
PhoneValid:
type: boolean
description: True if the phone number is valid.
example: true
PortfolioConsumer:
required:
- id
- firstName
- lastName
- customerId
- ssn
- birthday
type: object
properties:
id:
$ref: '#/components/schemas/ConsumerId'
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
ssn:
$ref: '#/components/schemas/SocialSecurityNumber'
birthday:
$ref: '#/components/schemas/Birthday'
suffix:
$ref: '#/components/schemas/Suffix'
PortfolioId:
type: string
description: >-
A unique identifier that will be consistent across all reports created
for the same customer
example: y4zsgccj4xpw-6-port
PortfolioReport:
required:
- id
- portfolioId
- type
- status
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/ReportId'
portfolioId:
$ref: '#/components/schemas/PortfolioId'
type:
$ref: '#/components/schemas/ReportType'
status:
$ref: '#/components/schemas/ReportStatus'
createdDate:
$ref: '#/components/schemas/UnixDate'
PortfolioSummary:
required:
- portfolioId
- reports
type: object
properties:
portfolioId:
$ref: '#/components/schemas/PortfolioId'
reports:
type: array
items:
$ref: '#/components/schemas/PortfolioReport'
description: A list of reports in the portfolio
PortfolioWithConsumerSummary:
required:
- portfolioId
- consumer
- reports
allOf:
- $ref: '#/components/schemas/PortfolioSummary'
- type: object
properties:
consumer:
$ref: '#/components/schemas/PortfolioConsumer'
PreAppId:
type: string
description: >-
Identifier to track the application registration from the App
Registration and Get App Registration Status APIs
example: '2581'
PrequalificationReport:
description: A Prequalification report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: The number of days covered by the report
example: 230
seasoned:
type: boolean
description: '"true" if the report covers more than 180 days'
example: true
consolidatedAvailableBalance:
type: number
description: >-
The sum of available balance for all of the accounts included in
the report
example: 1929.57
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts in this report
assets:
$ref: '#/components/schemas/PrequalificationReportAssetSummary'
PrequalificationReportAccount:
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
number:
type: string
description: >-
The account number from the institution (all digits except the last
four are obfuscated)
example: '1111'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
type:
type: string
description: The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
balance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 501.24
balanceDate:
type: integer
description: A timestamp of the balance
format: int64
example: 1588350276
availableBalance:
type: number
description: Available balance
example: 1000
averageMonthlyBalance:
type: number
description: The average monthly balance of the account
example: 501.02
totNumberInsufficientFundsFeeDebitTxAccount:
type: integer
description: >-
The count for the total number of insufficient funds transactions,
based on the `fromDate` of the report
format: int32
example: 0
totNumberInsufficientFundsFeeDebitTxOver6MonthsAccount:
type: integer
description: >-
The total number of insufficient funds fees for the account over
six months
format: int32
example: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount:
type: integer
description: >-
The total number of days since the most recent insufficient funds
fee for the account
format: int64
example: 120
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
asset:
$ref: '#/components/schemas/PrequalificationReportAssetSummary'
details:
$ref: '#/components/schemas/AccountDetails'
PrequalificationReportAck:
description: A Prequalification report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/PrequalificationReportConstraintsOut'
PrequalificationReportAssetSummary:
required:
- currentBalance
- twoMonthAverage
- beginningBalance
type: object
properties:
type:
type: string
description:
'The asset type: "checking", "savings", "moneyMarket", "cd",
"investment"'
example: checking
availableBalance:
type: number
description: The available balance for the account
example: 1000
currentBalance:
type: number
description: The current balance of the account
example: 1000
twoMonthAverage:
type: number
description: The two month average daily balance of the account
example: -1865.96
sixMonthAverage:
type: number
description: The six month average daily balance of the account
example: -7616.01
beginningBalance:
type: number
description:
The beginning balance of the account per the time period of the
report
example: -17795.6
PrequalificationReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
PrequalificationReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
PurposeCode:
type: string
description: >-
FCRA required 2-digit Permissible Purpose Code, specifying the reason
for retrieving this report.
example: '31'
RailType:
type: string
description: The Rail (ACH / RTP) used for initiating bank deposit(s).
example: ach
AutoVerifiedAccount:
type: integer
format: int64
description:
This field stores an ID for the linked bank account to verify the
microdeposits. It will have a value populated only when the
microdeposits are auto verified successfully via account aggregation,
otherwise this field will not be present.
example: 9876543210
Receiver:
required:
- routingNumber
- accountNumber
- accountType
- name
type: object
properties:
routingNumber:
$ref: '#/components/schemas/RoutingNumber'
accountNumber:
type: string
example: '123456'
description: Micro entries receiving account number of bank
accountType:
type: string
example: personalChecking
description: |-
The list of supported account types.
* "personalChecking": Personal Checking
* "businessChecking": Business Checking
* "personalSavings": Personal Savings
* "businessSavings": Business Savings
* "checking": Standard checking, will be deprecated
* "savings": Standard savings, will be deprecated
name:
type: string
example: Bob Smith
description: Name of the customer
memo:
type: string
example: micro deposit transfer
description: Transaction memo to be displayed for transactions
RedirectUri:
type: string
description: >-
The URL that customers will be redirected to after completing Finicity
Connect. Required unless Data Connect is embedded inside our
application (iframe). Required for NON SDK integrations, should be iOS
universal link OR Android app link when Data Connect is hosted in a web
view / secure container of the partner mobile app.
example: 'https://www.finicity.com/connect/'
RegisteredApplication:
required:
- preAppId
- status
type: object
properties:
preAppId:
$ref: '#/components/schemas/NumericPreAppId'
status:
$ref: '#/components/schemas/AppRegistrationStatus'
RepaymentPlanEndDate:
type: integer
description: >-
(Student Loan) The end date of the current repayment plan. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
RepaymentPlanStartDate:
type: integer
description: >-
(Student Loan) The start date of the current repayment plan. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
Report:
description: A report
type: object
required:
- id
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- type
- status
anyOf:
- $ref: '#/components/schemas/AFBalanceAnalyticsReport'
- $ref: '#/components/schemas/AFCashFlowAnalyticsReport'
- $ref: '#/components/schemas/ForesightAnalyticsReport'
- $ref: '#/components/schemas/AFPaymentHistoryAnalyticsReport'
- $ref: '#/components/schemas/CashFlowReport'
- $ref: '#/components/schemas/PrequalificationReport'
- $ref: '#/components/schemas/PayStatementReport'
- $ref: '#/components/schemas/StatementReport'
- $ref: '#/components/schemas/TransactionsReport'
- $ref: '#/components/schemas/VOAReport'
- $ref: '#/components/schemas/VOAWithIncomeReport'
- $ref: '#/components/schemas/VOEPayrollReport'
- $ref: '#/components/schemas/VOETransactionsReport'
- $ref: '#/components/schemas/VOIReport'
- $ref: '#/components/schemas/VOIEPayrollReport'
- $ref: '#/components/schemas/VOIEPaystubReport'
- $ref: '#/components/schemas/VOIEPaystubWithTXVerifyReport'
ReportWithFirstThirdParty:
description: A report
type: object
required:
- id
- requestId
- requesterName
- createdDate
- reportRefreshNumber
- originalReportCreatedDate
- title
- type
- status
allOf:
- $ref: '#/components/schemas/ForesightAnalyticsFirstThirdPartyReport'
ReportAccountIds:
description: >-
An array of account IDs to be included in the report (all accounts will
be included if not set)
type: array
items:
$ref: '#/components/schemas/AccountId'
example:
- '5011648377'
- '5011648378'
- '5011648379'
ReportAccountIdsString:
type: string
description: >-
A whitespace-separated list of account IDs to be included in the report
(all accounts will be included if not set)
example: 5011648377 5011648378 5011648379
ReportCustomField:
type: object
properties:
label:
type: string
description: The name of the custom field
example: loanID
value:
type: string
description: The value of the custom field
example: '123456'
shown:
type: boolean
description: If the custom field will show on the PDF or not
example: true
BillingResellerReport:
type: object
properties:
totalPages:
type: integer
totalElements:
type: integer
numberOfElements:
type: integer
pageable:
$ref: '#/components/schemas/PageableObject'
sort:
$ref: '#/components/schemas/SortObject'
number:
type: integer
first:
type: boolean
last:
type: boolean
size:
type: integer
content:
type: array
items:
$ref: '#/components/schemas/BillingReport'
empty:
type: boolean
PageableObject:
type: object
properties:
paged:
type: boolean
unpaged:
type: boolean
pageNumber:
type: integer
pageSize:
type: integer
sort:
$ref: '#/components/schemas/SortObject'
offset:
type: integer
SortObject:
type: object
properties:
unsorted:
type: boolean
sorted:
type: boolean
empty:
type: boolean
BillingReport:
type: object
properties:
reseller:
type: string
resellerProvider:
type: string
platformProvider:
type: string
customerId:
$ref: '#/components/schemas/NumericCustomerId'
consumerId:
$ref: '#/components/schemas/ConsumerId'
consumerSsn:
$ref: '#/components/schemas/SocialSecurityNumberLastDigits'
consumerCustomId:
type: string
firstName:
$ref: '#/components/schemas/FirstName'
lastName:
$ref: '#/components/schemas/LastName'
lastFourReportId:
description: This represents the last four character of Report
type: string
reportId:
$ref: '#/components/schemas/ReportId'
createdDate:
$ref: '#/components/schemas/UnixDate'
reportType:
$ref: '#/components/schemas/ReportType'
status:
$ref: '#/components/schemas/ReportStatus'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
ReportCustomFields:
type: array
items:
$ref: '#/components/schemas/ReportCustomField'
description: >-
The `reportCustomFields` parameter is used when experiences are
associated with a credit decisioning report.
Designate up to 5 custom fields that you'd like associated with the
report when it's generated. Every custom field consists of three
variables: `label`, `value`, and `shown`. The `shown` variable is "true"
or "false".
* "true": (default) display the custom field in the PDF report
* "false": don't display the custom field in the PDF report
For an experience that generates multiple reports, the
`reportCustomFields` parameter gets passed to all reports.
All custom fields display in the Reseller Billing API.
ReportEndDate:
type: integer
description: >-
The `postedDate` of the latest transaction analyzed for the report. A
date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
ReportId:
type: string
description: A report ID
example: u4hstnnak45g
ReportIncomeEstimate:
required:
- netAnnual
- projectedNetAnnual
- estimatedGrossAnnual
- projectedGrossAnnual
type: object
properties:
netAnnual:
description:
Sum of all values in `netMonthlyIncome` over the previous 12 months
type: number
example: 1000.12
projectedNetAnnual:
description: >-
Projected net income over the next 12 months, across all income
streams, based on `netAnnualIncome`
type: number
example: 1500.23
estimatedGrossAnnual:
description: >-
Before-tax gross annual income (estimated from `netAnnual`) across
all income stream in the past 12 months
type: number
example: 2000.12
projectedGrossAnnual:
description: >-
Projected gross income over the next 12 months, across all active
income streams, based on `projectedNetAnnual`
type: number
example: 2500.23
ReportIncomeStreamSummary:
required:
- confidenceType
- netMonthly
- incomeEstimate
type: object
properties:
confidenceType:
$ref: '#/components/schemas/EstimateInclusion'
netMonthly:
type: array
items:
$ref: '#/components/schemas/NetMonthly'
description: >-
A list of net monthly records. One instance for each complete
calendar month in the report.
incomeEstimate:
$ref: '#/components/schemas/ReportIncomeEstimate'
ReportInstitution:
required:
- id
- name
- urlHomeApp
type: object
properties:
id:
$ref: '#/components/schemas/NumericInstitutionId'
name:
type: string
description: Finicity institution name
example: FinBank Profiles
urlHomeApp:
type: string
description: The URL of the Financial Institution
example: 'http://www.finbank.com'
accounts:
type: array
items:
$ref: '#/components/schemas/ReportInstitutionAccount'
description: A list of account records
ReportInstitutionAccount:
description: An account record
type: object
anyOf:
- $ref: '#/components/schemas/AnalyticsReportsAccount'
- $ref: '#/components/schemas/CashFlowReportAccount'
- $ref: '#/components/schemas/PrequalificationReportAccount'
- $ref: '#/components/schemas/TransactionsReportAccount'
- $ref: '#/components/schemas/VOAReportAccount'
- $ref: '#/components/schemas/VOAWithIncomeReportAccount'
- $ref: '#/components/schemas/VOETransactionsReportAccount'
- $ref: '#/components/schemas/VOIReportAccount'
- $ref: '#/components/schemas/VOIETXVerifyReportAccount'
ReportPin:
type: string
description: A unique key returned per report for consumer Portal
example: 2398jk
AccountCurrency:
type: string
description: A currency code for account
example: USD
ReportRequestId:
type: string
description:
Finicity indicator to track all activity associated with this report
example: cjqm4wtdcn
ReportStartDate:
type: integer
description: >-
The `postedDate` of the earliest transaction analyzed for the report. A
date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
ReportStatus:
type: string
description: |
A report generation status. Possible values:
* `inProgress`
* `success`
* `failure`
example: inProgress
ReportSummaries:
required:
- reports
type: object
properties:
reports:
type: array
items:
$ref: '#/components/schemas/ReportSummary'
description: Data pertaining to each report
ReportSummary:
required:
- id
- requestId
- requesterName
- createdDate
- type
- status
properties:
id:
$ref: '#/components/schemas/ReportId'
requestId:
$ref: '#/components/schemas/ReportRequestId'
requesterName:
$ref: '#/components/schemas/PartnerName'
createdDate:
$ref: '#/components/schemas/UnixDate'
consumerId:
$ref: '#/components/schemas/ConsumerId'
consumerSsn:
$ref: '#/components/schemas/SocialSecurityNumberLastDigits'
type:
$ref: '#/components/schemas/ReportType'
status:
$ref: '#/components/schemas/ReportStatus'
ReportTitle:
type: string
description: Title of the report
example: Finicity Asset Ready Report (CRA)
ReportTransactionBase1:
required:
- id
- postedDate
- description
type: object
properties:
id:
$ref: '#/components/schemas/TransactionId'
amount:
type: number
description: >-
The total amount of the transaction. Transactions for deposits are
positive values, withdrawals and debits are negative values.
example: 100
postedDate:
type: integer
description: >-
A timestamp showing when the transaction was posted or cleared by
the institution
format: int64
example: 1571313600
description:
type: string
description: >-
The description of the transaction, as provided by the institution
(often known as `payee`). In the event that this field is left blank
by the institution, Finicity will pass a value of "No description
provided by institution". All other values are provided by the
institution.
example: ATM CHECK DEPOSIT mm/dd
memo:
type: string
description: >-
The memo field of the transaction, as provided by the institution.
The institution must provide either a description, a memo, or both.
It is recommended to concatenate the two fields into a single value.
example: Some St Somewhere City State
ReportTransactionBase2:
type: object
properties:
normalizedPayee:
type: string
description: >-
A normalized payee, derived from the transaction's `description` and
`memo` fields
example: T-Mobile
institutionTransactionId:
type: string
description:
The unique identifier given by the FI for each transaction
example: '0000000000'
category:
type: string
description:
One of the values from Categories (assigned based on the payee name)
example: Income
type:
type: string
description: One of the values from transaction types
example: debit
securityType:
type: string
description: The type of investment security (VOA only)
example: 'Stock'
symbol:
type: string
description: Investment symbol (VOA only)
example: 'DAL'
commission:
description: A commission amount
type: number
example: 0
ReportTransaction:
type: object
allOf:
- $ref: '#/components/schemas/ReportTransactionBase1'
- $ref: '#/components/schemas/ReportTransactionBase2'
ReportTransactionNewTxBased:
type: object
allOf:
- $ref: '#/components/schemas/ReportTransactionBase1'
- type: object
properties:
investmentTransactionType:
type: string
description: |
Keywords in the description and memo fields were used to translate investment transactions into these types
* `cancel`
* `purchaseToClose`
* `purchaseToCover`
* `contribution`
* `optionExercise`
* `optionExpiration`
* `fee`
* `soldToClose`
* `soldToOpen`
* `split`
* `transfer`
* `returnOfCapital`
* `income`
* `purchased`
* `sold`
* `dividendReinvest`
* `dividend`
* `reinvestOfIncome`
* `interest`
* `deposit`
* `otherInfo`
example: dividend
- $ref: '#/components/schemas/ReportTransactionBase2'
ReportAccountPosition:
type: object
properties:
id:
type: number
description: The id of the investment position
example: 637054
currency:
type: string
description: What currency the account operates in
example: USD
symbol:
type: string
description: The investment positionโs market ticker symbol
example: MCD
securityName:
type: string
description: The security name for the investment holding
example: Common Stock
units:
type: number
description: The number of units of the holding
example: 5
marketValue:
type: number
description:
Market value of an investment position at the time of retrieval
example: 1403.55
currentPrice:
description: The current price of the investment holding
type: number
example: 280.71
securityType:
description: Type of security of the investment position
type: number
example: Stock
ReportType:
description: |
A report type. Possible values:
* `voi`
* `voa`
* `voaHistory`
* `history`
* `voieTxVerify`
* `voieWithReport`
* `voieWithInterview`
* `voieWithStatement`
* `paystatement`
* `preQualVoa`
* `assetSummary`
* `voie`
* `transactions`
* `statement`
* `voiePayroll`
* `voeTransactions`
* `farpbfnoncra`
* `voePayroll`
* `cfrp`
* `cfrb`
* `barpcra`
* `barpnoncra`
* `barbcra`
* `barbftc`
* `barbnoncra`
* `cfrpcra`
* `cfrpnoncra`
* `cracfrbcra`
* `cfrbnoncra`
* `cfrbftc`
* `phrbcra`
* `phrbnoncra`
* `phrbftc`
* `sbcaanalyticsnoncra`
* `sbcabenchmarksnoncra`
type: string
example: voi
SBCAReportType:
description: |
A Small Business Credit Analytics Report type. Possible values:
* `sbcaanalyticsnoncra`
* `sbcabenchmarksnoncra`
type: string
example: voi
RoutingNumber:
type: string
example: '123456789'
description: Routing number of receiving bank
RoutingNumberInteger:
description: Routing number
type: integer
example: 9713824
maximum: 2147483647
minimum: 1
Rssd:
type: integer
description: >-
The RSSD ID is a unique identifier assigned to financial institutions by
the Federal Reserve. While the length of the RSSD ID varies by
institution, it cannot exceed 10 numerical digits.
format: int64
example: 490535
ScoreIndicator:
type: string
description:
'`scoreIndicator` conveys the `compositeScore`, projecting 3 possible
values: "Highly Likely to Settle", "Likely to Settle", and "Less Likely
to Settle"'
example: Likely to Settle
minLength: 1
maxLength: 50
SecurityIdType:
type: string
description: >-
The security type. This field is related to the `securityId` field.
Possible values:
* "CUSIP"
* "ISIN"
* "SEDOL"
* "SICC"
* "VALOR"
* "WKN"
example: CUSIP
ShowNsf:
type: boolean
description: >-
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 the most recent NFS funds fee
example: false
SingleUseUrl:
type: boolean
description: >-
"true": The URL link expires after a Data Connect session successfully
completes.
Note: when the `singleUseUrl` and the `experience` parameters are passed
in the same call, the `singleUseUrl` value overrides the `singleUseUrl`
value configured in the `experience` parameter.
example: true
SocialSecurityNumber:
type: string
description: A full SSN with or without hyphens
example: 999-99-9999
SocialSecurityNumberLastDigits:
type: string
description: Last 4 digits of a SSN
example: '9999'
DisputeStatement:
description: The dispute text
type: string
minLength: 1
maxLength: 2000
example: 'Statement dispute text'
SSNPayroll:
type: string
description:
The consumer's full SSN without hyphens. Only required for the Direct
API Payroll solution, not required for the Credentialed Payroll
solution.
example: '999999999'
SocialSecurityNumberNoHyphens:
type: string
description: The consumer's full SSN without hyphens
example: '999999999'
State:
type: string
description: State
example: UT
StatementData:
required:
- accountId
type: object
properties:
accountId:
$ref: '#/components/schemas/NumericAccountId'
statementIndex:
type: integer
description: >-
Index of the statement to include in the report. Request statements
from 1-24. By default, 1 is the most recent statement. Increase the
index value to count back (by month) and retrieve its most recent
statement.
format: int32
example: 1
default: 1
maximum: 24
StatementEndDate:
type: integer
description: >-
(Credit Card/Line Of Credit) End date of statement period. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
StatementReport:
description: A Statement report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAck'
- type: object
properties:
assetId:
$ref: '#/components/schemas/AssetId'
StatementReportAck:
description: A Statement report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/StatementReportConstraints'
StatementReportConstraints:
required:
- statementReportData
type: object
properties:
statementReportData:
$ref: '#/components/schemas/StatementData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
StatementStartDate:
type: integer
description: >-
(Credit Card/Line Of Credit) Start date of statement period. A date in
Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
StatementType:
type: string
description: Account statement types
example: taxStatement
StateAttribute:
description: 'An attribute which represents some state over time, such as
a balance or a
calculation, including derivatives, ratios, or projections. Reports the
state over the requested time interval(s).'
properties:
attributeName:
description: Name of Attribute as mentioned in Data Dictionary
example: NET_CASH_FLOW
type: string
reportedByTimePeriods:
description: List of state values grouped by specified Time Interval
items:
$ref: '#/components/schemas/StateTimeInterval'
type: array
required:
- attributeName
- reportedByTimePeriods
type: object
StatePeriod:
description: Statistics for one period in the report of a StateAttribute.
properties:
beginningValue:
description: Value on the first date in the period
example: 60.21
type: number
count:
description: Count of data points during the period
example: 2
type: integer
endDate:
description: End date for the period being reported
example: '2023-01-01'
format: date
type: string
endingValue:
description: Value on the last date in the period
example: 60.21
type: number
max:
description: Maximum amount during the period
example: 60.21
type: number
mean:
description: Mean of amounts during the period
example: 42.22
type: number
median:
description: Median of amounts during the period
example: 42.22
type: number
min:
description: Minimum amount during the period
example: 30.22
type: number
standardDeviation:
description: Standard deviation of amounts during the period
example: 14.995
type: number
startDate:
description: Start date for the period being reported
example: '2022-12-01'
format: date
type: string
sum:
description: Sum of amounts during the period
example: 90.43
type: number
required:
- startDate
- endDate
- count
- beginningValue
- endingValue
type: object
StateTimeInterval:
description: 'For a StateAttribute, describes a time interval type being
reported
and a list of periods generated according to that type.'
properties:
periods:
description:
Periods of the specified time interval type, describing the
attribute calculations
items:
$ref: '#/components/schemas/StatePeriod'
type: array
timeIntervalType:
$ref: '#/components/schemas/TimeIntervalTypeEnum'
required:
- timeIntervalType
- periods
type: object
StreamModel:
description:
Describes a history of repeated transactions between the same parties.
properties:
cadence:
description:
Number of days that occur between each transaction in the stream
example: 30
type: integer
id:
description: Stream Id assigned to identified Stream
example: '1'
type: string
payee:
description: The party in the transaction that is receiving the funds
example: Walmart
type: string
payor:
description: The party in the transaction that is sending the funds
example: Elizabeth Johnson
type: string
recency:
description:
Number of days since the last transaction occurred in the stream
example: 2
type: integer
transactionIds:
description: List of Transaction IDs that comprise the stream
example:
- '6010290887'
- '6010290914'
items:
type: string
type: array
required:
- id
- payor
- payee
- cadence
- recency
- transactionIds
type: object
StringUnixDate:
type: string
description: >-
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: '1607450357'
StudentLoanDataCertification:
type: boolean
description: |-
"true": The institution is certified for the Student Loan Data product
"false": The institution is decertified for the Student Loan Data product
example: true
SubscriptionId:
description: ID of a TxPush subscription
type: integer
format: int64
example: 17554874
SubscriptionRecord:
required:
- id
- accountId
- type
- callbackUrl
- signingKey
type: object
properties:
id:
$ref: '#/components/schemas/SubscriptionId'
accountId:
$ref: '#/components/schemas/NumericAccountId'
type:
$ref: '#/components/schemas/SubscriptionType'
callbackUrl:
$ref: '#/components/schemas/TxPushCallbackUrl'
signingKey:
type: string
description: Signing key for events
example: >-
zg4U0v1IvTzFEHIXzJMxPHnfUwWZAMVpXrUuNuL9IvZI0QzkDdwp39IAKuNOFxOVqCOgHLMS1Zpe4ZL40NX83aJkqI6v0Ez5B7BLBtvr7Ag11kPH3uG1taTeOV0CTyI4LOg7ohSHn0DqaRu2aBq26KI90nYe0CecTCzzhu4yMXL43JV8YfydAexNdkzfg8tY44MlhBPUh2neHW2EFTT2ja4s4Ul10JgID03un8WBSrIm2adHw3QYJB4jk4k1e
description: TxPush subscription details
SubscriptionType:
type: string
description: A TxPush subscription type ("account" or "transaction")
example: account
Suffix:
type: string
description: A generational or academic suffix
example: PhD
TaxId:
type: string
description: >-
Country specific tax ID associated with the customer.
* **United States**: Social Security number (SSN) or Taxpayer
Identification Number (TIN)
* Format: 123-45-7890
* **Canada**: Social Insurance Number (SIM) or Numero d'assurance
sociale (NAS)
* Format: 123-456-789
example: 123-45-7890
TestTxPushTransaction:
description: A fake transaction for TxPush testing
required:
- amount
- description
- transactionDate
type: object
properties:
amount:
type: number
description: The amount of the transaction
example: -4.25
description:
type: string
description: The description of the transaction
example: a testing transaction description
status:
type: string
description: '"active" or "pending" (optional)'
default: active
example: pending
postedDate:
$ref: '#/components/schemas/UnixDate'
transactionDate:
$ref: '#/components/schemas/UnixDate'
ThirdPartyAccessKeyData:
description: |-
An object representing the third party access key request
* `customerId`: This is recipient's customer identifier
* `partnerId`: This is recipient partner identifier
* `thirdPartyPartnerId`: This is requester's partner identifier
* `products`: Array of values representing the Mastercard Open Finance APIs for
which access needs to be generated.
type: object
required:
- customerId
- partnerId
- thirdPartyPartnerId
- products
properties:
customerId:
$ref: '#/components/schemas/CustomerId'
partnerId:
$ref: '#/components/schemas/PartnerId'
thirdPartyPartnerId:
$ref: '#/components/schemas/PartnerId'
provenance:
$ref: '#/components/schemas/ThirdPartyAccessProvenance'
products:
type: array
items:
$ref: '#/components/schemas/ThirdPartyAccessProduct'
ThirdPartyAccessKeyReceiptData:
description: |-
An object representing the third party access key receipt
* `customerId`: This is recipient's customerId represented as a
pseudo identifier.
* `accountId`: This is the value provided to recipient
represented as a pseudo identifier for the accountId.
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ThirdPartyAccessReceiptData'
ThirdPartyAccessPeriod:
type: object
description: Object which describes access validity
required:
- type
- startTime
- endTime
properties:
type:
$ref: '#/components/schemas/ThirdPartyAccessPeriodTypes'
startTime:
$ref: '#/components/schemas/DateTimeWithZone'
endTime:
$ref: '#/components/schemas/DateTimeWithZone'
ThirdPartyAccessPeriodTypes:
description: |-
Multiple types will be supported. Presently below types are supported.
* "timeframe": Specifies a timeframe bounded by a startTime and endTime.
The startTime is the time at which the access was granted and the
access key generated,
and the endTime is the time at which the access was revoked. Times
are represented in ISO 8601 format("2022-03-10T06:06:20Z")
type: string
example: timeframe
ThirdPartyAccessProduct:
description: Product for which access token to be generated
type: object
required:
- product
- accountId
- accessPeriod
properties:
product:
$ref: '#/components/schemas/ThirdPartyAccessProductTypes'
payorId:
type: string
description: >-
The Finicity Partner ID who should be billed when the Requester
requests data from Finicity. If no value specified, then the
Recipient will be billed.
example: '2445581559892'
maxCalls:
type: integer
description:
Max number of calls to the consented product (consented API)
example: 200
accountId:
$ref: '#/components/schemas/AccountId'
accessPeriod:
$ref: '#/components/schemas/ThirdPartyAccessPeriod'
ThirdPartyAccessProductTypes:
description: |-
Third party access token can be generated for the following product types:
* "moneyTransferDetails": Retrieve account details for money transfer
* "availableBalance": Retrieves the latest cached available and cleared
account balances for an account.
* "availableBalanceLive": Retrieves the available and cleared account
balances live from the financial institution
* "accountOwner": Retrieves names and addresses of the account owner
from a financial institution.
* "paymentIndicator": Get the Payment Success Indicator response,
scoring the likelihood of payment settlement
type: string
example: moneyTransferDetails
ThirdPartyAccessProof:
type: object
description: An object representing a digital signature of the access key
properties:
signature:
type: string
description:
The digital signature for the "receipt" portion of the access key
example: >-
JTdCyTIyY3VzdG9tZXJJZCUyMiUzQSUyMjU0NTQ1MTQwMDI5NTU2MjkzNDMlMjIlMkMlMjJwYXJ0bmVySWQlMjIlM0ElMjIyNDQ1NTgzOTIyNTM2JTIyJTJDJTIycHJvZHVjdHMlMjIlM0ElNUIlN0IlMjJhY2Nlc3NQZXJpb2QlMjIlM0ElN0IlMjJlbmRUaW1lJTIyJTNBJTIyMjAyMy0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIyc3RhcnRUaW1lJTIyJTNBJTIyMjAyMi0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIydHlwZSUyMiUzQSUyMnRpbWVmcmFtZSUyMiU3RCUyQyUyMmFjY291bnRJZCUyMiUzQSUyMjQ2MzM0MTU3NDM5NjAzNzQwMjQlMjIlMkMlMjJwcm9kdWN0JTIyJTNBJTIybW9uZXlUcmFuc2ZlckRldGFpbHMlMjIlN0QlMkMlN0IlMjJhY2Nlc3NQZXJpb2QlMjIlM0ElN0IlMjJlbmRUaW1lJTIyJTNBJTIyMjAyMy0xMC0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIyc3RhcnRUaW1lJTIyJTNBJTIyMjAyMi0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIydHlwZSUyMiUzQSUyMnRpbWVmcmFtZSUyMiU3RCUyQyUyMmFjY291bnRJZCUyMiUzQSUyMjQ2MzM0MTU3NDM5NjAzNzQwMjQlMjIlMkMlMjJwcm9kdWN0JTIyJTNBJTIybW9uZXlUcmFuc2ZlckRldGFpbHMlMjIlN0QlNUQlMkMlMjJwcm9maWxlJTIyJTNBMyUyQyUyMnByb3ZlbmFuY2UlMjIlM0FudWxsJTJDJTIycmVjZWlwdElkJTIyJTNBJTIyY3JfNHBmSTNyMVg4YU9IckREd3J3QzAxTkhDeE9YbFcxJTIyJTJDJTIycmVjZWlwdFZlcnNpb24lMjIlM0ExJTJDJTIydGltZXN0YW1wJTIyJTNBJTIyMjAyMi0xMS0yOVQxOCUzQTM1JTNBMDhaJTIyJTJDJTIydmVyc2lvbiUyMiUzQSUyMjElRjYlN9U=
keyId:
type: string
description:
The Finicity key identifier is used to sign the access key
example: 867-530-900
timestamp:
$ref: '#/components/schemas/DateTimeWithZone'
ThirdPartyAccessProvenance:
description: >-
Provenance regarding the calling client like `clientFingerprint`,
`ipAddress` and `token`.
type: object
properties:
clientFingerprint:
type: string
description: Calling client identifier
example: LU9ZYxcDNQCwEmAxH52XFzaRiGMAAAAABclSKxW5S9P8pUMDV4fbpg
ipAddress:
type: string
description: Calling client IP address
example: 8.8.8.8
token:
type: string
description: Calling client cookie
example: P9YbR+srNVyQI35893d+BzPrhGMAAAAAuacVUt+3m4svbaFjVSbHEA==
ThirdPartyAccessReceipt:
type: object
description: An object representing consent receipt
properties:
profile:
type: integer
description: Representation of the type of consent receipt
example: 3
version:
type: string
description: A schema version of receipt
example: '1'
receiptId:
type: string
description: >-
This is officially the Consent Receipt ID, but is aliased as the
Access Key ID. This is a unique identifier managed by Finicity that
points to the contents of this JSON document.
example: cr_4pfI2r1X8aOHrDDwrwC01NHTxOXlT1
customerId:
type: string
description:
This is recipient's customerId represented as a pseudo identifier
example: '3465230025077724000'
partnerId:
$ref: '#/components/schemas/PartnerId'
products:
type: array
items:
$ref: '#/components/schemas/ThirdPartyAccessProduct'
provenance:
$ref: '#/components/schemas/ThirdPartyAccessProvenance'
timestamp:
$ref: '#/components/schemas/DateTimeWithZone'
ThirdPartyAccessReceiptData:
type: object
description: An object representing consent access data
properties:
receipt:
$ref: '#/components/schemas/ThirdPartyAccessReceipt'
proof:
$ref: '#/components/schemas/ThirdPartyAccessProof'
TimeIntervalType:
description: >-
Possible values for strategies in which attributes may be aggregated and
reported across varying time intervals. Allowed Values -
MONTHLY_CALENDAR - MONTHLY_ROLLING_30
example: MONTHLY_CALENDAR
type: string
default: MONTHLY_CALENDAR
TimeIntervalTypeEnum:
description: >-
Possible values for strategies in which attributes may be aggregated and
reported across varying time intervals. Allowed Values -
MONTHLY_CALENDAR - MONTHLY_ROLLING_30
example: MONTHLY_CALENDAR
type: string
default: MONTHLY_CALENDAR
Transaction:
required:
- id
- amount
- accountId
- customerId
- status
- description
- createdDate
type: object
properties:
id:
$ref: '#/components/schemas/TransactionId'
amount:
type: number
description: >-
The total amount of the transaction. Transactions for deposits are
positive values, withdrawals and debits are negative values.
example: -828.9
accountId:
$ref: '#/components/schemas/NumericAccountId'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
status:
type: string
description: >-
One of "active", "pending", or "shadow" (see [Transaction
Status](https://developer.mastercard.com/open-finance-us/documentation/products/manage/transaction-data/understanding-transaction-data/#transaction-status))
example: active
description:
type: string
description: >-
The description value is from the financial institution (FI), often
known as the payee. The value "No description provided by
institution" is returned when the FI doesn't provide one
example: Buy Stock
memo:
type: string
description: >-
The institution must provide either a description, a memo, or both.
We recommended concatenating the two fields into a single value.
example: UWM HOLDINGS CORPORATION - CLASS A COMMON STOCK
type:
$ref: '#/components/schemas/TransactionType'
transactionDate:
$ref: '#/components/schemas/TransactionDate'
postedDate:
$ref: '#/components/schemas/TransactionPostedDate'
createdDate:
$ref: '#/components/schemas/TransactionCreatedDate'
firstEffectiveDate:
$ref: '#/components/schemas/TransactionFirstEffectiveDate'
effectiveDate:
$ref: '#/components/schemas/TransactionEffectiveDate'
optionExpireDate:
$ref: '#/components/schemas/TransactionOptionExpireDate'
checkNum:
type: string
description:
The reference for the transaction provided by the originating
institution.
example: 299
escrowAmount:
type: number
description: The portion of the transaction allocated to escrow
example: 2534
feeAmount:
type: number
description:
The portion of the overall transaction amount applied to fees
example: 0.51
suspenseAmount:
type: number
description:
Temporarily hold funds if you overpay or underpay your monthly
payment
example: 0.25
interestAmount:
type: number
description: The portion of the transaction allocated to interest
example: 132
principalAmount:
type: number
description: The portion of the transaction allocated to principal
example: 32560
optionStrikePrice:
type: number
description: The strike price of the option contract
example: 32560
unitQuantity:
type: number
description:
The number of units (individual shares) in the transaction
format: int32
example: 150.42
unitPrice:
type: number
description:
'Share price for the investment unit: stocks, mutual funds, ETFs'
example: 5.53
categorization:
$ref: '#/components/schemas/Categorization'
runningBalanceAmount:
description: The ending balance after the transaction was posted
type: number
example: 1000
subaccountSecurityType:
type: string
description: The type of sub account the funds came from
example: MARGIN
commissionAmount:
type: integer
description: Transaction commission
format: int32
example: 0
ticker:
type: string
description:
Ticker symbol for the investment related to the transaction
example: UWMC
investmentTransactionType:
$ref: '#/components/schemas/InvestmentTransactionTypes'
taxesAmount:
type: integer
description: Taxes applicable to the investment trade
format: int32
example: 0
currencySymbol:
type: string
description: >-
If the foreign amount value is present then this is the currency
code of that foreign amount
example: USD
incomeType:
type: string
description: >-
Capital gains applied in short, long, or miscellaneous terms for tax
purposes
example: DIV
splitDenominator:
type: number
description: Denominator of the stock split for the transaction
example: 152
splitNumerator:
type: number
description: Numerator of the stock split for the transaction
example: 20
sharesPerContract:
type: number
description: Shares per contract of the underlying stock option
example: 100
subAccountFund:
type: string
description: The sub account where the funds came from
example: MARGIN
securityId:
type: string
description: The security ID of the transaction
example: 91823B109
securityIdType:
$ref: '#/components/schemas/SecurityIdType'
TransactionCreatedDate:
type: integer
description: >-
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](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionDate:
type: integer
description: >-
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.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionEffectiveDate:
type: integer
description: >-
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 Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionFirstEffectiveDate:
type: integer
description: >-
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
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionId:
type: integer
description: A transaction ID
format: int64
example: 21284820852
TransactionOptionExpireDate:
type: integer
description: >-
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: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionPostedDate:
type: integer
description: >-
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 for student loan transaction data. See: [Handling Epoch
Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
TransactionType:
type: string
description: >-
If provided by the institution, the following values may be returned in
the field of a record:
* "atm"
* "cash"
* "check"
* "credit"
* "debit"
* "deposit"
* "directDebit"
* "directDeposit"
* "dividend"
* "fee"
* "interest"
* "other"
* "payment"
* "pointOfSale"
* "repeatPayment"
* "serviceCharge"
* "transfer"
example: atm
Transactions:
description: A list of transactions
required:
- found
- displaying
- moreAvailable
- fromDate
- toDate
- sort
- transactions
type: object
properties:
found:
$ref: '#/components/schemas/FoundResults'
displaying:
$ref: '#/components/schemas/DisplayingResults'
moreAvailable:
$ref: '#/components/schemas/MoreResultsAvailableForTransactions'
fromDate:
$ref: '#/components/schemas/TransactionsFromDate'
toDate:
$ref: '#/components/schemas/TransactionsToDate'
sort:
type: string
description:
Value of the sort request parameter that generated this response
example: desc
transactions:
description: The array of transactions
type: array
items:
$ref: '#/components/schemas/Transaction'
dailyBalances:
description:
Array of daily beginning and ending account balances for each day
that transactions are recorded
type: array
items:
$ref: '#/components/schemas/DailyBalance'
DailyBalance:
required:
- date
- beginning
- ending
type: object
properties:
date:
$ref: '#/components/schemas/UnixDate'
beginning:
$ref: '#/components/schemas/Beginning'
ending:
$ref: '#/components/schemas/Ending'
Beginning:
type: number
description: Beginning daily account balance
example: 1000.00
Ending:
type: number
description: Ending daily account balance.
example: 983.96
TransactionsFromDate:
type: string
description:
Value of the `fromDate` request parameter that generated this response.
This date is in Unix epoch time (in seconds).
example: '1607450357'
TransactionsReport:
description: A Transactions report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
format: int64
example: 174
seasoned:
type: boolean
description: '"true" if the report covers more than 365 days'
example: false
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: A list of institution records
TransactionsReportAccount:
type: object
properties:
id:
type: integer
description: The Finicity account ID
format: int64
example: 1000075473
name:
type: string
description: The account name from the financial institution.
example: Super Checking
number:
type: string
description: >-
The account number from the financial institution (obfuscated)
example: '5015'
type:
type: string
description: The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `unknown`
* `mortgage`
* `loan`
* `creditCard`
* `lineOfCredit`
* `payroll`
* `studentLoan`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: >-
The status of the most recent aggregation attempt for this account.
Note: non-zero means the account was not accessed successfully for
this report, and additional fields for this account may not be
reliable.
format: int32
example: 0
balance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 100000
balanceDate:
type: integer
description:
A timestamp showing when the balance was captured by the FI
format: int64
example: 1594676289
oldestTransactionDate:
type: integer
description: >-
The oldest transaction date of this account.
format: int64
example: 1588350276
maximum: 2147483647
minimum: 0
transactionsCount:
type: integer
description: >-
A number detailing the total number of transactions for a given
account.
format: int64
example: 3
maximum: 2147483647
minimum: 0
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
description: Fields used for the Transaction History Report (CRA products)
TransactionsReportAck:
description: A Transaction report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/TransactionsReportConstraintsOut'
TransactionsReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
fromDate:
$ref: '#/components/schemas/UnixDate'
toDate:
$ref: '#/components/schemas/UnixDate'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
findTransaction:
$ref: '#/components/schemas/FindTransactionConstraints'
TransactionsReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
fromDate:
$ref: '#/components/schemas/UnixDate'
toDate:
$ref: '#/components/schemas/UnixDate'
includePending:
$ref: '#/components/schemas/IncludePending'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
findTransaction:
$ref: '#/components/schemas/FindTransactionConstraints'
FindTransactionConstraints:
description: >-
Parameters used to return transactions matching the given criteria. The
presence of multiple parameters will be treated as an **AND** function.
type: object
properties:
findTransactionDescriptionMemo:
$ref: '#/components/schemas/FindTransactionDescriptionMemo'
findTransactionAmountFrom:
$ref: '#/components/schemas/FindTransactionAmountFrom'
findTransactionAmountTo:
$ref: '#/components/schemas/FindTransactionAmountTo'
findTransactionCategory:
$ref: '#/components/schemas/FindTransactionCategory'
FindTransactionAmountTo:
type: number
description: >
A decimal value to return transactions with **amount** less than or
equal to **findTransactionAmountTo**.
- If both **findTransactionAmountFrom** and **findTransactionAmountTo**
are present. Then transactions with **amount** between (inclusive) both
values will be returned.
example: 100
FindTransactionCategory:
type: array
description: >
An array of **categories** to return transactions with an exact match to
the array of **category**. Limit of 10.
maxItems: 10
items:
type: string
example:
- 'Paycheck'
- 'Groceries'
FindTransactionAmountFrom:
type: number
description: >
A decimal value to return transactions with **amount** greater than or
equal to **findTransactionAmountFrom**.
- If both **findTransactionAmountFrom** and **findTransactionAmountTo**
are present. Then transactions with **amount** between (inclusive) both
values will be returned.
example: 100
FindTransactionDescriptionMemo:
type: string
description: >
A string to return transactions that have an exact match to
Description/Memo.
- Description/Memo
- Found in the PDF report for reach transactions.
- A combination of **description** and **memo** from the JSON version
of the report.
example: 'Paycheck'
TransactionsToDate:
type: string
description:
Value of the `toDate` request parameter that generated this response.
This date is in Unix epoch time (in seconds).
example: '1607450357'
TransactionalAttribute:
description: 'An attribute which represents some
categorization/classification of
transactions. Enumerates those identified transactions and reports
aggregations of them over the requested time interval(s).'
properties:
aggregatedByTimePeriods:
description: List of aggregations by specified Time Interval
items:
$ref: '#/components/schemas/TransactionalTimeInterval'
type: array
attributeName:
description: Name of Attribute as mentioned in Data Dictionary
example: INFLOW_TRANSACTIONS
type: string
streamIds:
description:
List of stream IDs categorized as belonging to this attribute
example:
- '1'
- '2'
items:
type: string
type: array
transactionIds:
description:
List of transaction IDs categorized as belonging to this attribute
example:
- '6010290887'
- '6010290914'
items:
type: string
type: array
required:
- attributeName
- aggregatedByTimePeriods
- transactionIds
- streamIds
type: object
TransactionalPeriod:
description:
Statistics for one period in the report of a TransactionalAttribute.
properties:
count:
description: Count of data points during the period
example: 2
type: integer
endDate:
description: End date for the period being reported
example: '2023-01-01'
format: date
type: string
max:
description: Maximum amount during the period
example: 60.21
type: number
mean:
description: Mean of amounts during the period
example: 42.22
type: number
median:
description: Median of amounts during the period
example: 42.22
type: number
min:
description: Minimum amount during the period
example: 30.22
type: number
standardDeviation:
description: Standard deviation of amounts during the period
example: 14.995
type: number
startDate:
description: Start date for the period being reported
example: '2022-12-01'
format: date
type: string
sum:
description: Sum of amounts during the period
example: 90.43
type: number
required:
- startDate
- endDate
- count
type: object
TransactionalTimeInterval:
description: 'For a TransactionalAttribute, describes a time interval type
being reported
and a list of periods generated according to that type.'
properties:
periods:
description:
Periods of the specified time interval type, describing the
attribute calculations
items:
$ref: '#/components/schemas/TransactionalPeriod'
type: array
timeIntervalType:
$ref: '#/components/schemas/TimeIntervalTypeEnum'
required:
- timeIntervalType
- periods
type: object
ConnectGenerateTransferBillPaySwitchParameters:
type: object
required:
- cards
- customerId
- identity
- partnerId
- singleUseUrl
properties:
serviceAgreement:
$ref: '#/components/schemas/ServiceAgreement'
accounts:
$ref: '#/components/schemas/BankAccounts'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
experience:
$ref: '#/components/schemas/TransferExperience'
language:
description: |
By default, the Data Connect application is in English. You don't need to pass this parameter unless
you want to translate Data Connect into one of our supported languages.
* Spanish (United States): `es`
type: string
example: 'es'
singleUseUrl:
$ref: '#/components/schemas/SingleUseUrl'
redirectUri:
$ref: '#/components/schemas/RedirectUri'
cards:
description: List of the user cards. Mandatory when use case is BPS.
type: array
minItems: 1
items:
$ref: '#/components/schemas/Card'
identity:
$ref: '#/components/schemas/BillPaySwitchIdentity'
ExternalIdentity:
type: string
description: The identifier for your employee or branch.
example: '1234583871234'
Context:
type: string
description: The context in which you are using the Data Connect link.
enum:
- EMAIL
- SMS
- WEB
- MOBILE
example: 'EMAIL'
ExternalTransferDetails:
type: object
description: The context type.
required:
- id
- context
properties:
id:
$ref: '#/components/schemas/ExternalIdentity'
context:
$ref: '#/components/schemas/Context'
TransferDepositSwitchParameters:
type: object
required:
- partnerId
- customerId
- accounts
properties:
serviceAgreement:
$ref: '#/components/schemas/ServiceAgreement'
external:
$ref: '#/components/schemas/ExternalTransferDetails'
accounts:
$ref: '#/components/schemas/BankAccounts'
partnerId:
$ref: '#/components/schemas/PartnerId'
customerId:
$ref: '#/components/schemas/CustomerId'
language:
description: |
By default, the Connect Transfer application is in English. You don't need to pass this parameter unless
you want to translate Connect Transfer into one of our supported languages.
* Spanish (United States): `es`
type: string
example: 'es'
webhook:
type: string
deprecated: true
description: >-
The publicly available URL you want to be notified with events as
the user progresses through the application. See [Connect Webhook
Event](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-connect/)
for event details.
example: 'https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b'
webhookContentType:
type: string
deprecated: true
description: >-
The content type the webhook events will be sent in. Supported
types: "application/json" and "application/xml".
default: application/json
example: application/json
webhookData:
type: object
deprecated: true
description: >-
Allows additional identifiable information to be inserted into the
payload of Connect webhook events. See: [Custom
Webhooks](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-custom/).
webhookHeaders:
type: object
deprecated: true
description: >-
Allows additional identifiable information to be included as headers
of the Connect webhook event. See: [Custom
Webhooks](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-custom/).
redirectUri:
$ref: '#/components/schemas/RedirectUri'
experience:
$ref: '#/components/schemas/TransferExperience'
TxPushCallbackUrl:
type: string
description: A callback URL to receive TxPush notifications
example: 'https://www.example.com/txpush/listener'
TxPushSubscriptionParameters:
required:
- callbackUrl
type: object
properties:
callbackUrl:
$ref: '#/components/schemas/TxPushCallbackUrl'
TxPushSubscriptions:
required:
- subscriptions
type: object
properties:
subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionRecord'
TxVerifyInterview:
required:
- assetId
type: object
properties:
assetId:
$ref: '#/components/schemas/AssetId'
accounts:
$ref: '#/components/schemas/ReportAccountIds'
VOAIncomeReportIncomeFromDate:
type: integer
description: >-
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
By default, the income history is set to 24 months, however, a partner
can change the transaction history by setting the `incomeFromDate`
parameter.
format: int64
example: 1607450357
UnixDate:
type: integer
description: >-
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
Income:
type: integer
description: >-
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 into.
format: int64
example: 1000
minimum: 0
Age:
type: integer
description: >-
Age is an optional parameter. This data is used to determine the age
band the customer falls into.
format: int64
example: 25
minimum: 0
maximum: 125
UserType:
type: string
description: Type of User, Allowed values Personal/Business
example: business
ReportCreatedDate:
type: integer
description: >-
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
Note: If the report is retrieved on a day other than the day it was
generated, on the header of the PDF version of the report there will be
a "Retrieved Date" populated.
format: int64
example: 1607450357
VOAIReportIncomeStream:
description: A report income stream record
required:
- id
- name
- status
- estimateInclusion
- confidence
- cadence
- transactions
type: object
properties:
id:
type: string
description: Income stream ID
example: dens28i3vsch-voah
name:
type: string
description: >-
A human-readable name based on the `normalizedPayee` name of the
transactions for this income stream
example: none
status:
$ref: '#/components/schemas/ActiveStatus'
estimateInclusion:
$ref: '#/components/schemas/EstimateInclusion'
confidence:
type: integer
description: >-
Level of confidence that the deposit stream represents income
(example: 85%)
format: int32
example: 70
cadence:
$ref: '#/components/schemas/CadenceDetails'
netMonthly:
type: array
items:
$ref: '#/components/schemas/NetMonthly'
description: >-
A list of net monthly records. One instance for each complete
calendar month in the report.
example:
- month: 1522562400
net: 2004.77
netAnnual:
type: number
description:
Sum of all values in `netMonthlyIncome` over the previous 12 months
example: 110475.7
projectedNetAnnual:
type: number
description: >-
Projected net income over the next 12 months, across all income
streams, based on `netAnnualIncome`
example: 0
estimatedGrossAnnual:
type: number
description: >-
Before-tax gross annual income (estimated from `netAnnual`) across
all income stream in the past 12 months
example: 2000.12
projectedGrossAnnual:
type: number
description: >-
Projected gross income over the next 12 months, across all active
income streams, based on `projectedNetAnnual`
example: 151609
averageMonthlyIncomeNet:
type: number
description: Monthly average amount over the previous 24 months
example: 9206.31
incomeStreamMonths:
type: integer
description: The number of months the income transactions are observed
format: int32
example: 18
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: A list of transaction records
VOAReport:
description: A VOA report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 180
seasoned:
type: boolean
description: '"true" if the report covers more than 180 days'
example: true
consolidatedAvailableBalance:
type: number
description: >-
The sum of available balance for all of the accounts included in
the report
example: 1929.57
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: A list of institution records
assets:
$ref: '#/components/schemas/PrequalificationReportAssetSummary'
VOAReportAccount:
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
number:
type: string
description: >-
The account number from the institution (all digits except the last
four are obfuscated)
example: '1111'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
type:
type: string
description: >-
The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
availableBalance:
type: number
description: The available balance for the account
example: 501.24
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
balance:
type: number
description: The cleared balance of the account as-of balanceDate
example: 501.24
balanceDate:
type: integer
description:
A timestamp showing when the balance was captured by the FI
format: int64
example: 1588350276
averageMonthlyBalance:
type: number
description: The average monthly balance of this account
example: 501.02
totNumberInsufficientFundsFeeDebitTxAccount:
type: integer
description: >-
The count for the total number of insufficient funds transactions,
based on the `fromDate` of the report.
format: int64
example: 0
totNumberInsufficientFundsFeeDebitTxOver2MonthsAccount:
type: integer
description: >-
The count for the total number of insufficient funds transactions
for the last two months, based on the `fromDate` of the report.
format: int64
example: 0
totNumberDaysSinceMostRecentInsufficientFundsFeeDebitTxAccount:
type: integer
description: >-
The number of days since the most recent insufficient funds
transaction, based on the `fromDate` of the report.
format: int64
example: 120
oldestTransactionDate:
type: integer
description: >-
The oldest transaction date of this account.
format: int64
example: 1588350276
maximum: 2147483647
minimum: 0
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransactionNewTxBased'
description: a list of transaction records
details:
$ref: '#/components/schemas/AccountDetailsTxBased'
position:
type: array
items:
$ref: '#/components/schemas/ReportAccountPosition'
asset:
$ref: '#/components/schemas/PrequalificationReportAssetSummary'
VOAReportAck:
description: A VOA report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOAReportConstraintsOut'
VOAReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
VOAReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
toDate:
$ref: '#/components/schemas/UnixDate'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
VOAWithIncomeReport:
description: A VOA with income report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 180
seasoned:
type: boolean
description: '"true" if the report covers more than 180 days'
example: true
consolidatedAvailableBalance:
type: number
description: >-
The sum of available balance for all of the accounts included in
the report
example: 1929.57
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: A list of institution records
assets:
$ref: '#/components/schemas/PrequalificationReportAssetSummary'
VOAWithIncomeReportAccount:
type: object
allOf:
- $ref: '#/components/schemas/VOAReportAccount'
- type: object
properties:
incomeStreams:
type: array
items:
$ref: '#/components/schemas/VOAIReportIncomeStream'
description: A list of income stream records
VOAWithIncomeReportAck:
description: A VOA with income report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOAWithIncomeReportConstraintsOut'
VOAWithIncomeReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeFromDate:
$ref: '#/components/schemas/VOAIncomeReportIncomeFromDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOAWithIncomeReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
showNsf:
$ref: '#/components/schemas/ShowNsf'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeFromDate:
$ref: '#/components/schemas/VOAIncomeReportIncomeFromDate'
voaiPdfDepositView:
type: boolean
nullable: true
description:
Provide an alternate PDF view of deposit transactions group by
income stream in PDF.
example: true
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOEPayrollReport:
description: A VOE Payroll report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
employmentHistory:
type: array
items:
$ref: '#/components/schemas/PayrollEmploymentHistoryVOE'
description: >-
An array of employment histories, one for each of the consumer's
verified employers
gseEnabled:
$ref: '#/components/schemas/GseEnabled'
VOETransactionsReport:
description: A VOE Transactions report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
example: 120
seasoned:
type: boolean
description: '"true" if the report covers more than 180 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
A list of institution records, including information about the
individual accounts used in this report
VOETransactionsReportAccount:
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
number:
type: string
description: >-
The account number from the institution (all digits except the last
four are obfuscated)
example: '1111'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
type:
type: string
description: The list of supported account types
* `checking`
* `savings`
* `moneyMarket`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
incomeStreams:
type: array
items:
$ref: '#/components/schemas/VOETransactionsReportIncomeStream'
description: A list of income stream records
VOETransactionsReportAck:
description: A VOE Transactions report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOETransactionsReportConstraintsOut'
VOETransactionsReportConstraints:
type: object
properties:
reportId:
$ref: '#/components/schemas/ReportId'
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOETransactionsReportConstraintsOut:
type: object
properties:
reportId:
$ref: '#/components/schemas/ReportId'
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOETransactionsReportIncomeStream:
type: object
required:
- id
- name
- status
- estimateInclusion
- confidence
- cadence
- daysSinceLastTransaction
- nextExpectedTransactionDate
- transactions
properties:
id:
type: string
description: Income stream ID
example: dens28i3vsch-voah
name:
type: string
description: >-
A human-readable name based on the `normalizedPayee` name of the
transactions for this income stream
example: none
status:
$ref: '#/components/schemas/ActiveStatus'
estimateInclusion:
$ref: '#/components/schemas/EstimateInclusion'
confidence:
type: integer
description: >-
Level of confidence that the deposit stream represents income
(example: 85%)
format: int32
example: 70
cadence:
$ref: '#/components/schemas/CadenceDetails'
daysSinceLastTransaction:
type: integer
description: >-
The number of days since the last credit transaction for the
particular income stream
format: int32
example: 15
nextExpectedTransactionDate:
type: integer
description: >-
The next expected credit transaction date for the particular income
stream, based on the cadence
format: int64
example: 1572625469
incomeStreamMonths:
type: integer
description: The number of months the income transactions are observed
format: int32
example: 18
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: A list of transaction records
VOIEPayStatement:
type: object
properties:
payPeriod:
type: string
description: The pay period of the pay statement
example: LastPayPeriod
billable:
type: boolean
description: Designates whether the pay statement is billable
example: true
assetId:
type: string
description: The asset ID of the stored pay statement
example: 6f8fb0a0-e882-4f57-b672-cf53f1397581
payDate:
type: integer
description: The listed pay date for the pay statement
format: int64
example: 1559241000
startDate:
type: integer
description: The beginning of the pay period
format: int64
example: 1557513000
endDate:
type: integer
description: The end of the pay period
format: int64
example: 1558722600
netPayCurrent:
type: number
description: >-
The total pay after deductions for the employee for the current pay
period
example: 1802.22
netPayYTD:
type: number
description: >-
The total accumulation of pay after deductions for the employee for
the current pay year
example: 36000
grossPayCurrent:
type: number
description: >-
The total pay before deductions for the employee for the current pay
period
example: 24200
grossPayYTD:
type: number
description: >-
The total accumulation of pay before deductions for the employee for
the current pay year
example: 72600
payrollProvider:
type: string
description: The company that provides the pay stub.
example: Finicity
matchType:
type: string
description: >-
The statement match category. Possible values:
* "NET_PAY_MATCH"
* "SPLIT_INTERVIEW_AMOUNT_SUM_TO_NET_PAY_MATCH"
* "SPLIT_DIRECT_DEPOSIT_SUM_TO_NET_PAY_MATCH"
* "SPLIT_LESS_THAN_NET_PAY_SUM_TO_NET_PAY_MATCH"
* "PARTIAL"
* "TRANSACTION_DATE_RANGE_INVALID"
* "NO_MATCH"
example: PARTIAL
employer:
$ref: '#/components/schemas/Employer'
employee:
$ref: '#/components/schemas/Employee'
payStat:
type: array
items:
$ref: '#/components/schemas/PayStat'
description:
Information pertaining to the earnings on the pay statement
deductions:
type: array
items:
$ref: '#/components/schemas/Deduction'
description: Information pertaining to deductions on the pay statement
directDeposits:
type: array
items:
$ref: '#/components/schemas/DirectDeposit'
description:
Information pertaining to direct deposits on the pay statement
VOIEPayrollReport:
description: A VOIE Payroll report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
employmentHistory:
type: array
items:
$ref: '#/components/schemas/PayrollEmploymentHistoryVOIE'
description: >-
An array of employment histories, one for each of the consumer's
verified employers
gseEnabled:
$ref: '#/components/schemas/GseEnabled'
reportStyle:
$ref: '#/components/schemas/ReportStyle'
VOIEPaystubReport:
description: A VOIE Paystub report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
assetIds:
type: array
items:
$ref: '#/components/schemas/AssetId'
description: The pay statements included in the report
numberOfBillableAssets:
type: integer
description:
Total number of billable pay statements included in the report
format: int32
example: 1
payStatements:
type: array
items:
$ref: '#/components/schemas/VOIEPaystubPayStatement'
description: >-
Extracted pay statement details, and the transaction matching
summary
VOIEPaystubReportAck:
description: A VOIE Paystub report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOIEReportConstraints'
PayStatementForVoie:
required:
- billable
- assetId
- employer
- employee
- payStat
- monthlyIncome
- institutions
type: object
properties:
payPeriod:
type: string
description: The pay period of the pay statement
example: LastPayPeriod
billable:
type: boolean
description: >-
This will display true if the pay statement is billable. If a pay
statement has been digitized previously, this will display as false
as it will not be billable.
example: true
assetId:
type: string
description: The asset ID of the stored pay statement
example: 6f8fb0a0-e882-4f57-b672-cf53f1397581
payDate:
type: integer
description: The listed pay date for the pay statement
format: int64
example: 1559241000
startDate:
type: integer
description: The beginning of the pay period
format: int64
example: 1557513000
endDate:
type: integer
description: The end of the pay period
format: int64
example: 1558722600
netPayCurrent:
type: number
description: >-
The total pay after deductions for the employee for the current pay
period
example: 1802.22
netPayYTD:
type: number
description: >-
The total accumulation of pay after deductions for the employee for
the current pay year
example: 36000
grossPayCurrent:
type: number
description: >-
The total pay before deductions for the employee for the current pay
period
example: 24200
grossPayYTD:
type: number
description: >-
The total accumulation of pay before deductions for the employee for
the current pay year
example: 72600
payrollProvider:
type: string
description: The payroll provider extracted from the pay statement
example: Finicity
employer:
$ref: '#/components/schemas/Employer'
employee:
$ref: '#/components/schemas/Employee'
payStat:
type: array
items:
$ref: '#/components/schemas/PayStat'
description:
Information pertaining to the earnings on the pay statement
directDeposits:
type: array
items:
$ref: '#/components/schemas/DirectDeposit'
description:
Information pertaining to the direct deposits on the pay statement
institutions:
type: array
items:
type: string
description: >-
Not populated for the voieWithStatement style of paystub report. For
the VOIE - Paystub (with TXVerify) reports this would include
details of the financial institution accounts and income streams
with matching transactions to the pay statement.
example: []
errorCode:
type: integer
description: Error code for the asset
format: int32
example: 0
errorMessage:
type: string
description: Error message for the asset
example: 'Some error message'
VOIEPaystubWithStatementPayStatement:
type: object
allOf:
- $ref: '#/components/schemas/PayStatementForVoie'
- type: object
properties:
monthlyIncome:
$ref: '#/components/schemas/PaystubTxVerifyMonthlyIncomeRecord'
VOIEPaystubPayStatement:
type: object
allOf:
- $ref: '#/components/schemas/PayStatementForVoie'
- type: object
properties:
monthlyIncome:
$ref: '#/components/schemas/PaystubMonthlyIncomeRecord'
VOIEPaystubWithTXVerifyReport:
description: A VOIE Paystub With TXVerify report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
assetIds:
type: array
items:
$ref: '#/components/schemas/AssetId'
description: The pay statements included in the report
numberOfBillableAssets:
type: integer
description:
Total number of billable pay statements included in the report
format: int32
example: 1
payStatements:
type: array
items:
$ref: '#/components/schemas/VOIEPaystubWithStatementPayStatement'
description: >-
Extracted pay statement details, and the transaction matching
summary
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: >-
The details of the financial institution accounts included in
the report.
VOIEPaystubWithTXVerifyReportAck:
description: A VOIE Paystub With TXVerify report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOIEWithTXVerifyReportConstraintsOut'
VOIEReportConstraints:
required:
- voieWithStatementData
type: object
properties:
voieWithStatementData:
$ref: '#/components/schemas/VOIEWithStatementData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
description: >-
The request details from the report generation that were used to
generate the report
VOIETXVerifyReportAccount:
required:
- id
- name
- number
- type
- aggregationStatusCode
- transactions
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
number:
type: string
description: >-
The account number from the institution (all digits except the last
four are obfuscated)
example: '1111'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
type:
type: string
description: The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
* `cd`
* `investment`
* `investmentTaxDeferred`
* `employeeStockPurchasePlan`
* `ira`
* `401k`
* `roth`
* `403b`
* `529`
* `rollover`
* `ugma`
* `utma`
* `keogh`
* `457`
* `401a`
* `unknown`
* `mortgage`
* `loan`
* `creditCard`
* `lineOfCredit`
* `payroll`
* `studentLoan`
* `brokerageAccount`
* `educationSavings`
* `healthSavingsAccount`
* `nonTaxableBrokerageAccount`
* `pension`
* `profitSharingPlan`
* `roth401k`
* `sepIRA`
* `simpleIRA`
* `thriftSavingsPlan`
* `variableAnnuity`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
incomeStreams:
type: array
items:
$ref: '#/components/schemas/VOIETXVerifyReportIncomeStream'
description: A list of income stream records
balance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 123.45
averageMonthlyBalance:
type: number
description: The average monthly balance of this account
example: 301.45
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransactionNewTxBased'
description: a list of transaction records
details:
$ref: '#/components/schemas/AccountDetailsTxBased'
availableBalance:
type: number
description: The available balance for the account
example: 123.45
VOIETXVerifyReportIncomeStream:
required:
- id
- name
- status
- confidence
- cadence
- transactions
type: object
properties:
id:
type: string
description: Finicity's income stream ID
example: dens28i3vsch-voietxverify
name:
type: string
description: >-
A human-readable name based on the `normalizedPayee` name of the
transactions for this income stream
example: none
status:
$ref: '#/components/schemas/ActiveStatus'
confidence:
type: integer
description: >-
Level of confidence that the deposit stream represents income
(example: 85%)
format: int32
example: 70
cadence:
$ref: '#/components/schemas/CadenceDetails'
netMonthly:
type: array
items:
$ref: '#/components/schemas/NetMonthly'
description: >-
A list of net monthly records. One instance for each complete
calendar month in the report.
netAnnual:
type: number
description:
Sum of all values in `netMonthlyIncome` over the previous 12 months
example: 110475.7
projectedNetAnnual:
type: number
description: >-
Projected net income over the next 12 months, across all income
streams, based on `netAnnualIncome`
example: 0
estimatedGrossAnnual:
type: number
description: >-
Before-tax gross annual income (estimated from `netAnnual`) across
all income stream in the past 12 months
example: 12321.1
projectedGrossAnnual:
type: number
description: >-
Projected gross income over the next 12 months, across all active
income streams, based on `projectedNetAnnual`
example: 151609
averageMonthlyIncomeNet:
type: number
description: Monthly average amount over the previous 24 months
example: 9206.31
incomeStreamMonths:
type: integer
description: The number of months the income transactions are observed
format: int32
example: 24
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: A list of transaction records
VOIEWithInterviewData:
required:
- txVerifyInterview
type: object
properties:
txVerifyInterview:
description: An array of `TxVerifyInterview` objects
type: array
items:
$ref: '#/components/schemas/TxVerifyInterview'
extractEarnings:
$ref: '#/components/schemas/ExtractEarnings'
extractDeductions:
$ref: '#/components/schemas/ExtractDeductions'
extractDirectDeposit:
$ref: '#/components/schemas/ExtractDirectDeposit'
VOIEWithStatementData:
required:
- assetIds
type: object
properties:
assetIds:
description: A list of pay statement asset IDs
type: array
items:
$ref: '#/components/schemas/AssetId'
extractEarnings:
$ref: '#/components/schemas/ExtractEarnings'
extractDeductions:
$ref: '#/components/schemas/ExtractDeductions'
extractDirectDeposit:
$ref: '#/components/schemas/ExtractDirectDeposit'
VOIEWithTXVerifyReportConstraints:
required:
- voieWithInterviewData
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
voieWithInterviewData:
$ref: '#/components/schemas/VOIEWithInterviewData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOIEWithTXVerifyReportConstraintsOut:
required:
- voieWithInterviewData
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
voieWithInterviewData:
$ref: '#/components/schemas/VOIEWithInterviewData'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOIReport:
description: A VOI report
type: object
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
startDate:
$ref: '#/components/schemas/ReportStartDate'
endDate:
$ref: '#/components/schemas/ReportEndDate'
days:
type: integer
description: Number of days covered by the report
format: int64
example: 200
seasoned:
type: boolean
description: '"true" if the report covers more than 180 days'
example: true
institutions:
type: array
items:
$ref: '#/components/schemas/ReportInstitution'
description: A list of institution records
income:
description: 'Income details'
type: array
items:
$ref: '#/components/schemas/ReportIncomeStreamSummary'
VOIReportAccount:
type: object
properties:
id:
type: integer
description: The ID of the account
format: int64
example: 1000023996
number:
type: string
description: >-
The account number from the institution (all digits except the last
four are obfuscated)
example: '1111'
ownerName:
$ref: '#/components/schemas/ReportAccountOwnerName'
ownerAddress:
$ref: '#/components/schemas/ReportAccountOwnerAddress'
ownerAsOfDate:
$ref: '#/components/schemas/ReportAccountOwnerAsOfDate'
name:
type: string
description: The account name from the institution
example: Checking
type:
type: string
description: The list of supported account types.
* `checking`
* `savings`
* `moneyMarket`
example: checking
currency:
$ref: '#/components/schemas/AccountCurrency'
aggregationStatusCode:
type: integer
description: The status of the most recent aggregation attempt
format: int32
example: 0
incomeStreams:
type: array
items:
$ref: '#/components/schemas/VOIReportIncomeStream'
description: A list of income stream records
balance:
type: number
description: The cleared balance of the account as-of `balanceDate`
example: 714.16
averageMonthlyBalance:
type: number
description: The average monthly balance of this account
example: 720.75
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: a list of transaction records
availableBalance:
type: number
description: The available balance for the account
example: 714.16
currentBalance:
type: number
description: Current balance of the account
example: 714.16
beginningBalance:
type: number
description:
Beginning balance of account per the time period in the report
example: 714.77
oldestTransactionDate:
type: integer
description: >-
The oldest transaction date of this account.
format: int64
example: 1588350276
maximum: 2147483647
minimum: 0
miscDeposits:
maxItems: 100
minItems: 0
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: A list of miscellaneous deposits
CustomerAuthorizationDetails:
type: object
properties:
institutionLoginId:
type: integer
description: Institution login id of the customer.
format: int64
example: 7009561328
authorizationStartDate:
type: string
description: Authorization start date and time in ISO 8601 format.
example: 2024-01-01T16:11:23.20Z
authorizationEndDate:
type: string
description: Authorization end date and time in ISO 8601 format.
example: 2024-12-31T16:11:23.20Z
required:
- institutionLoginId
- authorizationStartDate
- authorizationEndDate
VOIReportAck:
description: A VOI report being generated
required:
- id
- portfolioId
- customerType
- customerId
- requestId
- requesterName
- createdDate
- title
- consumerId
- consumerSsn
- type
- status
- constraints
allOf:
- $ref: '#/components/schemas/BaseReportAckWithPortfolioId'
- type: object
properties:
constraints:
$ref: '#/components/schemas/VOIReportConstraintsOut'
VOIReportConstraints:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIdsString'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOIReportConstraintsOut:
type: object
properties:
accountIds:
$ref: '#/components/schemas/ReportAccountIds'
reportCustomFields:
$ref: '#/components/schemas/ReportCustomFields'
fromDate:
$ref: '#/components/schemas/UnixDate'
incomeStreamConfidenceMinimum:
$ref: '#/components/schemas/IncomeStreamConfidenceMinimum'
VOIReportIncomeStream:
type: object
required:
- id
- name
- status
- estimateInclusion
- confidence
- cadence
- transactions
properties:
id:
type: string
description: Income stream ID
example: dens28i3vsch-voi1
name:
type: string
description: >-
A human-readable name based on the `normalizedPayee` name of the
transactions for this income stream
example: none
status:
$ref: '#/components/schemas/ActiveStatus'
estimateInclusion:
$ref: '#/components/schemas/EstimateInclusion'
confidence:
type: integer
description: >-
Level of confidence that the deposit stream represents income
(example: 85%)
format: int32
example: 70
cadence:
$ref: '#/components/schemas/CadenceDetails'
netMonthly:
type: array
items:
$ref: '#/components/schemas/NetMonthly'
description: >-
A list of net monthly records. One instance for each complete
calendar month in the report.
netAnnual:
type: number
description:
Sum of all values in `netMonthlyIncome` over the previous 12 months
example: 110475.7
projectedNetAnnual:
type: number
description: >-
Projected net income over the next 12 months, across all income
streams, based on `netAnnualIncome`
example: 0
estimatedGrossAnnual:
type: number
description: >-
Before-tax gross annual income (estimated from `netAnnual`) across
all income stream in the past 12 months
example: 12321.1
projectedGrossAnnual:
type: number
description: >-
Projected gross income over the next 12 months, across all active
income streams, based on `projectedNetAnnual`
example: 151609
averageMonthlyIncomeNet:
type: number
description: Monthly average amount over the previous 24 months
example: 9206.31
incomeStreamMonths:
type: integer
description: The number of months the income transactions are observed
format: int32
example: 18
transactions:
type: array
items:
$ref: '#/components/schemas/ReportTransaction'
description: A list of transaction records
VerifiedMicroDeposit:
type: object
properties:
status:
type: string
example: Verified
description: Micro entries successful verification status
statusDescription:
type: string
example: Micro entries are successfully verified
description: Micro entries successful verification description
Warnings:
type: string
description: >-
An array containing warning messages. Warnings can be one of:
* Address: Input postal code was corrected
* Address: Input state corrected
* Email: Address is too long
* Email: General syntax error
* Email: Invalid domain syntax
* Email: Invalid top-level-domain (TLD) in address
* Email: Invalid username syntax
* IP: IP address is in private range
* Phone: Invalid country_hint value. Only Alpha-2 supported
example: Test warnings
Alerts:
type: string
description: >-
An alert generated when processing the request.
example: Unable to generate IP and user insights
Webhook:
type: string
description: >-
The publicly available URL you want to be notified with events as the
user progresses through the application. See [Connect Webhook
Event](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-connect/)
for event details.
example: 'https://webhook.site/8d4421a7-d1d1-4f01-bb08-5370aff0321b'
WebhookContentType:
type: string
description: >-
The content type the webhook events will be sent in. Supported types:
"application/json" and "application/xml".
default: application/json
example: application/json
WebhookData:
type: object
description: >-
Allows additional identifiable information to be inserted into the
payload of connect webhook events. See: [Custom
Webhooks](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-custom/).
WebhookHeaders:
type: object
description: >-
Allows additional identifiable information to be included as headers of
connect webhook event. See: [Custom
Webhooks](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-custom/).
WithInsights:
type: boolean
description: If Identity Insights data must be returned or not
example: true
Insights:
type: boolean
description: If Identity Insights data must be returned or not
example: true
ZipCode:
type: string
description: A ZIP code
example: '84123'
EmploymentId:
type: string
description: >-
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 limit the employment records that are returned in the
report.
example: 123v3bv2s5n
PayrollAccountId:
type: string
description: >-
The payrollAccountIds for the Credentialed Payroll accounts the consumer
has connected. Will be used to constrain the report to only
include the
specified accounts. Required if the consumer has connected
their
accounts previously and report generation was intentionally
delayed for
later.
example: 018b8f10-fdf8-0ef7-ded5-34a17c34d86f
ReportStyle:
type: string
example: credentialedPayroll
description:
A report style. Possible values are directAPIPayroll,
credentialedPayroll, paystatement, voieWithInterview, voieWithStatement,
voieWithReport
PaymentInstructions:
description: A list of payment instructions
type: object
properties:
paymentInstruction:
type: array
items:
$ref: '#/components/schemas/PaymentInstruction'
description: List of payment instructions
PaymentInstruction:
required:
- accountNumber
- type
type: object
properties:
type:
type: string
description: >-
The type of payment instruction:
1. ach: when payment instruction type is ACH (Automated Clearing
House)
2. rtp: when payment instruction type is RTP (Real-Time Payments)
3. fednow: when payment instruction type is FedNow
example: ach
accountNumber:
type: string
description: 'The account number from the institution'
example: '124344454'
tanEnabled:
type: boolean
default: false
description:
This field indicates whether the FI uses a tokenized account number
for origination purposes.
example: true
descriptors:
type: array
description: List of descriptors
items:
$ref: '#/components/schemas/Descriptor'
transferInEnabled:
type: boolean
description:
'Indicates whether transfer to this account is enabled or not.
Applicable for "RTP" and "FedNow" type only.'
example: true
transferOutEnabled:
type: boolean
description:
'Indicates whether transfer from this account is enabled or not.
Applicable for "RTP" and "FedNow" type only.'
example: true
Descriptor:
required:
- type
- value
type: object
properties:
type:
type: string
description: Payment Instruction Descriptor Type
example: routingNumber
value:
type: string
description: Value that the Descriptor Type Holds
example: '2434345'
ReportAccountOwnerName:
type: string
description: >-
The name(s) of the account owner(s). If the owner information is not
available, this field will not appear in the report. If the account has
multiple owners then all owners will be listed separated by |.
example: 'PATRICK PURCHASER|LORRAINE PURCHASER'
ReportAccountOwnerAddress:
type: string
description: >-
The mailing address of the account owner(s). If the owner information is
not available, this field will not appear in the report. If the account
has multiple owners then the address of the primary owner will be
listed.
example: '7195 BELMONT ST. PARLIN, NJ 08859'
ReportAccountOwnerAsOfDate:
type: integer
description: >-
The ownerAsOfDate field is populated if the account owner information
was retrieved from a prior report and will show the created date of that
report. Reports always try and aggregate fresh account owner information
and only rarely aren't able to aggregate it. If account owner
information is not able to be aggregated, but it was available from a
prior report that had that same account, the information from that prior
report will be used and this field will be populated. A date in Unix
epoch time (in seconds). See: [Handling Epoch Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1596175200
Experiences:
type: object
properties:
id:
type: string
format: uuid
minLength: 36
maxLength: 36
description: UUID that distinguishes each experience
example: 84fd419a-1add-4bf4-961b-16e8285b3a92
appName:
type: string
description: Your registered application name in our system
minLength: 1
maxLength: 255
example: Test Application Name
productCode:
type: array
description: A unique code assigned to each open finance product used.
example:
- ABC
- AO
items:
type: string
minLength: 1
maxLength: 10
EndUserUrl:
type: string
description: Reseller end user URL
minLength: 2
maximum: 999
example: 'testurl.com'
ConsumerEndUser:
description: Reseller end user information
required:
- name
- address
- city
- state
- zip
- phone
type: object
properties:
name:
$ref: '#/components/schemas/FirstName'
address:
$ref: '#/components/schemas/AddressLine1'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
zip:
$ref: '#/components/schemas/ZipCode'
phone:
$ref: '#/components/schemas/PhoneNumber'
email:
$ref: '#/components/schemas/EmailAddress'
url:
$ref: '#/components/schemas/EndUserUrl'
DepositSwitchesSummary:
required:
- customerId
- customerType
type: object
properties:
customerId:
type: string
description: A customer ID
example: '1005061234'
customerType:
type: string
description:
The type of Mastercard Open Finance customer (`active` or `testing`)
example: testing
switches:
type: array
description: Deposit switches summary
minItems: 0
maxItems: 10
items:
required:
- id
- status
- createdDate
properties:
id:
type: string
description: Deposit switch ID
example: 602414d84f9a1980cf5eafcc
status:
type: string
description: |
Deposit switch status. Possible values include `processing`,
`completed`, or `failed`.
* processing - The deposit switch is currently being processed.
* completed - The deposit switch has been completed successfully.
* failed - The deposit switch has failed. Refer to failureReason for more details.
example: completed
failureReason:
type: string
description: |
Deposit switch failure reason. Possible values include -
* account-lockout - The account is locked out, most likely the end user has had too many failed attempts.
* account-setup-incomplete - The user's account in the payroll system is not fully set up and will require additional
information from the user.
* account-unusable - The user's bank account is unusable for the selected product or use case.
* bad-credentials - Either the username or password was incorrect. This is our most common fail reason.
* connection-error - A network error occurred which caused the connection between our system and the payroll system to be
lost.
* distribution-not-supported - The payroll system did not support the type of distribution requested. For example,
the user attempted to allocate a percentage of their paycheck, but is only eligible for fixed amounts and remainder/net
balance.
* device-disconnected - The device used to start the task is no longer connected.
* enrolled-in-paycard - The user is enrolled in a paycard program instead of direct deposit via
their bank.
* expired - The user's password has expired and they must create a new one.
* no-data-found - No verify data was found for the user.
* product-not-supported - The payroll system did not allow the action to be taken. Many payroll
systems allow HR to customize what is allowed in their system.
Direct Deposit may be allowed by a payroll system, but may be disallowed by a specific employer. Therefore, when an employee
of that company goes to set up Direct Deposit it is rejected, resulting in this error code.
* routing-number-not-supported - The account did not support the routing number entered.
* session-timeout - The user's session timed out.
* system-unavailable - The system was unavailable. For example,
the site is undergoing maintenance or it is outside the window
of scheduled availability for the site.
* transaction-pending - There is a deposit allocation already in progress and additional updates cannot be made at this time.
For example, if an employer has an approval process in place, they may disallow modifications until the update has been processed.
* unknown-failure - We encountered an unexpected error.
* user-abandon - The user was asked an MFA question, but did not answer the question.
* work-status-terminated - The task could not be completed because the user's employment has been terminated.
example: bad-credentials
createdDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when
deposit switch was performed
example: '2023-07-25T08:14:20Z'
ExternalDepositSwitchesSummary:
required:
- externalId
type: object
properties:
externalId:
type: string
description: An external ID
example: 'b73af28c-0878djs3'
switches:
type: array
description: Deposit switches summary
minItems: 0
maxItems: 10
items:
required:
- id
- status
- createdDate
properties:
id:
type: string
description: Deposit switch ID
example: 602414d84f9a1980cf5eafcc
status:
type: string
description: |
Deposit switch status. Possible values include `processing`,
`completed`, or `failed`.
* processing - The deposit switch is currently being processed.
* completed - The deposit switch has been completed successfully.
* failed - The deposit switch has failed. Refer to failureReason for more details.
example: completed
failureReason:
type: string
description: |
Deposit switch failure reason. Possible values include -
* account-lockout - The account is locked out, most likely the end user has had too many failed attempts.
* account-setup-incomplete - The user's account in the payroll system is not fully set up and will require additional
information from the user.
* account-unusable - The user's bank account is unusable for the selected product or use case.
* bad-credentials - Either the username or password was incorrect. This is our most common fail reason.
* connection-error - A network error occurred which caused the connection between our system and the payroll system to be
lost.
* distribution-not-supported - The payroll system did not support the type of distribution requested. For example,
the user attempted to allocate a percentage of their paycheck, but is only eligible for fixed amounts and remainder/net
balance.
* device-disconnected - The device used to start the task is no longer connected.
* enrolled-in-paycard - The user is enrolled in a paycard program instead of direct deposit via
their bank.
* expired - The user's password has expired and they must create a new one.
* no-data-found - No verify data was found for the user.
* product-not-supported - The payroll system did not allow the action to be taken. Many payroll
systems allow HR to customize what is allowed in their system.
Direct Deposit may be allowed by a payroll system, but may be disallowed by a specific employer. Therefore, when an employee
of that company goes to set up Direct Deposit it is rejected, resulting in this error code.
* routing-number-not-supported - The account did not support the routing number entered.
* session-timeout - The user's session timed out.
* system-unavailable - The system was unavailable. For example,
the site is undergoing maintenance or it is outside the window
of scheduled availability for the site.
* transaction-pending - There is a deposit allocation already in progress and additional updates cannot be made at this time.
For example, if an employer has an approval process in place, they may disallow modifications until the update has been processed.
* unknown-failure - We encountered an unexpected error.
* user-abandon - The user was asked an MFA question, but did not answer the question.
* work-status-terminated - The task could not be completed because the user's employment has been terminated.
example: bad-credentials
createdDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when
deposit switch was performed
example: '2023-07-25T08:14:20Z'
DepositSwitchDetails:
required:
- customerId
- customerType
- switchId
- switchStatus
- createdDate
- updatedDate
- provider
- distributions
type: object
properties:
customerId:
type: string
description: A customer ID
example: '1005061234'
customerType:
type: string
description:
The type of Mastercard Open Finance customer (`active` or `testing`)
example: testing
switchId:
type: string
description: Deposit switch ID
example: 602414d84f9a1980cf5eafcc
switchStatus:
type: string
description: |
Deposit switch status. Possible values include `processing`,
`completed`, or `failed`.
* processing - The deposit switch is currently being processed.
* completed - The deposit switch has been completed successfully.
* failed - The deposit switch has failed. Refer to failureReason for more details.
example: completed
failureReason:
type: string
description: |
Deposit switch failure reason. Possible values include -
* account-lockout - The account is locked out, most likely the end
user has had too many failed attempts.
* account-setup-incomplete - The user's account in the payroll system is not fully set up and
will require additional information from the user.
* account-unusable - The user's bank account is unusable for the
selected product or use case.
* bad-credentials - Either the username or password was incorrect. This is our most common fail
reason.
* connection-error - A network error occurred which caused
the connection between our system and the payroll system to be lost.
* distribution-not-supported - The payroll system did not support
the type of distribution requested. For example, the user attempted
to allocate a percentage of their paycheck, but is only eligible for
fixed amounts and remainder/net balance.
* device-disconnected - The device used to start the task is no longer connected.
* enrolled-in-paycard - The user is enrolled in a paycard program
instead of direct deposit via their bank.
* expired - The user's password has expired and they must create a new one. * no-data-found
- No verify data was found for the user.
* product-not-supported - The payroll system did not allow the action to be taken. Many
payroll systems allow HR to customize what is allowed in their
system. Direct Deposit may be allowed by a payroll system, but may
be disallowed by a specific employer. Therefore, when an employee of
that company goes to set up Direct Deposit it is rejected, resulting
in this error code.
* routing-number-not-supported - The account did not support the routing number entered.
* session-timeout - The user's session timed out.
* system-unavailable - The system was unavailable. For example, the site is undergoing maintenance or it
is outside the window of scheduled availability for the site.
* transaction-pending - There is a deposit allocation already in progress and additional updates cannot be made at this time. For
example, if an employer has an approval process in place, they may
disallow modifications until the update has been processed.
* unknown-failure - We encountered an unexpected error.
* user-abandon - The user was asked an MFA question, but did not answer the
question.
* work-status-terminated - The task could not be completed
because the user's employment has been terminated.
example: bad-credentials
createdDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when deposit
switch was performed
example: '2023-07-25T08:14:20Z'
updatedDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when deposit
switch status was updated
example: '2023-07-25T08:30:20Z'
authenticated:
type: boolean
description:
Indicates whether or not the deposit switch task has successfully
authenticated against the payroll system
example: true
provider:
type: object
required:
- id
- name
properties:
id:
type: string
description: Unique identifier for the service provider
example: 607e249736b9f053b536bde0
name:
type: string
description: The name of the service provider
example: Paycom
distributions:
type: array
description: Deposit switch distribution details
items:
required:
- type
- bankIdentifier
- accountNumberEndsWith
properties:
type:
type: string
description:
The type of distribution for the account. Possible values
include `total`, `percent`, or `fixed`.
example: percent
allocatedValue:
type: number
description:
The amount being distributed to the account. When distribution
type is `percent`, this number represents a percentage of the
total pay. When distribution type is `fixed`, this number
represents a fixed dollar amount. This value is not set when
distribution type is `total`.
example: 52
bankIdentifier:
type: string
description: The bank routing number
example: '110000000'
accountNumberEndsWith:
type: string
description:
The trailing portion of customer's bank account number
example: '4126'
PaySwitchesSummary:
required:
- customerId
- customerType
type: object
properties:
customerId:
type: string
description: A customer ID
example: '1005061234'
customerType:
type: string
description:
The type of Mastercard Open Finance customer (`active` or `testing`)
example: testing
switches:
type: array
description: Pay switches summary
minItems: 0
maxItems: 10
items:
required:
- id
- status
- createdDate
properties:
id:
type: string
description: Pay switch ID
example: 602414d84f9a1980cf5eafcc
status:
type: string
description: |
Pay switch status. Possible values include `processing`,
`completed`, or `failed`.
* processing - The pay switch is currently being processed.
* completed - The pay switch has been completed successfully.
* failed - The pay switch has failed. Refer to failureReason for more details.
example: completed
failureReason:
type: string
description: |-
Pay switch failure reason. Possible values include -
* account-lockout - The account is locked out, most likely the end user has had too many failed attempts.
* account-unusable - The user's bank account is unusable for the selected product or use case.
* bad-credentials - Either the username or password was incorrect. This is our most common fail reason.
* connection-error - A network error occurred which caused the connection between our system and the bank/payroll system to be lost.
* device-disconnected - The device used to start the task is no longer connected.
* expired - The user's password has expired and they must create a new one.
* no-data-found - No verify data was found for the user.
* routing-number-not-supported - The account did not support the routing number entered.
* session-timeout - The user's session timed out.
* system-unavailable - The system was unavailable. For example, the site is undergoing maintenance or it is outside the window of scheduled availability for the site.
* transaction-pending - There is an allocation already in progress and additional updates cannot be made at this time.
* unknown-failure - We encountered an unexpected error.
* user-abandon - The user was asked an MFA question, but did not answer the question.
example: connection-error
createdDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when
deposit switch was performed
example: '2023-07-25T08:14:20Z'
PaySwitchDetails:
required:
- customerId
- customerType
- switchId
- switchStatus
- createdDate
- updatedDate
- provider
- paymentMethods
type: object
properties:
customerId:
type: string
description: A customer ID
example: '1005061234'
customerType:
type: string
description:
The type of Mastercard Open Finance customer (`active` or `testing`)
example: testing
switchId:
type: string
description: Pay switch ID
example: 602414d84f9a1980cf5eafcc
switchStatus:
type: string
description: |
Pay switch status. Possible values include `processing`,
`completed`, or `failed`.
* processing - The pay switch is currently being processed.
* completed - The pay switch has been completed successfully.
* failed - The pay switch has failed. Refer to failureReason for more details.
example: completed
failureReason:
type: string
description: |
Pay switch failure reason. Possible values include -
* account-lockout - The account is locked out, most likely the end user has had too many failed attempts.
* account-unusable - The user's bank account is unusable for the selected product or use case.
* bad-credentials - Either the username or password was incorrect. This is our most common fail reason.
* connection-error - A network error occurred which caused the connection between our
system and the bank/payroll system to be lost.
* device-disconnected - The device used to start the task is no longer connected.
* expired - The user's password has expired and they must create a new one.
* no-data-found - No verify data was found for the user.
* routing-number-not-supported - The account did not support the routing number entered.
* session-timeout - The user's session timed out.
* system-unavailable - The system was unavailable. For example, the site is undergoing
maintenance or it is outside the window of scheduled availability for the site.
* transaction-pending - There is an allocation already in progress and additional updates cannot
be made at this time.
* unknown-failure - We encountered an unexpected error.
* user-abandon - The user was asked an MFA question, but did not answer the question.
example: unknown-failure
createdDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when deposit
switch was performed
example: '2023-07-25T08:14:20Z'
updatedDate:
type: string
description:
Date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when deposit
switch status was updated
example: '2023-07-25T08:30:20Z'
authenticated:
type: boolean
description:
Indicates whether or not the pay switch task has successfully
authenticated against the payroll system
example: true
provider:
type: object
required:
- id
- name
properties:
id:
type: string
description: Unique identifier for the service provider
example: 607e249736b9f053b536bde0
name:
type: string
description: The name of the service provider
example: Netflix
paymentMethods:
type: array
description: Pay switch payment details
items:
required:
- type
properties:
type:
type: string
description:
The type of payment method used for the bill payment. Possible
values include `card` or `bank`.
example: 'card'
title:
type: string
description: The title of the card / account
example: 'Sample Card'
brand:
type: string
description: The co-branding for customer's card
example: 'Mastercard'
bankIdentifier:
type: string
description: The bank routing number
example: '110000000'
endsWith:
type: string
description:
The trailing portion of customer's bank account number or card
example: '4126'
bankAccountType:
type: string
description: The type of account used when payment type is bank
example: 'Checking'
AllowedBalanceCacheInterval:
type: integer
format: int32
default: 0
minimum: 0
maximum: 1440
description:
Time interval in minutes to check balance data against live balance from
financial institution or from latest cached
example: 1
BillPaySwitchIdentity:
description:
Identity information for the user. Mandatory when use case is BPS.
type: object
required:
- address
- city
- firstName
- lastName
- zipCode
- state
- phone
properties:
firstName:
type: string
description: User first name
example: 'Jane'
maxLength: 50
lastName:
type: string
description: User last name
example: 'Doe'
maxLength: 50
zipCode:
type: string
description: Postal / zip code of the user
example: '12345'
minLength: 5
maxLength: 10
address:
type: string
description: First line of user address
example: '123 Lane'
maxLength: 100
address2:
type: string
description: Second line of user address
example: 'Apt 987'
maxLength: 100
city:
type: string
description: City in which user is located
example: 'Purchase'
maxLength: 100
state:
type: string
description: State in which user is located
example: 'NY'
maxLength: 2
phone:
type: string
description: User phone number
example: '2121234567'
maxLength: 15
email:
type: string
description: User email address
example: 'jane.doe@example.com'
maxLength: 100
BankAccounts:
type: array
items:
$ref: '#/components/schemas/BankAccount'
description: List of customer accounts (one or more) for Deposit Switch.
example:
- accountNumber: '7526894126'
bankIdentifier: '110000000'
title: 'My savings account'
type: 'savings'
- accountNumber: '3740238560'
bankIdentifier: '110000000'
title: 'Checking account 8560'
type: 'checking'
BankAccount:
description: Deposit Switch account
type: object
required:
- accountNumber
- bankIdentifier
- type
properties:
accountNumber:
type: string
description: The user's bank account number
minLength: 4
maxLength: 17
example: '7526894126'
bankIdentifier:
description: >-
Code used to identify the financial institution also known as the
bank routing number
type: string
pattern: '^[0-9]{9}$'
example: '110000000'
title:
description: >-
The title of the account
type: string
example: 'My savings account'
type:
description: >-
Financial institution account type. Options `checking` or `savings`
type: string
example: 'checking'
ErrorWrapper:
description: A top level object for errors.
type: object
required:
- Errors
properties:
Errors:
$ref: '#/components/schemas/Errors'
Errors:
description: Object that contains the list of errors.
type: object
required:
- Error
properties:
Error:
$ref: '#/components/schemas/ErrorList'
ErrorList:
description: The list of errors.
type: array
minItems: 1
items:
$ref: '#/components/schemas/Error'
Error:
description: A single error.
type: object
properties:
Source:
type: string
minLength: 0
maxLength: 512
description: The application that generated this error
example: 'Event Subscription Service'
ReasonCode:
type: string
minLength: 0
maxLength: 512
description: >-
A unique constant identifying the error case encountered during
transaction processing
example: '10001'
Description:
type: string
minLength: 0
maxLength: 512
description:
Description of the ReasonCode field with additional details.
example: Resource Not Found.
Recoverable:
type: boolean
description:
Indicates whether this error will always be returned for this
request, or retrying could change the outcome
example: false
Details:
type: string
minLength: 0
maxLength: 512
description: Details for backwards compatibility.
example: Invalid JSON payload
WebhookUrl:
type: string
description:
The webhook Url where the event notifications will be sent. The URL must
be aligned with RFC 2396.
minLength: 1
maxLength: 2048
example: 'https://example.com/example_webhook'
Status:
type: string
description:
The status of the event (e.g. active, inactive, pending, removed).
minLength: 1
maxLength: 10
example: 'active'
Condition:
type: object
required:
- subscribeFor
properties:
subscribeFor:
type: string
description:
The field or entity that the event is subscribed for, such as an
institution or account ID.
minLength: 1
maxLength: 50
example: 'institutionId'
includes:
type: array
description:
A list of specific IDs or values to include in the subscription
condition.
items:
type: string
example:
- '100010'
- '100011'
excludes:
type: array
description:
A list of specific IDs or values to exclude from the subscription
condition.
items:
type: string
example:
- '170718'
- '170788'
WebhookEvent:
type: object
required:
- name
properties:
name:
type: string
description: The name of the webhook subscription event.
minLength: 1
maxLength: 255
example: 'authorization.accesstoken.expiry'
url:
$ref: '#/components/schemas/WebhookUrl'
condition:
$ref: '#/components/schemas/Condition'
Event:
type: object
required:
- webhookEventId
- name
- status
properties:
webhookEventId:
type: string
description: A unique UUID identifier for the webhook event.
minLength: 36
maxLength: 36
example: '661f3c48-f596-423b-81f5-d275d4dd1346'
name:
type: string
description: The name of the event.
minLength: 1
maxLength: 255
example: 'authorization.accesstoken.expiry'
url:
$ref: '#/components/schemas/WebhookUrl'
status:
$ref: '#/components/schemas/Status'
condition:
$ref: '#/components/schemas/Condition'
SubscriptionDetail:
type: object
required:
- subscriptionId
- events
- status
- createdDate
- lastUpdatedDate
properties:
subscriptionId:
type: string
description: A unique UUID identifier for the subscription.
minLength: 36
maxLength: 36
example: '661f3c48-f596-423b-81f5-d275d4dd1345'
url:
$ref: '#/components/schemas/WebhookUrl'
events:
$ref: '#/components/schemas/Events'
status:
$ref: '#/components/schemas/Status'
createdDate:
type: string
format: date-time
minLength: 1
maxLength: 255
description: Subscription creation date.
example: '2024-01-01T11:18:50Z'
lastUpdatedDate:
type: string
format: date-time
minLength: 1
maxLength: 255
description: Subscription last updated date.
example: '2024-01-01T11:18:50Z'
Events:
type: array
description: List of events for the subscription.
items:
$ref: '#/components/schemas/Event'
WebhookEvents:
type: array
description: List of webhook subscription event.
items:
$ref: '#/components/schemas/WebhookEvent'
CountResults:
type: integer
description:
The number of subscriptions currently displayed in the response.
minimum: 1
maximum: 2147483647
example: 10
OffsetResults:
type: integer
description:
The number of items you asked the start of the list to be offset.
minimum: 1
maximum: 2147483647
example: 5
LimitResults:
type: integer
description: The number of items you asked the list to be limited.
minimum: 1
maximum: 2147483647
example: 10
TotalResults:
type: integer
description: The total number of items in the collection.
minimum: 1
maximum: 2147483647
example: 10
Subscriptions:
type: object
required:
- count
- offset
- limit
- total
- subscriptions
properties:
count:
$ref: '#/components/schemas/CountResults'
offset:
$ref: '#/components/schemas/OffsetResults'
limit:
$ref: '#/components/schemas/LimitResults'
total:
$ref: '#/components/schemas/TotalResults'
subscriptions:
type: array
description: List of subscription objects returned by the API.
items:
$ref: '#/components/schemas/SubscriptionDetail'
AvailableEvent:
type: object
required:
- name
- description
- status
properties:
name:
type: string
description: The name of the event that is available for subscription.
minLength: 1
maxLength: 100
example: 'manage.txpush.account.created'
description:
type: string
description: A brief description of the event.
minLength: 1
maxLength: 500
example: 'Triggered when an account is created.'
conditionalSubscription:
type: object
required:
- applicable
- mandatory
properties:
applicable:
type: boolean
description:
Indicates whether conditional subscription is applicable for
this event.
example: true
fields:
type: string
description:
The fields that are applicable for conditional subscription,
such as `accountId` or `customerId`.
minLength: 1
maxLength: 200
example: 'accountId, customerId'
mandatory:
type: boolean
description:
Indicates whether the fields in the conditional subscription are
mandatory.
example: false
Subscription:
type: object
required:
- events
description: Request body to create or update a subscription.
properties:
url:
$ref: '#/components/schemas/WebhookUrl'
events:
$ref: '#/components/schemas/WebhookEvents'
EventStatusUpdate:
type: object
required:
- status
properties:
status:
type: string
description:
The status to set for the event. Can be `active`,`inactive` ,
`pending` or `removed`.
minLength: 1
maxLength: 10
example: active
LinkedAccountDate:
type: integer
description: >-
A timestamp showing when the customer first linked the account via Data
Connect. A date in Unix epoch time (in seconds). See: [Handling Epoch
Dates and
Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practices/).
format: int64
example: 1607450357
EnrichTransactionsPayload:
type: object
description: Request body that contains transactions to be enriched.
properties:
transactions:
type: array
description: A list of transactions requested to be enriched.
items:
$ref: '#/components/schemas/TransactionPayload'
minItems: 1
maxItems: 1000
required:
- transactions
TransactionPayload:
type: object
properties:
externalCustomerId:
type: string
description: A unique identifier assigned to the customer for a
particular institution.
__Note:__ The externalCustomerId and externalAccountId fields are to
allow you to map the transactions back to your data. __Do not send
Mastercard plaintext representations of customer or account IDs.__
The representative IDs must be obfuscated through cryptographically
strong hashing (we recommend using SHA-2 or SHA-3 methods).
minLength: 1
maxLength: 100
example: '1005061234'
externalAccountId:
type: string
description: A unique identifier assigned to the accounts for a
particular institution.
__Note:__ The externalCustomerId and externalAccountId fields are to
allow you to map the transactions back to your data. __Do not send
Mastercard plaintext representations of customer or account IDs.__
The representative IDs must be obfuscated through cryptographically
strong hashing (we recommend using SHA-2 or SHA-3 methods).
minLength: 1
maxLength: 100
example: '1005061234'
accountType:
type: string
description: |
Indicates the type of account associated with the transaction.
Listed below are the current account types supported:
"checking",
"savings",
"creditCard",
"brokerageAccount",
"investment",
"healthSavingsAccount",
"unknown"
NOTE : If "unknown" is provided, the enrichment service will assume it is a "checking" account. An incorrect assumption could impact the results from the enrichment service.
minLength: 1
maxLength: 511
example: 'checking'
externalTransactionId:
description:
A unique identifier for the transaction that assists in linking data
back to your systems.
type: string
minLength: 1
maxLength: 511
example: 'MAC1005061233'
postedTimestamp:
type: string
description: |
The date and time when the transaction was officially recorded in the account.
Supported formats are yyyy-MM-dd'T'HH:mm:ss.SSS'Z', yyyy-MM-dd'T'HH:mm:ss'Z', yyyy-MM-dd HH:mm:ss.0, yyyy-MM-dd.
minLength: 3
maxLength: 32
example: '2024-07-26T11:00:00Z'
transactionTimestamp:
type: string
description: |
The exact date and time when the transaction was initiated or occurred.
Supported formats are yyyy-MM-dd'T'HH:mm:ss.SSS'Z', yyyy-MM-dd'T'HH:mm:ss'Z', yyyy-MM-dd HH:mm:ss.0, yyyy-MM-dd.
minLength: 3
maxLength: 32
example: '2024-07-26T11:00:00Z'
description:
type: string
description: Description of the transaction.
minLength: 1
maxLength: 1024
example: 'STARBUCKS STORE 06565 LITTLETON CO 07/26'
memo:
type: string
description: Memo of the transaction.
minLength: 0
maxLength: 511
example: 'debit'
amount:
type: number
format: double
description: Value amount for transaction.
minimum: -1.7976931348623157E+308
maximum: 1.7976931348623157E+308
example: -13.26
transactionFee:
type: number
format: double
description: A charge applied to the transaction.
minimum: -1.7976931348623157E+308
maximum: 1.7976931348623157E+308
example: 0
type:
type: string
description: Type of the transaction.
minLength: 0
maxLength: 32
example: 'DEBIT'
directionIndicator:
type: string
description: |
- The directionIndicator should be from the perspective of the account holder.
- If you always send us positive amount values, you MUST send us corresponding directionIndicator values to ensure the categorization logic works as intended.
- If you have internal logic to provide the amount field as either positive or negative, do not send us data in the directionIndicator.
- Listed below are the current directionIndicator types supported:
- "Debit"
- "Credit"
minLength: 0
maxLength: 32
example: 'Debit'
additionalDetails:
type: object
description: |
A dictionary containing additional details of the transaction
being returned in the enrichment response.
- This object should not contain any PII.
- The max number of allowed keys are 30.
- The key max length should be 100.
- The value max length should be 255.
additionalProperties:
$ref: '#/components/schemas/AdditionalDetails'
example:
key1: 'value1'
key2: 'value2'
cardAcceptorId:
type: string
description:
Also known as CAID, Merchant ID, or DE42, cardAcceptorId is an
alphanumeric string assigned by the acquiring bank (Acquirer) to a
merchant or merchant location. It serves as a unique identifier for
the point of transaction origin, such as a physical store, payment
terminal, or online checkout page.
minLength: 0
maxLength: 15
example: '234523095820935'
inputIsRecurringTransaction:
type: boolean
description:
A flag indicating whether the transaction is recurring or not.
example: false
inputMerchantInformation:
$ref: '#/components/schemas/InputMerchantInformation'
required:
- externalCustomerId
- accountType
- description
- amount
- externalTransactionId
- transactionTimestamp
- externalAccountId
EnrichedTransactions:
type: object
description: Request body that contains transactions to be enriched.
properties:
transactions:
type: array
description: List of input transactions to be enriched.
items:
$ref: '#/components/schemas/EnrichedTransaction'
EnrichedTransaction:
type: object
properties:
externalCustomerId:
type: string
description:
A unique identifier assigned to the customer for a particular
institution.
minLength: 1
maxLength: 100
example: '1005061234'
externalAccountId:
type: string
description:
A unique identifier assigned to the accounts for a particular
institution.
minLength: 1
maxLength: 100
example: '1005061234'
accountType:
type: string
description: |
Indicates the type of account associated with the transaction.
Listed below are the current account types supported:
"checking",
"savings",
"creditCard",
"brokerageAccount",
"investment",
"healthSavingsAccount",
"unknown"
NOTE : If "unknown" is provided, the enrichment service will assume it is a "checking" account. An incorrect assumption could impact the results from the enrichment service.
minLength: 1
maxLength: 511
example: 'checking'
externalTransactionId:
description:
A unique identifier for the transaction that assists in linking data
back to your systems.
type: string
minLength: 1
maxLength: 511
example: 'MAC1005061233'
postedTimestamp:
type: string
description: |
The date and time when the transaction was officially recorded in the account.
Supported formats are yyyy-MM-dd'T'HH:mm:ss.SSS'Z', yyyy-MM-dd'T'HH:mm:ss'Z', yyyy-MM-dd HH:mm:ss.0, yyyy-MM-dd.
minLength: 3
maxLength: 32
example: '2024-07-26T11:00:00Z'
transactionTimestamp:
type: string
description: |
The exact date and time when the transaction was initiated or occurred.
Supported formats are yyyy-MM-dd'T'HH:mm:ss.SSS'Z', yyyy-MM-dd'T'HH:mm:ss'Z', yyyy-MM-dd HH:mm:ss.0, yyyy-MM-dd.
minLength: 3
maxLength: 32
example: '2024-07-26T11:00:00Z'
description:
type: string
description: Description of the transaction.
minLength: 1
maxLength: 1024
example: 'STARBUCKS STORE 06565 LITTLETON CO 07/26'
memo:
type: string
description: Memo of the transaction.
minLength: 0
maxLength: 511
example: 'debit'
amount:
type: number
format: double
description: Value amount for transaction.
minimum: -1.7976931348623157E+308
maximum: 1.7976931348623157E+308
example: -13.26
transactionFee:
type: number
format: double
description: A charge applied to the transaction.
minimum: -1.7976931348623157E+308
maximum: 1.7976931348623157E+308
example: 0
transactionCategory:
type: string
description: Transaction Category for the transaction.
minLength: 0
maxLength: 256
example: 'Coffee Shops'
transactionCategoryScore:
type: number
format: double
description:
A confidence score between 0 โ 100.0 for the transaction category.
minimum: 0
maximum: 100.0
example: 16
transactionCategoryGroup:
type: string
description: The parent group that a transaction category belongs to.
minLength: 0
maxLength: 256
example: 'Dining'
type:
type: string
description: Type for transaction.
minLength: 0
maxLength: 32
example: 'DEBIT'
directionIndicator:
type: string
description: |
- The directionIndicator should be from the perspective of the account holder.
- If you always send us positive amount values, you MUST send us corresponding directionIndicator values to ensure the categorization logic works as intended.
- If you have internal logic to provide the amount field as either positive or negative, do not send us data in the directionIndicator.
- Listed below are the current directionIndicator types supported:
- "Debit"
- "Credit"
minLength: 0
maxLength: 32
example: 'Debit'
entities:
$ref: '#/components/schemas/Entities'
address:
$ref: '#/components/schemas/DESAddress'
additionalDetails:
type: object
description: |
A dictionary containing additional details of the transaction
being returned in the enrichment response.
- This object should not contain any PII.
- The max number of allowed keys are 30.
- The key max length should be 100.
- The value max length should be 255.
additionalProperties:
$ref: '#/components/schemas/AdditionalDetails'
example:
key1: 'value1'
key2: 'value2'
cardAcceptorId:
type: string
description:
Also known as CAID, Merchant ID, or DE42, cardAcceptorId is an
alphanumeric string assigned by the acquiring bank (Acquirer) to a
merchant or merchant location. It serves as a unique identifier for
the point of transaction origin, such as a physical store, payment
terminal, or online checkout page.
minLength: 0
maxLength: 15
example: '234523095820935'
inputIsRecurringTransaction:
type: boolean
description:
A flag in the input indicating whether the transaction is recurring
or not.
example: false
inputMerchantInformation:
$ref: '#/components/schemas/InputMerchantInformation'
isRecurringTransaction:
type: boolean
description:
A flag indicating whether the transaction is recurring or not.
example: false
locationId:
type: number
description:
The Mastercard assigned location id representing this merchant
location.
example: 876875444777
minLength: 0
maxLength: 32
isEcommerce:
type: boolean
description:
A flag indicating whether the business location is ecommerce or not.
example: false
isBrickAndMortar:
type: boolean
description:
A boolean value indicating if the identified merchant is a brick and
mortar location.
example: false
matchConfidenceScore:
type: number
minimum: 0
maximum: 100
description:
If the merchantDescriptor is used to select the locationId and
location details, a matchConfidenceScore is returned, indicating the
score between the merchantDescriptor and the selected information
from our internal data on merchants.
example: 97
AdditionalDetails:
type: string
DESAddress:
description: Address source of the transactions.
type: object
properties:
line1:
type: string
description: Line 1 of the transaction address.
minLength: 1
maxLength: 100
example: '10278 W'
line2:
type: string
description: Line 2 of the transaction address.
minLength: 1
maxLength: 100
example: 'Centennial Rd'
city:
type: string
description: City of the transaction.
minLength: 1
maxLength: 100
example: 'Littleton'
state:
type: string
description: State of the transaction.
minLength: 1
maxLength: 100
example: 'CO'
postalCode:
type: string
description: Postal Code of the transaction.
minLength: 1
maxLength: 100
example: '80127'
country:
type: string
description: Country of the transaction.
minLength: 1
maxLength: 100
example: 'USA'
latitude:
type: number
description: Latitude of the transaction.
format: double
minimum: -90
maximum: 90
example: 39.56722
longitude:
type: number
description: Longitude of the transaction.
format: double
minimum: -180
maximum: 180
example: -105.11126
phoneNumber:
type: string
description: Phone number of the transaction.
minimum: 0
maximum: 20
example: '8017339340'
Entities:
description:
Entities refer to the distinct parties involved in the transaction.
type: array
items:
type: object
properties:
id:
type: string
description: ID of the entity (entities).
minLength: 1
maxLength: 100
example: 'MTc1ODA5NDU0MTYwNjM1OTA0MA=='
name:
type: string
description: Name of the entity (entities).
minLength: 1
maxLength: 100
example: 'Starbucks'
group:
type: string
description: Group of the entity (entities).
minLength: 1
maxLength: 100
example: 'Cafe'
category:
type: string
description: Category of the entity (entities).
minLength: 1
maxLength: 100
example: 'Coffee Shops'
website:
type: string
description: Website of the involved entity.
minLength: 1
maxLength: 100
example: 'https://starbucks.com'
logoUrl:
type: string
description: Logo of the involved entity.
minLength: 1
maxLength: 500
example: 'https://institution-branding-assets-cf.openbanking.mastercard.com/MTc1ODA5NDU0MTYwNjM1OTA0MA==/logo.svg'
entityStandardizationConfidenceScore:
type: number
format: double
description:
A confidence score indicating the entity name returned is
correctly standardized to a standard entity name. If no score is
returned, the entity has not been standardized.
minimum: 0
maximum: 100.0
example: 18.95
InputMerchantInformation:
description:
InputMerchantInformation is an object containing merchant details in the
request body.
type: object
properties:
merchantDescriptor:
type: string
description:
This is a concatenated combination of DE43 merchant name, DE43
merchant city and DE43 merchant state. Spaces should be excluded
when concatenating these fields. If merchant state is not provided
by the acquirer, use merchant name and city only. If the acquirer
provides a country code instead of a state, use a combination of
merchant name, city, and country.
minLength: 0
maxLength: 50
example: 'MCDONALDS10649CLINTONSC'
name:
type: string
description: Name of the merchant.
minLength: 0
maxLength: 256
example: 'McDonalds'
line1:
type: string
description: Line 1 of the transaction address.
minLength: 0
maxLength: 100
example: '101 S Broad St'
city:
type: string
description: City of the transaction.
minLength: 0
maxLength: 50
example: 'Clinton'
state:
type: string
description: State of the transaction.
minLength: 0
maxLength: 3
example: 'SC'
postalCode:
type: string
description: PostalCode of the transaction.
minLength: 0
maxLength: 10
example: '29325'
country:
type: string
description: Country of the transaction.
minLength: 0
maxLength: 3
example: 'US'
phoneNumber:
type: string
description: The phone number of the merchant
minLength: 0
maxLength: 20
example: '8648334816'
website:
type: string
description: Website of the involved entity.
minLength: 0
maxLength: 256
example: 'https://www.mcdonalds.com'
merchantCategoryCode:
type: string
description:
This code represents the category that a merchant location may be
under and is supported by most payment providers.
minLength: 0
maxLength: 128
example: '5814'
merchantCategoryName:
type: string
description:
This is the name of the Merchant Category that accompanies the MCC
Code which identifies the category a merchant falls under.
minLength: 0
maxLength: 256
example: 'FAST FOOD RESTAURANTS'
ShowDailyBalance:
type: boolean
example: true
default: false
Fields:
type: string
description: Mention API fields that needs to be fetched
example: 'balanceDetails,paymentInstruction,accountIdentity'
PaymentEnablementBundle:
required:
- errorCount
- customerId
- accounts
type: object
properties:
customerId:
$ref: '#/components/schemas/CustomerId'
errorCount:
$ref: '#/components/schemas/ErrorCount'
accountCount:
$ref: '#/components/schemas/AccountCount'
accountIdentitySuccessCount:
$ref: '#/components/schemas/AccountIdentitySuccessCount'
balanceDetailsSuccessCount:
$ref: '#/components/schemas/BalanceDetailsSuccessCount'
paymentInstructionSuccessCount:
$ref: '#/components/schemas/PaymentInstructionSuccessCount'
accounts:
type: array
description: List of Account Details
items:
$ref: '#/components/schemas/PEBAccountDetails'
ErrorCount:
type: integer
format: int32
description: >-
The number of errors or failures that have occurred while processing the
API request. If all the requested parameters are returned successfully
then this value will be 0. Any value other than zero indicates failures.
example: 0
AccountCount:
type: integer
format: int32
description: >-
Total number of accounts returned.
example: 1
AccountIdentitySuccessCount:
type: integer
format: int32
description: >-
Total number of successful sections returned when requesting
accountIdentity. If not provided, value will be 0.
example: 1
BalanceDetailsSuccessCount:
type: integer
format: int32
description: >-
Total number of successful sections returned when requesting
balanceDetails. If not provided, value will be 0.
example: 1
PaymentInstructionSuccessCount:
type: integer
format: int32
description: >-
Total number of successful sections returned when requesting
paymentInstruction. If not provided, value will be 0.
example: 1
PEBAccountDetails:
required:
- id
- institutionId
- institutionName
- institutionLoginId
type: object
properties:
id:
$ref: '#/components/schemas/AccountId'
realAccountNumberLast4:
$ref: '#/components/schemas/AccountNumberLast4'
institutionId:
$ref: '#/components/schemas/InstitutionId'
institutionName:
$ref: '#/components/schemas/InstitutionName'
institutionLoginId:
$ref: '#/components/schemas/NumericInstitutionLoginId'
accountDetails:
$ref: '#/components/schemas/AccountSimpleDetails'
balanceDetails:
$ref: '#/components/schemas/AvailableBalancePEB'
accountIdentity:
$ref: '#/components/schemas/AccountOwnerHolders'
paymentInstruction:
$ref: '#/components/schemas/PaymentInstructionPEB'
errors:
$ref: '#/components/schemas/FieldErrors'
AccountSimpleDetails:
required:
- accountNumberDisplay
- createdDate
- currency
- name
- status
- type
type: object
properties:
id:
$ref: '#/components/schemas/AccountId'
accountNumberDisplay:
$ref: '#/components/schemas/AccountNumberDisplay'
name:
$ref: '#/components/schemas/Name'
type:
$ref: '#/components/schemas/AccountType'
aggregationStatusCode:
$ref: '#/components/schemas/AggregationStatusCode'
status:
$ref: '#/components/schemas/AggregationStatus'
aggregationSuccessDate:
$ref: '#/components/schemas/DateTimeWithZone'
aggregationAttemptDate:
$ref: '#/components/schemas/DateTimeWithZone'
createdDate:
$ref: '#/components/schemas/DateTimeWithZone'
currency:
$ref: '#/components/schemas/Currency'
displayPosition:
$ref: '#/components/schemas/DisplayPosition'
parentAccount:
$ref: '#/components/schemas/AccountId'
PaymentInstructionPEB:
required:
- accountNumber
- type
type: object
properties:
type:
type: string
description: Payment instruction type
example: ach
accountNumber:
type: string
description: The account number from the institution
example: '124344454'
tanEnabled:
type: boolean
description:
'This field indicates whether the FI uses a tokenized account number
for origination purposes.'
example: true
descriptors:
type: array
description: List of descriptors
items:
$ref: '#/components/schemas/Descriptor'
FieldErrors:
type: array
description: Lists of errors while getting the data
items:
$ref: '#/components/schemas/FieldError'
PebAllowedBalanceCacheInterval:
type: integer
format: int32
default: 30
minimum: 1
maximum: 1440
description:
Time interval in minutes to check balance data against live balance from
financial institution or from latest cached
example: 15
FieldError:
required:
- fieldError
- code
- description
type: object
properties:
fieldName:
type: string
description: Field Name
example: balanceDetails
code:
type: string
description: Error Code
example: '102'
description:
type: string
description: Error Description
example: FI Down for maintenance
AvailableBalancePEB:
required:
- realAccountNumberLast4
- availableBalance
- availableBalanceDate
- clearedBalance
- clearedBalanceDate
- aggregationStatusCode
- currency
type: object
properties:
id:
$ref: '#/components/schemas/NumericAccountId'
realAccountNumberLast4:
$ref: '#/components/schemas/AccountNumberLast4'
availableBalance:
type: number
description: The available balance of the account
format: double
example: 123.45
minimum: 0
maximum: 10000000000000000
availableBalanceDate:
$ref: '#/components/schemas/DateTimeWithZone'
clearedBalance:
type: number
description: >-
The cleared balance of the account. Also referred as posted balance,
current balance, ledger balance
example: 222.25
format: double
minimum: 0
maximum: 9999999999999
clearedBalanceDate:
$ref: '#/components/schemas/DateTimeWithZone'
aggregationStatusCode:
$ref: '#/components/schemas/AggregationStatusCode'
currency:
$ref: '#/components/schemas/Currency'
PhoneNumberWithCountryCode:
type: object
description: A phone number with corresponding country code.
required:
- countryCode
- phoneNo
properties:
countryCode:
type: string
description:
The country code digit representing the phone number for specific
country.
minLength: 1
maxLength: 3
example: '1'
phoneNo:
type: string
description: A phone number (E.164 format)
minLength: 7
maxLength: 12
example: '8042221111'
BusinessURL:
type: string
description: A URL for the business website.
minLength: 0
maxLength: 2000
example: 'https://www.finicity.com/'
BusinessTaxId:
type: string
description: Provide details of the tax id for the business
maxLength: 15
minLength: 9
example: 'A1234561Z'
BusinessType:
type: string
description:
The business type eg LLC, Corp, S Corp, C Corp, B Corp, Sole
Propriertorship, Nonprofit, etc.
maxLength: 150
minLength: 0
example: 'Nonprofit'
BusinessPersonallyLiable:
type: boolean
description:
Indicates whether a business owner is personally liable for a loan.
example: false
BusinessDetailsRequest:
required:
- name
- address
- personallyLiable
- phoneNumber
properties:
name:
$ref: '#/components/schemas/BusinessName'
personallyLiable:
$ref: '#/components/schemas/BusinessPersonallyLiable'
phoneNumber:
$ref: '#/components/schemas/PhoneNumberWithCountryCode'
address:
type: object
description: >-
Business address where business is registered/located.
required:
- addressLine1
- city
- state
- country
- postalCode
properties:
addressLine1:
$ref: '#/components/schemas/BusinessAddressLine1'
addressLine2:
$ref: '#/components/schemas/BusinessAddressLine2'
city:
$ref: '#/components/schemas/City'
state:
$ref: '#/components/schemas/State'
country:
$ref: '#/components/schemas/Country'
postalCode:
$ref: '#/components/schemas/ZipCode'
LocationId:
type: string
description: The unique identifier for the merchant location.
format: uuid
example: 'a1b2c3d4-0000-1234-abcd-000000000001'
MetricType:
type: string
description: >-
The metric family or report type. Possible values are
retail_sales_analytics, retail_sales_benchmarks
example: retail_sales_analytics
MetricFrequency:
type: string
description: >-
Frequency of the metric aggregation/reporting. Possible values are
Monthly, Weekly.
example: 'Weekly'
HasConsent:
type: boolean
description: Indicates that the merchant has provided explicit consent.
SBCAParams:
type: object
description:
Parameters for small business credit analytics metrics retrieval.
required:
- hasConsent
- metricFrequency
- locationId
- metricType
properties:
hasConsent:
$ref: '#/components/schemas/HasConsent'
metricFrequency:
$ref: '#/components/schemas/MetricFrequency'
metricType:
$ref: '#/components/schemas/MetricType'
locationId:
$ref: '#/components/schemas/LocationId'
SBCAMetricsReportConstraints:
type: object
description: >-
Request constraints required to create Small Business Credit Analytics
report.
required:
- analyticsReportData
properties:
analyticsReportData:
$ref: '#/components/schemas/SBCAanalyticsReportData'
SBCAanalyticsReportData:
type: object
description: >-
Analytics reports data required to create business analytics.
required:
- sbcaParams
- businessDetails
properties:
sbcaParams:
$ref: '#/components/schemas/SBCAParams'
businessDetails:
$ref: '#/components/schemas/BusinessDetailsRequest'
SBCAAnalyticsReport:
description: >-
A generated report for Small Business Credit Analytics. The report
is enriched with retail sales analytics metrics.
type: object
required:
- id
- customerType
- customerId
- createdDate
- requestId
- requesterName
- partnerName
- type
- title
- status
- constraints
- retailSalesAnalyticsMetrics
properties:
id:
$ref: '#/components/schemas/ReportId'
customerType:
$ref: '#/components/schemas/CustomerType'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
createdDate:
$ref: '#/components/schemas/UnixDate'
requestId:
$ref: '#/components/schemas/ReportRequestId'
requesterName:
$ref: '#/components/schemas/PartnerName'
partnerName:
$ref: '#/components/schemas/PartnerName'
type:
$ref: '#/components/schemas/SBCAReportType'
title:
$ref: '#/components/schemas/ReportTitle'
status:
type: string
description: |-
A report generation status. Possible values:
* `success`
* `failure`
example: success
constraints:
$ref: '#/components/schemas/SBCAMetricsReportConstraints'
retailSalesAnalyticsMetrics:
$ref: '#/components/schemas/SBCAAnalyticsResponseData'
SBCABenchmarkReport:
description: >-
A generated report for Small Business Credit Analytics. The report
is enriched with retail sales benchmark metrics.
type: object
required:
- id
- customerType
- customerId
- createdDate
- requestId
- requesterName
- partnerName
- type
- title
- status
- constraints
- retailSalesBenchmarksMetrics
properties:
id:
$ref: '#/components/schemas/ReportId'
customerType:
$ref: '#/components/schemas/CustomerType'
customerId:
$ref: '#/components/schemas/NumericCustomerId'
createdDate:
$ref: '#/components/schemas/UnixDate'
requestId:
$ref: '#/components/schemas/ReportRequestId'
requesterName:
$ref: '#/components/schemas/PartnerName'
partnerName:
$ref: '#/components/schemas/PartnerName'
type:
$ref: '#/components/schemas/SBCAReportType'
title:
$ref: '#/components/schemas/ReportTitle'
status:
type: string
description: |-
A report generation status. Possible values:
* `success`
* `failure`
example: success
constraints:
$ref: '#/components/schemas/SBCAMetricsReportConstraints'
retailSalesBenchmarksMetrics:
$ref: '#/components/schemas/SBCABenchmarkResponseData'
SBCAAnalyticsResponseData:
type: array
description: >-
Analytics response data for SBCA report. This will be present in the
report for the report `retail_sales_analytics`.
minItems: 0
maxItems: 10
items:
type: object
properties:
locationId:
$ref: '#/components/schemas/LocationId'
merchantCategoryCode:
type: number
description: The merchant category code (MCC) for the business.
example: 5812
naicsCode:
type: number
description:
The North American Industry Classification System (NAICS) code for
the business.
example: 445110
industryName:
type: string
description: The industry name associated with the NAICS code.
example:
'Supermarkets and Other Grocery (except Convenience) Stores'
firstSeenTxnDate:
type: string
description: The date of the first seen transaction.
format: date
example: '2023-01-01'
lastSeenTxnDate:
type: string
description: The date of the last seen transaction.
format: date
example: '2023-12-31'
metricsFrequency:
$ref: '#/components/schemas/MetricFrequency'
metricsLists:
type: array
description: List of metrics data.
items:
type: object
properties:
periodStartDate:
type: string
description: The start date for the metric data.
format: date
example: '2023-06-30'
periodEndDate:
type: string
description: The end date for the metric data.
format: date
example: '2023-07-30'
year:
type: number
description: The year for the metric data.
example: 2023
metrics:
type: array
description: List of individual metrics.
items:
type: object
properties:
name:
type: string
description: The name of the metric.
example: txn_amt
value:
type: number
description: The value of the metric.
example: 150000.75
SBCABenchmarkResponseData:
type: array
description: >-
Benchmark response data for SBCA report. This will be present in the
report for the report `retail_sales_benchmarks`.
minItems: 0
maxItems: 10
items:
type: object
properties:
locationId:
$ref: '#/components/schemas/LocationId'
merchantCategoryCode:
type: number
description: The merchant category code (MCC) for the business.
example: 5812
naicsCode:
type: number
description:
The North American Industry Classification System (NAICS) code for
the business.
example: 445110
industryName:
type: string
description: The industry name associated with the NAICS code.
example:
'Supermarkets and Other Grocery (except Convenience) Stores'
firstSeenTxnDate:
type: string
description: The date of the first seen transaction.
format: date
example: '2023-01-01'
lastSeenTxnDate:
type: string
description: The date of the last seen transaction.
format: date
example: '2023-12-31'
metricsFrequency:
$ref: '#/components/schemas/MetricFrequency'
metricsLists:
type: array
description: List of metrics data.
items:
type: object
properties:
periodStartDate:
type: string
description: The start date for the metric data.
format: date
example: '2023-06-30'
periodEndDate:
type: string
description: The end date for the metric data.
format: date
example: '2023-07-30'
year:
type: number
description: The year for the metric data.
example: 2023
metrics:
type: array
description: List of individual metrics.
items:
type: object
properties:
name:
type: string
description: The name of the metric.
example: txn_amt
value:
type: number
description: The value of the metric.
example: 150000.75
BusinessAddressLine1:
type: string
minLength: 0
maxLength: 50
description: A street address
example: 434 W Ascension Way
BusinessAddressLine2:
type: string
minLength: 0
maxLength: 50
description: Address Line2, Apt/Unit Details
example: Apt E226