This is the Plaid schema guide.


Transactions

From Yodlee to Plaid

YODLEE 

{
	"date": "string",
	"sourceId": "string",
	"symbol": "string",
	"cusipNumber": "string",
	"highLevelCategoryId": 0,
	"detailCategoryId": 0,
	"description": : {
		"security": "string",
		"original": "string",
		"simple": "string",
		"consumer": "string"
		},
	"memo": "string",
	"settleDate": "string",
	"type": "string",
	"baseType": "CREDIT",
	"categorySource": "SYSTEM",
	"principal": {
		"amount": 0,
		"currency": "USD"
		},
	"lastUpdated": "string",
	"interest": {
		"amount": 0,
		"currency": "USD"
		},
	"price": {
		"amount": 0,
		"currency": "USD"
		},
	"commission": {
		"amount": 0,
		"currency": "USD"
		},
	"id": 0,
	"amount": {
		"amount": 0,
		"currency": "USD"
		},
	"checkNumber": "string",
	"quantity": 0,
	"valoren": "string",
	"isManual": true,
	"merchant": {
		"website": "string",
		"address": {
			"zip": "string",
			"country": "string",
			"address3": "string",
			"address2": "string",
			"city": "string",
			"sourceType": "string",
			"address1": "string",
			"street": "string",
			"state": "string",
			"type": "HOME"
		},
		"contact": {
			"phone": "string",
			"email": "string"
		},
		"categoryLabel": [
			"string"
		],
		"coordinates": {
			"latitude": 0,
			"longitude": 0
		},
		"name": "string",
		"id": "string",
		"source": "YODLEE"
	},
	"sedol": "string",
	"transactionDate": "string",
	"categoryType": "TRANSFER",
	"accountId": 0,
	"createdDate": "string",
	"sourceType": "AGGREGATED",
	"CONTAINER": "bank",
	"postDate": "string",
	"parentCategoryId": 0,
	"subType": "AUTH_HOLD",
	"category": "string",
	"runningBalance": {
		"amount": 0,
		"currency": "USD"
	},
	"categoryId": 0,
	"holdingDescription": "string",
	"isin": "string",
	"status": "POSTED"
}
PLAID

{
    "accounts": [{
        "account_id": "string",
        "balances": {
            "available": "number" | null,
            "current": "number" | null,
            "iso_currency_code": "string" | null,
            "limit": "number" | null,
            "unofficial_currency_code": "string" | null
        },
        "mask": "string" | null,
        "name": "string",
        "official_name": "string" | null,
        "subtype": "string" | null,
        "type": "string"
    }],
    "transactions": [{
        "account_id": "string",
        "amount": "number",
        "iso_currency_code": "string" | null,
        "unofficial_currency_code": "string" | null,
        "category": ["string"] | null,
        "category_id": "string" | null,
        "date": "string",
        "authorized_date": "string" | null,
        "location": {
            "address": "string" | null,
            "city": "string" | null,
            "region": "string" | null,
            "postal_code": "string" | null,
            "country": "string" | null,
            "lat": "number" | null,
            "lon": "number" | null,
            "store_number": "string" | null,
        },
        "name": "string",
        "merchant_name": "string" | null,
        "payment_meta": {
            "by_order_of": "string" | null,
            "payee": "string" | null,
            "payer": "string" | null,
            "payment_method": "string" | null,
            "payment_processor": "string" | null,
            "ppd_id": "string" | null,
            "reason": "string" | null,
            "reference_number": "string" | null
        },
        "payment_channel": "string",
        "pending": "boolean",
        "pending_transaction_id": "string" | null,
        "account_owner": "string" | null,
        "transaction_id": "string",
        "transaction_code": "string" | null,
        "transaction_type": "string"
    }],
    "item": {
        "available_products": ["string"],
        "billed_products": ["string"],
        "consent_expiration_time": "string" | null,
        "error": {
            "error_type": "string",
            "error_code": "string",
            "error_message": "string",
            "display_message": "string" | null,
            "request_id": "string",
            "causes": "array",
            "status": "number" | null,
            "documentation_url": "string",
            "suggested_action": "string"
        },
        "institution_id": "string" | null,
        "item_id": "string",
        "update_type": "string",
        "webhook": "string" | null
    },
    "total_transactions": "number",
    "request_id": "string"
}

Translations

Translation Notes


Accounts

Schema

YODLEE

