Skip to main content

Table of Endpoints

NameMethodEndpointLegacy ScopeCDP API Key Scope
Withdraw FundsPOST/v2/accounts/:account_id/withdrawalswallet:withdrawals:createtransfer
Commit WithdrawalPOST/v2/accounts/:account_id/withdrawals/:withdrawal_id/commitwallet:withdrawals:createtransfer
List WithdrawalsGET/v2/accounts/:account_id/withdrawalswallet:withdrawals:readview
Show WithdrawalGET/v2/accounts/:account_id/withdrawals/:withdrawal_idwallet:withdrawals:readview

Overview

The Withdrawal resource represents a withdrawal of funds using a payment method (e.g., a bank). Each committed withdrawal also has an associated transaction.
You can start a withdrawal with the flag, commit: false, which is useful if you want to display a withdrawal before executing. Withdrawals made with commit set to false will not complete nor receive an associated transaction until a separate commit request is made.
ParameterDescription
id stringResource ID
status string, enumerableStatus of the withdrawal. Valid values: created, completed, canceled
payment_method hashAssociated payment method (e.g., a bank)
transaction hashAssociated transaction (e.g., a bank, fiat account)
amount money hashAmount
subtotal money hashAmount without fees
fee money hashFee associated to this withdrawal
created_at timestamp
updated_at timestamp
resource string, constant withdrawal
resource_path string
committed booleanHas this withdrawal been committed?
payout_at timestamp, optionalWhen a withdrawal isn’t executed instantly, it receives a payout date for the time it will be executed

Example Withdrawal Resource

Withdraw Funds

Withdraws a user-defined amount of funds from a fiat account.

HTTP Request

POST https://api.coinbase.com/v2/accounts/:account_id/withdrawals

Scopes

  • wallet:withdrawals:create

Arguments

ParameterTypeRequiredDescription
amountstringRequiredWithdrawal amount
currencystringRequiredCurrency for the amount
payment_methodstringRequiredID of payment method used for the withdrawal. List Payment Methods: GET /payment-methods
commitbooleanOptionalIf false, this withdrawal is not immediately completed. Use the commit call to complete it. Default value: false

Examples

Request

Response (200)

Commit Withdrawal

Completes a withdrawal that is created in commit: false state.

HTTP Request

POST https://api.coinbase.com/v2/accounts/:account_id/withdrawals/:withdrawal_id/commit

Scopes

  • wallet:withdrawals:create

Arguments

None

Examples

Request

Response (200)

List Withdrawals

Lists withdrawals for an account.

HTTP Request

GET https://api.coinbase.com/v2/accounts/:account_id/withdrawals

Scopes

  • wallet:withdrawals:read

Examples

Request

Response

Show Withdrawal

Get a single withdrawal.

HTTP Request

GET https://api.coinbase.com/v2/accounts/:account_id/withdrawals/:withdrawal_id

Scopes

  • wallet:withdrawals:read

Examples

Request

Response