GET
/
core
/
accounts
/
{accountId}
/
deposit-method
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method \
  --header 'Authorization: Bearer <token>'
{
  "depositMethod": {
    "type": "blockchain",
    "status": "ok",
    "details": {
      "asset": "BTC",
      "network": "bitcoin",
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
    }
  }
}

You can check which assets support deposits by calling the List Assets endpoint and filtering for assets that have deposit included in their features.

Once you select an asset, you can determine the supported networks by calling the List Rails endpoint for that asset and filtering for rails that also include deposit in their features.

For more details, refer to the Assets section.

​
Asynchronous Setup Process

Some deposit methods require an asynchronous setup process depending on the network.

  • Calling this endpoint for the first time will trigger the setup of the underlying deposit method.
  • If the deposit method is not immediately available, subsequent calls with the same input can be used to check if it is ready for use.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

​
accountId
string
required

The account id.

Query Parameters

​
type
enum<string>
required

The type of the deposit method.

Available options:
blockchain
​
asset
string
required

The asset to use for the deposit.

​
network
string
required

The network to use for the deposit.

Response

200
application/json
Deposit method set up.
​
depositMethod
object