Skip to main content
PUT
/
core
/
accounts
/
{accountId}
/
deposit-method
Set up account deposit method
curl --request PUT \
  --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": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
    }
  }
}
Use this endpoint to initiate the setup of a deposit method for an account. 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, you can use the Get Account Deposit Method endpoint with the same inputs to check the deposit method state.
If the deposit method is already set up, calling this endpoint again with the same inputs will not trigger a new setup process and instead will return the existing deposit method.

​
Bank deposits

When setting up a bank deposit method, the bank details you receive depend on the subject requesting the setup:
  • Individual users receive virtual account details under their own name. Deposits without the provided reference will still be credited to the correct user, but funds will be deposited in a default account.
  • Business users may receive virtual account details under their own name or a master account in Uphold’s name. In the latter case, the reference uniquely identifies both the business and target account and must be included in every transfer; otherwise, the funds won’t be credited automatically and may be returned.

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 set up.

​
depositMethod
object
required