ReportType
{
"type": "string",
"example": "voi",
"description": "A report type. Possible values:\n\n* `voi` \n\n* `voa` \n\n* `voaHistory` \n\n* `history` \n\n* `voieTxVerify` \n\n* `voieWithReport` \n\n* `voieWithInterview` \n\n* `paystatement` \n\n* `preQualVoa` \n\n* `assetSummary` \n\n* `voie` \n\n* `transactions` \n\n* `statement` \n\n* `voiePayroll` \n\n* `voeTransactions` \n\n* `voePayroll` \n\n* `cfrp` \n\n* `cfrb`\n\n* `barpcra`\n\n* `barpnoncra`\n\n* `barbcra`\n\n* `barbftc`\n\n* `barbnoncra`\n"
}
RoutingNumber
{
"type": "string",
"example": "123456789",
"description": "Routing number of receiving bank"
}
Rssd
{
"type": "integer",
"format": "int64",
"example": 490535,
"description": "The RSSD ID is a unique identifier assigned to financial institutions by the Federal Reserve. While the length of the RSSD ID varies by institution, it cannot exceed 10 numerical digits."
}
SecurityIdType
{
"type": "string",
"example": "CUSIP",
"description": "The security type. This field is related to the `securityId` field. Possible values:\n* \"CUSIP\"\n\n* \"ISIN\"\n\n* \"SEDOL\"\n\n* \"SICC\"\n\n* \"VALOR\"\n\n* \"WKN\""
}
ShowNsf
{
"type": "boolean",
"example": false,
"description": "Include the non-sufficient funds (NSF) summary JSON and the NSF summary PDF section in the report. Data included:\n* Account\n\n* Total number of NSF funds\n\n* Days since the most recent NFS funds fee"
}
SingleUseUrl
{
"type": "boolean",
"example": true,
"description": "\"true\": The URL link expires after a Connect session successfully completes.\n\nNote: when the `singleUseUrl` and the `experience` parameters are passed in the same call, the `singleUseUrl` value overrides the `singleUseUrl` value configured in the `experience` parameter."
}
SocialSecurityNumber
{
"type": "string",
"example": "999-99-9999",
"description": "A full SSN with or without hyphens"
}
SocialSecurityNumberLastDigits
{
"type": "string",
"example": "9999",
"description": "Last 4 digits of a SSN"
}
SocialSecurityNumberNoHyphens
{
"type": "string",
"example": "999999999",
"description": "The consumer's full SSN without hyphens"
}
State
{
"type": "string",
"example": "UT",
"description": "State"
}
StateAttribute
{
"type": "object",
"required": [
"attributeName",
"reportedByTimePeriods"
],
"properties": {
"attributeName": {
"type": "string",
"example": "NET_CASH_FLOW",
"description": "Name of Attribute as mentioned in Data Dictionary"
},
"reportedByTimePeriods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateTimeInterval"
},
"description": "List of state values grouped by specified Time Interval"
}
},
"description": "An attribute which represents some state over time, such as a balance or a\ncalculation, including derivatives, ratios, or projections. Reports the\nstate over the requested time interval(s)."
}
StatePeriod
{
"type": "object",
"required": [
"startDate",
"endDate",
"count",
"beginningValue",
"endingValue"
],
"properties": {
"max": {
"type": "number",
"example": 60.21,
"description": "Maximum amount during the period"
},
"min": {
"type": "number",
"example": 30.22,
"description": "Minimum amount during the period"
},
"sum": {
"type": "number",
"example": 90.43,
"description": "Sum of amounts during the period"
},
"mean": {
"type": "number",
"example": 42.22,
"description": "Mean of amounts during the period"
},
"count": {
"type": "integer",
"example": 2,
"description": "Count of data points during the period"
},
"median": {
"type": "number",
"example": 42.22,
"description": "Median of amounts during the period"
},
"endDate": {
"type": "string",
"format": "date",
"example": "2023-01-01",
"description": "End date for the period being reported"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2022-12-01",
"description": "Start date for the period being reported"
},
"endingValue": {
"type": "number",
"example": 60.21,
"description": "Value on the last date in the period"
},
"beginningValue": {
"type": "number",
"example": 60.21,
"description": "Value on the first date in the period"
},
"standardDeviation": {
"type": "number",
"example": 14.995,
"description": "Standard deviation of amounts during the period"
}
},
"description": "Statistics for one period in the report of a StateAttribute."
}
StateTimeInterval
{
"type": "object",
"required": [
"timeIntervalType",
"periods"
],
"properties": {
"periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatePeriod"
},
"description": "Periods of the specified time interval type, describing the attribute calculations"
},
"timeIntervalType": {
"$ref": "#/components/schemas/TimeIntervalTypeEnum"
}
},
"description": "For a StateAttribute, describes a time interval type being reported\nand a list of periods generated according to that type."
}
StatementData
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"accountId": {
"$ref": "#/components/schemas/NumericAccountId"
},
"statementIndex": {
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"maximum": 24,
"description": "Index of the statement to include in the report. Request statements from 1-24. By default, 1 is the most recent statement. Increase the index value to count back (by month) and retrieve its most recent statement."
}
}
}
StatementEndDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "(Credit Card/Line Of Credit) End date of statement period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
StatementReport
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseReportAck"
},
{
"type": "object",
"properties": {
"assetId": {
"$ref": "#/components/schemas/AssetId"
}
}
}
],
"description": "A Statement report"
}
StatementReportAck
{
"allOf": [
{
"$ref": "#/components/schemas/BaseReportAckWithPortfolioId"
},
{
"type": "object",
"properties": {
"constraints": {
"$ref": "#/components/schemas/StatementReportConstraints"
}
}
}
],
"required": [
"id",
"portfolioId",
"customerType",
"customerId",
"requestId",
"requesterName",
"createdDate",
"title",
"consumerId",
"consumerSsn",
"type",
"status",
"constraints"
],
"description": "A Statement report being generated"
}
StatementReportConstraints
{
"type": "object",
"required": [
"statementReportData"
],
"properties": {
"reportCustomFields": {
"$ref": "#/components/schemas/ReportCustomFields"
},
"statementReportData": {
"$ref": "#/components/schemas/StatementData"
}
}
}
StatementStartDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "(Credit Card/Line Of Credit) Start date of statement period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
StatementType
{
"type": "string",
"example": "taxStatement",
"description": "Account statement types"
}
StreamModel
{
"type": "object",
"required": [
"id",
"payor",
"payee",
"cadence",
"recency",
"transactionIds"
],
"properties": {
"id": {
"type": "string",
"example": "1",
"description": "Stream Id assigned to identified Stream"
},
"payee": {
"type": "string",
"example": "Walmart",
"description": "The party in the transaction that is receiving the funds"
},
"payor": {
"type": "string",
"example": "Elizabeth Johnson",
"description": "The party in the transaction that is sending the funds"
},
"cadence": {
"type": "integer",
"example": 30,
"description": "Number of days that occur between each transaction in the stream"
},
"recency": {
"type": "integer",
"example": 2,
"description": "Number of days since the last transaction occurred in the stream"
},
"transactionIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"6010290887",
"6010290914"
],
"description": "List of Transaction IDs that comprise the stream"
}
},
"description": "Describes a history of repeated transactions between the same parties."
}
StringUnixDate
{
"type": "string",
"format": "int64",
"example": "1607450357",
"description": "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/)."
}
StudentLoanDataCertification
{
"type": "boolean",
"example": true,
"description": "\"true\": The institution is certified for the Student Loan Data product\n\n\"false\": The institution is decertified for the Student Loan Data product"
}
SubscriptionId
{
"type": "integer",
"format": "int64",
"example": 17554874,
"description": "ID of a TxPush subscription"
}
SubscriptionRecord
{
"type": "object",
"required": [
"id",
"accountId",
"type",
"callbackUrl",
"signingKey"
],
"properties": {
"id": {
"$ref": "#/components/schemas/SubscriptionId"
},
"type": {
"$ref": "#/components/schemas/SubscriptionType"
},
"accountId": {
"$ref": "#/components/schemas/NumericAccountId"
},
"signingKey": {
"type": "string",
"example": "zg4U0v1IvTzFEHIXzJMxPHnfUwWZAMVpXrUuNuL9IvZI0QzkDdwp39IAKuNOFxOVqCOgHLMS1Zpe4ZL40NX83aJkqI6v0Ez5B7BLBtvr7Ag11kPH3uG1taTeOV0CTyI4LOg7ohSHn0DqaRu2aBq26KI90nYe0CecTCzzhu4yMXL43JV8YfydAexNdkzfg8tY44MlhBPUh2neHW2EFTT2ja4s4Ul10JgID03un8WBSrIm2adHw3QYJB4jk4k1e",
"description": "Signing key for events"
},
"callbackUrl": {
"$ref": "#/components/schemas/TxPushCallbackUrl"
}
},
"description": "TxPush subscription details"
}
SubscriptionType
{
"type": "string",
"example": "account",
"description": "A TxPush subscription type (\"account\" or \"transaction\")"
}
Suffix
{
"type": "string",
"example": "PhD",
"description": "A generational or academic suffix"
}
TaxId
{
"type": "string",
"example": "123-45-7890",
"description": "Country specific tax ID associated with the customer. \n* **United Stated**: Social Security number (SSN) or Taxpayer Identification Number (TIN)\n\n * Format: 123-45-7890\n\n* **Canada**: Social Insurance Number (SIM) or Numero d'assurance sociale (NAS)\n\n * Format: 123-456-789"
}
TestTxPushTransaction
{
"type": "object",
"required": [
"amount",
"description",
"transactionDate"
],
"properties": {
"amount": {
"type": "number",
"example": -4.25,
"description": "The amount of the transaction"
},
"status": {
"type": "string",
"default": "active",
"example": "pending",
"description": "\"active\" or \"pending\" (optional)"
},
"postedDate": {
"$ref": "#/components/schemas/UnixDate"
},
"description": {
"type": "string",
"example": "a testing transaction description",
"description": "The description of the transaction"
},
"transactionDate": {
"$ref": "#/components/schemas/UnixDate"
}
},
"description": "A fake transaction for TxPush testing"
}
ThirdPartyAccessKeyData
{
"type": "object",
"required": [
"customerId",
"partnerId",
"thirdPartyPartnerId",
"products"
],
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThirdPartyAccessProduct"
}
},
"partnerId": {
"$ref": "#/components/schemas/PartnerId"
},
"customerId": {
"$ref": "#/components/schemas/CustomerId"
},
"provenance": {
"$ref": "#/components/schemas/ThirdPartyAccessProvenance"
},
"thirdPartyPartnerId": {
"$ref": "#/components/schemas/PartnerId"
}
},
"description": "An object representing the third party access key request\n\n* `customerId`: This is recipient's customer identifier\n* `partnerId`: This is recipient partner identifier\n* `thirdPartyPartnerId`: This is requester's partner identifier\n* `products`: Array of values representing the Mastercard Open Banking APIs for\nwhich access needs to be generated."
}
ThirdPartyAccessKeyReceiptData
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThirdPartyAccessReceiptData"
}
}
},
"description": "An object representing the third party access key receipt\n\n * `customerId`: This is recipient's customerId represented as a\n pseudo identifier. \n * `accountId`: This is the value provided to recipient\n represented as a pseudo identifier for the accountId."
}
ThirdPartyAccessPeriod
{
"type": "object",
"required": [
"type",
"startTime",
"endTime"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ThirdPartyAccessPeriodTypes"
},
"endTime": {
"$ref": "#/components/schemas/DateTimeWithZone"
},
"startTime": {
"$ref": "#/components/schemas/DateTimeWithZone"
}
},
"description": "Object which describes access validity"
}
ThirdPartyAccessPeriodTypes
{
"type": "string",
"example": "timeframe",
"description": "Multiple types will be supported. Presently below types are supported.\n* \"timeframe\": Specifies a timeframe bounded by a startTime and endTime. \n The startTime is the time at which the access was granted and the\naccess key generated, \n and the endTime is the time at which the access was revoked. Times\nare represented in ISO 8601 format(\"2022-03-10T06:06:20Z\")"
}
ThirdPartyAccessProduct
{
"type": "object",
"required": [
"product",
"accountId",
"accessPeriod"
],
"properties": {
"payorId": {
"type": "string",
"example": "2445581559892",
"description": "The Finicity Partner ID who should be billed when the Requester requests data from Finicity. If no value specified, then the Recipient will be billed."
},
"product": {
"$ref": "#/components/schemas/ThirdPartyAccessProductTypes"
},
"maxCalls": {
"type": "integer",
"example": 200,
"description": "Max number of calls to the consented product (consented API)"
},
"accountId": {
"$ref": "#/components/schemas/AccountId"
},
"accessPeriod": {
"$ref": "#/components/schemas/ThirdPartyAccessPeriod"
}
},
"description": "Product for which access token to be generated"
}
ThirdPartyAccessProductTypes
{
"type": "string",
"example": "moneyTransferDetails",
"description": "Third party access token can be generated for the following product types:\n\n\n* \"moneyTransferDetails\": Retrieve account details for money transfer \n* \"availableBalance\": Retrieves the latest cached available and cleared\n account balances for an account. \n* \"availableBalanceLive\": Retrieves the available and cleared account\nbalances live from the financial institution \n* \"accountOwner\": Retrieves names and addresses of the account owner\nfrom a financial institution. \n* \"paymentIndicator\": Get the Payment Success Indicator response,\nscoring the likelihood of payment settlement \n* \"paymentFeedback\": Create feedback loop for Payment Success Indicator\n(PSI) and/or Payment Routing Optimizer (PRO) \n* \"paymentRouting\": Product recommends the best rail to use as well as\nthe best time to initiate the payment"
}
ThirdPartyAccessProof
{
"type": "object",
"properties": {
"keyId": {
"type": "string",
"example": "867-530-900",
"description": "The Finicity key identifier is used to sign the access key"
},
"signature": {
"type": "string",
"example": "JTdCyTIyY3VzdG9tZXJJZCUyMiUzQSUyMjU0NTQ1MTQwMDI5NTU2MjkzNDMlMjIlMkMlMjJwYXJ0bmVySWQlMjIlM0ElMjIyNDQ1NTgzOTIyNTM2JTIyJTJDJTIycHJvZHVjdHMlMjIlM0ElNUIlN0IlMjJhY2Nlc3NQZXJpb2QlMjIlM0ElN0IlMjJlbmRUaW1lJTIyJTNBJTIyMjAyMy0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIyc3RhcnRUaW1lJTIyJTNBJTIyMjAyMi0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIydHlwZSUyMiUzQSUyMnRpbWVmcmFtZSUyMiU3RCUyQyUyMmFjY291bnRJZCUyMiUzQSUyMjQ2MzM0MTU3NDM5NjAzNzQwMjQlMjIlMkMlMjJwcm9kdWN0JTIyJTNBJTIybW9uZXlUcmFuc2ZlckRldGFpbHMlMjIlN0QlMkMlN0IlMjJhY2Nlc3NQZXJpb2QlMjIlM0ElN0IlMjJlbmRUaW1lJTIyJTNBJTIyMjAyMy0xMC0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIyc3RhcnRUaW1lJTIyJTNBJTIyMjAyMi0xMS0yOVQwNiUzQTA2JTNBMjBaJTIyJTJDJTIydHlwZSUyMiUzQSUyMnRpbWVmcmFtZSUyMiU3RCUyQyUyMmFjY291bnRJZCUyMiUzQSUyMjQ2MzM0MTU3NDM5NjAzNzQwMjQlMjIlMkMlMjJwcm9kdWN0JTIyJTNBJTIybW9uZXlUcmFuc2ZlckRldGFpbHMlMjIlN0QlNUQlMkMlMjJwcm9maWxlJTIyJTNBMyUyQyUyMnByb3ZlbmFuY2UlMjIlM0FudWxsJTJDJTIycmVjZWlwdElkJTIyJTNBJTIyY3JfNHBmSTNyMVg4YU9IckREd3J3QzAxTkhDeE9YbFcxJTIyJTJDJTIycmVjZWlwdFZlcnNpb24lMjIlM0ExJTJDJTIydGltZXN0YW1wJTIyJTNBJTIyMjAyMi0xMS0yOVQxOCUzQTM1JTNBMDhaJTIyJTJDJTIydmVyc2lvbiUyMiUzQSUyMjElRjYlN9U=",
"description": "The digital signature for the \"receipt\" portion of the access key"
},
"timestamp": {
"$ref": "#/components/schemas/DateTimeWithZone"
}
},
"description": "An object representing a digital signature of the access key"
}
ThirdPartyAccessProvenance
{
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "P9YbR+srNVyQI35893d+BzPrhGMAAAAAuacVUt+3m4svbaFjVSbHEA==",
"description": "Calling client cookie"
},
"ipAddress": {
"type": "string",
"example": "8.8.8.8",
"description": "Calling client IP address"
},
"clientFingerprint": {
"type": "string",
"example": "LU9ZYxcDNQCwEmAxH52XFzaRiGMAAAAABclSKxW5S9P8pUMDV4fbpg",
"description": "Calling client identifier"
}
},
"description": "Provenance regarding the calling client like `clientFingerprint`, `ipAddress` and `token`."
}
ThirdPartyAccessReceipt
{
"type": "object",
"properties": {
"profile": {
"type": "integer",
"example": 3,
"description": "Representation of the type of consent receipt"
},
"version": {
"type": "string",
"example": "1",
"description": "A schema version of receipt"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThirdPartyAccessProduct"
}
},
"partnerId": {
"$ref": "#/components/schemas/PartnerId"
},
"receiptId": {
"type": "string",
"example": "cr_4pfI2r1X8aOHrDDwrwC01NHTxOXlT1",
"description": "This is officially the Consent Receipt ID, but is aliased as the Access Key ID. This is a unique identifier managed by Finicity that points to the contents of this JSON document."
},
"timestamp": {
"$ref": "#/components/schemas/DateTimeWithZone"
},
"customerId": {
"type": "string",
"example": "3465230025077724000",
"description": "This is recipient's customerId represented as a pseudo identifier"
},
"provenance": {
"$ref": "#/components/schemas/ThirdPartyAccessProvenance"
}
},
"description": "An object representing consent receipt"
}
ThirdPartyAccessReceiptData
{
"type": "object",
"properties": {
"proof": {
"$ref": "#/components/schemas/ThirdPartyAccessProof"
},
"receipt": {
"$ref": "#/components/schemas/ThirdPartyAccessReceipt"
}
},
"description": "An object representing consent access data"
}
TimeIntervalType
{
"type": "string",
"default": "MONTHLY_CALENDAR",
"example": "MONTHLY_CALENDAR",
"description": "Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLY_CALENDAR - MONTHLY_ROLLING_30"
}
TimeIntervalTypeEnum
{
"type": "string",
"default": "MONTHLY_CALENDAR",
"example": "MONTHLY_CALENDAR",
"description": "Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLY_CALENDAR - MONTHLY_ROLLING_30"
}
Transaction
{
"type": "object",
"required": [
"id",
"amount",
"accountId",
"customerId",
"status",
"description",
"createdDate"
],
"properties": {
"id": {
"$ref": "#/components/schemas/TransactionId"
},
"memo": {
"type": "string",
"example": "UWM HOLDINGS CORPORATION - CLASS A COMMON STOCK",
"description": "The institution must provide either a description, a memo, or both. We recommended concatenating the two fields into a single value."
},
"type": {
"$ref": "#/components/schemas/TransactionType"
},
"amount": {
"type": "number",
"example": -828.9,
"description": "The total amount of the transaction. Transactions for deposits are positive values, withdrawals and debits are negative values."
},
"status": {
"type": "string",
"example": "active",
"description": "One of \"active\", \"pending\", or \"shadow\" (see [Transaction Status](https://developer.mastercard.com/open-banking-us/documentation/products/manage/transaction-data/#transaction-status))"
},
"ticker": {
"type": "string",
"example": "UWMC",
"description": "Ticker symbol for the investment related to the transaction"
},
"checkNum": {
"type": "string",
"example": 299,
"description": "The check number of the transaction"
},
"accountId": {
"$ref": "#/components/schemas/NumericAccountId"
},
"feeAmount": {
"type": "number",
"example": 0.51,
"description": "The portion of the overall transaction amount applied to fees"
},
"unitPrice": {
"type": "number",
"example": 5.53,
"description": "Share price for the investment unit: stocks, mutual funds, ETFs"
},
"customerId": {
"$ref": "#/components/schemas/NumericCustomerId"
},
"incomeType": {
"type": "string",
"example": "DIV",
"description": "Capital gains applied in short, long, or miscellaneous terms for tax purposes"
},
"postedDate": {
"$ref": "#/components/schemas/TransactionPostedDate"
},
"securityId": {
"type": "string",
"example": "91823B109",
"description": "The security ID of the transaction"
},
"createdDate": {
"$ref": "#/components/schemas/TransactionCreatedDate"
},
"description": {
"type": "string",
"example": "Buy Stock",
"description": "The description value is from the financial institution (FI), often known as the payee. The value \"No description provided by institution\" is returned when the FI doesn't provide one"
},
"taxesAmount": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "Taxes applicable to the investment trade"
},
"escrowAmount": {
"type": "number",
"example": 2534,
"description": "The portion of the transaction allocated to escrow"
},
"unitQuantity": {
"type": "integer",
"format": "int32",
"example": 150,
"description": "The number of units (individual shares) in the transaction"
},
"effectiveDate": {
"$ref": "#/components/schemas/TransactionEffectiveDate"
},
"categorization": {
"$ref": "#/components/schemas/Categorization"
},
"currencySymbol": {
"type": "string",
"example": "USD",
"description": "If the foreign amount value is present then this is the currency code of that foreign amount"
},
"interestAmount": {
"type": "number",
"example": 132,
"description": "The portion of the transaction allocated to interest"
},
"securityIdType": {
"$ref": "#/components/schemas/SecurityIdType"
},
"splitNumerator": {
"type": "number",
"example": 20,
"description": "Numerator of the stock split for the transaction"
},
"subAccountFund": {
"type": "string",
"example": "MARGIN",
"description": "The sub account where the funds came from"
},
"suspenseAmount": {
"type": "number",
"example": 0.25,
"description": "Temporarily hold funds if you overpay or underpay your monthly payment"
},
"principalAmount": {
"type": "number",
"example": 32560,
"description": "The portion of the transaction allocated to principal"
},
"transactionDate": {
"$ref": "#/components/schemas/TransactionDate"
},
"commissionAmount": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "Transaction commission"
},
"optionExpireDate": {
"$ref": "#/components/schemas/TransactionOptionExpireDate"
},
"splitDenominator": {
"type": "number",
"example": 152,
"description": "Denominator of the stock split for the transaction"
},
"optionStrikePrice": {
"type": "number",
"example": 32560,
"description": "The strike price of the option contract"
},
"sharesPerContract": {
"type": "number",
"example": 100,
"description": "Shares per contract of the underlying stock option"
},
"firstEffectiveDate": {
"$ref": "#/components/schemas/TransactionFirstEffectiveDate"
},
"runningBalanceAmount": {
"type": "number",
"example": 1000,
"description": "The ending balance after the transaction was posted"
},
"subaccountSecurityType": {
"type": "string",
"example": "MARGIN",
"description": "The type of sub account the funds came from"
},
"investmentTransactionType": {
"$ref": "#/components/schemas/InvestmentTransactionTypes"
}
}
}
TransactionCreatedDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was added to our platform. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it occurred. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionEffectiveDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it became effective on an account by an institution. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionFirstEffectiveDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the first timestamp of the transaction recorded in the `effectiveDate` field. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionId
{
"type": "integer",
"format": "int64",
"example": 21284820852,
"description": "A transaction ID"
}
TransactionOptionExpireDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the timestamp of the transaction expiration date when it became expires on an account by an institution. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionPostedDate
{
"type": "integer",
"format": "int64",
"example": 1607450357,
"description": "A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was posted or cleared by the institution. This value isn't required for student loan transaction data. See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-banking-us/documentation/codes-and-formats/)."
}
TransactionType
{
"type": "string",
"example": "atm",
"description": "If provided by the institution, the following values may be returned in the field of a record:\n* \"atm\"\n\n* \"cash\"\n\n* \"check\"\n\n* \"credit\"\n\n* \"debit\"\n\n* \"deposit\"\n\n* \"directDebit\"\n\n* \"directDeposit\"\n\n* \"dividend\"\n\n* \"fee\"\n\n* \"interest\"\n\n* \"other\"\n\n* \"payment\"\n\n* \"pointOfSale\"\n\n* \"repeatPayment\"\n\n* \"serviceCharge\"\n\n* \"transfer\""
}