orders
Start Signing
blockchain
clearloop
network
address-book
currencies
API Reference
orders
files
lending
- GETGet Loans
- POSTCreate Loan
- PATCHCalculate Loan LTV Dry Run
- 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 Default
- 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
reports
orders
Start Signing
Start crypto signing for an order
PATCH
/
orders
/
{startSigningOrderId}
curl --request PATCH \
--url https://api.copper.co/platform/orders/{startSigningOrderId}
{
"amount": "<string>",
"baseCurrency": "<string>",
"createdAt": "<string>",
"createdBy": "<string>",
"externalOrderId": "<string>",
"extra": {
"availableCoSigners": [
"<string>"
],
"availableSnapshot": "<string>",
"balanceSnapshot": "<string>",
"blockchainTransactionType": "send",
"clearLoop": true,
"clearLoopExtra": {
"clearLoopExternalNetted": true,
"clearLoopSettlementId": "<string>"
},
"clientAccountId": "<string>",
"coSigners": [
"<string>"
],
"coSignersNumber": "<string>",
"confirmations": "<string>",
"counterpartyPortfolioId": "<string>",
"deliveryType": "free-of-payment",
"depositOrderId": "<string>",
"depositTargetId": "<string>",
"description": "<string>",
"estimatedFees": {
"estimatedTime": "<string>",
"fee": "<string>",
"feeCurrency": "<string>",
"feePerByte": {},
"gasLimit": {},
"gasPriceGwei": "<string>",
"reportingCurrencyRate": "<string>",
"transactionBytes": "<string>"
},
"externalBroadcast": true,
"feeLevel": "low",
"fromAddresses": [
"<string>"
],
"fromCounterpartyId": "<string>",
"fromCryptoAddress": {
"_embedded": {
"currencyConfigurations": [
{
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"currencyConfigurationId": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
},
"acceptTokens": true,
"address": "<string>",
"addressTags": [
null
],
"addressType": "externally-owned-account",
"category": "smart-contract",
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"mainCurrency": "<string>",
"memo": "<string>",
"name": "<string>",
"organizationId": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
},
"fromCryptoAddressId": "<string>",
"fromPortfolioId": "<string>",
"includeFeeInWithdraw": true,
"invoiceId": "<string>",
"marketPrice": "<string>",
"memo": "<string>",
"nextTransferTo": [
{
"cryptoAddressId": "<string>",
"portfolioId": "<string>",
"targetType": "external"
}
],
"originalDepositAmount": "<string>",
"partSigned": {},
"payload": "<string>",
"payloads": [
"<string>"
],
"reportingCurrencyRate": "<string>",
"reportingQuoteCurrencyRate": "<string>",
"signed": {},
"spenderAddress": "<string>",
"terminatedReportingCurrencyRate": "<string>",
"toAddress": "<string>",
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>",
"totalQuoteAmount": "<string>",
"transactionId": "<string>",
"transactionRequest": {},
"transferAmount": "<string>",
"transferChainId": "<string>",
"transferDepositTargetId": "<string>",
"transferFees": "<string>",
"transferFeesCurrency": "<string>",
"transferTransactionId": "<string>",
"withdrawFee": "<string>",
"withdrawOrderId": "<string>"
},
"limitType": "otc",
"mainCurrency": "<string>",
"orderId": "<string>",
"orderType": "sell",
"organizationId": "<string>",
"portfolioId": "<string>",
"portfolioType": "custody",
"quoteCurrency": "<string>",
"quoteMainCurrency": "<string>",
"status": "new",
"terminatedAt": "<string>",
"updatedAt": "<string>"
}
Headers
application/vnd.start-signing+json
Path Parameters
Response
200
application/vnd.start-signing+json
OK
The response is of type object
.
curl --request PATCH \
--url https://api.copper.co/platform/orders/{startSigningOrderId}
{
"amount": "<string>",
"baseCurrency": "<string>",
"createdAt": "<string>",
"createdBy": "<string>",
"externalOrderId": "<string>",
"extra": {
"availableCoSigners": [
"<string>"
],
"availableSnapshot": "<string>",
"balanceSnapshot": "<string>",
"blockchainTransactionType": "send",
"clearLoop": true,
"clearLoopExtra": {
"clearLoopExternalNetted": true,
"clearLoopSettlementId": "<string>"
},
"clientAccountId": "<string>",
"coSigners": [
"<string>"
],
"coSignersNumber": "<string>",
"confirmations": "<string>",
"counterpartyPortfolioId": "<string>",
"deliveryType": "free-of-payment",
"depositOrderId": "<string>",
"depositTargetId": "<string>",
"description": "<string>",
"estimatedFees": {
"estimatedTime": "<string>",
"fee": "<string>",
"feeCurrency": "<string>",
"feePerByte": {},
"gasLimit": {},
"gasPriceGwei": "<string>",
"reportingCurrencyRate": "<string>",
"transactionBytes": "<string>"
},
"externalBroadcast": true,
"feeLevel": "low",
"fromAddresses": [
"<string>"
],
"fromCounterpartyId": "<string>",
"fromCryptoAddress": {
"_embedded": {
"currencyConfigurations": [
{
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"currencyConfigurationId": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
},
"acceptTokens": true,
"address": "<string>",
"addressTags": [
null
],
"addressType": "externally-owned-account",
"category": "smart-contract",
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"mainCurrency": "<string>",
"memo": "<string>",
"name": "<string>",
"organizationId": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
},
"fromCryptoAddressId": "<string>",
"fromPortfolioId": "<string>",
"includeFeeInWithdraw": true,
"invoiceId": "<string>",
"marketPrice": "<string>",
"memo": "<string>",
"nextTransferTo": [
{
"cryptoAddressId": "<string>",
"portfolioId": "<string>",
"targetType": "external"
}
],
"originalDepositAmount": "<string>",
"partSigned": {},
"payload": "<string>",
"payloads": [
"<string>"
],
"reportingCurrencyRate": "<string>",
"reportingQuoteCurrencyRate": "<string>",
"signed": {},
"spenderAddress": "<string>",
"terminatedReportingCurrencyRate": "<string>",
"toAddress": "<string>",
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>",
"totalQuoteAmount": "<string>",
"transactionId": "<string>",
"transactionRequest": {},
"transferAmount": "<string>",
"transferChainId": "<string>",
"transferDepositTargetId": "<string>",
"transferFees": "<string>",
"transferFeesCurrency": "<string>",
"transferTransactionId": "<string>",
"withdrawFee": "<string>",
"withdrawOrderId": "<string>"
},
"limitType": "otc",
"mainCurrency": "<string>",
"orderId": "<string>",
"orderType": "sell",
"organizationId": "<string>",
"portfolioId": "<string>",
"portfolioType": "custody",
"quoteCurrency": "<string>",
"quoteMainCurrency": "<string>",
"status": "new",
"terminatedAt": "<string>",
"updatedAt": "<string>"
}