Loan payment details
The Get Loan Payment Details API is used to retrieve information about payments made to general loan account types. You can also use this API to get student loan account information from one of Finicity’s certified student loan financial institutions.
Note: This is a premium service, billable per every successful API call.
Get loan payment details
The loan payment details API returns the following loan detail information:
Loan Number
Loan Payment Number
Loan Payment Address
curl -X GET \
--url 'https://api.finicity.com/aggregation/v1/customers/1005061234/accounts/1014136057/loanDetails' \
-H 'Finicity-App-Token: Finicity-App-Token'\
-H 'Finicity-App-Key: Finicity-App-Key'\
-H 'Accept: application/json'
--data-raw’
--data-raw '{
"loanNumber": "LN_10001",
"loanPaymentNumber": "LPN_10001",
"loanPaymentAddress": "434, West Ascension Way Suite"
}' {
"loanNumber": "LN_10001",
"loanPaymentNumber": "LPN_10001",
"loanPaymentAddress": "434, West Ascension Way Suite"
} Student loan accounts
You can retrieve student loan account information using the fields in the primary data fields list from student loan FIs. The secondary data fields are available at most certified student loan FIs.
Primary Data Fields
| Parameter | Type |
|---|---|
| Specific Student Loan Account Type | Student Loan Account Type indicated as a separate and distinct type from stand loan account types |
| Loan Sub Account Support | The connection has been modified to properly identify each individual sub student loan account and not just the overall summary |
| Loan Number | The specific loan number for the sub loan (Provided Through Loan Payment Details Service) |
| Loan Payment Number | The payment number from the lender (Provided Through Loan Payment Details Service) |
| Loan Payment Address | The payment address from the lender (Provided Through Loan Payment Details Service) |
| Loan Account Transactions | Account transaction aggregation is supported for certified student loan accounts |
Secondary Data Fields
| Parameter | Type |
|---|---|
| PDF Statements | The last 6 months of statements for the loan. Provided through the “Get Customer Account Statement” service |
| Loan Status | The status of the loan |
| Repayment Plan | The repayment plan for the loan |
| Loan End Date | The final payment date for the loan |
| Loan Origination Amount | The original amount of the loan |
| Loan Origination Date | The date the loan started |
| The date the loan started | The amount to payoff the loan |
| YTD Interest | The interest accrued on the loan YTD |
| Next Payment Amount | The amount of the next loan payment |
| YTD Principle | The principle amount paid year to date |
| Monthly Payment | Regular monthly payment amount |
Certified student loan financial institutions
| FI ID | FI Name |
|---|---|
| 13179 | EdFinancial Services |
| 3261 | American Education Services |
| 13739 | Firstmark Services |
| 101130 | Higher Education Student Assistance Authority |
| 3303 | UNIVERSITY ACCOUNTING SERVICE, LLC |
| 11814 | Great Lakes Educational Loan Services Inc. |
| 13319 | Mohela (SoFi Layout) |
| 31 | Wells Fargo |
| 100722 | Oklahoma Student Loan Authority (OSLA) – Direct Loan |
| 14551 | Granite State Management and Resources |
| 102073 | Sallie Mae Loan Service |
| 101988 | MOHELA – SoFi |
| 5640 | NelNet Student Loan |
| 100540 | Cornerstone Education Loan Services |
| 100646 | Aspire Servicing Center |
| 100302 | FedLoan Servicing |
| 101329 | ECMC |
| 102165 | Educational Computer Systems, Inc. (Heartland ECSI) |
| 12828 | Reunion Student Loan Finance Corporation |
| 102109 | LendKey Technologies, Inc |
| 12346 | THECB |
| 101749 | Navient Customer Loan Service |
| 170865 | U-fi by Union Bank |
| 170869 | Vemo Education |
| 102110 | Laurel Road – MOHELA |
| 100995 | Vermont Student Assistance Corporation |