plaid2.model.student_loan module

class plaid2.model.student_loan.StudentLoan(*, origination_date: Optional[str] = None, last_payment_amount: Optional[float] = None, outstanding_interest_amount: Optional[float] = None, sequence_number: Optional[str] = None, loan_name: Optional[str] = None, minimum_payment_amount: Optional[float] = None, disbursement_dates: Optional[List[str]] = None, expected_payoff_date: Optional[str] = None, account_number: Optional[str] = None, interest_rate_percentage: float, origination_principal_amount: Optional[float] = None, payment_reference_number: Optional[str] = None, pslf_status: PslfStatus, servicer_address: ServicerAddressData, ytd_principal_paid: Optional[float] = None, ytd_interest_paid: Optional[float] = None, last_statement_issue_date: Optional[str] = None, account_id: Optional[str] = None, is_overdue: Optional[bool] = None, repayment_plan: StudentRepaymentPlan, guarantor: Optional[str] = None, last_payment_date: Optional[str] = None, loan_status: StudentLoanStatus, next_payment_due_date: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]: The ID of the account that this liability belongs to.

account_number: Optional[str]: The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

disbursement_dates: Optional[List[str]]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an [ISO 8601](https

expected_payoff_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an [ISO 8601](https

guarantor: Optional[str]: The guarantor of the student loan.

interest_rate_percentage: float: The interest rate on the loan as a percentage.

is_overdue: Optional[bool]: true if a payment is currently overdue. Availability for this field is limited.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_payment_amount: Optional[float]: The amount of the last payment.

last_payment_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date of the last payment. Dates are returned in an [ISO 8601](https

last_statement_issue_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date of the last statement. Dates are returned in an [ISO 8601](https

loan_name: Optional[str]: The type of loan, e.g., “Consolidation Loans”.

loan_status: StudentLoanStatus: An object representing the status of the student loan

minimum_payment_amount: Optional[float]: The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( ins_116861), Firstmark (ins_116295), Commonbond Firstmark Services (ins_116950), Nelnet (ins_116528), EdFinancial Services (ins_116304), Granite State (ins_116308), and Oklahoma Student Loan Authority (ins_116945). Firstmark (ins_116295 ) and Navient (ins_116248) will display as $0 if there is an autopay program in effect.

next_payment_due_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The due date for the next payment. The due date is null if a payment is not expected. A payment is not expected if loan_status.type is deferment, in_school, consolidated, paid in full, or transferred. Dates are returned in an [ISO 8601](https

origination_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).

Type: The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https

origination_principal_amount: Optional[float]: The original principal balance of the loan.

outstanding_interest_amount: Optional[float]: The total dollar amount of the accrued interest balance. For Sallie Mae ( ins_116944), this amount is included in the current balance of the loan, so this field will return as null.

classmethod parse_obj(data: Any) → StudentLoan[source]: Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → StudentLoan[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_reference_number: Optional[str]: The relevant account number that should be used to reference this loan for payments. In the majority of cases, payment_reference_number will match a`ccount_number,` but in some institutions, such as Great Lakes (ins_116861), it will be different.

pslf_status: PslfStatus: Information about the student’s eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is Fedloan (ins_116527).

repayment_plan: StudentRepaymentPlan: An object representing the repayment plan for the student loan

sequence_number: Optional[str]: The sequence number of the student loan. Heartland ECSI (ins_116948) does not make this field available.

servicer_address: ServicerAddressData: The address of the student loan servicer. This is generally the remittance address to which payments should be sent.

ytd_interest_paid: Optional[float]: The year to date (YTD) interest paid. Availability for this field is limited.

ytd_principal_paid: Optional[float]: The year to date (YTD) principal paid. Availability for this field is limited.