PATCH
/
orders
/
{orderId}
Provide master password for Order
curl --request PATCH \
  --url https://api.copper.co/platform/orders/{orderId} \
  --header 'Content-Type: application/vnd.enter-master-password+json' \
  --data '{
  "masterPassword": "<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": {
      "baseFeePerGas": "<string>",
      "estimatedTime": "<string>",
      "fee": "<string>",
      "feeCurrency": "<string>",
      "feePerByte": {},
      "gasLimit": {},
      "gasPriceGwei": "<string>",
      "maxFeePerGas": "<string>",
      "maxPriorityFeePerGas": "<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>"
}
When order status is master-password-required you can use this API to enter the Master Password for the order. Please note for convenience there is an Approve order endpoint that allows the user to co-sign and enter a master password.

Headers

Content-Type
string

application/vnd.enter-master-password+json

Path Parameters

orderId
string
required

Body

application/vnd.enter-master-password+json
masterPassword
string
required

Withdrawal password (also known as Master Password)

Response

OK

amount
string
required

Amount of order in baseCurrency

baseCurrency
string
required

Base currency of the order

createdAt
string
required

Order creation timestamp

externalOrderId
string
required

The order ID in the external system

orderId
string
required

Order ID

orderType
enum<string>
required

Order type. See details

Available options:
sell,
buy,
deposit,
withdraw,
multi-withdraw,
wallet-message,
retrieved-deposit,
earn-reward,
earn-shared-reward,
claim-shared-reward,
cross-chain-deposit,
cross-chain-withdraw
portfolioId
string
required

Portfolio ID

portfolioType
enum<string>
required

Portfolio type. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
status
enum<string>
required

Order status. See details

Available options:
new,
waiting-funds,
reserving,
reserved,
queued,
validating-funds,
working,
waiting-approve,
co-sign-require,
approved,
processing,
executed,
canceled,
rejecting,
rejected,
declining,
declined,
suspending,
suspended,
blocked,
action-required,
require-initializer-approve,
waiting-counterparty-approve,
require-counterparty-approve,
ready-for-settlement,
settled,
part-signed-tx-added,
full-signed-tx-added,
rejected-part-signed-tx-added,
rejected-full-signed-tx-added,
awaiting-settlement,
master-password-required,
manual-resolving,
error,
pending-atomic-settlement-confirmation,
atomic-settlement-reservation-completed
createdBy
string

Creator user id

extra
object

Additional order information

limitType
enum<string>

Limit type of the order. See details

Available options:
otc,
rfq
mainCurrency
string

Blockchain network of a baseCurrency

organizationId
string

Organization id

quoteCurrency
string

The quote currency of the order (in case of a settle order)

quoteMainCurrency
string

Blockchain network of a quoteCurrency

terminatedAt
string

Order termination timestamp

updatedAt
string

Order update timestamp