{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Onboard a line of credit","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"onboard-a-line-of-credit","__idx":0},"children":["Onboard a line of credit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide walks you from credentials-in-hand to an activated, revolving line of credit in the sandbox, then opens a draw and records a purchase against it, using the same public API you call in production. Run every call against the sandbox host. By the end you have an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}," line of credit with a credit limit, an active draw, and a purchase recorded against that draw."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the line-of-credit sibling of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/use-cases/onboard-installment-loan"},"children":["Onboard an installment loan"]},". The borrower step is identical and is not re-explained here; everything from the loan-create step onward diverges, because a line of credit is a different schema (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NewLineOfCredit"]},", not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NewInstallment"]},") with a different money model — a revolving credit limit drawn against over time, not a fixed amount disbursed once. Where this guide overlaps the installment recipe it links to it rather than restating."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do this in the sandbox. For how the sandbox is provisioned, the environment model, and the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment"]}," failure path, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data"},"children":["Sandbox and test data"]}," — this guide does not restate them. The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["purchase"]}," decline path is different from the payment decline path, and this guide documents it below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["An API key."]}," Sent in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-API-KEY"]}," header on every request. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/credentials-and-access"},"children":["Credentials and access"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The sandbox base URL."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://sandboxapi.peach.finance/api"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/portals-and-environments"},"children":["Portals and environments"]}," for the host model."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["A line-of-credit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanTypeId"]},"."]}," Configured by Peach and handed to you during onboarding — you cannot create or list loan types through the public API, and a line-of-credit loan type is a distinct product template from an installment one. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/credentials-and-access"},"children":["Credentials and access"]},". This guide uses the placeholder ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LT-AAAA-BBBB"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The borrower, loan, and loan-type concepts."]}," See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/core-concepts"},"children":["Core concepts"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your loan type must be configured before any of these calls succeed, and it must be a line-of-credit type: loan creation rejects a request whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," does not match the loan type's configured type. Creation also resolves the loan type's asset type and the company's default investor; a missing asset type or a company with no default investor (and no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["investors"]}," passed in the request) is rejected — the same gate the installment recipe describes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-onboarding-sequence","__idx":2},"children":["The onboarding sequence"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Six calls take a borrower to a line of credit with a purchase recorded against it. The borrower, line, and activation are the origination; the draw and purchase exercise the revolving surface an installment loan does not have."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant You as Your application\n participant Peach as Peach API\n You->>Peach: POST /people (create borrower)\n Peach-->>You: personId\n You->>Peach: POST /people/{personId}/loans (type lineOfCredit, status originated)\n Peach-->>You: loanId (status originated)\n You->>Peach: POST /people/{personId}/loans/{loanId}/activate\n Peach-->>You: line status active, credit limit established\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws (status originated)\n Peach-->>You: drawId (status originated)\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws/{drawId}/activate\n Peach-->>You: draw status active\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws/{drawId}/purchases\n Peach-->>You: purchase recorded against the draw\n","diagramHtml":"Peach APIYour applicationPeach APIYour applicationPOST /people (create borrower)personIdPOST /people/{personId}/loans (type lineOfCredit, status originated)loanId (status originated)POST /people/{personId}/loans/{loanId}/activateline status active, credit limit establishedPOST /people/{personId}/loans/{loanId}/draws (status originated)drawId (status originated)POST /people/{personId}/loans/{loanId}/draws/{drawId}/activatedraw status activePOST /people/{personId}/loans/{loanId}/draws/{drawId}/purchasespurchase recorded against the draw","diagramHtmlDark":"Peach APIYour applicationPeach APIYour applicationPOST /people (create borrower)personIdPOST /people/{personId}/loans (type lineOfCredit, status originated)loanId (status originated)POST /people/{personId}/loans/{loanId}/activateline status active, credit limit establishedPOST /people/{personId}/loans/{loanId}/draws (status originated)drawId (status originated)POST /people/{personId}/loans/{loanId}/draws/{drawId}/activatedraw status activePOST /people/{personId}/loans/{loanId}/draws/{drawId}/purchasespurchase recorded against the draw"},"children":["sequenceDiagram\n participant You as Your application\n participant Peach as Peach API\n You->>Peach: POST /people (create borrower)\n Peach-->>You: personId\n You->>Peach: POST /people/{personId}/loans (type lineOfCredit, status originated)\n Peach-->>You: loanId (status originated)\n You->>Peach: POST /people/{personId}/loans/{loanId}/activate\n Peach-->>You: line status active, credit limit established\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws (status originated)\n Peach-->>You: drawId (status originated)\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws/{drawId}/activate\n Peach-->>You: draw status active\n You->>Peach: POST /people/{personId}/loans/{loanId}/draws/{drawId}/purchases\n Peach-->>You: purchase recorded against the draw\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-the-borrower","__idx":3},"children":["Step 1: Create the borrower"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create the person the line of credit will belong to. This step is identical to the installment recipe — same endpoint, same required fields (a person borrower needs a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identity"]}," is required unless your company disables it). See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/use-cases/onboard-installment-loan#step-1-create-the-borrower"},"children":["Onboard an installment loan → Create the borrower"]}," for the request body and field table; it is not repeated here."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"name\": { \"firstName\": \"Ada\", \"lastName\": \"Lovelace\" },\n \"identity\": { \"identityType\": \"SSN\", \"value\": \"000000000\" }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify","__idx":4},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response returns a person ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BO-AAAA-BBBB"]},") with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: active"]},". Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," — it is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personId"]}," in every subsequent call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-create-the-line-of-credit","__idx":5},"children":["Step 2: Create the line of credit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create the line against your line-of-credit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanTypeId"]},". Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lineOfCredit"]}," and create it in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," status: the line is originated but does not start until you activate it in Step 3."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"type\": \"lineOfCredit\",\n \"loanTypeId\": \"LT-AAAA-BBBB\",\n \"servicedBy\": \"creditor\",\n \"status\": \"originated\",\n \"newDrawsAllowed\": true,\n \"atOrigination\": {\n \"creditLimitAmount\": 5000,\n \"paymentFrequency\": \"monthly\",\n \"originationLicense\": \"nationalBank\",\n \"originatingCreditorName\": \"Example Bank\",\n \"interestRates\": [\n { \"interestType\": \"absolute\", \"days\": null, \"rate\": 0.1899 }\n ],\n \"personAddress\": {\n \"addressLine1\": \"1 Main St\",\n \"city\": \"Houston\",\n \"state\": \"TX\",\n \"postalCode\": \"77002\",\n \"country\": \"US\"\n }\n }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields","__idx":6},"children":["Required fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lineOfCredit"]},". Must match your loan type's configured type, or the request is rejected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanTypeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your Peach-configured line-of-credit loan type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["servicedBy"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who services the line. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["creditor"]}," for a line serviced on the Peach platform. Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["creditor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["thirdPartyServicer"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debtCollectionAgency"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New loans accept only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]},". Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," to originate now and activate next."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newDrawsAllowed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Line-of-credit only."]}," Whether the borrower can open additional draws on the line. Required on the line schema and read unconditionally by the create handler."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.creditLimitAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Line-of-credit only."]}," The revolving credit limit — the maximum the borrower can utilize across draws. There is no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountFinanced"]}," and no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]}," on a line; those installment fields do not apply."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.paymentFrequency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weekly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["everyTwoWeeks"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["twiceMonthly"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["monthly"]},". Note ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["singleTerm"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," valid for a line of credit (it is for installment)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.originationLicense"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nationalBank"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stateLicense"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankSubsidiary"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stateBank"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.originatingCreditorName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name shown to the borrower in communications."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.interestRates"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of rate periods; the final entry must have ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["days: null"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddress"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["or"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddressId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An address is required to create the loan. See below."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the complete field contract — every optional origination parameter, fee, grace-period, and promo structure — see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-docs/api-public/"},"children":["Create loan endpoint"]}," in the API Reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"an-address-is-required-to-originate","__idx":7},"children":["An address is required to originate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An address requirement applies to the line of credit exactly as it does to an installment loan, and for the same reason: the create-loan handler calls ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extract_address_fields_for_create_loan"]}," unconditionally for every loan create, regardless of type, and that function rejects a request that carries neither ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddress"]}," nor ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddressId"]},". This was re-verified independently against the line-of-credit path — it is the same code gate, not an assumption carried over from the installment recipe."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Address is a create-loan requirement, not an activation gate"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As with installment loans, the address requirement is enforced at line creation, not at activation, and it is enforced in code rather than declared in the OpenAPI spec (both address fields are optional on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LineOfCredit"]}," schema). You do not need to create a separate address contact first — inlining ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personAddress"]}," in the origination request satisfies the requirement. Supplying both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personAddress"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personAddressId"]}," is rejected."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-1","__idx":8},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response returns a loan ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LN-AAAA-BBBB"]},") with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: lineOfCredit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: originated"]},". Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," — it is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanId"]}," for activation and for every draw and purchase call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-activate-the-line-of-credit","__idx":9},"children":["Step 3: Activate the line of credit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Activate the originated line to start it. The request body is optional. The line must be in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," status to activate; calling activate on a line in any other status returns a 400. This is the same activation handler and the same status guard the installment recipe uses — the endpoint is shared."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/activate\nX-API-KEY: \nContent-Type: application/json\n\n{}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Activating a line does not disburse money"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the central divergence from installment. When you activate an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["installment"]}," loan, Peach disburses principal — it moves the amount financed from cash to accounts receivable. When you activate a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["line of credit"]},", no principal is disbursed: the disbursement ledger entry is guarded to installment loans only. Line activation establishes the revolving credit line and its credit limit and starts the line; money is utilized later, through draws and purchases (Steps 4–6). A line has a credit limit, not an amount financed."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As with installment, activating a line assesses fees only when your loan type configures them — an origination or draw fee, and any service or membership fee marked to charge at activation. Activation does not open a draw (you create draws explicitly, in Step 4), does not enrol autopay, and does not itself deliver a borrower notice; it fires a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loan.activated"]}," event, and any activation-notice delivery is a downstream, configuration-gated step."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-2","__idx":10},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Re-fetch the line with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}"]}," and confirm ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is now ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},". The line carries a credit limit (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["current.creditLimitAmount"]},") but no outstanding principal balance yet — nothing has been drawn."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-open-a-draw","__idx":11},"children":["Step 4: Open a draw"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A draw is the container credit is utilized through. Create it against the active line. The draw's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is required; create it in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," to activate it next."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/draws\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"status\": \"originated\",\n \"drawType\": \"regularPurchase\",\n \"atOrigination\": {\n \"interestRates\": [\n { \"interestType\": \"absolute\", \"days\": null, \"rate\": 0.1899 }\n ]\n }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields-1","__idx":12},"children":["Required fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Draws accept only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," (plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}," when the loan type is not managed by Peach, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}," for a non-migrating line). Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]},", then activate."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceTransfer"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cashAdvance"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regularPurchase"]},". Drives how the system auto-associates card transactions with the draw."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional as a whole, but if supplied for an amortized draw it carries its own rate and min-payment fields. The full draw origination contract (amortization method, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minPaymentCalculation"]},") is a larger surface — see the API Reference and the note below."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The line must be ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["active"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not closed"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newDrawsAllowed"]}," must be true"]}," for a draw to be created. A draw created against an inactive line, a closed line, or a line with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newDrawsAllowed: false"]}," returns a 400."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination"]}," is optional on a draw. The draw schema requires only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," (see above), and the create handler reads ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination"]}," with an empty-object default, so a bare ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"status\": \"originated\"}"]}," draw is accepted; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minPaymentCalculation"]}," is required only when you do supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination"]},". When you omit the amortization inputs, the draw inherits its expected-periodic-payment method from the loan type. A card-style, non-amortized draw does not need an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination"]}," block."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Draw amortization and schedule computation are out of scope here, the same as the installment schedule is; see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/loan-lifecycle/amortization-utility"},"children":["amortization utility"]}," documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-3","__idx":13},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response returns a draw ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DR-AAAA-BBBB"]},") with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: originated"]},". Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," — it is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["drawId"]}," for activation and for the purchase call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-activate-the-draw","__idx":14},"children":["Step 5: Activate the draw"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Activate the draw to start it. The draw-activate endpoint resolves to the same handler as loan activation, so the same guard applies: the draw must be in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," status."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/draws/{drawId}/activate\nX-API-KEY: \nContent-Type: application/json\n\n{}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-4","__idx":15},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Re-fetch the draw with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws/{drawId}"]}," and confirm ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},". An active draw can now have purchases recorded against it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-6-record-a-purchase-against-the-draw","__idx":16},"children":["Step 6: Record a purchase against the draw"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Utilization happens through purchases. Record a purchase against the active draw. A regular purchase requires only an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," and at least one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.description"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.merchantName"]},"; the draw must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}," (for a regular purchase without a prior authorization). By default a purchase is created in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}," status, which increases the draw balance and posts to the ledger."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/draws/{drawId}/purchases\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"amount\": 100,\n \"type\": \"regular\",\n \"status\": \"settled\",\n \"purchaseDetails\": {\n \"merchantName\": \"Example Merchant\"\n }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields-2","__idx":17},"children":["Required fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The purchase amount (minimum 0)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.description"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["or"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.merchantName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["At least one must be present, or the request is rejected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regular"]}," (default), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refund"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cashBack"]},". A regular purchase increases the draw balance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]},". Accepts a purchase status (see below). ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," post to the ledger and increase the draw balance; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}," does not."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card used for the purchase. If it cannot be resolved, the purchase is still created and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validation.cardIdMissing"]}," is set in the response."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}," purchase posts to the ledger at creation, with no separate settlement or processor step. Peach is the system of record for line-of-credit purchases: for a regular purchase the create call writes the ledger entries directly and emits the balance-change event, rather than routing through a card processor the way a card ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["payment"]}," does. A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," purchase posts the same way; a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}," purchase is record-keeping only and never posts."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-5","__idx":18},"children":["Verify"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch the purchases on the draw with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws/{drawId}/purchases"]}," and confirm the purchase is present in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["settled"]}," status. Then check the draw balances — a settled purchase increases the draw's outstanding balance by the purchase amount, and the line's utilization rises correspondingly."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"purchase-declines-are-not-payment-declines","__idx":19},"children":["Purchase declines are not payment declines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["declined purchase"]}," and a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["declined payment"]}," are two different objects with two different mechanisms. Do not model them the same way."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment"]}," decline is a runtime outcome. A card payment (a transaction) is adjudicated by the processor; when it is declined, the transaction lands in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionStatus.Failed"]}," with the failure reason ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardDeclined"]},". There is no literal \"declined\" transaction status — a decline is a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}," transaction plus a reason code. That path, its CyberSource test-host routing, and how to drive it are documented in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data#exercising-the-decline-and-failure-path"},"children":["Sandbox and test data → Exercising the decline and failure path"]},"; this guide does not restate it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["purchase"]}," decline is a status you set. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PurchaseStatus"]}," has a literal ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Declined"]}," member. Peach is the system of record for line-of-credit purchases — your platform (or its card processor) has already adjudicated the authorization, and you record the outcome, including a decline, into Peach. You create or transition a purchase to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}," directly through the API: pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"status\": \"declined\""]}," (with an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declineReason"]},") on the create call, or transition an existing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]}," purchase to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]},". A declined purchase is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["record-keeping only"]}," — it never posts to the ledger and does not increase the draw balance when created that way."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/draws/{drawId}/purchases\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"amount\": 100,\n \"type\": \"regular\",\n \"status\": \"declined\",\n \"declineReason\": \"insufficientCredit\",\n \"purchaseDetails\": { \"merchantName\": \"Example Merchant\" }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Payment decline"},"children":["Payment decline"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purchase decline"},"children":["Purchase decline"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purchase"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}," (no literal \"declined\")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Declined"]}," (literal enum member)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Extra field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failureReason: CardDeclined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declineReason"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set by"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The processor at runtime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You, as system of record"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ledger effect"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No successful money movement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — record-keeping only"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Where documented"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data#exercising-the-decline-and-failure-path"},"children":["Sandbox and test data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This page"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":20},"children":["Error handling"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resolution"},"children":["Resolution"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"Cannot create loan of type ... with configuration for type ...\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," in the request does not match the loan type's configured type."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use a line-of-credit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loanTypeId"]}," and set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: lineOfCredit"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"a personAddressId or personAddress is required to create a loan\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /people/{personId}/loans"]}," sent with no address."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddress"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.personAddressId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"New loans can only be created in status: ...\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," not one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create the line in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]},", then activate."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"... is in an incorrect status for activation\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Activate called on a line (or draw) not in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm the object is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originated"]}," before activating."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"Cannot create draws on inactive line of credit.\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Draw created before the line was activated."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Activate the line (Step 3) first."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"New draws not allowed on this loan.\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Draw created while the line has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newDrawsAllowed: false"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create the line with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newDrawsAllowed: true"]},", or update the line."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"Cannot create a purchase on an inactive line.\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Regular purchase recorded before the line/draw was active."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Activate the line and the draw first; a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}," purchase is exempt on a closed/terminal line."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"At least one of the attributes, 'description' or 'merchantName' must be passed.\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purchase created with an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.description"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purchaseDetails.merchantName"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"testing","__idx":21},"children":["Testing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run this whole sequence against the sandbox host and confirm each step's verify condition. To exercise both decline paths: record a purchase with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"status\": \"declined\""]}," (the Step 6 variant above) to confirm your integration reads ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PurchaseStatus.Declined"]},", and separately drive a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment"]}," transaction to a declined outcome per ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data#exercising-the-decline-and-failure-path"},"children":["Sandbox and test data"]},". For seeding wider test data and the test payment instruments, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data"},"children":["Sandbox and test data"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"production-considerations","__idx":22},"children":["Production considerations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request and response contracts are identical between sandbox and production — the only difference is the host you call and the credentials you use. When you move to production, point the same calls at the production base URL with production credentials. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/portals-and-environments"},"children":["Portals and environments"]}," for the host model and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/credentials-and-access"},"children":["Credentials and access"]}," for environment-scoped keys."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":23},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/use-cases/onboard-installment-loan"},"children":["Onboard an installment loan"]}," — The fixed-amount sibling of this recipe; start there for the installment comparison and the shared borrower step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/sandbox-and-test-data"},"children":["Sandbox and test data"]}," — Test instruments, magic values, and the payment failure path (distinct from the purchase decline above)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/core-concepts"},"children":["Core concepts"]}," — The borrower, loan, draw, and purchase model behind these calls."]}]}]},"headings":[{"value":"Onboard a line of credit","id":"onboard-a-line-of-credit","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"The onboarding sequence","id":"the-onboarding-sequence","depth":2},{"value":"Step 1: Create the borrower","id":"step-1-create-the-borrower","depth":2},{"value":"Verify","id":"verify","depth":3},{"value":"Step 2: Create the line of credit","id":"step-2-create-the-line-of-credit","depth":2},{"value":"Required fields","id":"required-fields","depth":3},{"value":"An address is required to originate","id":"an-address-is-required-to-originate","depth":3},{"value":"Verify","id":"verify-1","depth":3},{"value":"Step 3: Activate the line of credit","id":"step-3-activate-the-line-of-credit","depth":2},{"value":"Verify","id":"verify-2","depth":3},{"value":"Step 4: Open a draw","id":"step-4-open-a-draw","depth":2},{"value":"Required fields","id":"required-fields-1","depth":3},{"value":"Verify","id":"verify-3","depth":3},{"value":"Step 5: Activate the draw","id":"step-5-activate-the-draw","depth":2},{"value":"Verify","id":"verify-4","depth":3},{"value":"Step 6: Record a purchase against the draw","id":"step-6-record-a-purchase-against-the-draw","depth":2},{"value":"Required fields","id":"required-fields-2","depth":3},{"value":"Verify","id":"verify-5","depth":3},{"value":"Purchase declines are not payment declines","id":"purchase-declines-are-not-payment-declines","depth":2},{"value":"Error handling","id":"error-handling","depth":2},{"value":"Testing","id":"testing","depth":2},{"value":"Production considerations","id":"production-considerations","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Onboard a line of credit","description":"Originate one line of credit in the sandbox end to end: create the borrower, create the line against a credit limit, activate it, then open a draw and record a purchase against it — including how a declined purchase differs from a declined payment.","verifiedDate":"2026-07-23T00:00:00.000Z","verifiedSpec":"api-public.yml","verifiedRef":"peach@5e10825f3","seo":{"title":"Onboard a line of credit"}},"lastModified":"2026-07-24T18:38:56.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/getting-started/use-cases/onboard-loc","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}