Preview payment split

Payment splits are used when multiple loans are linked together. For example, a single borrower may have several loans, and they may want to make a single payment that will apply to each of them. Note the following when using this request:

This request only_previews_ a payment split—it does not apply the payment. To split a payment, use the PUT Split payment request to apply the preview.

The main benefit of this request exists within the response it provides: A 200 response will list a preview of the Payment Breakdown for each loan included in the payment.

Unlike when applying a split payment, the preview does not require the loans to be linked. Also, the preview does not require the sum of the distribution of payments to match the total payment amount.

For an example of how split payments work within the UI, take a look at our Split a Payment article.

👆

Pay special attention to the endpoint of this request.

This request does not use OData, so it's not included in the endpoint like most other LMS requests.

Database

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

Database – Payments (payment_entity)

Database – Payment Defaults (defaults_payments)

Database – Additional Payment Information (payment_info_entity)

{
    "data": {
        "Date": "2022-04-19",
        "Amount": "100", // This is the total payment amount.
        "PaymentTypeId": 1,
        "Extra": "payment.extra.periods.principalonly",
        "chargeFeeType": "loan.cardfee.types.0",
        "chargeFeeAmount": 0,
        "chargeFeePercentage": 0,
        "early": 0
    },
    "splitLoans": [
        {
            "id": 9111,
            "displayId": "9111",
            "amount": "50" // This is a portion of the total payment amount that will apply to loan 9111.
        },
        {
            "id": "9114",
            "displayId": "9114",
            "amount": "50" // This is a portion of the total payment amount that will apply to loan 9114.
        }
    ],
    "splitFeeOptions": "loan.splitFee.option.0"
}