{
  "account": [
    {
      "availableCash": {
        "amount": 0,
        "currency": "AUD"
      },
      "includeInNetWorth": true,
      "moneyMarketBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "enrollmentDate": "string",
      "estimatedDate": "string",
      "memo": "string",
      "guarantor": "string",
      "interestPaidLastYear": {
        "amount": 0,
        "currency": "AUD"
      },
      "lastUpdated": "string",
      "balance": {
        "amount": 0,
        "currency": "AUD"
      },
      "homeInsuranceType": "HOME_OWNER",
      "id": 0,
      "cash": {
        "amount": 0,
        "currency": "AUD"
      },
      "totalCreditLine": {
        "amount": 0,
        "currency": "AUD"
      },
      "providerName": "string",
      "valuationType": "SYSTEM",
      "marginBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "apr": 0,
      "availableCredit": {
        "amount": 0,
        "currency": "AUD"
      },
      "currentBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "isManual": true,
      "profile": {
        "identifier": [
          {
            "type": "NIE",
            "value": "string"
          }
        ],
        "address": [
          {
            "zip": "string",
            "country": "string",
            "address3": "string",
            "address2": "string",
            "city": "string",
            "sourceType": "string",
            "address1": "string",
            "street": "string",
            "state": "string",
            "type": "HOME"
          }
        ],
        "phoneNumber": [
          {
            "type": "HOME",
            "value": "string"
          }
        ],
        "email": [
          {
            "type": "PRIMARY",
            "value": "string"
          }
        ]
      },
      "escrowBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "nextLevel": "string",
      "classification": "OTHER",
      "loanPayoffAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "interestRateType": "FIXED",
      "loanPayByDate": "string",
      "faceAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "policyFromDate": "string",
      "premiumPaymentTerm": "string",
      "policyTerm": "string",
      "repaymentPlanType": "STANDARD",
      "availableBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "accountStatus": "ACTIVE",
      "lifeInsuranceType": "OTHER",
      "fullAccountNumber": "string",
      "premium": {
        "amount": 0,
        "currency": "AUD"
      },
      "aggregationSource": "SYSTEM",
      "overDraftLimit": {
        "amount": 0,
        "currency": "AUD"
      },
      "nickname": "string",
      "term": "string",
      "interestRate": 0,
      "deathBenefit": {
        "amount": 0,
        "currency": "AUD"
      },
      "address": {
        "zip": "string",
        "country": "string",
        "address3": "string",
        "address2": "string",
        "city": "string",
        "sourceType": "string",
        "address1": "string",
        "street": "string",
        "state": "string",
        "type": "HOME"
      },
      "cashValue": {
        "amount": 0,
        "currency": "AUD"
      },
      "holder": [
        {
          "identifier": [
            {
              "type": "NIE",
              "value": "string"
            }
          ],
          "gender": "string",
          "ownership": "PRIMARY",
          "name": {
            "middle": "string",
            "last": "string",
            "fullName": "string",
            "first": "string"
          }
        }
      ],
      "401kLoan": {
        "amount": 0,
        "currency": "AUD"
      },
      "homeValue": {
        "amount": 0,
        "currency": "AUD"
      },
      "accountNumber": "string",
      "createdDate": "string",
      "interestPaidYTD": {
        "amount": 0,
        "currency": "AUD"
      },
      "providerAccountId": 0,
      "collateral": "string",
      "dataset": [
        {
          "lastUpdated": "string",
          "updateEligibility": "ALLOW_UPDATE",
          "additionalStatus": "LOGIN_IN_PROGRESS",
          "nextUpdateScheduled": "string",
          "name": "BASIC_AGG_DATA",
          "lastUpdateAttempt": "string"
        }
      ],
      "runningBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "sourceId": "string",
      "dueDate": "string",
      "frequency": "DAILY",
      "maturityAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "associatedProviderAccountId": [
        0
      ],
      "isAsset": true,
      "principalBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "totalCashLimit": {
        "amount": 0,
        "currency": "AUD"
      },
      "maturityDate": "string",
      "minimumAmountDue": {
        "amount": 0,
        "currency": "AUD"
      },
      "annualPercentageYield": 0,
      "accountType": "string",
      "originationDate": "string",
      "totalVestedBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "rewardBalance": [
        {
          "expiryDate": "string",
          "balanceToReward": "string",
          "balanceType": "EXPIRING_BALANCE",
          "balance": 0,
          "description": "string",
          "balanceToLevel": "string",
          "units": "string"
        }
      ],
      "sourceAccountStatus": "IN_REPAYMENT",
      "derivedApr": 0,
      "policyEffectiveDate": "string",
      "totalUnvestedBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "annuityBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "accountName": "string",
      "totalCreditLimit": {
        "amount": 0,
        "currency": "AUD"
      },
      "policyStatus": "ACTIVE",
      "shortBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "lender": "string",
      "lastEmployeeContributionAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "providerId": "string",
      "lastPaymentDate": "string",
      "primaryRewardUnit": "string",
      "lastPaymentAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "remainingBalance": {
        "amount": 0,
        "currency": "AUD"
      },
      "userClassification": "BUSINESS",
      "bankTransferCode": [
        {
          "id": "string",
          "type": "BSB"
        }
      ],
      "expirationDate": "string",
      "coverage": [
        {
          "amount": [
            {
              "cover": {
                "amount": 0,
                "currency": "AUD"
              },
              "unitType": "PER_FAMILY",
              "type": "DEDUCTIBLE",
              "limitType": "IN_NETWORK",
              "met": {
                "amount": 0,
                "currency": "AUD"
              }
            }
          ],
          "planType": "PPO",
          "endDate": "string",
          "type": "VISION",
          "startDate": "string"
        }
      ],
      "cashApr": 0,
      "autoRefresh": {
        "additionalStatus": "SCHEDULED",
        "asOfDate": "string",
        "status": "ENABLED"
      },
      "oauthMigrationStatus": "IN_PROGRESS",
      "displayedName": "string",
      "fullAccountNumberList": {
        "paymentAccountNumber": "string",
        "unmaskedAccountNumber": "string"
      },
      "amountDue": {
        "amount": 0,
        "currency": "AUD"
      },
      "currentLevel": "string",
      "originalLoanAmount": {
        "amount": 0,
        "currency": "AUD"
      },
      "policyToDate": "string",
      "loanPayoffDetails": {
        "payByDate": "string",
        "payoffAmount": {
          "amount": 0,
          "currency": "AUD"
        },
        "outstandingBalance": {
          "amount": 0,
          "currency": "AUD"
        }
      },
      "paymentProfile": {
        "identifier": {
          "type": "REFERENCE_NUMBER",
          "value": "string"
        },
        "address": [
          {
            "zip": "string",
            "country": "string",
            "address3": "string",
            "address2": "string",
            "city": "string",
            "sourceType": "string",
            "address1": "string",
            "street": "string",
            "state": "string",
            "type": "HOME"
          }
        ],
        "paymentBankTransferCode": {
          "id": "string",
          "type": "ROUTING_NUMBER"
        }
      },
      "CONTAINER": "bank",
      "lastEmployeeContributionDate": "string",
      "lastPayment": {
        "amount": 0,
        "currency": "AUD"
      },
      "recurringPayment": {
        "amount": 0,
        "currency": "AUD"
      }
    }
  ]
}
PLAID

