Plaid::StudentLoan
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Contains details about a student loan account
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned
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).
Custom attribute writer method checking allowed values (enum). @param [Object] account_number Object to be assigned
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 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] disbursement_dates Object to be assigned
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 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] expected_payoff_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] guarantor Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] interest_rate_percentage Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] is_overdue Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_amount Object to be assigned
The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_date Object to be assigned
The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] last_statement_issue_date Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] loan_name Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] loan_status Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] minimum_payment_amount Object to be assigned
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 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] next_payment_due_date Object to be assigned
The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
Custom attribute writer method checking allowed values (enum). @param [Object] origination_date Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] origination_principal_amount Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] outstanding_interest_amount Object to be assigned
The relevant account number that should be used to reference this loan for payments. In the majority of cases, payment_reference_number will match account_number, but in some institutions, such as Great Lakes (ins_116861), it will be different.
Custom attribute writer method checking allowed values (enum). @param [Object] payment_reference_number Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] pslf_status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] repayment_plan Object to be assigned
The sequence number of the student loan. Heartland ECSI (ins_116948) does not make this field available.
Custom attribute writer method checking allowed values (enum). @param [Object] sequence_number Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] servicer_address Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
The year to date (YTD) interest paid. Availability for this field is limited.
Custom attribute writer method checking allowed values (enum). @param [Object] ytd_interest_paid Object to be assigned
The year to date (YTD) principal paid. Availability for this field is limited.