From 5e1156cb42d885eff66802968265f6fe79ff5a4f Mon Sep 17 00:00:00 2001 From: Padma Jadav <147383171+Jadavpadma@users.noreply.github.com> Date: Mon, 12 Feb 2024 12:35:23 +0530 Subject: [PATCH] Update openbanking-us.yaml --- openbanking-us.yaml | 5281 +++---------------------------------------- 1 file changed, 320 insertions(+), 4961 deletions(-) diff --git a/openbanking-us.yaml b/openbanking-us.yaml index e9520f4..01f95f5 100644 --- a/openbanking-us.yaml +++ b/openbanking-us.yaml @@ -10,7 +10,7 @@ info: name: API Support email: apisupport@mastercard.com url: 'https://developer.mastercard.com/open-banking-us/documentation/support/' - version: 1.15.0 + version: 1.14.1 servers: - url: 'https://api.finicity.com' description: Production @@ -35,7 +35,7 @@ tags: description: Generate cash flow reports asynchronously - name: Cash Flow Analytics description: Cash Flow Analytics for business - - name: Connect 🔗 + - name: Connect 🔗 description: Allow customers to log into their financial institutions and grant Finicity authorization @@ -94,12 +94,12 @@ paths: 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 + * ⚠️ After five failed attempts to authenticate, your account will be locked. Contact [support@finicity.com](mailto:support@finicity.com) to get help resetting your account. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: CreateToken requestBody: $ref: '#/components/requestBodies/CreateTokenRequest' @@ -127,7 +127,7 @@ paths: should be between 12 and 255 characters. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: ModifyPartnerSecret requestBody: $ref: '#/components/requestBodies/ModifyPartnerSecretRequest' @@ -143,7 +143,7 @@ paths: /connect/v2/generate: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Generate Connect URL description: >- Generate a Connect 2.0 URL link to add within your own applications. @@ -168,7 +168,7 @@ paths: the SSN value for the consumer in the body of the request call. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateConnectUrl requestBody: $ref: '#/components/requestBodies/GenerateConnectUrlRequest' @@ -182,7 +182,7 @@ paths: /connect/v2/generate/lite: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Generate Lite Connect URL description: >- Connect Lite is a variation of Connect Full (`POST @@ -198,7 +198,7 @@ paths: then you must integrate with the Connect Web SDK. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateLiteConnectUrl requestBody: $ref: '#/components/requestBodies/GenerateLiteConnectUrlRequest' @@ -212,7 +212,7 @@ paths: /connect/v2/generate/fix: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Generate Fix Connect URL description: >- Use the Connect Fix API when the following conditions occur: @@ -224,7 +224,7 @@ paths: * The user's MFA challenge has expired - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateFixConnectUrl requestBody: $ref: '#/components/requestBodies/GenerateFixConnectUrlRequest' @@ -240,14 +240,14 @@ paths: /connect/v2/send/email: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Send Connect Email description: >- Same as Connect Full (`POST /connect/v2/generate`) but send a Connect email to a consumer. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: SendConnectEmail requestBody: $ref: '#/components/requestBodies/SendConnectEmailRequest' @@ -261,7 +261,7 @@ paths: /connect/v2/generate/jointBorrower: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Generate Connect URL - Joint Borrower description: >- Same as Connect Full (`POST /connect/v2/generate`) but for joint @@ -272,7 +272,7 @@ paths: financial, payroll, and paystub information in the same Connect session. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateJointBorrowerConnectUrl requestBody: $ref: '#/components/requestBodies/GenerateJointBorrowerConnectUrlRequest' @@ -286,14 +286,14 @@ paths: /connect/v2/generate/microentry/verify: post: tags: - - Connect 🔗 + - 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_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: VerifyMicroEntryMicrodeposit requestBody: $ref: '#/components/requestBodies/MicroEntryVerifyRequest' @@ -308,12 +308,12 @@ paths: /connect/v2/send/email/jointBorrower: post: tags: - - Connect 🔗 + - Connect 🔗 summary: Send Connect Email - Joint Borrower description: >- Same as Connect Joint Borrower (`POST /connect/v2/generate/jointBorrower`) but send a Connect email to at - least one of the joint borrower's email addresses. + least one of the joint borrower's email addresses. When the consumer opens the email, MVS prompts both the primary and @@ -321,7 +321,7 @@ paths: information in the same Connect session. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: SendJointBorrowerConnectEmail requestBody: $ref: '#/components/requestBodies/SendJointBorrowerConnectEmailRequest' @@ -350,7 +350,7 @@ paths: profiles), and cannot access live financial institutions. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: AddTestingCustomer requestBody: $ref: '#/components/requestBodies/AddCustomerRequest' @@ -372,10 +372,10 @@ paths: Active customers must use the "FinBank Billable" profiles for testing - purposes. + purposes. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: AddCustomer requestBody: $ref: '#/components/requestBodies/AddCustomerRequest' @@ -400,7 +400,7 @@ paths: customers will be returned. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomers parameters: - $ref: '#/components/parameters/CustomerUsernameParameter' @@ -425,7 +425,7 @@ paths: application. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerWithAppData parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -447,7 +447,7 @@ paths: Retrieve a customer by ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -471,7 +471,7 @@ paths: You must specify either `firstName`, `lastName`, or both in the request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: ModifyCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -495,11 +495,11 @@ paths: customer and all associated accounts and transactions. - ⚠️ Use this service carefully! It will not pause for confirmation before + ⚠️ Use this service carefully! It will not pause for confirmation before performing the operation! - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: DeleteCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -525,7 +525,7 @@ paths: the Generate Report services. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: CreateConsumer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -550,7 +550,7 @@ paths: Get the details of a consumer record by customer ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetConsumerForCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -572,7 +572,7 @@ paths: Get the details of a consumer record by consumer ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetConsumer parameters: - $ref: '#/components/parameters/ConsumerIdParameter' @@ -595,7 +595,7 @@ paths: that are not specified will be left unchanged. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: ModifyConsumer parameters: - $ref: '#/components/parameters/ConsumerIdParameter' @@ -621,7 +621,7 @@ paths: single institution. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountsByInstitutionLogin parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -667,7 +667,7 @@ paths: Note: This service is not available for all tiers of dynamic billing. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RefreshCustomerAccountsByInstitutionLogin parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -704,7 +704,7 @@ paths: ATD. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RefreshCustomerAccountsByInstitutionLoginV2 parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -729,7 +729,7 @@ paths: institution login ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: DeleteCustomerAccountsByInstitutionLogin parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -752,7 +752,7 @@ paths: Get a customer account by ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccount parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -775,7 +775,7 @@ paths: Remove the given account from Finicity aggregation. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: DeleteCustomerAccount parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -798,7 +798,7 @@ paths: Get all accounts owned by the given customer. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccounts parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -845,7 +845,7 @@ paths: Note: This service is not available for all tiers of dynamic billing. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RefreshCustomerAccounts parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -881,7 +881,7 @@ paths: ATD. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RefreshCustomerAccountsV2 parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -904,7 +904,7 @@ paths: institution. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountsByInstitution parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -929,7 +929,7 @@ paths: given customer at the given institution. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountsByInstitutionSimple parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -954,7 +954,7 @@ paths: by the given customer at the given institution login ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountsByInstitutionLoginSimple parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -978,7 +978,7 @@ paths: only basic information of a customer account. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountSimple parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1002,7 +1002,7 @@ paths: basic information of all active customer accounts. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountsSimple parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1066,7 +1066,7 @@ paths: in the request body to force the second connection. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: LoadHistoricTransactionsForCustomerAccount parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1100,7 +1100,7 @@ paths: complete. In the event of a timeout condition, retry the call. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAccountOwner parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1150,7 +1150,7 @@ paths: billable per each successful API call. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAccountOwnerDetails parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1173,7 +1173,7 @@ paths: connections. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RegisterApp requestBody: $ref: '#/components/requestBodies/RegisterAppRequest' @@ -1193,7 +1193,7 @@ paths: Update a registered application. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: ModifyAppRegistration parameters: - $ref: '#/components/parameters/PreAppIdPathParameter' @@ -1217,7 +1217,7 @@ paths: Get the status of your application registration(s). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAppRegistrationStatus parameters: - $ref: '#/components/parameters/PreAppIdQueryParameter' @@ -1249,7 +1249,7 @@ paths: customer. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: SetCustomerAppID parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1277,7 +1277,7 @@ paths: This API returns a list of accounts for the given institution login ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: MigrateInstitutionLoginAccounts parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1300,7 +1300,7 @@ paths: Search for certified financial institutions w/RSSD. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCertifiedInstitutionsWithRSSD parameters: - $ref: '#/components/parameters/InstitutionSearchParameter' @@ -1324,7 +1324,7 @@ paths: Search for financial institutions. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetInstitutions parameters: - $ref: '#/components/parameters/InstitutionSearchParameter' @@ -1348,7 +1348,7 @@ paths: Search for financial institutions by certified product. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCertifiedInstitutions parameters: - $ref: '#/components/parameters/InstitutionSearchParameter' @@ -1372,7 +1372,7 @@ paths: Get financial institution details by ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetInstitution parameters: - $ref: '#/components/parameters/InstitutionIdParameter' @@ -1394,7 +1394,7 @@ paths: Return the branding information for a financial institution. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetInstitutionBranding parameters: - $ref: '#/components/parameters/InstitutionIdParameter' @@ -1432,7 +1432,7 @@ paths: found, the service will return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOAReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1478,7 +1478,7 @@ paths: found, the service will return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOAWithIncomeReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1509,7 +1509,7 @@ paths: found, the service will return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GeneratePrequalificationCRAReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1540,7 +1540,7 @@ paths: found, the service will return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GeneratePrequalificationNonCRAReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1577,7 +1577,7 @@ paths: service will return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOIReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1610,7 +1610,7 @@ paths: generation of a VOE - Payroll report. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOEPayrollReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1640,7 +1640,7 @@ paths: 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. + requirements. Retrieve the latest credit transaction information from the borrower's @@ -1651,7 +1651,7 @@ paths: necessary. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOETransactionsReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1675,7 +1675,7 @@ paths: 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. + Statement Extraction Report. This is a premium service. The billing rate is the variable rate for Pay @@ -1684,7 +1684,7 @@ paths: Extraction Report. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GeneratePayStatementReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1727,7 +1727,7 @@ paths: the successful generation of a VOIE TXVerify Report. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOIEPaystubWithTXVerifyReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1760,7 +1760,7 @@ paths: is the successful generation of a VOIE - Paystub Report. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateVOIEPaystubReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1793,7 +1793,7 @@ paths: generation of a VOIE - Payroll report. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: RefreshVOIEPayrollReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1849,7 +1849,7 @@ paths: time for a response. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountStatement parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1885,7 +1885,7 @@ paths: customer ID (see Consumers APIs). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateStatementReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1924,7 +1924,7 @@ paths: page is 1000. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAllCustomerTransactions parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1952,7 +1952,7 @@ paths: Get details for the given transaction. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerTransaction parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -1989,7 +1989,7 @@ paths: page is 1000. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetCustomerAccountTransactions parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2022,7 +2022,7 @@ paths: This is a premium service. A billable event will be created upon the - successful generation of the Transactions Report. + successful generation of the Transactions Report. Before calling this API, a consumer must be created for the given @@ -2032,7 +2032,7 @@ paths: There cannot be more than 24 months between `fromDate` and `toDate`. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateTransactionsReport parameters: - $ref: '#/components/parameters/ReportCallbackUrlParameter' @@ -2050,100 +2050,6 @@ paths: $ref: '#/components/responses/UnauthorizedErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' - '/decisioning/v2/customers/{customerId}/reports/balance-analytics/userTypes/{userType}': - post: - tags: - - Balance Analytics - summary: Generate Balance Analytics Report - 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 - analytics report which can be retrieved via Get Report by Customer or - Get Report by Consumer. - - - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) - 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' - '404': - $ref: '#/components/responses/ResourceNotFoundErrorResponse' - '/decisioning/v2/customers/{customerId}/reports/cashflow-analytics/userTypes/{userType}': - post: - tags: - - Cash Flow Analytics - summary: Generate Cashflow Analytics Report - 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 - analytics report which can be retrieved via Get Report by Customer or - Get Report by Consumer. - - - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) - 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' - '404': - $ref: '#/components/responses/ResourceNotFoundErrorResponse' '/aggregation/v1/customers/{customerId}/payStatements': post: tags: @@ -2153,7 +2059,7 @@ paths: Upload pay statements for a customer. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: StoreCustomerPayStatement parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2180,7 +2086,7 @@ paths: Note: this is a premium service, billable per every successful API call. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetLoanPaymentDetails parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2206,7 +2112,7 @@ paths: generated report for the type will be returned. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetPortfolioByCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2250,7 +2156,7 @@ paths: Service](https://developer.mastercard.com/open-banking-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: SubscribeToTxPushNotifications parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2281,7 +2187,7 @@ paths: Service](https://developer.mastercard.com/open-banking-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: DisableTxPushNotifications parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2314,7 +2220,7 @@ paths: Service](https://developer.mastercard.com/open-banking-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: CreateTxPushTestTransaction parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2346,7 +2252,7 @@ paths: Service](https://developer.mastercard.com/open-banking-us/documentation/products/manage/tx-push/#setting-up-the-txpush-listener-service). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: DeleteTxPushSubscription parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2372,7 +2278,7 @@ paths: generated report for the type will be returned. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetPortfolioByConsumer parameters: - $ref: '#/components/parameters/ConsumerIdParameter' @@ -2402,7 +2308,7 @@ paths: _Supported account types_: "checking", "savings", "moneyMarket", "cd" - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAccountACHDetails parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2437,7 +2343,7 @@ paths: set, the report format will be returned as a JSON document. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetReportByCustomer parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2474,7 +2380,7 @@ paths: set, the report format will be returned as a JSON document. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetReportByConsumer parameters: - $ref: '#/components/parameters/PurposeParameter' @@ -2505,7 +2411,7 @@ paths: app should wait 20 seconds and then call this API again. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetReportsByCustomerId parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2536,7 +2442,7 @@ paths: app should wait 20 seconds and then call this API again. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetReportsByConsumerId parameters: - $ref: '#/components/parameters/PurposeParameter' @@ -2561,7 +2467,7 @@ paths: Retrieve a binary file for the given asset ID. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAssetByCustomerID parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2591,7 +2497,7 @@ paths: _Supported account types_: "checking", "savings", "moneyMarket", "cd" - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAvailableBalanceLive parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2626,7 +2532,7 @@ paths: _Supported account types_: "checking", "savings", "moneyMarket", "cd" - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetAvailableBalance parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2661,7 +2567,7 @@ paths: return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateCashFlowBusinessReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2708,7 +2614,7 @@ paths: return HTTP 400 Bad Request. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GenerateCashFlowPersonalReport parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2736,7 +2642,7 @@ paths: Two random micro amounts less than a dollar each will be deposited to provided customer's account. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: InitiateMicroAmountDeposits parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2767,7 +2673,7 @@ paths: account. `customerId` and `accountId` are the identifiers of the customer and account receiving the micro entries. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: VerifyMicroAmountDeposits parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2794,7 +2700,7 @@ paths: `customerId` and `accountId` are the identifiers of the customer and account receiving the micro entries. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetMicroDepositsDetails parameters: - $ref: '#/components/parameters/CustomerIdParameter' @@ -2848,7 +2754,7 @@ paths: Report_ (operation: _GetObbAnalyticsReport_). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -2908,7 +2814,7 @@ paths: Report - FCRA_ (operation: _GetObbAnalyticsReportFCRA_). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -2970,7 +2876,7 @@ paths: Analytics Report_ (operation: _GetCashFlowAnalyticsReport_). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -3033,7 +2939,7 @@ paths: Analytics Report - FCRA_ (operation: _GetCashFlowAnalyticsReportFCRA_). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -3109,7 +3015,7 @@ paths: call for non-testing customers. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -3175,7 +3081,7 @@ paths: Report - FCRA_ (operation: _GetObbAnalyticsReportFcra_). - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/CustomerIdParameter' - $ref: '#/components/parameters/ReferenceNumberParameter' @@ -3209,7 +3115,7 @@ paths: Report data can either be retrieved as a JSON document or PDF file. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/ObbReportIdParameter' responses: @@ -3242,7 +3148,7 @@ paths: call for non-testing customers. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) parameters: - $ref: '#/components/parameters/ObbReportIdParameter' - $ref: '#/components/parameters/RequiredPurposeParameter' @@ -3318,8 +3224,6 @@ paths: '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' '/business-services/customers/{customer_id}/businesses': - parameters: - - $ref: '#/components/parameters/CustomerIdPathParameter' post: tags: - Businesses API @@ -3330,8 +3234,10 @@ paths: A customer can have one business record associated. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: AddBusinessDetails + parameters: + - $ref: '#/components/parameters/CustomerIdPathParameter' requestBody: $ref: '#/components/requestBodies/BusinessDetailRequest' responses: @@ -3351,7 +3257,7 @@ paths: business can be accessed. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: GetBusinessByCustomer parameters: - $ref: '#/components/parameters/CustomerIdPathParameter' @@ -3361,8 +3267,6 @@ paths: '404': $ref: '#/components/responses/CustomerNotFoundErrorResponse' '/business-services/businesses/{business_id}': - parameters: - - $ref: '#/components/parameters/BusinessIdParameter' put: tags: - Businesses API @@ -3373,8 +3277,10 @@ paths: request, modifications can be made to the business's profile. - _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) + _Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png) operationId: UpdateBusiness + parameters: + - $ref: '#/components/parameters/BusinessIdParameter' requestBody: $ref: '#/components/requestBodies/BusinessDetailRequest' responses: @@ -3393,6 +3299,8 @@ paths: _Supported regions_: ![\U0001F1FA\U0001F1F8](https://flagcdn.com/20x15/us.png) operationId: GetBusinessById + parameters: + - $ref: '#/components/parameters/BusinessIdParameter' responses: '200': $ref: '#/components/responses/BusinessFoundResponse' @@ -3623,40 +3531,6 @@ components: 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' CreateTxPushTestTransactionRequest: required: true content: @@ -4067,70 +3941,6 @@ components: 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' GetReportResponse: description: The report was successfully retrieved content: @@ -4138,26 +3948,6 @@ components: schema: $ref: '#/components/schemas/Report' examples: - 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' - CashflowusinessNonCraAnalyticsReportResponseExample: - $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: @@ -5148,38 +4938,45 @@ components: value: PSC Finance shown: false fromDate: 1580558400 - GenerateBalanceBusinessCraAnalyticsReportRequestExample: + GenerateTransactionsReportResponseExample: 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: + id: dnuru2ua2trs-transactions + portfolioId: hupvwpdzr9dq-16-port + customerType: testing + customerId: 1000018865 + requestID: ky2nhsufhv + requesterName: Decisioning API Tests + createdDate: 1594678007 + title: Finicity Transactions Report + consumerId: a925b07c9e028c680ad9c1d18d2e7199 + consumerSsn: '6789' + 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 + type: transactions + status: inProgress + GenerateVOAReportRequestExample: value: - analyticsReportData: - forCraPurpose: false - timeIntervalTypes: - - MONTHLY_CALENDAR - accountIds: '1000535275 1000535276' + accountIds: '1000535275' reportCustomFields: - label: loanID value: '12345' @@ -5196,39 +4993,48 @@ components: - label: vendorName value: PSC Finance shown: false + showNsf: false fromDate: 1580558400 - GenerateBalanceBusinessFtcAnalyticsReportRequestExample: + GenerateVOAReportResponseExample: 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: + id: u4hstnnak45g + portfolioId: dyr6qvqd2yhb-1-port + customerType: active + customerId: 1000006677 + requestId: sfb7xp439w + requesterName: Decisioning API + createdDate: 1588350269 + title: Finicity Verification of Assets + consumerId: ac39e237c7619a4ecf014b8d399c0696 + consumerSsn: '6789' + 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: - analyticsReportData: - forCraPurpose: true - timeIntervalTypes: - - MONTHLY_CALENDAR - accountIds: '1000535275 1000535276' + accountIds: '1000535275' + fromDate: 1580558400 reportCustomFields: - label: loanID value: '12345' @@ -5245,14 +5051,48 @@ components: - label: vendorName value: PSC Finance shown: false - fromDate: 1580558400 - GenerateBalancePersonalNonCraAnalyticsReportRequestExample: + showNsf: false + incomeStreamConfidenceMinimum: 50 + GenerateVOAWithIncomeReportResponseExample: + value: + id: u4hstnyak45g + portfolioId: dyr6weqd2yhb-1-port + customerType: active + customerId: 1000006677 + requestId: sfb7x1we9w + requesterName: Decisioning API + createdDate: 1588350269 + title: Verification of Asset and Income - Transactions + consumerId: ac39e237c7619a4ecf014b8d399c0696 + consumerSsn: '6789' + constraints: + 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 + incomeStreamConfidenceMinimum: 50 + type: voaHistory + status: inProgress + GeneratePrequalificationReportRequestExample: value: - analyticsReportData: - forCraPurpose: false - timeIntervalTypes: - - MONTHLY_CALENDAR - accountIds: '1000535275 1000535276' + accountIds: '1000535275' + fromDate: 1580558400 reportCustomFields: - label: loanID value: '12345' @@ -5269,302 +5109,8 @@ components: - 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 - GenerateTransactionsReportResponseExample: - value: - id: dnuru2ua2trs-transactions - portfolioId: hupvwpdzr9dq-16-port - customerType: testing - customerId: 1000018865 - requestID: ky2nhsufhv - requesterName: Decisioning API Tests - createdDate: 1594678007 - title: Finicity Transactions Report - consumerId: a925b07c9e028c680ad9c1d18d2e7199 - consumerSsn: '6789' - 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 - 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 - createdDate: 1588350269 - title: Finicity Verification of Assets - consumerId: ac39e237c7619a4ecf014b8d399c0696 - consumerSsn: '6789' - 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 - 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 - createdDate: 1588350269 - title: Verification of Asset and Income - Transactions - consumerId: ac39e237c7619a4ecf014b8d399c0696 - consumerSsn: '6789' - constraints: - 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 - 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: + showNsf: false + GeneratePrequalificationCRAReportResponseExample: value: id: 88w4fbssrbja-prequalvoa portfolioId: 0whcism47a34-5-port @@ -7338,3628 +6884,6 @@ components: currentPrice: 280.71 securityType: Stock availableBalance: 123.45 - GenerateBalanceBusinessCraAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-barbcra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - createdDate: 1579819592 - title: Mastercard Open Banking Balance Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - createdDate: 1579819592 - title: Mastercard Open Banking Balance Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - 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 - createdDate: 1579819592 - title: Mastercard Open Banking Cash Flow Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - createdDate: 1579819592 - title: Mastercard Open Banking Cash Flow Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - 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 - BalanceBusinessCraAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-barbcra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Balance Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - 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 - 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 - 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 - 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 - 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 - 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 - title: Mastercard Open Banking Balance Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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 - 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 - 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 - 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 - 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 - 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: sd1j45yn37wr-cfrbcra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Cashflow Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - 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: cfrbcra - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - CashflowBusinessNonCraAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-cfrbnoncra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Cashflow 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: cfrbnoncra - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - CashflowBusinessFtcAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-cfrbftc - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Cashflow 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: cfrbftc - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - customerAnalytics: - transactionalAttributes: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - CashflowPersonalCraAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-cfrpcra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Cashflow Analytics - consumerId: 3f7ff2cf0ffb3d0cd59875e070c9b1d4 - consumerSsn: '1234' - constraints: - analyticsReportData: - forCraPurpose: true - timeIntervalTypes: - - MONTHLY_CALENDAR - type: cfrpcra - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - customerAnalytics: - transactionalAttributes: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - CashflowPersonalNonCraAnalyticsReportResponseExample: - value: - id: sd1j45yn37wr-cfrpnoncra - customerType: active - customerId: 1275320 - requestId: 7a7qyps2iy - requesterName: Decisioning API - title: Mastercard Open Banking Cashflow Analytics - constraints: - analyticsReportData: - forCraPurpose: false - timeIntervalTypes: - - MONTHLY_CALENDAR - type: cfrpnoncra - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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 - 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: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' - customerAnalytics: - transactionalAttributes: - - attributeName: CASH_OUTFLOW - aggregatedByTimePeriods: - - periods: - - count: 4 - endDate: '2021-12-31' - max: -32 - mean: -317.6825 - median: -142.5 - min: -953.73 - standardDeviation: 433.2871371561819 - startDate: '2021-12-22' - sum: -1270.73 - - count: 12 - endDate: '2022-01-31' - max: -32 - mean: -171.95250000000001 - median: -68.35 - min: -953.73 - standardDeviation: 258.5863414492168 - startDate: '2022-01-01' - sum: -2063.43 - - count: 0 - endDate: '2022-02-28' - max: 0 - mean: 0.0 - median: 0.0 - min: 0.0 - standardDeviation: 0.0 - startDate: '2022-02-01' - sum: 0.0 - timeIntervalType: MONTHLY_CALENDAR - streamIds: - - 26126034-6adb-4400-aaba-84f1d75522c5 - - 60e0afe6-8bea-4ba5-ba41-5a7f20add371 - transactionIds: - - '7019271133' - - '7019271149' - - '7019271008' - - '7019271153' - 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' ObbBadRequestResponseExample: value: errorCode: 400 @@ -11972,16 +7896,6 @@ components: 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 @@ -12129,29 +8043,6 @@ components: 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 @@ -12338,7 +8229,7 @@ components: description: |- The account owner's email type. - * "Personal" + * "Personal" * "Business" example: Personal @@ -12430,7 +8321,7 @@ components: AccountOwnerPhoneType: type: string description: |- - The account owner's phone type: + The account owner's phone type: * "HOME" @@ -12448,14 +8339,14 @@ components: AccountOwnerRelationshipType: type: string description: |- - The type of relationship to the account: - * "AUTHORIZED_USER" + The type of relationship to the account: + * "AUTHORIZED_USER" - * "BUSINESS" + * "BUSINESS" - * "FOR_BENEFIT_OF_PRIMARY" + * "FOR_BENEFIT_OF_PRIMARY" - * "FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED" + * "FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED" * "FOR_BENEFIT_OF_SECONDARY" @@ -12640,7 +8531,7 @@ components: 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”. + level), it would return “valid_to_city”. * missing_address - An input address was not provided. * invalid - The input address is not valid. @@ -12666,70 +8557,14 @@ components: 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 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 - 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' + 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 AggregationStatus: type: string description: |- @@ -12744,143 +8579,6 @@ components: Codes](https://developer.mastercard.com/open-banking-us/documentation/products/manage/account-aggregation/#aggregation-status-codes)). Won't be present until you have run your first aggregation for the account. - 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' - constraints: - $ref: '#/components/schemas/AnalyticsReportConstraintsOut' - 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: - type: string - description: - The name(s) of the account owner(s), retrieved from the institution. - example: PATRICK & LORRAINE PURCHASER - ownerAddress: - type: string - description: >- - The mailing address of the account owner, retrieved from the - institution. - example: 7195 BELMONT ST. PARLIN, NJ 08859 - 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: One of the values from account types - example: checking - 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' - accountAnalytics: - $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 @@ -13784,40 +9482,6 @@ components: 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: @@ -15630,15 +11294,15 @@ components: However, Connect doesn't pass this parameter to the following reports: - * Pay Statement Extraction Report + * Pay Statement Extraction Report - * VOIE - Paystub (with TXVerify) Report + * VOIE - Paystub (with TXVerify) Report - * Statement Report + * Statement Report - * Verification of Income Report + * Verification of Income Report - * VOIE - Payroll Report + * VOIE - Payroll Report Note: this field isn't used if you're only collecting transaction data @@ -16844,29 +12508,6 @@ components: 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: @@ -16893,7 +12534,7 @@ components: 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.). + 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 @@ -16995,34 +12636,34 @@ components: Deduction types: - * `Federal tax`: Federal tax withholdings + * `Federal tax`: Federal tax withholdings - * `State tax`: State tax withholdings + * `State tax`: State tax withholdings - * `Local tax`: Local tax withholdings + * `Local tax`: Local tax withholdings - * `Social security tax`: Social security tax withholdings + * `Social security tax`: Social security tax withholdings - * `Medicare tax`: Medicare withholdings + * `Medicare tax`: Medicare withholdings - * `SUI SDI VPDI tax`: SUI SDI VPDI tax + * `SUI SDI VPDI tax`: SUI SDI VPDI tax - * Retirement deductions: Retirement withholdings + * Retirement deductions: Retirement withholdings * `Benefit deductions`: Medical/Health benefits withholdings (i.e. - medical, dental, vision, insurance) + medical, dental, vision, insurance) * `Garnishment deductions`: Garnishment withholdings, (i.e. bankruptcy, student loan, state garnishments, tax levy garnishments, - child support) + child support) * `Other deductions`: Other withholdings, includes any other @@ -17320,11 +12961,11 @@ components: * Brand: color and logo - * Icon: displayed on the "Share your data" page + * Icon: displayed on the "Share your data" page - * Popular institutions: displayed on the Bank Search page + * Popular institutions: displayed on the Bank Search page - * Report: the credit decisioning report to send when Connect completes. + * Report: the credit decisioning report to send when Connect completes. * MVS modules: financial, payroll, paystub @@ -17336,9 +12977,9 @@ components: URL](https://developer.mastercard.com/open-banking-us/documentation/connect/generate-2-connect-url-apis/). - Experience values options: + Experience values options: - * "default": your default experience (must be defined) + * "default": your default experience (must be defined) * GUID: the code for a different experience @@ -17426,7 +13067,7 @@ components: * Driver's license: 1-19 digits * **Canada**: - * Passport: 8 digits + * Passport: 8 digits * Driver: 6-9 digits example: '123456789' @@ -17781,7 +13422,7 @@ components: investment transactions into these types. - Possible values: + Possible values: * "cancel" @@ -18151,7 +13792,7 @@ components: payFrequency: type: string description: | - The current pay frequency, or how often a regular pay check is + The current pay frequency, or how often a regular pay check is distributed: * `Daily` @@ -19015,27 +14656,27 @@ components: description: | The current pay frequency or how often a regular pay check is: - * `Daily` + * `Daily` - * `Weekly` + * `Weekly` - * `Bi-Weekly` + * `Bi-Weekly` - * `Semi-Monthly` + * `Semi-Monthly` - * `Monthly` + * `Monthly` - * `Quarterly` + * `Quarterly` - * `Semi-Annual` + * `Semi-Annual` - * `Annual` + * `Annual` - * `Every 2.6 wks` + * `Every 2.6 wks` - * `Every 4 wks` + * `Every 4 wks` - * `Every 5.2 wks` + * `Every 5.2 wks` * `Other` example: Weekly @@ -19423,7 +15064,7 @@ components: example: 1527832800 latestPayPeriodEndDate: type: integer - description: The most recent pay period’s end date. + description: The most recent pay period’s end date. format: int64 example: 1596175201 latestPayDate: @@ -19803,25 +15444,25 @@ components: 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. + city, state, and postal code. * postal-match - Phone location postal code matches input address postal - code. + code. * zip4-match - Phone location postal code zip+4 matches input address - postal code zip+4. + postal code zip+4. * city-state-match - Phone location city and state matches input address - city and state. + city and state. * metro-match - Phone location is in the same metro area as input - address. + address. - * country-match - Phone location country matches input address country. + * country-match - Phone location country matches input address country. * no-match - Phone location does not match input address. @@ -20201,8 +15842,6 @@ components: - type - status allOf: - - $ref: '#/components/schemas/AFBalanceAnalyticsReport' - - $ref: '#/components/schemas/AFCashFlowAnalyticsReport' - $ref: '#/components/schemas/CashFlowReport' - $ref: '#/components/schemas/PrequalificationReport' - $ref: '#/components/schemas/PayStatementReport' @@ -20359,7 +15998,6 @@ components: description: An account record type: object allOf: - - $ref: '#/components/schemas/AnalyticsReportsAccount' - $ref: '#/components/schemas/CashFlowReportAccount' - $ref: '#/components/schemas/PrequalificationReportAccount' - $ref: '#/components/schemas/TransactionsReportAccount' @@ -20368,10 +16006,6 @@ components: - $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 ReportRequestId: type: string description: @@ -20580,7 +16214,7 @@ components: example: USD symbol: type: string - description: The investment position’s market ticker symbol + description: The investment position’s market ticker symbol example: MCD securityName: type: string @@ -20607,51 +16241,41 @@ components: description: | A report type. Possible values: - * `voi` + * `voi` - * `voa` + * `voa` - * `voaHistory` + * `voaHistory` - * `history` + * `history` - * `voieTxVerify` + * `voieTxVerify` - * `voieWithReport` + * `voieWithReport` - * `voieWithInterview` + * `voieWithInterview` - * `paystatement` + * `paystatement` - * `preQualVoa` + * `preQualVoa` - * `assetSummary` + * `assetSummary` - * `voie` + * `voie` - * `transactions` + * `transactions` - * `statement` + * `statement` - * `voiePayroll` + * `voiePayroll` - * `voeTransactions` + * `voeTransactions` - * `voePayroll` + * `voePayroll` - * `cfrp` + * `cfrp` * `cfrb` - - * `barpcra` - - * `barpnoncra` - - * `barbcra` - - * `barbftc` - - * `barbnoncra` type: string example: voi RoutingNumber: @@ -20804,144 +16428,6 @@ components: 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: >- @@ -20995,7 +16481,7 @@ components: TaxId: type: string description: >- - Country specific tax ID associated with the customer. + Country specific tax ID associated with the customer. * **United Stated**: Social Security number (SSN) or Taxpayer Identification Number (TIN) @@ -21065,7 +16551,7 @@ components: An object representing the third party access key receipt * `customerId`: This is recipient's customerId represented as a - pseudo identifier. + pseudo identifier. * `accountId`: This is the value provided to recipient represented as a pseudo identifier for the accountId. type: object @@ -21091,9 +16577,9 @@ components: ThirdPartyAccessPeriodTypes: description: |- Multiple types will be supported. Presently below types are supported. - * "timeframe": Specifies a timeframe bounded by a startTime and endTime. + * "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, + 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 @@ -21129,17 +16615,17 @@ components: Third party access token can be generated for the following product types: - * "moneyTransferDetails": Retrieve account details for money transfer + * "moneyTransferDetails": Retrieve account details for money transfer * "availableBalance": Retrieves the latest cached available and cleared - account balances for an account. + account balances for an account. * "availableBalanceLive": Retrieves the available and cleared account - balances live from the financial institution + balances live from the financial institution * "accountOwner": Retrieves names and addresses of the account owner - from a financial institution. + from a financial institution. * "paymentIndicator": Get the Payment Success Indicator response, - scoring the likelihood of payment settlement + scoring the likelihood of payment settlement * "paymentFeedback": Create feedback loop for Payment Success Indicator - (PSI) and/or Payment Routing Optimizer (PRO) + (PSI) and/or Payment Routing Optimizer (PRO) * "paymentRouting": Product recommends the best rail to use as well as the best time to initiate the payment type: string @@ -21221,22 +16707,6 @@ components: $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 @@ -21667,113 +17137,6 @@ components: Value of the `toDate` request parameter that generated this response format: int64 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 TxPushCallbackUrl: type: string description: A callback URL where to receive TxPush notifications @@ -21810,10 +17173,6 @@ components: Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/). format: int64 example: 1607450357 - UserType: - type: string - description: Type of User, Allowed values Personal/Business - example: business ReportCreatedDate: type: integer description: >-