Parent-Child Loan Linking

This request allows you to link multiple loans via a parent-child relationship.

General

Parent-child loan linking lets you designate multiple loans as the child of a single parent loan. When transactions are posted to the parent loan, a transaction is also posted to each child loan in a specified percentage. Here's what you need to know about this request:

  • This request is sent through an endpoint including the parent loan's ID. Then, the LoanChilds object is included in the payload to link child loans.
  • You need a minimum of one parent loan and one child loan; however, you can set multiple child loans.
  • Your loans must not have any current links to other loans. These links are one-dimensional—if a loan is a child to a parent loan, it cannot act as a parent to any other loan.
  • The percentage fields in the LoanChilds array(s) need to add up to exactly 100. This field determines the percentage split of the transactions made on the loans.

For more information, see our Parent-Child Loan Linking article on our help site.

And for an example of how loan linking works within the UI, check out our Parent-Child Loan Linking article.

Database

For information on loans and database tables, see the following articles:

{  
   "LoanChilds":{  
      "results":[  
         {  
            "id": null,
            "childId":"9337",
            "enrolled":1,
            "percentage":50
         },
         {  
            "id": null,
            "childId":"9411",
            "enrolled":1,
            "percentage":50
         }
      ]
   }
}

🚧

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.

Typically, we provide example information linked to our demo account in our requests. However, we can’t provide sample ID values that will work for multiple users since loans in this request can't be currently linked. Providing examples would result in a lot of 409 responses for anyone testing this request. 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 yourself, 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. You will also need a minimum of two loans that have not been linked to other loans.

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