curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loans{
"loans": [
{
"amount": "<string>",
"borrowerCounterpartyId": "<string>",
"borrowerOrganizationId": "<string>",
"createdBy": "<string>",
"currency": "<string>",
"externalId": "<string>",
"lenderCounterpartyId": "<string>",
"lenderOrganizationId": "<string>",
"loanId": "<string>",
"loanType": "bilateral-lending-title-transfer-collateralised-loan",
"mainCurrency": "<string>",
"status": "awaiting-approval",
"borrowerPortfolioId": "<string>",
"createdAt": "<string>",
"debtRatio": "<string>",
"debtRatioUpdatedAt": "<string>",
"embedded": {
"childLoans": "<array>",
"collaterals": [
{
"amount": "<string>",
"collateralId": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
],
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
],
"loanAllocations": [
{
"allocationType": "disburse",
"amount": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"confirmedAt": "<string>",
"confirmedBy": "<string>"
},
"loanAllocationId": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"status": "new",
"counterpartyOrderId": "<string>",
"createdBy": "<string>",
"externalFailureDescription": "<string>",
"fromPortfolioId": "<string>",
"orderId": "<string>",
"requestorCounterpartyId": "<string>",
"terminatedAt": "<string>",
"toPortfolioId": "<string>",
"updatedAt": "<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>",
"currency": "<string>",
"mainCurrency": "<string>",
"amountInUsd": "<string>"
}
]
},
"interestRate": "<string>",
"lenderPortfolioId": "<string>",
"maturityDate": "<string>",
"startDate": "<string>",
"terminatedAt": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
]
}Retrieve loans
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loans{
"loans": [
{
"amount": "<string>",
"borrowerCounterpartyId": "<string>",
"borrowerOrganizationId": "<string>",
"createdBy": "<string>",
"currency": "<string>",
"externalId": "<string>",
"lenderCounterpartyId": "<string>",
"lenderOrganizationId": "<string>",
"loanId": "<string>",
"loanType": "bilateral-lending-title-transfer-collateralised-loan",
"mainCurrency": "<string>",
"status": "awaiting-approval",
"borrowerPortfolioId": "<string>",
"createdAt": "<string>",
"debtRatio": "<string>",
"debtRatioUpdatedAt": "<string>",
"embedded": {
"childLoans": "<array>",
"collaterals": [
{
"amount": "<string>",
"collateralId": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
],
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
],
"loanAllocations": [
{
"allocationType": "disburse",
"amount": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"confirmedAt": "<string>",
"confirmedBy": "<string>"
},
"loanAllocationId": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"status": "new",
"counterpartyOrderId": "<string>",
"createdBy": "<string>",
"externalFailureDescription": "<string>",
"fromPortfolioId": "<string>",
"orderId": "<string>",
"requestorCounterpartyId": "<string>",
"terminatedAt": "<string>",
"toPortfolioId": "<string>",
"updatedAt": "<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>",
"currency": "<string>",
"mainCurrency": "<string>",
"amountInUsd": "<string>"
}
]
},
"interestRate": "<string>",
"lenderPortfolioId": "<string>",
"maturityDate": "<string>",
"startDate": "<string>",
"terminatedAt": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
]
}The account to filter by
The loan side to filter by. See details
lend, borrow bilateral-lending-title-transfer-collateralised-loan The loan status to filter by. See details
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 Flag to filter out open loans
Flag indicating if collaterals should be included in embedded
Flag indicating if counterparties should be included in embedded
The number of loans to include in the response
The number of loans to skip in the response
The field to sort by. Currently supported: updatedAt
The direction to sort by - must be used in conjunction with sortBy. See details
ASC, DESC OK
The list of loans
Show child attributes
Was this page helpful?