Skip to main content
GET
/
deposit-addresses
/
{depositAddressId}
Get a Deposit Address
curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}', 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://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}",
  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://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}"

	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://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.10/deposit-addresses/{depositAddressId}")

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
{
  "createdAt": "2023-11-07T05:31:56Z",
  "customerId": "<string>",
  "depositInstructions": {
    "address": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "destination": {
    "category": "crypto",
    "details": {
      "asset": "<string>",
      "blockchainAddress": "<string>",
      "blockchainAsset": {
        "chainId": "<string>",
        "tokenId": "<string>"
      },
      "id": "<string>",
      "network": "<string>",
      "txHash": "<string>"
    },
    "type": "walletOms",
    "party": {
      "customerId": "<string>",
      "relationship": "customer"
    },
    "payoutOrigin": {
      "details": {
        "accountHolder": "customer",
        "accountHolderName": "<string>",
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "virtualAccountId": "<string>"
      },
      "type": "bank"
    }
  },
  "expectedSourceAsset": "<string>",
  "expectedSourceNetwork": "<string>",
  "id": "<string>",
  "label": "<string>",
  "metadata": {},
  "object": "depositAddress",
  "statusReason": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

depositAddressId
string
required

Response

200 - application/json

The request has succeeded.

createdAt
string<date-time>
customerId
string

Public customer id (cst_...). Named customerId to match VA's naming convention.

depositInstructions
object

Null in the 201 until provisioning populates the OMS-owned inlet address. Top-level mirror of the virtual account's bankDetails.

destination
object

Unified destination shape (payoutOrigin lives inside TransactionDestination).

expectedSourceAsset
string

Asset of the inbound crypto the DA expects.

expectedSourceNetwork
string

Network of the inbound crypto the DA expects.

failureReason
enum<string>

v2: closed enum carried on DA when status = "failed". camelCase per partner channel naming convention.

Available options:
provisioningTimeout,
systemError,
ereborRejected,
intlBankAccountCreateRejected,
noMatchingNetwork,
blockchainAddressInUse,
bankAccountInUse
id
string
label
string
metadata
object
object
enum<string>
Available options:
depositAddress
status
enum<string>
Available options:
pending,
active,
frozen,
closed,
failed,
inactiveActionRequired
statusReason
string
transactionType
enum<string>

Always TransferType.cryptoToFiat for DA. Reuses the existing TransferType enum (instead of a string literal) to avoid collision-driven renames on the generated oapi enums - see feedback_reuse_enums_over_collision memory.

Available options:
cryptoToCrypto,
fiatToCrypto,
cryptoToFiat
updatedAt
string<date-time>