lending
- GETGet Loans
- POSTCreate Loan
- PATCHAccept Loan Term Extension
- PATCHAccept Loan Interest Payment
- PATCHAccept Loan
- PATCHAccept Loan Rebalance
- PATCHAccept Loan Repayment
- PATCHAccept Loan Rerate
- PATCHAccept Loan Top Up
- PATCHApprove Loan
- PATCHCancel Loan Term Extension
- PATCHCancel Loan Interest Payment
- PATCHCancel Loan
- PATCHCancel Loan Rebalance
- PATCHCancel Loan Repayment
- PATCHCancel Loan Rerate
- PATCHCancel Loan Top Up
- PATCHConfirm External Disbursement
- PATCHConfirm External Interest Payment
- PATCHConfirm External Repayment
- PATCHConfirm External Top Up
- PATCHDefault Loan
- PATCHEstimate Loan Leverage Ratio
- PATCHEstimate Loan LTV
- PATCHExtend Loan Term
- GETGet Loan by ID
- PATCHPay Loan Interest
- PATCHRebalance Loan
- PATCHReject Loan
- PATCHRepay Loan
- PATCHRerate Loan
- PATCHSecure Collateral Loan
- PATCHTop Up Loan
lending
Get Loans
Retrieve loans
GET
/
organizations
/
{organizationId}
/
loans
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loans
{
"loans": [
{
"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>"
}
]
}
Path Parameters
Query Parameters
The account to filter by
The loan side to filter by. See details
Available options:
lend
, borrow
Available options:
bilateral-lending-title-transfer-collateralised-loan
The loan status to filter by. See details
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
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
Available options:
ASC
, DESC
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loans
{
"loans": [
{
"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>"
}
]
}