Pulling Payment History
A quick example of pulling a loan's payment history
We will be using the GET endpoint, /loans/{loan_id}/payment-history, to return payment history for a given loan.
Response Example
The method will return the following attributes per payment in JSON format:
{
"status": {
"code": 200,
"message": "string"
},
"payload": {
"totalCount": 0,
"count": 0,
"data": [
{
"Row_Id": 0,
"Payment_Reference_No": 0,
"Transaction_Reference_No": 0,
"Date_Due": "2021-12-06T02:48:16.817Z",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": 0,
"Date_Paid": "2021-12-06T02:48:16.817Z",
"Payment_Number": 0,
"Gl_Date": "2021-12-06T02:48:16.817Z",
"Payment_Type": "string",
"Payment_Amount": 0,
"Payment_Description": "string",
"Transaction_Code": 0,
"User_Reference": "string",
"Memoentry": 0,
"Payment_Method_Reference": "string",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "string",
"Ach_Trace_Number": "string",
"Userdef02": "string",
"Userdef03": "string",
"Userdef04": "string",
"Userdef05": "string",
"Nsf_Flag": true,
"Nsf_Date": "2021-12-06T02:48:16.817Z",
"Acctrefno": 0,
"Payment_Method_No": 0,
"Bulk_Payment_Id": 0,
"Paid_By_Cifno": 0
}
]
}
}
Postman Example
This is a loan's payment history as shown in the NLS application showing 4 Principal and Interest payments made. We will pull this data from the API.
Step 1
Open the request method, /loans/{loan_id}/payment-history in Postman. In this example below we will be pulling payment history for loan_id (acctrefno) 10633. This is how the request will look like in Postman.
Step 2
Click SEND.
Auth Token
Make sure to authorize with a token before sending the request.
[Check out how to get an access token] (https://apidocs.nortridge.com/docs/get-access-token)
Request Output
The payment history will be returned in JSON format. Each object (count) inside payload represents a single line item from the payment history. You may notice that there is a count of 12. If you look back at the NLS application payment history example, there are 4 P/I payments. Each one is composed of a Principal, Interest, and Total Sum.
You will see a Status Code 200 if the request is successful.
{
"status": {
"code": 200,
"message": "Success"
},
"payload": {
"totalCount": 12,
"count": 12,
"data": [
{
"Row_Id": 136503,
"Payment_Reference_No": 37680,
"Transaction_Reference_No": 37681,
"Date_Due": null,
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-09-05T00:00:00",
"Payment_Number": 0,
"Gl_Date": "2021-09-05T00:00:00",
"Payment_Type": "ZZ",
"Payment_Amount": 846.94,
"Payment_Description": "PAYMENT",
"Transaction_Code": 0,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136504,
"Payment_Reference_No": 37680,
"Transaction_Reference_No": 37681,
"Date_Due": "2021-09-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-09-05T00:00:00",
"Payment_Number": 1,
"Gl_Date": "2021-09-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 25.47,
"Payment_Description": "P+I Interest Payment",
"Transaction_Code": 206,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136505,
"Payment_Reference_No": 37680,
"Transaction_Reference_No": 37681,
"Date_Due": "2021-09-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-09-05T00:00:00",
"Payment_Number": 1,
"Gl_Date": "2021-09-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 821.47,
"Payment_Description": "P+I Principal Payment",
"Transaction_Code": 204,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136506,
"Payment_Reference_No": 37682,
"Transaction_Reference_No": 37683,
"Date_Due": null,
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-10-05T00:00:00",
"Payment_Number": 0,
"Gl_Date": "2021-10-05T00:00:00",
"Payment_Type": "ZZ",
"Payment_Amount": 846.94,
"Payment_Description": "PAYMENT",
"Transaction_Code": 0,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136507,
"Payment_Reference_No": 37682,
"Transaction_Reference_No": 37683,
"Date_Due": "2021-10-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-10-05T00:00:00",
"Payment_Number": 2,
"Gl_Date": "2021-10-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 22.64,
"Payment_Description": "P+I Interest Payment",
"Transaction_Code": 206,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136508,
"Payment_Reference_No": 37682,
"Transaction_Reference_No": 37683,
"Date_Due": "2021-10-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-10-05T00:00:00",
"Payment_Number": 2,
"Gl_Date": "2021-10-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 824.30,
"Payment_Description": "P+I Principal Payment",
"Transaction_Code": 204,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136509,
"Payment_Reference_No": 37684,
"Transaction_Reference_No": 37685,
"Date_Due": null,
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-11-05T00:00:00",
"Payment_Number": 0,
"Gl_Date": "2021-11-05T00:00:00",
"Payment_Type": "ZZ",
"Payment_Amount": 846.94,
"Payment_Description": "PAYMENT",
"Transaction_Code": 0,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136510,
"Payment_Reference_No": 37684,
"Transaction_Reference_No": 37685,
"Date_Due": "2021-11-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-11-05T00:00:00",
"Payment_Number": 3,
"Gl_Date": "2021-11-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 21.28,
"Payment_Description": "P+I Interest Payment",
"Transaction_Code": 206,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136511,
"Payment_Reference_No": 37684,
"Transaction_Reference_No": 37685,
"Date_Due": "2021-11-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-11-05T00:00:00",
"Payment_Number": 3,
"Gl_Date": "2021-11-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 825.66,
"Payment_Description": "P+I Principal Payment",
"Transaction_Code": 204,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136512,
"Payment_Reference_No": 37686,
"Transaction_Reference_No": 37687,
"Date_Due": null,
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-12-05T00:00:00",
"Payment_Number": 0,
"Gl_Date": "2021-12-05T00:00:00",
"Payment_Type": "ZZ",
"Payment_Amount": 846.94,
"Payment_Description": "PAYMENT",
"Transaction_Code": 0,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136513,
"Payment_Reference_No": 37686,
"Transaction_Reference_No": 37687,
"Date_Due": "2021-12-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-12-05T00:00:00",
"Payment_Number": 4,
"Gl_Date": "2021-12-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 18.57,
"Payment_Description": "P+I Interest Payment",
"Transaction_Code": 206,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
},
{
"Row_Id": 136514,
"Payment_Reference_No": 37686,
"Transaction_Reference_No": 37687,
"Date_Due": "2021-12-05T00:00:00",
"Participant_Reference_No": 0,
"Consolidated_Reference_No": 0,
"Impound_Id": null,
"Date_Paid": "2021-12-05T00:00:00",
"Payment_Number": 4,
"Gl_Date": "2021-12-05T00:00:00",
"Payment_Type": "PI",
"Payment_Amount": 828.37,
"Payment_Description": "P+I Principal Payment",
"Transaction_Code": 204,
"User_Reference": "",
"Memoentry": 0,
"Payment_Method_Reference": "",
"Late_Fee_Code": 0,
"Batch_No": 0,
"Userdef01": "A",
"Ach_Trace_Number": "",
"Userdef02": "1234567890",
"Userdef03": "",
"Userdef04": "",
"Userdef05": "",
"Nsf_Flag": false,
"Nsf_Date": null,
"Acctrefno": 10633,
"Payment_Method_No": 0,
"Bulk_Payment_Id": null,
"Paid_By_Cifno": 2
}
]
}
}
Common Request Errors
401 - The request does not have a valid token.
403 - If you received a 403 error when calling this method, this means that the NLS Account (NLS username and password) does not have privileges to pull payment history. Please consult with an NLS admin and review account privileges.
404 - This means that the loan_id (acctrefno) does not exist.
NLS Web Client
Now that we have data on payment history, it can be used to display payment history on a customer or agent facing portal. Here is an example from the JSON output above being used to display payment history in the NLS Web Client.
Updated almost 3 years ago