{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Loan Management Quickstart","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"loan-management-quickstart","__idx":0},"children":["Loan Management Quickstart"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Learn how to create and activate a loan in Peach through a practical example using a $10,000 personal installment loan."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also do this through the sandbox Admin Portal. This"," ","quickstart covers the API approach."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, ensure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An active Peach account with API access"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Valid API credentials"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A borrower already created in Peach"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A configured loan type in your account"]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The following examples use commonly used fields, but for full details, including additional data and parameters, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-docs/api-public"},"children":["API Reference"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-a-loan","__idx":2},"children":["Step 1: Create a Loan"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's create an installment loan with the following terms:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Principal: $10,000"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Term: 36 months"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Interest rate: 5.00% APR"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment frequency: Monthly"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Due date: 15th of each month"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Origination fee: $100"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/loans\nX-API-KEY: <YOUR-API-KEY>\nContent-Type: application/json\n\n{\n  \"loanTypeId\": \"LT-8765-4321\",\n  \"externalId\": \"LOAN-12345\", \n  \"type\": \"installment\",\n  \"servicedBy\": \"creditor\",\n  \"status\": \"originated\",\n  \"assetType\": \"personalClosedEndUnsecured\",\n  \"mainBorrowerId\": \"BO-1234-5678\",\n  \"newDrawsAllowed\": false,\n  \"atOrigination\": {\n    \"amountFinanced\": 10000,\n    \"principalAmount\": 10000,\n    \"duration\": 36,\n    \"paymentFrequency\": \"monthly\",\n    \"originationLicense\": \"stateLicense\",\n    \"originatingCreditorName\": \"Sample Bank\",\n    \"interestRates\": [\n      {\n        \"interestType\": \"absolute\",\n        \"days\": null,\n        \"rate\": 0.05\n      }\n    ],\n    \"specificDays\": [15],\n    \"fees\": {\n      \"originationFeeAmount\": 100\n    }\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes your loan ID and initial status:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": 200,\n  \"data\": {\n    \"loanId\": \"LN-9876-5432\",\n    \"status\": \"originated\",\n    \"type\": \"installment\"\n    ...\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanId"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," object and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The actual response will contain additional fields. Refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-docs/api-public"},"children":["API Reference"]}," for the full response details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-activate-the-loan","__idx":3},"children":["Step 2: Activate the Loan"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On activation, the loan will be amortized and a payment schedule generated. Activate the loan to begin servicing:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/loans/{loanId}/activate\nX-API-KEY: <YOUR-API-KEY>\nContent-Type: application/json\n\n{\n  \"amortizationAtActivation\": \"amortizeAtActivation\",\n  \"sendNotice\": true\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The activation response includes validation results and the final payment schedule:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": 200,\n  \"data\": {\n    \"ratesValidation\": {\n      \"interestRateAtOrigExceedsMax\": false\n    },\n    \"amountsValidation\": {\n      \"principalMatch\": true\n    }\n  },\n  \"message\": \"Loan activated.\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response message says \"Loan activated.\" and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ratesValidation"]}," shows no errors."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-confirm-payment-schedule","__idx":4},"children":["Step 3: Confirm Payment Schedule"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After activation, verify the payment schedule to ensure it matches your requirements:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /api/people/{personId}/loans/{loanId}/expected-payments\nX-API-KEY: <YOUR-API-KEY>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Review the response to confirm:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monthly payment amounts are correct ($315.25)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Due dates align with the specified day (15th)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Principal and interest splits are accurate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Origination fee is properly applied to first payment"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response returns a list of expected payments with the correct monthly amount of $315.25."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":5},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/loan-lifecycle/create-loc"},"children":["Create a Line of Credit"]}]}," — Walk through creating a line of credit loan after your first installment loan."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/loan-lifecycle"},"children":["Loan Lifecycle overview"]}]}," — Index of the full loan lifecycle from origination through closeout."]}]}]},"headings":[{"value":"Loan Management Quickstart","id":"loan-management-quickstart","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Step 1: Create a Loan","id":"step-1-create-a-loan","depth":2},{"value":"Step 2: Activate the Loan","id":"step-2-activate-the-loan","depth":2},{"value":"Step 3: Confirm Payment Schedule","id":"step-3-confirm-payment-schedule","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Loan Management Quickstart"}},"lastModified":"2026-05-21T20:50:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/loan-lifecycle/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}