-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67f2cd1
commit 4b6f198
Showing
1 changed file
with
42 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ info: | |
| name: API Support | ||
| email: [email protected] | ||
| url: 'https://developer.mastercard.com/open-banking-us/documentation/support/' | ||
| version: 1.13.10 | ||
| version: 1.13.11 | ||
| servers: | ||
| - url: 'https://api.finicity.com' | ||
| description: Production | ||
|
|
@@ -3053,7 +3053,7 @@ paths: | |
|
|
||
|
|
||
| This version of the API is intended for production use. It maintains and | ||
| enforces all compliance iwth FCRA rules and requirements. | ||
| enforces all compliance with FCRA rules and requirements. | ||
|
|
||
|
|
||
| *Note:* this is a premium service, billable per every successful API | ||
|
|
@@ -7000,7 +7000,7 @@ components: | |
| reportDate: '2022-03-16T21:28:38-07:00' | ||
| reportId: 8ff8b4b2-706f-45c3-8d66-857bdb516214 | ||
| requesterName: 'Mortgage ABC LLC' | ||
| title: 'Fincity Balance Analytics' | ||
| title: 'Finicity Balance Analytics' | ||
| CashFlowAnalyticsReportExample: | ||
| value: | ||
| accountResults: | ||
|
|
@@ -7516,7 +7516,7 @@ components: | |
| Queries](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)). | ||
| schema: | ||
| type: string | ||
| example: searchvalue | ||
| example: 'Search Value' | ||
| CustomerUsernameParameter: | ||
| name: username | ||
| in: query | ||
|
|
@@ -8295,10 +8295,10 @@ components: | |
| 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. | ||
| 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, | ||
|
|
@@ -8900,10 +8900,10 @@ components: | |
| description: Top-level summary of transactions | ||
| properties: | ||
| totalNonSufficientFunds: | ||
| description: Total of nsf transactions | ||
| description: Total of NSF transactions | ||
| type: number | ||
| averageMonthlyNonSufficientFunds: | ||
| description: Monthly average of nsf transactions | ||
| description: Monthly average of NSF transactions | ||
| type: number | ||
| totalDeposits: | ||
| description: Total of deposit transactions | ||
|
|
@@ -8996,11 +8996,11 @@ components: | |
| type: string | ||
| example: '2023-06-01' | ||
| totalNonsufficientFunds: | ||
| description: Total of nsf transactions in this account | ||
| description: Total of NSF transactions in this account | ||
| type: number | ||
| example: 123.45 | ||
| daysSinceNonsufficientFunds: | ||
| description: Days since the latest nsf transaction for this account | ||
| description: Days since the latest NSF transaction for this account | ||
| type: integer | ||
| example: 3 | ||
| required: | ||
|
|
@@ -9048,7 +9048,7 @@ components: | |
| type: number | ||
| example: 123.45 | ||
| nonSufficientFunds: | ||
| description: Total of nsf transactions for the month | ||
| description: Total of NSF transactions for the month | ||
| type: number | ||
| example: 3 | ||
| insurancePayments: | ||
|
|
@@ -9844,7 +9844,7 @@ components: | |
| - historicCountOfDepositTransactions | ||
| type: object | ||
| CashFlowInsufficientFundsFees: | ||
| description: Non Sufficient Fund Fees | ||
| description: Non-Sufficient Fund Fees | ||
| properties: | ||
| countOfTransactionsForTheReportTimePeriod: | ||
| description: Count of all NSF transactions during the report | ||
|
|
@@ -10620,7 +10620,7 @@ components: | |
|
|
||
| * "Baby Supplies" | ||
|
|
||
| * "Babysitter & Daycare" | ||
| * "Babysitter & Day Care" | ||
|
|
||
| * "Bank Fee" | ||
|
|
||
|
|
@@ -10664,7 +10664,7 @@ components: | |
|
|
||
| * "Entertainment" | ||
|
|
||
| * "Eyecare" | ||
| * "Eye Care" | ||
|
|
||
| * "Fast Food" | ||
|
|
||
|
|
@@ -11182,7 +11182,7 @@ components: | |
| description: >- | ||
| Third party access key receipt ID. Generated by generate third party | ||
| access key API. | ||
| example: cr_dcfvygbhunjimk | ||
| example: 'cr_4pfI3r1X8aOHrDDwrwC01NHFxOXlT1' | ||
| Consumer: | ||
| description: A finicity consumer record | ||
| required: | ||
|
|
@@ -11754,7 +11754,7 @@ components: | |
| originalSchool: | ||
| type: string | ||
| description: (Mortgage/Loan) Original school | ||
| example: brigham young university | ||
| example: Brigham young university | ||
| recurringPaymentAmount: | ||
| type: number | ||
| description: (Mortgage/Loan) Recurring payment amount | ||
|
|
@@ -11852,11 +11852,11 @@ components: | |
| example: 2000 | ||
| preTaxAmount: | ||
| type: number | ||
| description: (Investment) Pre tax amount of total balance | ||
| description: (Investment) Pre-tax amount of total balance | ||
| example: 78564.99 | ||
| afterTaxAmount: | ||
| type: number | ||
| description: (Investment) Post tax amount of total balance | ||
| description: (Investment) After-tax amount of total balance | ||
| example: 68564.99 | ||
| matchAmount: | ||
| type: number | ||
|
|
@@ -12596,7 +12596,7 @@ components: | |
| type: string | ||
| description: | ||
| The institution address to appear in the footer of the email | ||
| example: '222 Winipeg Drive SLC UT, 84109' | ||
| example: '222 Winnipeg Drive SLC UT, 84109' | ||
| signature: | ||
| type: array | ||
| items: | ||
|
|
@@ -13209,7 +13209,7 @@ components: | |
| * "sold" | ||
|
|
||
|
|
||
| * "dividendreInvest" | ||
| * "dividendReinvest" | ||
|
|
||
|
|
||
| * "tax" | ||
|
|
@@ -14043,7 +14043,7 @@ components: | |
| type: integer | ||
| requestedReportBeginDate: | ||
| description: >- | ||
| Date the report would have began on if enough data was available for | ||
| Date the report would have begun on if enough data was available for | ||
| which the partner requested | ||
| example: '2022-01-01' | ||
| type: string | ||
|
|
@@ -14394,7 +14394,7 @@ components: | |
| PayFrequency: | ||
| type: string | ||
| description: | | ||
| The current pay frequency or or how often a regular pay check is: | ||
| The current pay frequency or how often a regular pay check is: | ||
|
|
||
| * `Daily` | ||
|
|
||
|
|
@@ -14832,7 +14832,7 @@ components: | |
| type: string | ||
| description: >- | ||
| The length of time an employee has been employed with that employer | ||
| in ISO 8601 format (eg P1Y6M0D) | ||
| in ISO 8601 format (e.g. P1Y6M0D) | ||
| example: P1Y6M0D | ||
| employerAddress: | ||
| type: array | ||
|
|
@@ -15891,7 +15891,7 @@ components: | |
|
|
||
| * `purchaseToClose` | ||
|
|
||
| * `purchasetoCover` | ||
| * `purchaseToCover` | ||
|
|
||
| * `contribution` | ||
|
|
||
|
|
@@ -15917,7 +15917,7 @@ components: | |
|
|
||
| * `sold` | ||
|
|
||
| * `dividendreInvest` | ||
| * `dividendReinvest` | ||
|
|
||
| * `dividend` | ||
|
|
||
|
|
@@ -16280,9 +16280,9 @@ components: | |
| An object representing the third party access key receipt | ||
|
|
||
| * `customerId`: This is recipient's customerId represented as a | ||
| pseudoidentifier. | ||
| pseudo identifier. | ||
| * `accountId`: This is the value provided to recipient | ||
| represented as a pseudoidentifier for the accountId. | ||
| represented as a pseudo identifier for the accountId. | ||
| type: object | ||
| properties: | ||
| data: | ||
|
|
@@ -16333,7 +16333,7 @@ components: | |
| maxCalls: | ||
| type: integer | ||
| description: | ||
| Max number of calls to the consented product (consented api) | ||
| Max number of calls to the consented product (consented API) | ||
| example: 200 | ||
| accountId: | ||
| $ref: '#/components/schemas/AccountId' | ||
|
|
@@ -16416,7 +16416,7 @@ components: | |
| customerId: | ||
| type: string | ||
| description: | ||
| This is recipient's customerId represented as a pseudoidentifier | ||
| This is recipient's customerId represented as a pseudo identifier | ||
| example: '3465230025077724000' | ||
| partnerId: | ||
| $ref: '#/components/schemas/PartnerId' | ||
|
|
@@ -18233,8 +18233,17 @@ components: | |
| Warnings: | ||
| type: string | ||
| description: >- | ||
| Array of warnings. [Generalsyntaxerror,Invalidusernamesyntax,Missing | ||
| country_code,Input postal code was corrected] | ||
| 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 | ||
| Webhook: | ||
| type: string | ||
|
|
||