Skip to main content
GET
/
core
/
accounts
/
{accountId}
/
deposit-method
Get account deposit method
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method \
  --header 'Authorization: Bearer <token>'
{
  "depositMethod": {
    "type": "crypto",
    "status": "ok",
    "details": {
      "asset": "BTC",
      "network": "bitcoin",
      "address": "tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn",
      "addressFormats": [
        {
          "format": "native-segwit",
          "value": "tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn"
        },
        {
          "format": "wrapped-segwit",
          "value": "2MzJXEZeyJV4jMHxkeGY7x88DPpF15p78ks"
        }
      ]
    }
  }
}
Use this endpoint to retrieve the deposit method for a given account, asset, and network. This is useful for determining available deposit options before initiating a deposit setup. 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.
Calling this endpoint will not trigger the asynchronous setup process of the deposit method which some networks require. You will need to call the Set up Account Deposit Method endpoint to trigger it.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

​
accountId
string<uuid>
required

The account id.

Query Parameters

​
type
enum<string>
required

The type of the deposit method.

Available options:
crypto,
bank
​
asset
string
required

The asset to use for the deposit.

​
network
string
required

The network to use for the deposit.

Response

Deposit method retrieved.

​
depositMethod
object
required