Get account deposit method
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"depositMethod": {
"type": "crypto",
"status": "ok",
"details": {
"asset": "BTC",
"network": "bitcoin",
"address": "tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn",
"addressFormats": [
{
"format": "native-segwit",
"value": "tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn"
},
{
"format": "wrapped-segwit",
"value": "2MzJXEZeyJV4jMHxkeGY7x88DPpF15p78ks"
}
]
}
}
}Accounts
Get account deposit method
Gets deposit method for depositing into an account externally.
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>'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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.
Scopes
Query Parameters
Was this page helpful?