POST
/
v1
/
portfolios
/
{portfolio_id}
/
wallets
/
{wallet_id}
/
withdrawals
Create Withdrawal
curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/wallets/{wallet_id}/withdrawals \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "destination_type": "DESTINATION_PAYMENT_METHOD",
  "idempotency_key": "<string>",
  "currency_symbol": "<string>",
  "payment_method": {
    "payment_method_id": "<string>"
  },
  "blockchain_address": {
    "address": "<string>",
    "account_identifier": "<string>",
    "network": {
      "id": "<string>",
      "type": "<string>"
    }
  },
  "counterparty": {
    "counterparty_id": "<string>"
  }
}'
{
  "activity_id": "<string>",
  "approval_url": "<string>",
  "symbol": "<string>",
  "amount": "<string>",
  "fee": "<string>",
  "destination_type": "<string>",
  "source_type": "<string>",
  "blockchain_destination": {
    "address": "<string>",
    "account_identifier": "<string>",
    "network": {
      "id": "<string>",
      "type": "<string>"
    }
  },
  "counterparty_destination": {
    "counterparty_id": "<string>"
  },
  "blockchain_source": {
    "address": "<string>",
    "account_identifier": "<string>",
    "network": {
      "id": "<string>",
      "type": "<string>"
    }
  },
  "transaction_id": "<string>"
}
Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
TransactionsService transactionsService = PrimeServiceFactory.createTransactionsService(client);

CreateWithdrawalRequest request = new CreateWithdrawalRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .walletId("WALLET_ID_HERE")
    .amount("0.001")
    .destinationType(DestinationType.DESTINATION_BLOCKCHAIN)
    .idempotencyKey(UUID.randomUUID().toString())
    .currencySymbol("ETH")
    .blockchainAddress(new BlockchainAddress.Builder()
        .address("DESTINATION_WALLET_ADDRESS")
        .build())
    .build();

CreateWithdrawalResponse response = transactionsService.createWithdrawal(request);
For more information, please visit the Prime Java SDK.

Path Parameters

portfolio_id
string
required

The portfolio ID

wallet_id
string
required

The wallet ID

Body

application/json
amount
string
required

The amount in whole units of the withdrawal

destination_type
enum<string>
required
Available options:
DESTINATION_PAYMENT_METHOD,
DESTINATION_BLOCKCHAIN,
DESTINATION_WALLET,
DESTINATION_COUNTERPARTY
idempotency_key
string
required

The idempotency key associated with the withdrawal

currency_symbol
string
required

The currency symbol for the withdrawal

payment_method
object
blockchain_address
object
counterparty
object

Response

200 - application/json

A successful response.

activity_id
string

The activity ID associated with the withdrawal

approval_url
string

A URL to the activity in the Prime application

symbol
string

The currency symbol associated with the withdrawal

amount
string

The amount of the withdrawal

fee
string

The network fee associated with the withdrawal

destination_type
string

The destination type used for the withdrawal

source_type
string

The source type used for the withdrawal

blockchain_destination
object
counterparty_destination
object
blockchain_source
object
transaction_id
string

The id of the just created transaction