/mastercard

Primary LanguagePHP

OpenAPIClient-php

OpenAPI specification for Finicity APIs.

Open Banking solutions in the US are provided by Finicity, a Mastercard company.

For more information, please visit https://developer.mastercard.com/open-banking-us/documentation/support/.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: FinicityAppToken
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Finicity-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Finicity-App-Token', 'Bearer');

// Configure API key authorization: FinicityAppKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Finicity-App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Finicity-App-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AccountValidationAssistanceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer_id = 1005061234; // string | A customer ID
$account_id = 5011648377; // string | The account ID

try {
    $result = $apiInstance->getMicroDepositsDetails($customer_id, $account_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountValidationAssistanceApi->getMicroDepositsDetails: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.finicity.com

Class Method HTTP request Description
AccountValidationAssistanceApi getMicroDepositsDetails GET /microentry/v1/customers/{customerId}/accounts/{accountId} Get Micro Entries Details
AccountValidationAssistanceApi initiateMicroAmountDeposits POST /microentry/v1/customers/{customerId} Initiate Micro Entries
AccountValidationAssistanceApi verifyMicroAmountDeposits POST /microentry/v1/customers/{customerId}/accounts/{accountId}/amounts Verify Micro Entries
AccountsApi deleteCustomerAccount DELETE /aggregation/v1/customers/{customerId}/accounts/{accountId} Delete Customer Account by ID
AccountsApi deleteCustomerAccountsByInstitutionLogin DELETE /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId} Delete Customer Accounts by Institution Login ID
AccountsApi getCustomerAccount GET /aggregation/v2/customers/{customerId}/accounts/{accountId} Get Customer Account by ID
AccountsApi getCustomerAccounts GET /aggregation/v1/customers/{customerId}/accounts Get Customer Accounts
AccountsApi getCustomerAccountsByInstitution GET /aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts Get Customer Accounts by Institution ID
AccountsApi getCustomerAccountsByInstitutionLogin GET /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts Get Customer Accounts by Institution Login ID
AccountsApi refreshCustomerAccounts POST /aggregation/v1/customers/{customerId}/accounts Refresh Customer Accounts
AccountsApi refreshCustomerAccountsByInstitutionLogin POST /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts Refresh Customer Accounts by Institution Login ID
AccountsApi refreshCustomerAccountsByInstitutionLoginV2 POST /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts Refresh Customer Account by Institution Login ID for Data Access Tiers
AccountsApi refreshCustomerAccountsV2 POST /aggregation/v2/customers/{customerId}/accounts Refresh Customer Accounts for Data Access Tiers
AccountsSimpleApi getCustomerAccountSimple GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/simple Get Customer Account by ID (Simple)
AccountsSimpleApi getCustomerAccountsByInstitutionLoginSimple GET /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts/simple Get Customer Accounts by Institution Login ID (Simple)
AccountsSimpleApi getCustomerAccountsByInstitutionSimple GET /aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts/simple Get Customer Accounts by Institution ID (Simple)
AccountsSimpleApi getCustomerAccountsSimple GET /aggregation/v1/customers/{customerId}/accounts/simple Get Customer Accounts (Simple)
AppRegistrationApi getAppRegistrationStatus GET /aggregation/v2/partners/applications Get App Registration Status
AppRegistrationApi migrateInstitutionLoginAccounts PUT /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration Migrate Institution Login Accounts
AppRegistrationApi modifyAppRegistration PUT /aggregation/v1/partners/applications/{preAppId} Modify App Registration
AppRegistrationApi registerApp POST /aggregation/v1/partners/applications Register App
AppRegistrationApi setCustomerAppID PUT /aggregation/v1/customers/{customerId}/applications/{applicationId} Set Customer App ID
AssetsApi getAssetByCustomerID GET /aggregation/v1/customers/{customerId}/assets/{assetId} Get Asset by Customer and ID
AuthenticationApi createToken POST /aggregation/v2/partners/authentication Create Access Token
AuthenticationApi modifyPartnerSecret PUT /aggregation/v2/partners/authentication Modify Partner Secret
BalanceAnalyticsApi generateBalanceAnalytics POST /analytics/balance/v1/customer/{customerId} Generate Balance Analytics
BalanceAnalyticsApi generateBalanceAnalyticsFcra POST /analytics/balance/v1/customer/{customerId}/fcra Generate Balance Analytics - FCRA
BalanceAnalyticsApi generateBalanceAnalyticsReport POST /decisioning/v2/customers/{customerId}/reports/balance-analytics/userTypes/{userType} Generate Balance Analytics Report - Personal/Business
BalanceAnalyticsApi getObbAnalyticsReport GET /analytics/data/v1/{obb_report_id} Get OBB Analytics Report
BalanceAnalyticsApi getObbAnalyticsReportFcra GET /analytics/data/v1/{obb_report_id}/fcra Get OBB Analytics Report - FCRA
BankStatementsApi generateStatementReport POST /decisioning/v2/customers/{customerId}/statement Generate Statement Report
BankStatementsApi getCustomerAccountMultipleStatement GET /aggregation/v3/customers/{customerId}/accounts/{accountId}/statement Get Customer Account Multiple Statements
BankStatementsApi getCustomerAccountStatement GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/statement Get Customer Account Statement
BusinessesAPIApi addBusinessDetails POST /business-services/customers/{customer_id}/businesses Create a New Business for a Customer
BusinessesAPIApi getBusinessByCustomer GET /business-services/customers/{customer_id}/businesses Get Business for Customer
BusinessesAPIApi getBusinessById GET /business-services/businesses/{business_id} Get Business by ID
BusinessesAPIApi updateBusiness PUT /business-services/businesses/{business_id} Update Business by ID
CashFlowApi generateCashFlowBusinessReport POST /decisioning/v2/customers/{customerId}/cashFlowBusiness Generate Cash Flow Report - Business
CashFlowApi generateCashFlowPersonalReport POST /decisioning/v2/customers/{customerId}/cashFlowPersonal Generate Cash Flow Report - Personal
CashFlowAnalyticsApi generateCashFlowAnalytics POST /analytics/cashflow/v1/customer/{customerId} Generate Cash Flow Analytics
CashFlowAnalyticsApi generateCashFlowAnalyticsFcra POST /analytics/cashflow/v1/customer/{customerId}/fcra Generate Cash Flow Analytics - FCRA
CashFlowAnalyticsApi generateCashflowAnalyticsReport POST /decisioning/v2/customers/{customerId}/reports/cashflow-analytics/userTypes/{userType} Generate Cashflow Analytics Report - Personal/Business
CashFlowAnalyticsApi getObbAnalyticsReport GET /analytics/data/v1/{obb_report_id} Get OBB Analytics Report
CashFlowAnalyticsApi getObbAnalyticsReportFcra GET /analytics/data/v1/{obb_report_id}/fcra Get OBB Analytics Report - FCRA
ConnectApi generateConnectUrl POST /connect/v2/generate Generate Connect URL
ConnectApi generateFixConnectUrl POST /connect/v2/generate/fix Generate Fix Connect URL
ConnectApi generateJointBorrowerConnectUrl POST /connect/v2/generate/jointBorrower Generate Connect URL - Joint Borrower
ConnectApi generateLiteConnectUrl POST /connect/v2/generate/lite Generate Lite Connect URL
ConnectApi sendConnectEmail POST /connect/v2/send/email Send Connect Email
ConnectApi sendJointBorrowerConnectEmail POST /connect/v2/send/email/jointBorrower Send Connect Email - Joint Borrower
ConnectApi verifyMicroEntryMicrodeposit POST /connect/v2/generate/microentry/verify Account Validation Assistant User verification of microdeposits
ConsumersApi createConsumer POST /decisioning/v1/customers/{customerId}/consumer Create Consumer
ConsumersApi getConsumer GET /decisioning/v1/consumers/{consumerId} Get Consumer by ID
ConsumersApi getConsumerForCustomer GET /decisioning/v1/customers/{customerId}/consumer Get Consumer For Customer
ConsumersApi modifyConsumer PUT /decisioning/v1/consumers/{consumerId} Modify Consumer by ID
CustomerAuthorizationDetailsApi getCustomerAuthorizationDetails GET /customers/institution-logins/{institution_login_id}/authorization-details Returns customer authorization details for the institution login identification.
CustomersApi addCustomer POST /aggregation/v2/customers/active Add Customer
CustomersApi addTestingCustomer POST /aggregation/v2/customers/testing Add Testing Customer
CustomersApi deleteCustomer DELETE /aggregation/v1/customers/{customerId} Delete Customer by ID
CustomersApi getCustomer GET /aggregation/v1/customers/{customerId} Get Customer by ID
CustomersApi getCustomerWithAppData GET /aggregation/v1/customers/{customerId}/application Get Customer With App Data by ID
CustomersApi getCustomers GET /aggregation/v1/customers Get Customers
CustomersApi modifyCustomer PUT /aggregation/v1/customers/{customerId} Modify Customer by ID
InstitutionsApi getCertifiedInstitutions GET /institution/v2/certifiedInstitutions Get Certified Institutions
InstitutionsApi getCertifiedInstitutionsWithRSSD GET /institution/v2/certifiedInstitutions/rssd Get Certified Institutions With RSSD
InstitutionsApi getInstitution GET /institution/v2/institutions/{institutionId} Get Institution by ID
InstitutionsApi getInstitutionBranding GET /institution/v2/institutions/{institutionId}/branding Get Institution Branding by ID
InstitutionsApi getInstitutions GET /institution/v2/institutions Get Institutions
PayStatementsApi storeCustomerPayStatement POST /aggregation/v1/customers/{customerId}/payStatements Store Customer Pay Statement
PaymentHistoryApi generatePaymentHistory POST /analytics/payment-history/v1/customer/{customerId} Generate Payment History
PaymentHistoryApi generatePaymentHistoryFcra POST /analytics/payment-history/v1/customer/{customerId}/fcra Generate Payment History - FCRA
PaymentHistoryApi getObbAnalyticsReport GET /analytics/data/v1/{obb_report_id} Get OBB Analytics Report
PaymentHistoryApi getObbAnalyticsReportFcra GET /analytics/data/v1/{obb_report_id}/fcra Get OBB Analytics Report - FCRA
PaymentsApi getAccountACHDetails GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/details Get Account ACH Details
PaymentsApi getAccountOwner GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/owner Get Account Owner
PaymentsApi getAccountOwnerDetails GET /aggregation/v3/customers/{customerId}/accounts/{accountId}/owner Get Account Owner Details
PaymentsApi getAvailableBalance GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance Get Available Balance
PaymentsApi getAvailableBalanceLive GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance/live Get Available Balance - Live
PaymentsApi getLoanPaymentDetails GET /aggregation/v2/customers/{customerId}/accounts/{accountId}/loanDetails Get Loan Payment Details
PortfoliosApi getPortfolioByConsumer GET /decisioning/v1/consumers/{consumerId}/portfolios/{portfolioId} Get Portfolio by Consumer
PortfoliosApi getPortfolioByCustomer GET /decisioning/v1/customers/{customerId}/portfolios/{portfolioId} Get Portfolio by Customer
ReportsApi getReportByConsumer GET /decisioning/v3/consumers/{consumerId}/reports/{reportId} Get Report by Consumer and ID
ReportsApi getReportByCustomer GET /decisioning/v3/customers/{customerId}/reports/{reportId} Get Report by Customer and ID
ReportsApi getReportsByConsumerId GET /decisioning/v1/consumers/{consumerId}/reports Get Reports by Consumer ID
ReportsApi getReportsByCustomerId GET /decisioning/v1/customers/{customerId}/reports Get Reports by Customer ID
ThirdPartyAccessApi generateThirdPartyAccessKey POST /aggregation/v1/partners/accessKey Generate Third Party Access Key
ThirdPartyAccessApi revokeThirdPartyAccessKey DELETE /aggregation/v1/partners/accessKey/{consentReceiptId} Revoke Third Party Access
ThirdPartyAccessApi updateThirdPartyAccessKey PUT /aggregation/v1/partners/accessKey/{consentReceiptId} Update Third Party Access
TransactionsApi generateTransactionsReport POST /decisioning/v2/customers/{customerId}/transactions Generate Transactions Report
TransactionsApi getAllCustomerTransactions GET /aggregation/v3/customers/{customerId}/transactions Get All Customer Transactions
TransactionsApi getCustomerAccountTransactions GET /aggregation/v4/customers/{customerId}/accounts/{accountId}/transactions Get Customer Account Transactions
TransactionsApi getCustomerTransaction GET /aggregation/v2/customers/{customerId}/transactions/{transactionId} Get Customer Transaction by ID
TransactionsApi loadHistoricTransactionsForCustomerAccount POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic Load Historic Transactions for Customer Account
TxPushApi createTxPushTestTransaction POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions Create TxPush Test Transaction
TxPushApi deleteTxPushSubscription DELETE /aggregation/v1/customers/{customerId}/subscriptions/{subscriptionId} Delete TxPush Subscription
TxPushApi disableTxPushNotifications DELETE /aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush Disable TxPush Notifications
TxPushApi subscribeToTxPushNotifications POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush Subscribe to TxPush Notifications
VerifyAssetsApi generatePrequalificationCRAReport POST /decisioning/v2/customers/{customerId}/preQualVoa Generate Prequalification (CRA) Report
VerifyAssetsApi generatePrequalificationNonCRAReport POST /decisioning/v2/customers/{customerId}/assetSummary Generate Prequalification (Non-CRA) Report
VerifyAssetsApi generateVOAReport POST /decisioning/v2/customers/{customerId}/voa Generate VOA Report
VerifyAssetsApi generateVOAWithIncomeReport POST /decisioning/v2/customers/{customerId}/voaHistory Generate VOA With Income Report
VerifyIncomeAndEmploymentApi generatePayStatementReport POST /decisioning/v2/customers/{customerId}/payStatement Generate Pay Statement Report
VerifyIncomeAndEmploymentApi generateVOEPayrollReport POST /decisioning/v2/customers/{customerId}/voePayroll Generate VOE - Payroll Report
VerifyIncomeAndEmploymentApi generateVOETransactionsReport POST /decisioning/v2/customers/{customerId}/voeTransactions Generate VOE - Transactions Report
VerifyIncomeAndEmploymentApi generateVOIEPaystubReport POST /decisioning/v2/customers/{customerId}/voieTxVerify/withStatement Generate VOIE - Paystub Report
VerifyIncomeAndEmploymentApi generateVOIEPaystubWithTXVerifyReport POST /decisioning/v2/customers/{customerId}/voieTxVerify/withInterview Generate VOIE - Paystub (with TXVerify) Report
VerifyIncomeAndEmploymentApi generateVOIReport POST /decisioning/v2/customers/{customerId}/voi Generate VOI Report
VerifyIncomeAndEmploymentApi refreshVOIEPayrollReport POST /decisioning/v2/customers/{customerId}/voiePayroll Generate VOIE - Payroll Report

Models

Authorization

Authentication schemes defined for the API:

FinicityAppKey

  • Type: API key
  • API key parameter name: Finicity-App-Key
  • Location: HTTP header

FinicityAppToken

  • Type: API key
  • API key parameter name: Finicity-App-Token
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

apisupport@mastercard.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.16.1
    • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen