Write every field a banker edits on the loan record. The request needs all of them: a missing field returns 400 and the message lists it. A field that can be empty accepts null to clear it. Money is in whole cents and rates in basis points. To change some fields and leave the rest, use PATCH. PUT does not move the loan to another stage and does not accept status: PATCH moves it with stageId.
A product of the bank. A change of product applies the terms of the new product that the request does not send, and moves the loan to the matching stage of the new product.
Replaces the tiers of the loan. An empty list means no penalty.
The prime rate of the loan. When you send rateBenchmarkId without it, the loan takes the current rate of that benchmark, as it does in the banker portal.
The referring broker, from GET /brokers. Null: the bank originated the loan.
A rate wins over an amount: sending one clears the other.
A rate wins over an amount: sending one clears the other.
- https://api.pioneerft.com/apihttps://api.pioneerft.com/api/public/v1/loans/{id}
- https://api.staging.pioneerft.com/apihttps://api.staging.pioneerft.com/api/public/v1/loans/{id}
curl -i -X PUT \
'https://api.pioneerft.com/api/public/v1/loans/{id}' \
-H 'Authorization: Bearer <YOUR_API Key_HERE>' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: string' \
-d '{
"loanNumber": "string",
"type": "business",
"productId": "string",
"purpose": "string",
"purposeNarrative": "string",
"crmRecordNumber": "string",
"documentRetentionRecordNumber": "string",
"centsAmount": 0,
"centsDeposit": 0,
"depositDisposition": "refunded",
"closingCostsMode": "estimate",
"centsEstimatedClosingCosts": 0,
"monthsTerm": 1,
"monthsInterestOnly": 0,
"monthsReamortizationTerm": 1,
"paymentFrequency": "weekly",
"paymentType": "ACH",
"prepaymentPenalty": [
{
"year": -9007199254740991,
"bpsRate": -9007199254740991
}
],
"rateType": "fixed",
"bpsFixedRate": 0,
"bpsSpreadRate": 0,
"bpsPrimeRate": 0,
"rateBenchmarkId": "string",
"rateDiscountId": "string",
"applicationDate": "string",
"closeDate": "string",
"firstPaymentDate": "string",
"maturityDate": "string",
"initialDisbursementDate": "string",
"firstRateChangeDate": "string",
"branchId": "string",
"purposeCodeId": "string",
"classCodeId": "string",
"productCodeId": "string",
"concentrationCodeId": "string",
"collateralCodeId": "string",
"ecoaCodeId": "string",
"brokerId": "string",
"centsReferralFeeOverride": 0,
"bpsReferralFeeOverride": 0,
"referralFeePaidBy": "bank",
"centsPackagingFeeOverride": 0,
"bpsPackagingFeeOverride": 0,
"packagingFeePaidBy": "bank",
"sbaDetails": {
"processingMethod": "PLP",
"approvalNumber": "string",
"submittedToSbaDate": "string",
"sbaApprovalDate": "string",
"centsGuaranteeFeeOverride": 0,
"guaranteeFeeOverrideReason": "string",
"guaranteeFeeFinanced": true,
"secondaryMarketSold": true
}
}'{ "data": { "id": "string", "loanNumber": "string", "status": "draft", "type": "business", "centsAmount": -9007199254740991, "centsMonthlyPayment": -9007199254740991, "monthsTerm": -9007199254740991, "monthsInterestOnly": -9007199254740991, "paymentFrequency": "weekly", "rateType": "fixed", "bpsRate": -9007199254740991, "bpsFixedRate": -9007199254740991, "bpsPrimeRate": -9007199254740991, "bpsSpreadRate": -9007199254740991, "rateDiscount": { "id": "string", "name": "string", "bpsRate": -9007199254740991 }, "borrowerName": "string", "purpose": "string", "purposeNarrative": "string", "applicationDate": "string", "closeDate": "string", "maturityDate": "string", "firstPaymentDate": "string", "product": { "id": "string", "name": "string" }, "stage": { "id": "string", "name": "string", "parent": { "id": "string", "name": "string" } }, "createdAt": "string", "updatedAt": "string", "centsDeposit": -9007199254740991, "depositDisposition": "refunded", "closingCostsMode": "estimate", "centsEstimatedClosingCosts": -9007199254740991, "monthsReamortizationTerm": -9007199254740991, "paymentType": "ACH", "prepaymentPenalty": [ { "year": -9007199254740991, "bpsRate": -9007199254740991 } ], "rateBenchmarkId": "string", "effectiveRateBenchmark": { "id": "string", "code": "string", "name": "string", "coreCode": "string", "bpsRate": -9007199254740991, "isActive": true }, "initialDisbursementDate": "string", "firstRateChangeDate": "string", "crmRecordNumber": "string", "documentRetentionRecordNumber": "string", "centsReferralFeeOverride": -9007199254740991, "bpsReferralFeeOverride": -9007199254740991, "referralFeePaidBy": "bank", "centsPackagingFeeOverride": -9007199254740991, "bpsPackagingFeeOverride": -9007199254740991, "packagingFeePaidBy": "bank", "centsInterestOnlyPayment": -9007199254740991, "centsAmortizingPayment": -9007199254740991, "interestMethod": "30/360", "yearBase": "Actual/365 Payments P&I", "ratePeriods": [ { "phaseName": "string", "monthsLength": -9007199254740991, "rateKind": "fixed", "rateBenchmarkId": "string", "monthsAdjustment": -9007199254740991 } ], "paymentSchedule": [ { "segmentType": "Interest Only", "numberOfPayments": -9007199254740991, "firstPaymentDate": "string", "centsPayment": -9007199254740991 } ], "metrics": { "hasOpenTasks": true, "hasMessages": true, "bpsGrossLtv": 0, "bpsNetLtv": 0 }, "loanTeam": [ { "role": { "id": "string", "name": "string", "label": "string" }, "banker": { "id": "string", "name": "string", "lastName": "string", "email": "string" } } ], "sbaDetails": { "program": "SBA_7A", "programLabel": "string", "processingMethod": "PLP", "processingMethodIsDefault": true, "approvalNumber": "string", "submittedToSbaDate": "string", "sbaApprovalDate": "string", "bpsGuarantee": -9007199254740991, "centsGuaranteeAmount": -9007199254740991, "centsGuaranteeFee": -9007199254740991, "centsGuaranteeFeeOverride": -9007199254740991, "guaranteeFeeOverrideReason": "string", "centsEffectiveGuaranteeFee": -9007199254740991, "bpsGuaranteeFeeRate": -9007199254740991, "waiverReason": "string", "feeScheduleFiscalYear": -9007199254740991, "feeNoticeReference": "string", "appliedRuleNames": [ "string" ], "guaranteeFeeFinanced": true, "secondaryMarketSold": true }, "referralSource": { "company": { "id": "string", "name": "string" }, "broker": { "id": "string", "name": "string", "lastName": "string", "email": "string", "phone": "string" }, "feesFrozen": true, "referralFee": { "centsAmount": -9007199254740991, "feeType": "flat", "bpsRate": -9007199254740991, "paidBy": "bank", "isOverridden": true }, "packagingFee": { "centsAmount": -9007199254740991, "feeType": "flat", "bpsRate": -9007199254740991, "paidBy": "bank", "isOverridden": true } }, "reporting": { "branch": { "id": "string", "name": "string" }, "codes": [ { "type": "ecoa", "id": "string", "code": "string", "label": "string", "active": true } ], "flexFieldCode": "string" }, "useOfProceeds": { "centsProjectCost": -9007199254740991, "centsRoundingPlug": -9007199254740991, "lineItems": [ { "name": "string", "label": "string", "centsProjectCost": -9007199254740991, "centsLoanAmount": -9007199254740991, "nonLoanFunding": [ { "source": "equity_injection", "centsAmount": -9007199254740991 } ], "isRefinance": true, "isGuaranteeFee": true, "isClosingCosts": true, "disbursementClass": "BORROWER", "source": "manual", "displayOrder": -9007199254740991, "notes": "string" } ] }, "credit": { "guarantors": [ { "person": { "id": "string", "firstName": "string", "lastName": "string" }, "hardPulls": [ { "id": "string", "pullType": "hard", "score": -9007199254740991, "bureauScores": [ {} ], "errors": [null], "notEntitled": true, "frozenBureaus": [null], "timeRun": "string", "fileId": "string" } ], "softPulls": [ { "id": "string", "pullType": "hard", "score": -9007199254740991, "bureauScores": [ {} ], "errors": [null], "notEntitled": true, "frozenBureaus": [null], "timeRun": "string", "fileId": "string" } ] } ], "authorization": { "date": "string", "recordedBy": { "type": "customer", "name": "string" }, "authorizedVia": [ "prequalify" ] } }, "dueDiligence": { "entities": [ { "type": "business", "id": "string", "name": "string", "roles": [ "string" ], "items": [ { "serviceId": "string", "name": "string", "integration": "docusign", "result": "string", "timeRun": "string", "fileId": "string" } ] } ] }, "uccFiling": { "configured": true, "filings": [ { "id": "string", "status": "string", "debtorName": "string", "filingState": "string", "collateralDescription": "string", "date": "string" } ] }, "amortization": { "summary": { "totalPayments": -9007199254740991, "centsTotalScheduled": -9007199254740991, "centsTotalInterest": -9007199254740991, "centsTotalPrincipal": -9007199254740991 }, "centsBalloonPayment": -9007199254740991, "calculatedAt": "string", "schedule": [ { "period": -9007199254740991, "date": "string", "centsPayment": -9007199254740991, "centsPrincipal": -9007199254740991, "centsInterest": -9007199254740991, "centsBalance": -9007199254740991 } ] } } }