PATCH
/
organizations
/
{organizationId}
/
loans
/
{cancelInterestLoanId}
curl --request PATCH \
  --url https://api.copper.co/platform/organizations/{organizationId}/loans/{cancelInterestLoanId} \
  --header 'Content-Type: application/vnd.cancel-interest-payment+json' \
  --data '{}'
{
  "amount": "<string>",
  "borrowerCounterpartyId": "<string>",
  "borrowerOrganizationId": "<string>",
  "borrowerPortfolioId": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "currency": "<string>",
  "debtRatio": "<string>",
  "debtRatioUpdatedAt": "<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>"
        },
        "fromPortfolioId": "<string>",
        "loanAllocationId": "<string>",
        "loanId": "<string>",
        "mainCurrency": "<string>",
        "orderId": "<string>",
        "requestorCounterpartyId": "<string>",
        "status": "new",
        "terminatedAt": "<string>",
        "toPortfolioId": "<string>",
        "updatedAt": "<string>"
      }
    ]
  },
  "externalId": "<string>",
  "extra": {
    "acceptedAt": "<string>",
    "acceptedBy": "<string>",
    "approvedAt": "<string>",
    "approvedBy": "<string>",
    "cancelledAt": "<string>",
    "cancelledBy": "<string>",
    "defaultReason": "<string>",
    "defaultThreshold": "<string>",
    "defaultedAt": "<string>",
    "defaultedBy": "<string>",
    "disbursedAt": "<string>",
    "externalDisbursal": true,
    "externalInterestPayment": true,
    "initialLtv": "<string>",
    "initiallyRequiredCollateralUsd": "<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": "bilateral-lending-title-transfer-collateralised-loan",
  "mainCurrency": "<string>",
  "maturityDate": "<string>",
  "startDate": "<string>",
  "status": "awaiting-approval",
  "terminatedAt": "<string>",
  "unrealisedAmount": "<string>",
  "updatedAt": "<string>"
}

Headers

​
Content-Type
string

application/vnd.cancel-interest-payment+json

Path Parameters

​
organizationId
string
required
​
cancelInterestLoanId
string
required

Body

application/vnd.cancel-interest-payment+json · object

Response

200
application/vnd.cancel-interest-payment+json

OK

The response is of type object.