{
    "accounts": [
        {
            "account_id": "string",
            "balances": {
                "available": "number" | null,
                "current": "number" | null,
                "iso_currency_code": "string" | null,
                "limit": "number" | null,
                "unofficial_currency_code": "string" | null
            },
            "mask": "string" | null,
            "name": "string",
            "official_name": "string" | null,
            "subtype": "string" | null,
            "type": "string"
        }
    ],
    "item": {
        "available_products": ["string"],
        "billed_products": ["string"],
        "consent_expiration_time": "string" | null,
        "error": {
            "error_type": "string",
            "error_code": "string",
            "error_message": "string",
            "display_message": "string" | null,
            "request_id": "string",
            "causes": "array",
            "status": "number" | null,
            "documentation_url": "string",
            "suggested_action": "string"
        } | null,
        "institution_id": "string" | null,
        "item_id": "string",
        "update_type": "string",
        "webhook": "string" | null,
    },
    "request_id": "string"
}

Accounts


Users


{
  "user": {
    "preferences": {
      "dateFormat": "string",
      "timeZone": "string",
      "currency": "AUD",
      "locale": "en_US"
    },
    "address": {
      "zip": "string",
      "country": "string",
      "address3": "string",
      "address2": "string",
      "city": "string",
      "address1": "string",
      "state": "string"
    },
    "loginName": "string",
    "name": {
      "middle": "string",
      "last": "string",
      "fullName": "string",
      "first": "string"
    },
    "id": 0,
    "roleType": "INDIVIDUAL",
    "email": "string",
    "segmentName": "string"
  }
}
**No support for Users**