Table of Endpoints
Name | Method | Endpoint | Legacy Scope | CDP API Key Scope |
---|---|---|---|---|
Deposit Funds | POST | /v2/accounts/:account_id/deposits | wallet:deposits:create | transfer |
Commit Deposit | POST | /v2/accounts/:account_id/deposits/:deposit_id/commit | wallet:deposits:create | transfer |
List Deposits | GET | /v2/accounts/:account_id/deposits | wallet:deposits:read | view |
Show Deposit | GET | /v2/accounts/:account_id/deposits/:deposit_id | wallet:deposits:read | view |
Overview
The Deposit resource represents a deposit of funds using a payment method (e.g., a bank). Each committed deposit also has an associated transaction.You can start a withdrawal with the flag,
commit: false
, which is useful if you want to display a deposit before executing. Deposits 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 deposit. 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 | Fees associated to this deposit |
created_at timestamp | |
updated_at timestamp | |
resource string, constant deposit | |
resource_path string | |
committed boolean | Has this deposit been committed? |
payout_at timestamp, optional | When a deposit isn’t executed instantly, it receives a payout date for the time it will be executed |
Example Deposit Resource
Deposit Funds
Deposits user-defined amount of funds to a fiat account.HTTP Request
POST https://api.coinbase.com/v2/accounts/:account_id/deposits
Scopes
wallet:deposits:create
Arguments
Parameter | Type | Required | Description |
---|---|---|---|
amount | string | Required | Deposit amount |
currency | string | Required | Currency for the amount |
payment_method | string | Required | ID of payment method to be used for the deposit. List Payment Methods: GET /payment-methods |
commit | boolean | Optional | If false , this deposit is not immediately completed. Use the commit call to complete it. Default value: false |
Examples
Request
Response (200)
Commit Deposit
Completes a deposit that is created incommit: false
state.
HTTP Request
POST https://api.coinbase.com/v2/accounts/:account_id/deposits/:deposit_id/commit
Scopes
wallet:deposits:create
Arguments
NoneExamples
Request
Response (200)
List Deposits
Lists fiat deposits for an account.Deposits are only listed for fiat accounts and wallets. To list deposits associated with a crypto account/wallet, use List Transactions.
HTTP Request
GET https://api.coinbase.com/v2/accounts/:account_id/deposits
Scopes
wallet:deposits:read
Examples
Request
Response
Show Deposit
Get one deposit by deposit Id.HTTP Request
GET https://api.coinbase.com/v2/accounts/:account_id/deposits/:deposit_id
Scopes
wallet:deposits:read