Skip to content

Replace a loan

Request

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.

Security
ApiKeyAuth
Path
idstringrequired
Headers
Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired
loanNumberstring or nullrequired
typestringrequired
Enum:"business""personal"
productIdstring, non-emptyrequired

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.

purposestring or nullrequired
purposeNarrativestring or nullrequired
crmRecordNumberstring or nullrequired
documentRetentionRecordNumberstring or nullrequired
centsAmountinteger or null, [ 0 .. 9007199254740991 ]required
centsDepositinteger or null, [ 0 .. 9007199254740991 ]required
depositDispositionstringrequired
Enum:"refunded""applied"
closingCostsModestringrequired
Enum:"estimate""actual"
centsEstimatedClosingCostsinteger or null, [ 0 .. 9007199254740991 ]required
monthsTerminteger or null, ( 0 .. 9007199254740991 ]required
monthsInterestOnlyinteger or null, [ 0 .. 9007199254740991 ]required
monthsReamortizationTerminteger or null, ( 0 .. 9007199254740991 ]required
paymentFrequencystring or nullrequired
Enum:"weekly""biweekly""monthly""quarterly""semi-annual""annual""lump sum""irregular payments"
paymentTypestring or nullrequired
Enum:"ACH""Wire"
prepaymentPenaltyArray of objectsrequired

Replaces the tiers of the loan. An empty list means no penalty.

rateTypestring or nullrequired
Enum:"fixed""variable"
bpsFixedRateinteger or null, [ 0 .. 9007199254740991 ]required
bpsSpreadRateinteger or null, [ 0 .. 9007199254740991 ]required
bpsPrimeRateinteger or null, [ 0 .. 9007199254740991 ]required

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.

rateBenchmarkIdstring or nullrequired

An active benchmark from GET /rate-benchmarks.

rateDiscountIdstring or nullrequired

An active percentage discount from GET /rate-discounts.

applicationDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
closeDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
firstPaymentDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
maturityDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
initialDisbursementDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
firstRateChangeDatestring or null^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...required
branchIdstring or nullrequired

A branch from GET /branches.

purposeCodeIdstring or nullrequired

An active code from GET /reporting-codes.

classCodeIdstring or nullrequired

An active code from GET /reporting-codes.

productCodeIdstring or nullrequired

An active code from GET /reporting-codes.

concentrationCodeIdstring or nullrequired

An active code from GET /reporting-codes.

collateralCodeIdstring or nullrequired

An active code from GET /reporting-codes.

ecoaCodeIdstring or nullrequired

An active code from GET /reporting-codes.

brokerIdstring or nullrequired

The referring broker, from GET /brokers. Null: the bank originated the loan.

centsReferralFeeOverrideinteger or null, [ 0 .. 9007199254740991 ]required
bpsReferralFeeOverrideinteger or null, [ 0 .. 10000 ]required

A rate wins over an amount: sending one clears the other.

referralFeePaidBystring or nullrequired
Enum:"bank""customer"
centsPackagingFeeOverrideinteger or null, [ 0 .. 9007199254740991 ]required
bpsPackagingFeeOverrideinteger or null, [ 0 .. 10000 ]required

A rate wins over an amount: sending one clears the other.

packagingFeePaidBystring or nullrequired
Enum:"bank""customer"
sbaDetailsobject or nullrequired

The SBA details a banker edits. Required, as an object, for a loan of an SBA product. Null for any other loan.

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
    }
  }'

Responses

The loan after the write, as GET /loans/{id} returns it

Bodyapplication/json
dataobject(PublicLoan)
Response
{ "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 } ] } } }