Get Loan Payment Details
GET {{baseUrl}}/aggregation/v2/customers/{{customerId}}/accounts/{{loanAccountId}}/loanDetails
Return the loan payment details of the customer for a loan-type account.
Note: this is a premium service, billable per every successful API call.
Supported regions:
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Finicity-App-Key | string | ||
Accept | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{"loanNumber":"123456789","loanPaymentNumber":"5231123456789","loanPaymentAddress":"Heartland ECSI PO Box 718 Wexford PA 15090","accountDetail":{"accountId":"5011648377","accountNumber":"9876543210","accountPaymentNumber":"00001234895413","accountPaymentAddress":"P.O. Box 123 Sioux Falls, IA 51054","accountFuturePayoffAmount":10000,"accountFuturePayoffDate":"2022-01-01T00:00:00.000Z","groupDetail":[{"accountId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupPaymentNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupPaymentAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupFuturePayoffAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupFuturePayoffDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupLoanDetail":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"accountId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupPaymentNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupPaymentAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupFuturePayoffAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupFuturePayoffDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"groupLoanDetail":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"loanDetail":[{"accountId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanPaymentNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanPaymentAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanFuturePayoffAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanFuturePayoffDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"accountId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanPaymentNumber":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanPaymentAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanFuturePayoffAmount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"loanFuturePayoffDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}