Skip to main content
PATCH
/
organizations
/
{organizationId}
/
loans
/
{cancelDefaultLoanId}
Cancel Loan Default
curl --request PATCH \
  --url https://api.copper.co/platform/organizations/{organizationId}/loans/{cancelDefaultLoanId}
{
  "amount": "<string>",
  "borrowerCounterpartyId": "<string>",
  "borrowerOrganizationId": "<string>",
  "borrowerPortfolioId": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "currency": "<string>",
  "debtRatio": "<string>",
  "debtRatioUpdatedAt": "<string>",
  "defaultReason": "<string>",
  "embedded": {
    "childLoans": [
      {}
    ],
    "collaterals": [
      {
        "amount": "<string>",
        "collateralId": "<string>",
        "createdAt": "<string>",
        "currency": "<string>",
        "loanId": "<string>",
        "mainCurrency": "<string>",
        "portfolioId": "<string>",
        "unrealisedAmount": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "counterparties": [
      {
        "backgroundImageId": "<string>",
        "counterpartyDescription": "<string>",
        "counterpartyId": "<string>",
        "counterpartyName": "<string>",
        "counterpartyType": "standard",
        "extra": {
          "exchangeId": "<string>"
        },
        "imageId": "<string>",
        "networkTag": "<string>",
        "priority": "<string>",
        "tags": [
          "featured"
        ]
      }
    ],
    "loanAllocations": [
      {
        "allocationType": "disburse",
        "amount": "<string>",
        "counterpartyOrderId": "<string>",
        "createdAt": "<string>",
        "createdBy": "<string>",
        "currency": "<string>",
        "externalFailureDescription": "<string>",
        "extra": {
          "acceptedAt": "<string>",
          "acceptedBy": "<string>",
          "cancelledAt": "<string>",
          "cancelledBy": "<string>",
          "confirmedAt": "<string>",
          "confirmedBy": "<string>",
          "effectiveDate": "<string>"
        },
        "fromPortfolioId": "<string>",
        "loanAllocationId": "<string>",
        "loanId": "<string>",
        "mainCurrency": "<string>",
        "orderId": "<string>",
        "requestorCounterpartyId": "<string>",
        "status": "new",
        "terminatedAt": "<string>",
        "toPortfolioId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "loanInterest": {
      "accruedInterest": "<string>",
      "createdAt": "<string>",
      "interestCurrency": "<string>",
      "lastPaymentAt": "<string>",
      "loanId": "<string>",
      "loanInterestId": "<string>",
      "realisedInterest": "<string>",
      "unrealisedInterest": "<string>",
      "updatedAt": "<string>"
    },
    "loanModifications": [
      {
        "createdAt": "<string>",
        "createdBy": "<string>",
        "extra": {
          "acceptedAt": "<string>",
          "acceptedBy": "<string>",
          "cancelledAt": "<string>",
          "cancelledBy": "<string>",
          "currentInterestRate": "<string>",
          "currentMaturityDate": "<string>",
          "newInterestRate": "<string>",
          "newMaturityDate": "<string>"
        },
        "loanId": "<string>",
        "loanModificationId": "<string>",
        "modificationType": "rerate",
        "requestorCounterpartyId": "<string>",
        "status": "awaiting-acceptance",
        "updatedAt": "<string>"
      }
    ]
  },
  "externalId": "<string>",
  "extra": {
    "acceptedAt": "<string>",
    "acceptedBy": "<string>",
    "approvedAt": "<string>",
    "approvedBy": "<string>",
    "cancelledAt": "<string>",
    "cancelledBy": "<string>",
    "defaultThreshold": "<string>",
    "defaultedAt": "<string>",
    "defaultedBy": "<string>",
    "disbursedAt": "<string>",
    "externalDisbursal": true,
    "externalInterestPayment": true,
    "initialLtv": "<string>",
    "initiallyRequiredCollateralUsd": "<string>",
    "lenderFeeShare": "<string>",
    "lenderFeeSharePercentage": "<string>",
    "marginCallThreshold": "<string>",
    "rebalanceThreshold": "<string>",
    "rejectedAt": "<string>",
    "rejectedBy": "<string>",
    "repaidAt": "<string>",
    "repaidBy": "<string>",
    "requiredCollaterals": [
      {
        "amount": "<string>",
        "amountInUsd": "<string>",
        "currency": "<string>",
        "mainCurrency": "<string>"
      }
    ]
  },
  "interestRate": "<string>",
  "lenderCounterpartyId": "<string>",
  "lenderOrganizationId": "<string>",
  "lenderPortfolioId": "<string>",
  "loanId": "<string>",
  "loanType": "agency-lending-parent-loan",
  "mainCurrency": "<string>",
  "maturityDate": "<string>",
  "originalLoanAmount": "<string>",
  "originalLoanValue": "<string>",
  "startDate": "<string>",
  "status": "awaiting-approval",
  "terminatedAt": "<string>",
  "unrealisedAmount": "<string>",
  "updatedAt": "<string>"
}

Headers

Content-Type
string

Path Parameters

organizationId
string
required
cancelDefaultLoanId
string
required

Response

amount
string
required
borrowerCounterpartyId
string
required
borrowerOrganizationId
string
required
createdBy
string
required
currency
string
required
externalId
string
required
lenderCounterpartyId
string
required
lenderOrganizationId
string
required
loanId
string
required
loanType
enum<string>
required
Available options:
agency-lending-parent-loan,
agency-lending-collateralised-child-loan,
agency-lending-uncollateralised-child-loan,
agency-lending-first-lien-child-loan,
agency-lending-pledge-collateralised-child-loan,
bilateral-lending-title-transfer-collateralised-loan
mainCurrency
string
required
status
enum<string>
required
Available options:
awaiting-approval,
awaiting-acceptance,
awaiting-collateral,
awaiting-interest-payment,
disbursing,
active,
repaying,
defaulting,
defaulted,
cancelled,
rejected,
errored,
repaid,
repaying-interest,
interest-repaid,
securing-collateral,
collateral-secured,
releasing-collateral,
collateral-released,
closed
borrowerPortfolioId
string
createdAt
string
debtRatio
string
debtRatioStatus
enum<string>
debtRatioUpdatedAt
string
defaultReason
string
embedded
object
extra
object
interestRate
string
lenderPortfolioId
string
maturityDate
string
originalLoanAmount
string
originalLoanValue
string
startDate
string
terminatedAt
string
unrealisedAmount
string
updatedAt
string