CustomerAccountBalanceDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A timestamp showing when the balance was captured. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
CustomerAccountCreatedDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A timestamp showing when the account was added to the system. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
CustomerAccountDetail
{
"type": "object",
"properties": {
"owner": {
"type": "string",
"example": "FinBank",
"description": "(Student Loan) Owner of the loan"
},
"lender": {
"type": "string",
"example": "utah community credit union",
"description": "(Mortgage/Loan) Owner of loan"
},
"buyPower": {
"type": "number",
"example": 34567.89,
"description": "(Investment) Money available to buy securities"
},
"dateAsOf": {
"$ref": "#/components/schemas/DateAsOf"
},
"loanRate": {
"type": "number",
"example": 3.275,
"description": "(Investment) Interest rate of loan"
},
"openDate": {
"$ref": "#/components/schemas/OpenDate"
},
"termOfMl": {
"type": "string",
"example": "36",
"description": "(Mortgage/Loan) Length of loan in months"
},
"guarantor": {
"type": "string",
"example": "FinBank",
"description": "(Student Loan) The financial institution guarantor of the loan (who will pay the loan amount to the owner if the borrower defaults)"
},
"collateral": {
"type": "string",
"example": "nissan sentra",
"description": "(Mortgage/Loan) Collateral on loan"
},
"loanStatus": {
"type": "string",
"example": "Deferment",
"description": "(Student Loan) The repayment status phase (i.e. In School, Grace, Repayment, Deferment, Forbearance)"
},
"ytdTaxPaid": {
"type": "number",
"example": 1489,
"description": "(Mortgage/Loan) Tax paid year-to-date"
},
"description": {
"type": "string",
"example": "a description",
"description": "(Mortgage/Loan) Description of loan"
},
"feesBalance": {
"type": "number",
"example": 150,
"description": "(Student Loan) The total outstanding fees balance"
},
"loanAwardId": {
"type": "string",
"example": "1234568",
"description": "(Student Loan) The federal unique loan identifying number"
},
"matchAmount": {
"type": "number",
"example": 378,
"description": "(Investment) Amount matched"
},
"nextPayment": {
"type": "number",
"example": 1578,
"description": "(Mortgage/Loan) Minimum payment due"
},
"rolloverLtd": {
"type": "number",
"example": 23456.78,
"description": "(Investment) Life to date of money rolled over"
},
"interestRate": {
"type": "string",
"example": "15.789",
"description": "(Credit Card/Line Of Credit) and (Mortgage/Loan) The account's current interest rate"
},
"loanTermType": {
"type": "string",
"example": "fixed",
"description": "(Mortgage/Loan) Type of loan term"
},
"maturityDate": {
"$ref": "#/components/schemas/MaturityDate"
},
"mlHolderName": {
"type": "string",
"example": "John Smith",
"description": "(Mortgage/Loan) Holder of the mortgage or loan"
},
"paymentsMade": {
"type": "integer",
"format": "int32",
"example": 14,
"description": "(Mortgage/Loan) Number of payments made"
},
"payoffAmount": {
"type": "number",
"example": 45567.98,
"description": "(Mortgage/Loan) The amount required to payoff the loan"
},
"preTaxAmount": {
"type": "number",
"example": 78564.99,
"description": "(Investment) Pre-tax amount of total balance"
},
"shortBalance": {
"type": "number",
"example": 12456.89,
"description": "(Investment) Sum of short balance"
},
"balloonAmount": {
"type": "number",
"example": 1678.56,
"description": "(Mortgage/Loan) Balloon payment amount"
},
"currentSchool": {
"type": "string",
"example": "utah valley university",
"description": "(Mortgage/Loan) Current school"
},
"escrowBalance": {
"type": "number",
"example": 2345.01,
"description": "(Mortgage/Loan) The escrow balance"
},
"firstMortgage": {
"type": "boolean",
"example": true,
"description": "(Mortgage/Loan) First mortgage (F/Y)"
},
"initialMlDate": {
"$ref": "#/components/schemas/InitialMlDate"
},
"lateFeeAmount": {
"type": "number",
"example": 35,
"description": "(Mortgage/Loan) Late fee charged"
},
"marginAllowed": {
"type": "boolean",
"example": true,
"description": "Margin trading indicator (true / false)"
},
"marginBalance": {
"type": "number",
"example": 456,
"description": "(Investment) Net interest earned after deducting interest paid out"
},
"pastDueAmount": {
"type": "number",
"example": 3688.99,
"description": "(Credit Card/Line Of Credit) Balance past due"
},
"periodEndDate": {
"$ref": "#/components/schemas/PeriodEndDate"
},
"repaymentPlan": {
"type": "string",
"example": "Standard, Graduated, Extended, Pay As You Earn, and more.",
"description": "(Mortgage/Loan) Type of repayment plan for the student loan"
},
"vestedBalance": {
"type": "number",
"example": 45000,
"description": "(Investment) Vested amount in account"
},
"afterTaxAmount": {
"type": "number",
"example": 68564.99,
"description": "(Investment) After-tax amount of total balance"
},
"currentBalance": {
"type": "number",
"example": 5789.34,
"description": "(Credit Card/Line Of Credit) and (Investment) Current balance"
},
"daysDelinquent": {
"type": "integer",
"format": "int32",
"example": 5,
"description": "(Student Loan) The number of days past a due date that a payment should have been made"
},
"empMatchAmount": {
"type": "number",
"example": 256.99,
"description": "(Investment) Employer matched contributions"
},
"interestPeriod": {
"type": "string",
"example": "monthly",
"description": "(Mortgage/Loan) Period of interest"
},
"originalSchool": {
"type": "string",
"example": "Brigham young university",
"description": "(Mortgage/Loan) Original school"
},
"paymentDueDate": {
"$ref": "#/components/schemas/PaymentDueDate"
},
"rolloverAmount": {
"type": "number",
"example": 101234.67,
"description": "(Investment) Amount of balance rolled over from original account (401k, etc.)"
},
"autoPayEnrolled": {
"type": "boolean",
"example": true,
"description": "(Mortgage/Loan) Enrolled in autopay (F/Y)"
},
"contribTotalYtd": {
"type": "number",
"example": 2045,
"description": "(Investment) Total year to date contributions"
},
"creditMaxAmount": {
"type": "number",
"example": 7000,
"description": "(Credit Card/Line Of Credit) The account's credit limit"
},
"initialMlAmount": {
"type": "number",
"example": 65000,
"description": "(Mortgage/Loan) Original loan amount"
},
"interestBalance": {
"type": "number",
"example": 2000,
"description": "(Student Loan) The total outstanding interest balance"
},
"interestPaidLtd": {
"type": "number",
"example": 56789.34,
"description": "(Mortgage/Loan) Interest paid since inception of loan (life to date)"
},
"lastPaymentDate": {
"$ref": "#/components/schemas/LastPaymentDate"
},
"loanPaymentFreq": {
"type": "string",
"example": "monthly",
"description": "(Mortgage/Loan) Frequency of payments (monthly, etc.)"
},
"loanPaymentType": {
"type": "string",
"example": "principle",
"description": "(Mortgage/Loan) Type of loan payment"
},
"loanYtdFeesPaid": {
"type": "number",
"example": 5621.23,
"description": "(Student Loan) Loan fees paid year-to-date"
},
"nextPaymentDate": {
"$ref": "#/components/schemas/NextPaymentDate"
},
"otherVestAmount": {
"type": "number",
"example": 34000,
"description": "(Investment) Other vested amount"
},
"outOfSchoolDate": {
"$ref": "#/components/schemas/OutOfSchoolDate"
},
"periodStartDate": {
"$ref": "#/components/schemas/PeriodStartDate"
},
"previousBalance": {
"type": "number",
"example": 1234.56,
"description": "(Credit Card/Line Of Credit) Prior balance in last statement"
},
"totalAmountPaid": {
"type": "number",
"example": 16125,
"description": "(Student Loan) The total amount paid"
},
"ytdInterestPaid": {
"type": "number",
"example": 3948.56,
"description": "(Mortgage/Loan) Interest paid year-to-date"
},
"firstPaymentDate": {
"$ref": "#/components/schemas/FirstPaymentDate"
},
"interestRateType": {
"type": "string",
"example": "variable",
"description": "(Mortgage/Loan) Type of interest rate"
},
"paymentMinAmount": {
"type": "number",
"example": 456.78,
"description": "(Credit Card/Line Of Credit) and (Mortgage/Loan) Minimum payment due"
},
"payoffAmountDate": {
"$ref": "#/components/schemas/PayoffAmountDate"
},
"principalBalance": {
"type": "number",
"example": 45056.7,
"description": "(Mortgage/Loan) The principal balance"
},
"statementEndDate": {
"$ref": "#/components/schemas/StatementEndDate"
},
"ytdInsurancePaid": {
"type": "number",
"example": 1345.89,
"description": "(Mortgage/Loan) Insurance paid year-to-date"
},
"ytdPrincipalPaid": {
"type": "number",
"example": 5432.01,
"description": "(Mortgage/Loan) Principal paid year-to-date"
},
"cashBalanceAmount": {
"type": "number",
"example": 2000,
"description": "(Investment) Cash balance of account"
},
"interestYtdAmount": {
"type": "number",
"example": 1056.67,
"description": "(Checking/Savings/CD/MoneyMarket) Interest accrued year-to-date"
},
"lastPaymentAmount": {
"type": "number",
"example": 567.89,
"description": "(Credit Card/Line Of Credit) and (Mortgage/Loan) The amount received in the last payment"
},
"loanStatusEndDate": {
"$ref": "#/components/schemas/LoanStatusEndDate"
},
"paymentsRemaining": {
"type": "integer",
"format": "int32",
"example": 45,
"description": "(Mortgage/Loan) Number of payments remaining before loan is paid off"
},
"projectedInterest": {
"type": "number",
"example": 10456.78,
"description": "(Mortgage/Loan) Projected interest on the loan"
},
"remainingTermOfMl": {
"type": "number",
"example": 2,
"description": "(Student Loan) The number of months still outstanding on a loan"
},
"totalInterestPaid": {
"type": "number",
"example": 1125,
"description": "(Student Loan) The total amount paid towards interest"
},
"cashAccountAllowed": {
"type": "boolean",
"example": true,
"description": "Cash account allowed indicator (true / false)"
},
"cashAdvanceBalance": {
"type": "number",
"example": 1000,
"description": "(Credit Card/Line Of Credit) Balance of current cash advance"
},
"convertToRepayment": {
"$ref": "#/components/schemas/ConvertToRepayment"
},
"currentLoanBalance": {
"type": "number",
"example": 345789.23,
"description": "(Investment) Current loan balance"
},
"expectedPayoffDate": {
"$ref": "#/components/schemas/ExpectedPayoffDate"
},
"lastPaymentDueDate": {
"$ref": "#/components/schemas/LastPaymentDueDate"
},
"otherNonvestAmount": {
"type": "number",
"example": 26000,
"description": "(Investment) Other nonvested amount"
},
"periodInterestRate": {
"type": "number",
"example": 13.245,
"description": "(Checking/Savings/CD/MoneyMarket) The APY for the current period interest rate"
},
"statementStartDate": {
"$ref": "#/components/schemas/StatementStartDate"
},
"totalPrincipalPaid": {
"type": "number",
"example": 15000,
"description": "(Student Loan) The total amount paid towards the principal balance"
},
"endingBalanceAmount": {
"type": "number",
"example": 234789.45,
"description": "(Mortgage/Loan) Ending balance"
},
"initialInterestRate": {
"type": "number",
"example": 34567.89,
"description": "(Student Loan) Initial interest rate of loan"
},
"interestSubsidyType": {
"type": "string",
"example": "Subsidy type",
"description": "(Student Loan) The indication of the presence of an interest subsidy (i.e. subsidized)"
},
"loanStatusStartDate": {
"$ref": "#/components/schemas/LoanStatusStartDate"
},
"loanYtdInterestPaid": {
"type": "number",
"example": 5623.23,
"description": "(Student Loan) Loan interest paid year-to-date"
},
"maturityValueAmount": {
"type": "number",
"example": 34067.78,
"description": "(Investment) amount payable to an investor at maturity"
},
"periodDepositAmount": {
"type": "number",
"example": 2356.56,
"description": "(Checking/Savings/CD/MoneyMarket) Amount deposited in period"
},
"profitSharingAmount": {
"type": "number",
"example": 34678.89,
"description": "(Investment) Amount of balance for profit sharing"
},
"rewardEarnedBalance": {
"type": "integer",
"format": "int32",
"example": 500,
"description": "(Credit Card/Line Of Credit) Earned reward balance"
},
"availableCashBalance": {
"type": "number",
"example": 3456.78,
"description": "(Investment) Amount available for cash withdrawal"
},
"cashAdvanceMaxAmount": {
"type": "number",
"example": 3000,
"description": "(Credit Card/Line Of Credit) Maximum cash advance amount"
},
"loanYtdPrincipalPaid": {
"type": "number",
"example": 5621.23,
"description": "(Student Loan) Loan principal paid year-to-date"
},
"originalInterestRate": {
"type": "number",
"example": 12,
"description": "(Student Loan) The original interest rate to which the loan was disbursed, in APY"
},
"originalMaturityDate": {
"$ref": "#/components/schemas/OriginalMaturityDate"
},
"periodInterestAmount": {
"type": "number",
"example": 1234.56,
"description": "(Checking/Savings/CD/MoneyMarket) Interest accrued during the current period"
},
"repaymentPlanEndDate": {
"$ref": "#/components/schemas/RepaymentPlanEndDate"
},
"weightedInterestRate": {
"type": "number",
"example": 12,
"description": "(Student Loan) The interest rate of multiple interest rates and balances at the group level, in APY"
},
"creditAvailableAmount": {
"type": "number",
"example": 3000,
"description": "(Credit Card/Line Of Credit) The available credit (typically the credit limit minus the current balance)"
},
"lastPaymentLateCharge": {
"type": "number",
"example": 50,
"description": "(Mortgage/Loan) Amount of late charge in last payment"
},
"statementCloseBalance": {
"type": "number",
"example": 2456.69,
"description": "(Credit Card/Line Of Credit) Balance of statement at close"
},
"statementCreditAmount": {
"type": "number",
"example": 345,
"description": "(Credit Card/Line Of Credit) Credit amount applied in statement period"
},
"availableBalanceAmount": {
"type": "number",
"example": 5678.78,
"description": "(Checking/Savings/CD/MoneyMarket) and (Mortgage/Loan) The available balance (typically the current balance with adjustments for any pending transactions)"
},
"empPretaxContribAmount": {
"type": "number",
"example": 450,
"description": "(Investment) Employer pretax contribution amount"
},
"interestPriorYtdAmount": {
"type": "number",
"example": 3056.79,
"description": "(Checking/Savings/CD/MoneyMarket) Interest earned in prior year"
},
"lastPaymentReceiveDate": {
"$ref": "#/components/schemas/LastPaymentReceiveDate"
},
"recurringPaymentAmount": {
"type": "number",
"example": 456.23,
"description": "(Mortgage/Loan) Recurring payment amount"
},
"repaymentPlanStartDate": {
"$ref": "#/components/schemas/RepaymentPlanStartDate"
},
"statementFinanceAmount": {
"type": "number",
"example": 156.78,
"description": "(Credit Card/Line Of Credit) Finance amount of statement period"
},
"cashAdvanceInterestRate": {
"type": "number",
"example": 21.5,
"description": "(Credit Card/Line Of Credit) Interest rate for cash advances"
},
"lastPaymentEscrowAmount": {
"type": "number",
"example": 456.78,
"description": "(Mortgage/Loan) Amount towards escrow in last payment"
},
"statementPurchaseAmount": {
"type": "number",
"example": 2345.9,
"description": "(Credit Card/Line Of Credit) Purchase amount of statement period"
},
"lastPaymentLastFeeAmount": {
"type": "number",
"example": 150,
"description": "(Mortgage/Loan) Amount of last fee in last payment"
},
"empPretaxContribAmountYtd": {
"type": "number",
"example": 700,
"description": "(Investment) Employer pretax contribution amount year to date"
},
"lastPaymentInterestAmount": {
"type": "number",
"example": 234.56,
"description": "(Mortgage/Loan) Amount of interest in last payment"
},
"nextPaymentInterestAmount": {
"type": "number",
"example": 234.56,
"description": "(Mortgage/Loan) Amount of interest in next payment"
},
"cashAdvanceAvailableAmount": {
"type": "number",
"example": 2000,
"description": "(Credit Card/Line Of Credit) Currently available cash advance"
},
"lastPaymentPrincipalAmount": {
"type": "number",
"example": 1256.67,
"description": "(Mortgage/Loan) Amount towards principal in last payment"
},
"nextPaymentPrincipalAmount": {
"type": "number",
"example": 1256.67,
"description": "(Mortgage/Loan) Amount towards principal in next payment"
}
},
"description": "Additional customer account details. Not all data points will return for each account type. You can see the account type that each data point will return for in descriptions. The data point are also subject to availability by the institution."
}
CustomerAccountLastTransactionDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
CustomerAccountMarketSegment
{
"type": "string",
"example": "personal",
"description": "The market segment of the account. Possible values: personal, business"
}
CustomerAccountMultipleStatement
{
"type": "object",
"required": [
"asOfDate",
"index"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AssetId"
},
"code": {
"type": "string",
"description": "Error code for the bank statement not generated"
},
"index": {
"$ref": "#/components/schemas/Index"
},
"message": {
"type": "string",
"description": "Error message for the bank statement not generated"
},
"asOfDate": {
"$ref": "#/components/schemas/UnixDate"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"documentDate": {
"$ref": "#/components/schemas/DocumentDate"
}
},
"description": "Statement represents the bank statements for a given customer's account"
}
CustomerAccountMultipleStatements
{
"type": "object",
"required": [
"statements"
],
"properties": {
"statements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerAccountMultipleStatement"
},
"example": [
{
"id": "a9e96186-2896-4a21-8759-450403dadf47-1063025272",
"index": "1",
"asOfDate": 1669036741,
"description": "08/28/2020 - 09/27/2020",
"documentDate": "2020-09-27"
},
{
"code": "960",
"index": "2",
"message": "statement not found.",
"asOfDate": 1669036741
}
],
"description": "List of customer account statements"
}
},
"description": "A list of customer account statements"
}
CustomerAccountOldestTransactionDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "The date of the oldest transaction in the transactions for the account. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
CustomerAccountParentAccountId
{
"type": "string",
"example": "5011648377",
"description": "The assigned account ID for the account one level higher in the student loan account hierarchy"
}
CustomerAccountPosition
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 454678080,
"description": "The ID of the investment position"
},
"units": {
"type": "number",
"example": 6.537,
"description": "The number of units of the holding"
},
"mfType": {
"type": "string",
"example": "OPENEND",
"description": "Type of mutual fund, such as open ended"
},
"status": {
"type": "string",
"example": "A",
"description": "The status of the holding"
},
"symbol": {
"type": "string",
"example": "DAL",
"description": "The investment position's market ticker symbol"
},
"posType": {
"type": "string",
"example": "Long",
"description": "Fund type assigned by the FI (long or short)"
},
"holdType": {
"type": "string",
"example": "INVESTMENT",
"description": "The type of the holding"
},
"costBasis": {
"type": "number",
"example": 190.01,
"description": "The total cost of acquiring the security"
},
"assetClass": {
"type": "string",
"example": "INTLSTOCK",
"description": "An asset class is a grouping of comparable financial securities. These include equities (stocks), fixed income (bonds), and cash equivalent or money market instruments. (DOMESTICBOND, LARGESTOCK, INTLSTOCK, MONEYMRKT, OTHER)"
},
"optionType": {
"type": "string",
"example": "PUT",
"description": "The type of option contract (PUT or CALL)"
},
"securityId": {
"type": "string",
"example": "25400W102",
"description": "The security ID of the transaction"
},
"dailyChange": {
"type": "number",
"example": 180.03,
"description": "The value amount change since the previous day"
},
"description": {
"type": "string",
"example": "DELTA AIR LINES INC",
"description": "The description of the holding"
},
"marketValue": {
"type": "number",
"example": 271.84,
"description": "Market value of an investment position at the time of retrieval"
},
"currencyRate": {
"type": "number",
"example": 1,
"description": "Currency rate, ratio of currency to original currency"
},
"currentPrice": {
"type": "number",
"example": 41.585,
"description": "The current price of the investment holding"
},
"fiAssetClass": {
"type": "string",
"example": "COMNEQTY",
"description": "Financial Institution (FI) defined asset class (COMMON STOCK, COMNEQTY, EQUITY/STOCK, CMA-ISA, CONVERTIBLE PREFERREDS, CORPORATE BONDS, OTHER MONEY FUNDS, ALLOCATION FUNDS, CMA-TAXABLE, FOREIGNEQUITYADRS, COMMONSTOCK, PREFERRED STOCKS, STABLE VALUE, FOREIGN EQUITY ADRS)"
},
"securityName": {
"type": "string",
"example": "DELTA AIR LINES INC",
"description": "The security name for the investment holding"
},
"securityType": {
"type": "string",
"example": "Stock",
"description": "Type of security for the investment position"
},
"changePercent": {
"type": "number",
"example": 170.02,
"description": "The percent change in value since the previous day"
},
"todayGLDollar": {
"type": "number",
"example": 16272.9,
"description": "The current day's gain and loss of the position at the time of aggregation in dollars"
},
"totalGLDollar": {
"type": "number",
"example": 162742.9,
"description": "Total gain and loss of the position at the time of aggregation in dollars"
},
"securityIdType": {
"$ref": "#/components/schemas/SecurityIdType"
},
"subAccountType": {
"type": "string",
"example": "CASH",
"description": "The subaccount's type, such as cash"
},
"todayGLPercent": {
"type": "number",
"example": 18.89,
"description": "The current day's gain and loss of the position at the time of aggregation in percentage"
},
"totalGLPercent": {
"type": "number",
"example": 68.89,
"description": "Total gain and loss of the position at the time of aggregation in percentage"
},
"invSecurityType": {
"type": "string",
"example": "OTHERINFO",
"description": "The security type for the investment holding"
},
"transactionType": {
"type": "string",
"example": "Margin",
"description": "The transaction type of the holding, such as cash, margin, and more"
},
"currentPriceDate": {
"$ref": "#/components/schemas/UnixDate"
},
"optionExpireDate": {
"type": "string",
"format": "date",
"example": "1644994800",
"description": "Expiration date of option"
},
"securityCurrency": {
"type": "string",
"example": "USD",
"description": "Symbol for the currency that the account is being converted into"
},
"costBasisPerShare": {
"type": "number",
"example": 13.38,
"description": "The per share cost of acquiring the security"
},
"optionStrikePrice": {
"type": "number",
"example": 50,
"description": "The strike price of the option contract"
},
"optionSharesPerContract": {
"type": "number",
"example": 100,
"description": "The number of shares per option contract"
}
},
"description": "Details for investment account holdings"
}
CustomerAccountSimple
{
"type": "object",
"required": [
"id",
"accountNumberDisplay",
"name",
"type",
"status",
"customerId",
"institutionId",
"createdDate",
"currency",
"institutionLoginId",
"displayPosition"
],
"properties": {
"id": {
"$ref": "#/components/schemas/AccountId"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"type": {
"$ref": "#/components/schemas/AccountType"
},
"status": {
"$ref": "#/components/schemas/AggregationStatus"
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"customerId": {
"$ref": "#/components/schemas/CustomerId"
},
"createdDate": {
"$ref": "#/components/schemas/UnixDate"
},
"institutionId": {
"$ref": "#/components/schemas/InstitutionId"
},
"parentAccount": {
"$ref": "#/components/schemas/AccountId"
},
"displayPosition": {
"$ref": "#/components/schemas/DisplayPosition"
},
"institutionLoginId": {
"$ref": "#/components/schemas/NumericInstitutionLoginId"
},
"accountNumberDisplay": {
"$ref": "#/components/schemas/AccountNumberDisplay"
},
"aggregationStatusCode": {
"$ref": "#/components/schemas/AggregationStatusCode"
},
"aggregationAttemptDate": {
"$ref": "#/components/schemas/UnixDate"
},
"aggregationSuccessDate": {
"$ref": "#/components/schemas/UnixDate"
}
},
"description": "An account represents a bank account such as a checking or savings that the customer has added via the Connect interface."
}
CustomerAccounts
{
"type": "object",
"required": [
"accounts"
],
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerAccount"
},
"description": "List of customer accounts"
}
},
"description": "A list of customer accounts"
}
CustomerAccountsSimple
{
"type": "object",
"required": [
"accounts"
],
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerAccountSimple"
},
"description": "A list of accounts with basic information of a customer"
}
},
"description": "A list of accounts with basic information of a customer"
}
CustomerAnalytics
{
"type": "object",
"required": [
"transactionalAttributes",
"stateAttributes",
"streams"
],
"properties": {
"streams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StreamModel"
},
"description": "List of generated streams"
},
"stateAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateAttribute"
},
"description": "List of calculated state attributes"
},
"transactionalAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionalAttribute"
},
"description": "List of calculated transactional attributes"
}
},
"description": "Analytics and attributes generated at a customer level"
}
CustomerId
{
"type": "string",
"example": "1005061234",
"description": "A customer ID. See Add Customer API for how to create a customer ID."
}
CustomerLastUpdatedDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A timestamp showing when the account was last modified to the system. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
CustomerType
{
"type": "string",
"example": "active",
"description": "The type of customer (\"active\" or \"testing\" or \"\" for all types)"
}
CustomerUpdate
{
"type": "object",
"properties": {
"lastName": {
"$ref": "#/components/schemas/LastName"
},
"firstName": {
"$ref": "#/components/schemas/FirstName"
}
},
"description": "Represent an update to customer fields"
}
CustomerUsername
{
"type": "string",
"example": "customerusername1",
"description": "The customer's username, assigned by the partner (a unique identifier), following these rules: minimum 6 characters maximum 255 characters any mix of uppercase, lowercase, numeric, and non-alphabet special characters ! @ . # $ % & * _ - + the use of email in this field is discouraged it is recommended to use a unique non-email identifier. Use of special characters may result in an error (e.g. í, ü, etc.). Usernames are unique. A username used in Test Drive can't be reused in other plans."
}
CustomerWithAppData
{
"allOf": [
{
"$ref": "#/components/schemas/Customer"
},
{
"type": "object",
"properties": {
"applicationId": {
"$ref": "#/components/schemas/ApplicationId"
},
"applicationName": {
"$ref": "#/components/schemas/ApplicationName"
}
}
}
],
"required": [
"id",
"username",
"firstName",
"lastName",
"type",
"createdDate",
"applicationId",
"applicationName"
],
"description": "A finicity customer record with application info"
}
Customers
{
"type": "object",
"required": [
"displaying",
"moreAvailable",
"customers"
],
"properties": {
"found": {
"$ref": "#/components/schemas/FoundResults"
},
"customers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
},
"description": "A list of customer records"
},
"displaying": {
"$ref": "#/components/schemas/DisplayingResults"
},
"moreAvailable": {
"$ref": "#/components/schemas/MoreResultsAvailable"
}
},
"description": "A list of customers"
}
DateAsOf
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "(All Account Types) Most recent date of the following information. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
DateTimeWithZone
{
"type": "string",
"format": "date-time",
"example": "2022-03-10T06:06:20.042584549Z",
"description": "A date-time with time zone"
}
DecimalNumber
{
"type": "number",
"format": "float",
"example": 0.12,
"description": "Decimal number"
}
Deduction
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "401",
"description": "The normalized category of the deductions in the format [type][number]. The number is the will be the iterating number of the type's occurrence starting at one."
},
"type": {
"type": "string",
"example": "401 Deductions",
"description": "Categorization based on the deduction line's description"
},
"amountYTD": {
"type": "number",
"example": 1744.6,
"description": "The amount for the deduction line being deducted from the employee's pay for the current pay year"
},
"description": {
"type": "string",
"example": "401k",
"description": "The deduction line's deduction type description"
},
"amountCurrent": {
"type": "number",
"example": 1744.61,
"description": "The amount for the deduction line deducted from employee's pay for the specified pay period"
}
}
}
Deductions
{
"type": "object",
"required": [
"type",
"amount"
],
"properties": {
"type": {
"type": "string",
"example": "State tax",
"description": "Deduction types:\n\n* `Federal tax`: Federal tax withholdings \n\n* `State tax`: State tax withholdings \n\n* `Local tax`: Local tax withholdings \n\n* `Social security tax`: Social security tax withholdings \n\n* `Medicare tax`: Medicare withholdings \n\n* `SUI SDI VPDI tax`: SUI SDI VPDI tax \n\n* Retirement deductions: Retirement withholdings \n\n* `Benefit deductions`: Medical/Health benefits withholdings (i.e. medical, dental, vision, insurance) \n\n* `Garnishment deductions`: Garnishment withholdings, (i.e. bankruptcy, student loan, state garnishments, tax levy garnishments, child support) \n\n* `Other deductions`: Other withholdings, includes any other uncommon withholdings, pension plan, stock plans, etc.\n"
},
"amount": {
"type": "number",
"example": 4.28,
"description": "Amount associated with deduction"
}
}
}
Description
{
"type": "string",
"description": "Date range representing the period for when the statement data is generated."
}
Descriptor
{
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string",
"example": "routingNumber",
"description": "Payment Instruction Descriptor Type"
},
"value": {
"type": "string",
"example": "2434345",
"description": "Value that the Descriptor Type Holds"
}
}
}
DirectDeposit
{
"type": "object",
"properties": {
"amountCurrent": {
"type": "number",
"example": 1744.61,
"description": "The amount of the deposit"
},
"accountLastFour": {
"type": "string",
"example": "1234",
"description": "The last four numbers of the account the deposit went into"
}
}
}
DirectDeposits
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 12.34,
"description": "Direct deposit amount"
},
"routingNumber": {
"type": "string",
"example": 30207583,
"description": "Routing number for the deposit account"
},
"accountLastFour": {
"type": "string",
"example": 3337,
"description": "Last four digits of the deposit account number"
},
"accountTypeCode": {
"type": "string",
"example": "Savings",
"description": "Bank account type:\n\n* `Checking`\n\n* `Savings`\n\n* `Loan`: Loan account employee choose to direct a portion of their net pay to help pay off a loan\n"
}
}
}
DirectPayStatements
{
"type": "object",
"required": [
"payrollPayHistoryId",
"lastPayPeriodIndicator",
"mainPayStatementFields",
"earnings"
],
"properties": {
"earnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Earnings"
},
"description": "Categorization of pay, for the pay period"
},
"deductions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Deductions"
},
"description": "Deductions from the pay check"
},
"directDeposits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DirectDeposits"
},
"description": "Direct deposit information for the paycheck"
},
"payrollPayHistoryId": {
"type": "string",
"example": "qsrt2hmjnf",
"description": "An ID for the income and employment details for the given pay period"
},
"lastPayPeriodIndicator": {
"type": "boolean",
"example": true,
"description": "Most recent available pay check"
},
"mainPayStatementFields": {
"$ref": "#/components/schemas/MainPayStatementFields"
}
}
}
DisplayPosition
{
"type": "integer",
"format": "int32",
"example": 2,
"description": "Display position of the account at the financial institution, \"1\"\n being the top listed account"
}
DisplayingResults
{
"type": "integer",
"example": 1,
"description": "The number of results returned"
}
DocumentDate
{
"type": "string",
"description": "The date when the statement was generated."
}
Earnings
{
"type": "object",
"required": [
"type",
"amount"
],
"properties": {
"name": {
"type": "string",
"example": "bonusPayAmount",
"description": "Where available, the employer description of earnings on the paycheck"
},
"rate": {
"type": "number",
"example": 19,
"description": "Rate of pay"
},
"type": {
"type": "string",
"example": "bonus",
"description": "Categorization of the earnings:\n\n* `base`\n\n* `bonus`\n\n* `overtime`\n\n* `commission`\n\n* `tips`\n\n* `other`\n"
},
"amount": {
"type": "number",
"example": 589,
"description": "Earnings amount for each earning type"
},
"amountYTD": {
"type": "number",
"example": 14301.25,
"description": "Earnings YTD amount if available"
}
}
}
EmailAddress
{
"type": "string",
"example": "myname@mycompany.com",
"description": "An email address"
}
EmailDomainCreationDate
{
"type": "string",
"example": "2011-06-29T00:00:00.000Z",
"description": "Returns a date that the email domain was created."
}
EmailFirstSeenDays
{
"type": "number",
"example": 453,
"description": "Count of days since the email was first observed in Ekata's Identity Network. If the email has not been observed before, first_seen_days will be 0."
}
EmailOptions
{
"type": "object",
"required": [
"to"
],
"properties": {
"to": {
"type": "string",
"example": "bob@example.com",
"description": "The email address for the customer receiving the Connect email"
},
"from": {
"type": "string",
"example": "test.lender@test.com",
"description": "The name of a person or business sending the Connect email"
},
"subject": {
"type": "string",
"example": "Verify your income",
"description": "The subject line of the email. The default is \"Verify your Financial Information\"."
},
"firstName": {
"type": "string",
"example": "Bob",
"description": "The first name of the customer or both names of the customers for joint borrowers. Example: \"Marvin and Jenny\"."
},
"signature": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Cindy Mayfield",
"Senior Loan Officer",
"Direct 123-456-7890"
],
"description": "A signature for the email"
},
"supportPhone": {
"type": "string",
"example": "800-555-5555",
"description": "The support phone number listed in the email"
},
"institutionName": {
"type": "string",
"example": "Acme Lending",
"description": "The name of your company"
},
"institutionAddress": {
"type": "string",
"example": "222 Winnipeg Drive SLC UT, 84109",
"description": "The institution address to appear in the footer of the email"
}
},
"description": "Configuration for the Connect email's sent to customers"
}
EmailToName
{
"type": "string",
"example": "not found",
"description": "The match status between the input name and the queried entity.\n* not found\n* match\n* no-match"
}
EmailValid
{
"type": "boolean",
"example": true,
"description": "True if the email address is valid."
}
Employee
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Patrick Purchaser",
"description": "The name of the employee"
}
}
}
Employer
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Rocket Surgery",
"description": "The name of the employer"
}
}
}
EmployerName
{
"type": "string",
"example": "ACME INC",
"description": "Name of the employer as stated by the employer in the payroll system"
}
EmploymentId
{
"type": "string",
"example": "123v3bv2s5n",
"description": "This is a Mastercard assigned ID to the employment record. It remains consistent for that employment record, even if the report is refreshed. It can be used to limit the employment records that are returned in the report."
}
ErrorMessage
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "object",
"example": "10001",
"description": "An error code (can be returned as a number or a string). Useful links: [Common API Status Codes](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/#common-api-status-codes), [Aggregation Status Codes](https://developer.mastercard.com/open-banking-us/documentation/products/manage/account-aggregation/#aggregation-status-codes)."
},
"level": {
"type": "string",
"example": "error",
"description": "An error level"
},
"title": {
"type": "string",
"example": "Connecting accounts error",
"description": "A title for the error"
},
"status": {
"type": "string",
"example": "401",
"description": "A status code"
},
"assetId": {
"$ref": "#/components/schemas/AssetId"
},
"message": {
"type": "string",
"example": "Invalid authorization credentials",
"description": "An error message"
},
"accountId": {
"$ref": "#/components/schemas/AccountId"
},
"user_message": {
"type": "string",
"example": "The session has expired or is invalid",
"description": "Some more details about the error"
}
}
}
EstimateInclusion
{
"type": "string",
"example": "HIGH",
"description": "Possible values: \"HIGH\", \"MODERATE\", \"LOW\", \"NO\""
}
ExcludeEmpInfo
{
"type": "boolean",
"example": false,
"description": "Only used on an exception basis for clients that need to exclude EmpInfo data from the VOE-Payroll or VOIE-Payroll report. If true is passed EmpInfo payroll provider's data will not be searched or returned."
}
ExpectedPayoffDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "(Student Loan) The expected date of the payoff date. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
Experience
{
"type": "string",
"example": "default",
"description": "The `experience` field allows you to customize:\n* Brand: color and logo\n* Icon: displayed on the \"Share your data\" page \n* Popular institutions: displayed on the Bank Search page \n* Report: the credit decisioning report to send when Connect completes. \n* MVS modules: financial, payroll, paystub\n\nNote: the Finicity sales engineers (SE) help you set up a default experience for your company when you migrate to Connect 2.0. For each additional experience you create thereafter, they'll give you a unique ID. See [Generate Connect URL](https://developer.mastercard.com/open-banking-us/documentation/connect/generate-2-connect-url-apis/).\n\nExperience values options: \n* \"default\": your default experience (must be defined) \n* GUID: the code for a different experience\n* Not defined: If you don't pass the experience parameter, then Connect's out of the box default experience (add accounts but no branding) is used, and the MVS modules will not run."
}