Welcome
Guides
- Fetch Balances and Transfers
- Funds Transfers
- Copper Network
- ClearLoop
- Copper Unlimited Online
- Fees Vaults
- DeFi
- Staking
- Webhooks
Funds Transfers
Withdraw to an Address Book address
POST
/
orders
curl --request POST \
--url https://api.copper.co/platform/orders \
--header 'Content-Type: application/json' \
--data '{
"amount": "0.1",
"baseCurrency": "BTC",
"description": "Withdrawal to my wallet",
"externalOrderId": "<string>",
"feeLevel": "low",
"includeFeeInWithdraw": "false",
"mainCurrency": "<string>",
"orderType": "withdraw",
"portfolioId": "<string>",
"toCryptoAddressId": "<string>"
}'
{
"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>"
}
Travel Rule
Financial regulations require us to collect information under the Travel Rule.
Therefore, all outgoing withdrawal orders are only allowed to be made to addresses from the Address Book that have passed the Travel Rule
checks. Use the Copper Platform to create a new address and pass the Travel Rule checks before making a withdrawal.
To create a withdrawal to an address book address, send the following parameters:
Body
application/json
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.copper.co/platform/orders \
--header 'Content-Type: application/json' \
--data '{
"amount": "0.1",
"baseCurrency": "BTC",
"description": "Withdrawal to my wallet",
"externalOrderId": "<string>",
"feeLevel": "low",
"includeFeeInWithdraw": "false",
"mainCurrency": "<string>",
"orderType": "withdraw",
"portfolioId": "<string>",
"toCryptoAddressId": "<string>"
}'
{
"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>"
}
Assistant
Responses are generated using AI and may contain mistakes.