Create Withdrawal

Create a withdrawal.

POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/withdrawals

Create Withdrawal

cURL

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>"
  },
  "travel_rule_data": {
    "beneficiary": {
      "name": "<string>",
      "natural_person_name": {
        "first_name": "<string>",
        "middle_name": "<string>",
        "last_name": "<string>"
      },
      "address": {
        "address_1": "<string>",
        "address_2": "<string>",
        "address_3": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>"
      },
      "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
      "vasp_id": "<string>",
      "vasp_name": "<string>",
      "personal_id": "<string>",
      "date_of_birth": {
        "year": 123,
        "month": 123,
        "day": 123
      },
      "telephone_number": "<string>",
      "account_id": "<string>"
    },
    "originator": {
      "name": "<string>",
      "natural_person_name": {
        "first_name": "<string>",
        "middle_name": "<string>",
        "last_name": "<string>"
      },
      "address": {
        "address_1": "<string>",
        "address_2": "<string>",
        "address_3": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>"
      },
      "wallet_type": "TRAVEL_RULE_WALLET_TYPE_UNSPECIFIED",
      "vasp_id": "<string>",
      "vasp_name": "<string>",
      "personal_id": "<string>",
      "date_of_birth": {
        "year": 123,
        "month": 123,
        "day": 123
      },
      "telephone_number": "<string>",
      "account_id": "<string>"
    },
    "is_self": true,
    "is_intermediary": true,
    "opt_out_of_ownership_verification": true,
    "attest_verified_wallet_ownership": true
  }
}
'

200

{
  "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

Java

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.

.NET

var transactionsService = new TransactionsService(client);

var request = new CreateWithdrawalRequest("PORTFOLIO_ID_HERE", "WALLET_ID_HERE")
{
    Amount = "0.001",
    DestinationType = DestinationType.DESTINATION_BLOCKCHAIN,
    IdempotencyKey = Guid.NewGuid().ToString(),
    CurrencySymbol = "ETH",
    BlockchainAddress = new BlockchainAddress
    {
        Address = "DESTINATION_WALLET_ADDRESS",
    },
};

var response = transactionsService.CreateWithdrawal(request);

For more information, please visit the Prime .NET SDK.

Go

transactionsService := transactions.NewTransactionsService(client)

request := &transactions.CreateWalletWithdrawalRequest{
    PortfolioId: "PORTFOLIO_ID_HERE",
    WalletId: "WALLET_ID_HERE",
    Amount: "0.001",
    DestinationType: "DESTINATION_BLOCKCHAIN",
    IdempotencyKey: uuid.New().String(),
    Symbol: "ETH",
    BlockchainAddress: &transactions.BlockchainAddress{
        Address: "DESTINATION_WALLET_ADDRESS",
    },
}

response, err := transactionsService.CreateWalletWithdrawal(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = CreateWithdrawalRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
    wallet_id="WALLET_ID_HERE",
    amount = '0.001',
    destination_type = 'DESTINATION_BLOCKCHAIN',
    idempotency_key = str(uuid.uuid4()),
    currency_symbol = 'ETH',
    blockchain_address = BlockchainAddress(
        address='DESTINATION_WALLET_ADDRESS',
    ),
)

response = prime_client.create_withdrawal(request)

For more information, please visit the Prime Python SDK.

CLI

primectl create-withdrawal --help

For more information, please visit the Prime CLI.

TS/JS

const transactionsService = new TransactionsService(client);

transactionsService.createWithdrawal({
    portfolioId: 'PORTFOLIO_ID_HERE',
    walletId: 'WALLET_ID_HERE',
    amount: "0.001",
    idempotencyKey: uuidv4(),
    currencySymbol: "ETH",
    destinationType: DestinationType.DestinationBlockchain,
    blockchainAddress: {
        address: 'DESTINATION_WALLET_ADDRESS',
    }
}).then(async (response) => {
    console.log('Withdrawal: ', response);
})

For more information, please visit the Prime TS 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

Show child attributes

blockchain_address · object

Show child attributes

counterparty · Represents a destination for a counterparty payment · object

Show child attributes

travel_rule_data · object

Data object used for withdrawals.

Show child attributes

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

Show child attributes

counterparty_destination · Represents a destination for a counterparty payment · object

Show child attributes

blockchain_source · object

Show child attributes

transaction_id · string

The id of the just created transaction