COcopper-co
lending

Get Loan by ID

Retrieve a loan by its ID

get/organizations/{organizationId}/loans/{loanId}

Request

Path parameters

organizationIdstring required
loanIdstring required

Query parameters

includeCollateralsboolean

Flag indicating if collaterals should be included in embedded

includeCounterpartiesboolean

Flag indicating if counterparties should be included in embedded

includeChildLoansboolean

Flag indicating if child loans should be included in embedded - Only applicable for agency lending parent loans

includeLoanAllocationsboolean

Flag indicating if allocations should be included in embedded

includeLoanInterestboolean

Flag indicating if loan interest should be included in embedded - Only applicable for bilateral loans

Response

OK

amountstring required

The amount of the loan

borrowerCounterpartyIdstring required

The counterparty ID of the borrower

borrowerOrganizationIdstring required

The organization ID of the borrower. Obfuscated for lender

borrowerPortfolioIdstring

The ID of the account which is to be the destination of disbursed funds. Obfuscated for lender

createdAtstring

Timestamp in epoch milliseconds of the loan creation

createdBystring required

The ID of the user that created the loan

currencystring required

Currency code of the asset being lent

debtRatiostring

The LTV of the loan

debtRatioStatusstring
debtRatioUpdatedAtstring

Timestamp in epoch milliseconds when the LTV was last updated

defaultReasonstring

The reason for the loan default

externalIdstring required

Unique identifier for externally originated loans, must be unique

interestRatestring

The interest rate for the loan in basis points (BPS)

lenderCounterpartyIdstring required

The counterparty ID of the lender

lenderOrganizationIdstring required

The organization ID of the lender. Obfuscated for borrower

lenderPortfolioIdstring

The ID of the account which is to be used for disbursing the loan to the borrower. Obfuscated for borrower

loanIdstring required

Unique identifier of the loan

loanType'agency-lending-parent-loan' | 'agency-inventory' | 'agency-lending-collateralised-child-loan' | 'agency-title-transfer-collateralised-loan' | 'agency-lending-uncollateralised-child-loan' | 'agency-uncollateralised-loan' | 'agency-lending-first-lien-child-loan' | 'agency-clearloop-loan' | 'agency-lending-pledge-collateralised-child-loan' | 'agency-pledge-collateralised-loan' | 'bilateral-lending-title-transfer-collateralised-loan' | 'bilateral-title-transfer-collateralised-loan' | 'bilateral-lending-pledge-collateralised-loan' | 'bilateral-pledge-collateralised-loan' | 'bilateral-lending-uncollateralised-loan' | 'bilateral-uncollateralised-loan' required
mainCurrencystring required

Currency code of the network being used to transfer the asset

maturityDatestring

Timestamp in epoch milliseconds of the maturity date

originalLoanAmountstring

The original amount of the loan at time of disbursal

originalLoanValuestring

The original value of the loan at time of disbursal

startDatestring

Timestamp in epoch milliseconds the loan is meant to be disbursed and activated

status'awaiting-approval' | 'awaiting-acceptance' | 'awaiting-collateral' | 'awaiting-interest-payment' | 'disbursing' | 'active' | 'repaying' | 'defaulting' | 'partially-defaulting' | 'early-termination-in-progress' | 'early-termination-completed' | 'defaulted' | 'default-resolved' | 'cancelled' | 'rejected' | 'errored' | 'repaid' | 'repaying-interest' | 'interest-repaid' | 'securing-collateral' | 'collateral-secured' | 'releasing-collateral' | 'collateral-released' | 'closed' required
terminatedAtstring

Timestamp in epoch milliseconds of the loan termination

unrealisedAmountstring

The amount of pending loan funds; can be positive and negative

updatedAtstring

Timestamp in epoch milliseconds of the most recent loan update

Changes

No recorded changes to this operation across all 1 revision of this API.