Name | Method | Endpoint | Legacy Scope | CDP API Key Scope |
---|---|---|---|---|
Withdraw Funds | POST | /v2/accounts/:account_id/withdrawals | wallet:withdrawals:create | transfer |
Commit Withdrawal | POST | /v2/accounts/:account_id/withdrawals/:withdrawal_id/commit | wallet:withdrawals:create | transfer |
List Withdrawals | GET | /v2/accounts/:account_id/withdrawals | wallet:withdrawals:read | view |
Show Withdrawal | GET | /v2/accounts/:account_id/withdrawals/:withdrawal_id | wallet:withdrawals:read | view |
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.
Parameter | Description |
---|---|
id string | Resource ID |
status string, enumerable | Status of the withdrawal. Valid values: created , completed , canceled |
payment_method hash | Associated payment method (e.g., a bank) |
transaction hash | Associated transaction (e.g., a bank, fiat account) |
amount money hash | Amount |
subtotal money hash | Amount without fees |
fee money hash | Fee associated to this withdrawal |
created_at timestamp | |
updated_at timestamp | |
resource string, constant withdrawal | |
resource_path string | |
committed boolean | Has this withdrawal been committed? |
payout_at timestamp, optional | When a withdrawal isn’t executed instantly, it receives a payout date for the time it will be executed |
Withdraws a user-defined amount of funds from a fiat account.
POST https://api.coinbase.com/v2/accounts/:account_id/withdrawals
wallet:withdrawals:create
Parameter | Type | Required | Description |
---|---|---|---|
amount | string | Required | Withdrawal amount |
currency | string | Required | Currency for the amount |
payment_method | string | Required | ID of payment method used for the withdrawal. List Payment Methods: GET /payment-methods |
commit | boolean | Optional | If false , this withdrawal is not immediately completed. Use the commit call to complete it. Default value: false |
Completes a withdrawal that is created in commit: false
state.
POST https://api.coinbase.com/v2/accounts/:account_id/withdrawals/:withdrawal_id/commit
wallet:withdrawals:create
None
Response (200)
Lists withdrawals for an account.
GET https://api.coinbase.com/v2/accounts/:account_id/withdrawals
wallet:withdrawals:read
Get a single withdrawal.
GET https://api.coinbase.com/v2/accounts/:account_id/withdrawals/:withdrawal_id
wallet:withdrawals:read