Preview Payment Split

This request allows you preview a split payment and how it will affect the loans' Payment BreakdownPayment Breakdown - Specified application of a payment to different components of a loan such as interest, principal, fees, and more..

General

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. Here's what you need to know about this request:

  • This request only previews a payment split—it does not apply the payment. (You will need to use the 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 BreakdownPayment Breakdown - Specified application of a payment to different components of a loan such as interest, principal, fees, and more. for each loan included in the payment.
  • Unlike when actually 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.

Database

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

{
    "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"
}

🚧

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.

This request requires two separate objects within the splitLoans array, and you will need to create them manually.

After clicking the "+" icon to create the splitLoans array, you will need to create a second object by clicking 'ADD OBJECT' within the payload parameters. Then, you will need to list a separate loan ID in the second array. (And if you'd like, feel free to model it after our sample payload above and use the IDs of 9114 and 9111.)

If you would like to try this request with your own tenant credentials, 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!