Posting a payment
A simple way to post a payment into a loan using Postman
In this example we have a Principal and Interest receivable due on loan_id 10642 for the amount of $865.27. We will need to pay this off using the endpoint, /loans/{loan_id}/transactions/payments.
Step 1
Using Postman we will start a new request for /loans/{loan_id}/transactions/payments.
In the Params tab we will define the path variable loan_id which will determine where the payment will be posted.
10642 will be our loan_id.
Step 2
Payment post details will be configured in the Body tab and set to x-www-form-urlencoded. We will post a payment for the amount of $865.27 with an effective date set to 11/25/21.
Step 3
Click SEND to post the payment.
Don't Forget to Authenticate!
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)
If the payment post is successful we should get a 201 status code from Postman.
The JSON return is quite long. Notice that it returned 3 objects despite posting a single payment. This because the payment is broken down into 3 transaction JSON objects, Principal, Interest, and Total Payment Amount. Each object contain detailed information of the transaction.
{
"status": {
"code": 201,
"message": "Success"
},
"payload": {
"totalCount": 3,
"count": 3,
"data": [
{
"Transrefno": 231503,
"Transaction_Reference_No": 37734,
"Amortized_Fee_Id": null,
"Voucher_Id": null,
"Impound_Id": null,
"Creditline_Id": null,
"Transaction_Code": 206,
"Associated_Transrefno": 0,
"Reversal_Transrefno": 0,
"Participant_Reference_No": 0,
"Loan_Group_No": 1,
"Participant_Detail_Flag": false,
"Participantrefno": null,
"Ach_Trace_Number": "",
"Transaction_Date": "2021-12-16T23:42:11",
"Effective_Date": "2021-11-25T00:00:00",
"Batch_No": 0,
"Transaction_Amount": 59.45,
"Enteredby_Uid": 45,
"User_Reference": null,
"Comment_Indicator": 0,
"Transaction_Type": "I CN DIP DNA DNA DNA DX",
"Gl_Date": "2021-12-16T00:00:00",
"Transaction_Description": "P+I Interest Payment",
"Payment_Method_No": 1,
"Payment_Method_Reference": null,
"Userdef01": null,
"Memoentry": 0,
"Userdef02": null,
"Userdef03": null,
"Userdef04": null,
"Userdef05": null,
"Deposit_Id": null,
"Date_Due": "2021-11-25T00:00:00",
"Payment_Number": 1,
"PaymentGatewayTransactionID": null,
"Acctrefno": 10642,
"Accounting_Status": 0,
"IRS_Event_Code": ""
},
{
"Transrefno": 231504,
"Transaction_Reference_No": 37734,
"Amortized_Fee_Id": null,
"Voucher_Id": null,
"Impound_Id": null,
"Creditline_Id": null,
"Transaction_Code": 204,
"Associated_Transrefno": 0,
"Reversal_Transrefno": 0,
"Participant_Reference_No": 0,
"Loan_Group_No": 1,
"Participant_Detail_Flag": false,
"Participantrefno": null,
"Ach_Trace_Number": "",
"Transaction_Date": "2021-12-16T23:42:11",
"Effective_Date": "2021-11-25T00:00:00",
"Batch_No": 0,
"Transaction_Amount": 805.82,
"Enteredby_Uid": 45,
"User_Reference": null,
"Comment_Indicator": 0,
"Transaction_Type": "P CN DPP DNA DNA DNA DX",
"Gl_Date": "2021-12-16T00:00:00",
"Transaction_Description": "P+I Principal Payment",
"Payment_Method_No": 1,
"Payment_Method_Reference": null,
"Userdef01": null,
"Memoentry": 0,
"Userdef02": null,
"Userdef03": null,
"Userdef04": null,
"Userdef05": null,
"Deposit_Id": null,
"Date_Due": "2021-11-25T00:00:00",
"Payment_Number": 1,
"PaymentGatewayTransactionID": null,
"Acctrefno": 10642,
"Accounting_Status": 0,
"IRS_Event_Code": ""
},
{
"Transrefno": 231505,
"Transaction_Reference_No": 37734,
"Amortized_Fee_Id": null,
"Voucher_Id": null,
"Impound_Id": null,
"Creditline_Id": null,
"Transaction_Code": 10,
"Associated_Transrefno": 0,
"Reversal_Transrefno": 0,
"Participant_Reference_No": 0,
"Loan_Group_No": 1,
"Participant_Detail_Flag": false,
"Participantrefno": null,
"Ach_Trace_Number": "",
"Transaction_Date": "2021-12-16T23:42:11",
"Effective_Date": "2021-12-16T00:00:00",
"Batch_No": 0,
"Transaction_Amount": 865.27,
"Enteredby_Uid": 45,
"User_Reference": null,
"Comment_Indicator": 0,
"Transaction_Type": "N DN DNA DNA DNA DNA DX",
"Gl_Date": "2021-12-16T00:00:00",
"Transaction_Description": "Trust Deposit",
"Payment_Method_No": 1,
"Payment_Method_Reference": null,
"Userdef01": null,
"Memoentry": 0,
"Userdef02": null,
"Userdef03": null,
"Userdef04": null,
"Userdef05": null,
"Deposit_Id": 34568,
"Date_Due": null,
"Payment_Number": 0,
"PaymentGatewayTransactionID": null,
"Acctrefno": 10642,
"Accounting_Status": 0,
"IRS_Event_Code": ""
}
]
}
}
NLS Web Client
Here is our posted payment as shown in NLS Web Client.
Updated about 2 years ago