Process New Payment

This request allows you to process a new payment on a loan.

General

There are two types of payments that LoanPro handles: logged and logged and processed. They differ from each other slightly, and here's a breakdown of what a processed payment is:

🚧

This request will log AND process a payment

Logged and processed payments are those that are processed via LoanPro. In other words, a transfer of money was made, and LoanPro was directly involved in the transfer. This request will pull funds from a card or an account, and it will create a record of a transaction where money was exchanged. This type of payment applies to situations like the following:

  • A borrower pays with a credit or debit card
  • A borrower pays with a bank account

For more information, see our API – Logging a Payment article on our help site.

And for an example on how payments works within the UI, take a look at our Log a Payment article.

Database

For information on payment database tables, see the following articles:

{
    "Payments": {
        "results": [
            {
                "selectedProcessor": 0,
                "paymentMethodId": 3,
                "early": 0,
                "echeckAuthType": "payment.echeckauth.WEB",
                "amount": "303.78",
                "date": "2022-04-15",
                "info": "04/15/2022 Credit/Debit Card",
                "paymentTypeId": 1,
                "active": 1,
                "resetPastDue": 0,
                "payoffPayment": false,
                "CustomFieldValues": {
                    "results": []
                },
                "_saveProfile": 0,
                "extra": "payment.extra.tx.principal",
                "__processorName": "{\"id\":\"98\",\"key\":\"anet\",\"name\":\"Anet Default processor\",\"default\":\"1\"}",
                "paymentAccountId": 289,
                "chargeFeeType": "loan.cardfee.types.0",
                "chargeFeeAmount": 5,
                "chargeFeePercentage": 5,
                "payoffFlag": 0
            }
        ]
    }
}

🚧

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is a bit different.

We have included sample payload values for this request; but these values won't process an actual payment, so you won't get a 200 response from the Try It button. However, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.

To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.

Language
Authentication
Click Try It! to start a request and see the response here!