Process payment

This request logs and process a payment via one of LoanPro's natively integrated payment processors.

   Click here to learn more about this request

Payments made on line of credit accounts reduce the account's current balance and free up available credit. Note the following when processing payments on a line of credit account:

LoanPro communicates with the payment processor via Secure Payments. This request initiates a money movement that is completed via the following steps:

  1. The payment is initiated via LoanPro and then sent to Secure Payments
  2. Secure Payments sends the payment information to the selected payment processor
  3. The payment processor attempts to process and payment and returns an immediate response to Secure Payments. The response is relayed back to LoanPro while the transaction waits to settle.
  4. Once the transaction settles, the payment processor notifies Secure Payments, which then notifies LoanPro. LoanPro then updates the account's information to reflect the final status of the payment.

If the line of credit is linked to other line of credit accounts, the payment amount can be allocated in two different ways:

1. individually on the child line of credit

Logging a payment on the parent line allows you to split the payment across child lines. LMS will automatically update the child lines to reflect the payment.

2. broadly on the parent line

Logging a payment on the child line allows you to apply payments on individual accounts. LMS will automatically update the parent line to reflect the payment.

ℹ️

This request interacts with Compliance Guardrails.

Compliance Guardrails are a LoanPro feature that helps ensure actions taken on accounts are done so compliantly with lending laws. Once configured, these guardrails are applied to a line of credit program, ensuring all accounts within that program adhere to the same compliance standards.

Guardrails are configurable, allowing you to set rule criteria for which accounts should either result in a warning or an error. If your request attempt is flagged by a guardrail, a 409 response code is returned along with one of the following responses:

{ "error": { "message": "", "type": "GuardrailEvaluationException", "code": 409 }, "warnings": [ "<p>CARD Act Warning: This is a configurable warning message.</p>" ] }
{ "error": { "message": "CARD Act Compliance: This is a configurable error message.", "type": "GuardrailEvaluationException", "code": 409 } }

Guardrail flags can be ignored for testing purposes by adding "ignoreGuardrailWarnings": true to the payload of this request.

Database

For information regarding Line of Credit and Payment database tables, see the following articles:

Database – Line of Credit Payments (line_of_credit_payment_entity)

Database – Line of Credit Payment Type (line_of_credit_payment_type_entity)

Database – Line of Credit Account (line_of_credit_entity)

{ "entityId": 35, "entityType": "Entity.LineOfCredit", "status": "lineOfCredit.transactionStatus.pending", "description": "JULY STATEMENT PAYMENT", "applyDate": "2024-07-15", "amount": 2.39, "displayId": "102937", "echeckAuthType": "payment.echeckauth.WEB", "paymentTypeId": 1, "paymentProcessorId": 17, "paymentMethodId": 4, "paymentAccountId": 190, "chargeFeeType": "lineOfCredit.convenienceFeeType.waiveConvenienceFee", "chargeFeeAmount": 0, "chargeFeePercentage": 0, "isSplit": 0, "paymentSplitTypeId": null, "ignoreGuardrailWarnings": false }
Query Params
string

Optional parameter that determines whether to wait to receive a successful 200 response until the calculator has updated all loan values affected by the payment.
> Set this field to calc-response to wait for calculations to finish before receiving a 200 response.
> Please note that using this param will likely cause longer request times when applying payments to an account.

Body Params
int32
required

The ID of the associated entity. In this context, this is the ID of the associated line of credit account.

string
required

The type of the entity on which the payment will be processed. In the context of this request, this field should be set as "Entity.LineOfCredit".

string
required

The processing status of the payment. This field should be set as pending when initiating a new payment.

date
required

The date on which the payment will be applied.
> Formatted as YYYY-MM-DD

string
required

A text description of the payment.
> Limited to 255 characters

float
required

The numeric amount of the payment.

int32

An optional, user-defined ID that represents the payment. This is useful for implementing the same identification for payments in separate systems of record.

string
required

the method in which the payment is authorized.
> For more information on these values, click here

int32
required

The ID of the payment waterfall application.
> Payment type IDs can be found under Settings > Line of Credit > Payments > Payment Types within the UI.

int32
required

The ID of the payment processor used to process the payment.
> If you are using a merchant processor group or the default processor, set this field as 0.
> These IDs can be found under Settings > Company > Merchant > Secure Payments.

int32
required

The Payment Method used for the payment.
> Payment method IDs can be found under Settings > Loan >Payments > Methods within the UI.

int32
required

The ID of the borrower's Payment Profile.
> This ID can be found within the customer's profile information.

string
required

The type of the convenience fee that will apply to the payment.

float

A flat convenience fee amount applied to the payment.
> This field applies if the chargeFeeType field is set to one of the following:
    > flatFee
    > lesser
    > greater

float

The percentage-based convenience fee amount applied to the payment. This is a percentage of the payment amount.
> This field applies if the chargeFeeType field is set to one of the following:
    > percentage
    > lesser
    > greater

int32

Determines whether the payment will be split between the main account and linked accounts.
> 1 - yes, 0 - no

int32

The ID of the split payment configuration.

boolean

Optional field that bypasses warnings and errors provided by Compliance Guardrails. See the learn more section above to learn about Compliance Guardrails.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json