Update a Deposit Address

curl --request PATCH \
  --url https://sandbox-api.polygon.technology/v0.12/deposit-addresses/{depositAddressId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "<string>",
      "asset": "usd",
      "accountHolder": "customer",
      "memo": "<string>",
      "companyDiscretionaryData": "<string>"
    },
    "amount": "<string>"
  },
  "sponsorGas": true,
  "label": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "<string>",
            "asset": "usd",
            "accountHolder": "customer",
            "memo": "<string>",
            "companyDiscretionaryData": "<string>"
        },
        "amount": "<string>"
    },
    "sponsorGas": True,
    "label": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: {
      type: 'bankUs',
      details: {
        id: '<string>',
        asset: 'usd',
        accountHolder: 'customer',
        memo: '<string>',
        companyDiscretionaryData: '<string>'
      },
      amount: '<string>'
    },
    sponsorGas: true,
    label: '<string>',
    metadata: {}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.12/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.12/deposit-addresses/{depositAddressId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => '<string>',
                'asset' => 'usd',
                'accountHolder' => 'customer',
                'memo' => '<string>',
                'companyDiscretionaryData' => '<string>'
        ],
        'amount' => '<string>'
    ],
    'sponsorGas' => true,
    'label' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox-api.polygon.technology/v0.12/deposit-addresses/{depositAddressId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "depositAddress",
  "customerId": "<string>",
  "customer": {
    "id": "<string>",
    "name": "<string>"
  },
  "statusReason": "<string>",
  "expectedSourceAsset": "<string>",
  "depositInstructions": {
    "asset": "<string>",
    "address": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "destination": {
    "type": "walletCrypto",
    "category": "crypto",
    "details": {
      "id": "<string>",
      "asset": "<string>",
      "network": "<string>",
      "blockchainAddress": "<string>",
      "txHash": "<string>",
      "blockchainAsset": {
        "chainId": "<string>",
        "tokenId": "<string>"
      }
    },
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "customerId": "<string>"
    },
    "payoutOrigin": {
      "type": "bank",
      "details": {
        "accountHolder": "customer",
        "accountHolderName": "<string>",
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "virtualAccountId": "<string>"
      }
    }
  },
  "returnDestination": {
    "id": "<string>"
  },
  "sponsorGas": true,
  "label": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

PATCH

deposit-addresses

{depositAddressId}

Update a Deposit Address

curl --request PATCH \
  --url https://sandbox-api.polygon.technology/v0.12/deposit-addresses/{depositAddressId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "<string>",
      "asset": "usd",
      "accountHolder": "customer",
      "memo": "<string>",
      "companyDiscretionaryData": "<string>"
    },
    "amount": "<string>"
  },
  "sponsorGas": true,
  "label": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "<string>",
            "asset": "usd",
            "accountHolder": "customer",
            "memo": "<string>",
            "companyDiscretionaryData": "<string>"
        },
        "amount": "<string>"
    },
    "sponsorGas": True,
    "label": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: {
      type: 'bankUs',
      details: {
        id: '<string>',
        asset: 'usd',
        accountHolder: 'customer',
        memo: '<string>',
        companyDiscretionaryData: '<string>'
      },
      amount: '<string>'
    },
    sponsorGas: true,
    label: '<string>',
    metadata: {}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.12/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.12/deposit-addresses/{depositAddressId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => '<string>',
                'asset' => 'usd',
                'accountHolder' => 'customer',
                'memo' => '<string>',
                'companyDiscretionaryData' => '<string>'
        ],
        'amount' => '<string>'
    ],
    'sponsorGas' => true,
    'label' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox-api.polygon.technology/v0.12/deposit-addresses/{depositAddressId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"<string>\",\n      \"asset\": \"usd\",\n      \"accountHolder\": \"customer\",\n      \"memo\": \"<string>\",\n      \"companyDiscretionaryData\": \"<string>\"\n    },\n    \"amount\": \"<string>\"\n  },\n  \"sponsorGas\": true,\n  \"label\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "depositAddress",
  "customerId": "<string>",
  "customer": {
    "id": "<string>",
    "name": "<string>"
  },
  "statusReason": "<string>",
  "expectedSourceAsset": "<string>",
  "depositInstructions": {
    "asset": "<string>",
    "address": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "destination": {
    "type": "walletCrypto",
    "category": "crypto",
    "details": {
      "id": "<string>",
      "asset": "<string>",
      "network": "<string>",
      "blockchainAddress": "<string>",
      "txHash": "<string>",
      "blockchainAsset": {
        "chainId": "<string>",
        "tokenId": "<string>"
      }
    },
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "customerId": "<string>"
    },
    "payoutOrigin": {
      "type": "bank",
      "details": {
        "accountHolder": "customer",
        "accountHolderName": "<string>",
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "virtualAccountId": "<string>"
      }
    }
  },
  "returnDestination": {
    "id": "<string>"
  },
  "sponsorGas": true,
  "label": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Path Parameters

depositAddressId

string

required

Deposit Address ID (da_ prefix).

Body

application/json

Partial update payload for a Deposit Address. The patchable fields are destination (re-point to a different bank-type External Account), returnDestination, label, and metadata. Any additional key in the JSON body is rejected with 400 by the handler (strict whitelist).

Re-pointing destination to a healthy bank External Account recovers a DA from inactiveActionRequired back to active; a re-point on an already active DA updates the target without a status transition.

destination

US bank account · object

Re-point the DA destination (bank-type External Account by EA id, a registered walletExternal crypto wallet, or a walletFiat fiat wallet). Re-validated exactly like create; walletCrypto is NOT currently supported — 422 destinationWalletCryptoNotSupported. Switching between destination kinds (bank / cryptoWallet / walletFiat) involving walletFiat is rejected with 422 destinationTypeSwitchNotSupported.

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

bankUs

destination.details

object

required

Hide child attributes

destination.details.id

string

required

US bank ExternalAccount ID (ext_bankUs_ prefix).

destination.details.asset

enum<string>

required

Canonical asset identifier.

Available options:

usd

destination.details.network

enum<string>

required

Network identifier.

Available options:

ach,

achSameDay,

wire

destination.details.accountHolder

enum<string>

required

Who holds the payout bank account (OMS closed enum). customer is the only valid value.

Available options:

customer

destination.details.memo

string | null

Optional customer-supplied payment memo delivered to the beneficiary's bank.

HONORED TODAY ON: a Deposit Address bankUs destination with network: "wire" (create and update). The stored value replaces — it does not append to — the memo OMS would otherwise generate for every outbound Fedwire payout from that deposit address. Send null (or omit it on an update that replaces destination) to restore the generated memo. Because the memo is read when each payout wire is built, an edit affects only future payouts, never one already in flight.

REJECTED EVERYWHERE ELSE, with 422 memoNotSupported: this model is shared by the Quote and Virtual Account request surfaces (create and update), and by a deposit-address bankUs destination on the ach / achSameDay rails. A non-empty memo on any of those is refused rather than accepted and dropped — a silently ignored field on a money path gives the caller a success response while the payout carries the generated memo. Sending null, omitting the field, or sending only whitespace is always accepted (it means "no override"). Each rejected surface becomes accepting as its slice ships (omsx#2254); relaxing a 422 into an accepted value never breaks a caller, so no client needs to change when that happens.

The error body's details.reason tells apart a temporary gap from a permanent one: "notImplemented" means this surface/rail will accept the field once its omsx#2254 slice ships (every current rejection above is this case); "unsupportedRail" would mean the field is not a concept on this rail and never will be (e.g. the shared model also carries fields that are rail-specific by design, like ACH's companyDiscretionaryData on a wire destination) — retry the first after a release, never the second.

Maximum string length: 140

Pattern: ^[A-Za-z0-9 /?:().,'+\-]*$

destination.details.companyDiscretionaryData

string | null

Optional ACH-only field for the originator's internal use (NACHA batch header). See the companyDiscretionaryData scalar doc. Honored only when network is "ach" or "achSameDay"; 422 memoNotSupported on "wire".

Maximum string length: 20

Pattern: ^[A-Z0-9 &\-\.\$*\/#@%]*$

destination.amount

string

Wire-safe decimal string for financial float values (USD amounts, percentages).

returnDestination

object

Re-point the registered crypto return destination (v0.11-8). PATCHable per the v0.11-8 contract; send explicit null to clear.

Hide child attributes

returnDestination.type

enum<string>

required

Available options:

walletCrypto,

walletExternal

returnDestination.network

enum<string>

required

Return network. Must equal the DA's expectedSourceNetwork for the return to be usable.

Available options:

ethereum,

polygon,

base,

solana

returnDestination.id

string

required

walletCrypto: OMS wallet id (acc_…). walletExternal: registered ExternalAccount id (ext_…).

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported; accepted for forward-compatibility.

label

string

Partner display label.

metadata

object

Free-form key-value pairs stored on the resource and echoed back on reads.

Hide child attributes

metadata.{key}

string

Response

200 - application/json

The request has succeeded.

A reusable crypto deposit configuration. Senders deposit the expected asset/network to the assigned on-chain address; OMS converts and delivers the funds to the configured bank destination automatically, creating a transaction per inbound deposit.

string

Deposit Address ID (da_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

object

enum<string>

Resource type discriminator. Always "depositAddress".

Available options:

depositAddress

customerId

string

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

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

customer

object

Resolved id + display name of the owning customer, so list/detail rendering needs no follow-up customer fetch (v0.12, #2665).

Hide child attributes

customer.id

string

required

The OMS customer id (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

customer.name

string

required

Customer display name.

status

enum<string>

Current lifecycle status of the deposit address.

Available options:

pending,

active,

frozen,

closed,

failed,

inactiveActionRequired

statusReason

string

Human-readable explanation of the current status.

expectedSourceAsset

string

Asset of the inbound crypto the DA expects.

expectedSourceNetwork

enum<string>

Network of the inbound crypto the DA expects.

Available options:

ethereum,

polygon,

base,

solana

depositInstructions

object

Null in the 201 until DEPOSIT_ACCOUNT.OPEN populates the Erebor-owned inlet address.

Hide child attributes

depositInstructions.asset

string

required

Same value as expectedSourceAsset.

depositInstructions.network

enum<string>

required

Same value as expectedSourceNetwork.

Available options:

ethereum,

polygon,

base,

solana

depositInstructions.address

string

required

Erebor-owned on-chain inlet address for this DA.

depositInstructions.expiresAt

string<date-time>

Placeholder for a future provider-imposed inlet expiry. Null for Erebor DDAs today; surfaced now so adding it later is not a breaking change.

destination

OMS wallet · object

V0.10: unified destination shape (payoutOrigin now lives inside TransactionDestination).

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

walletCrypto

destination.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

destination.details

object

required

WalletCrypto instrument details: an OMS-custodied crypto wallet.

Hide child attributes

destination.details.id

string

Internal OMS wallet (wlt_ prefix; legacy acc_ also accepted on input).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.details.asset

string

Canonical asset identifier.

destination.details.network

string

Network identifier.

destination.details.blockchainAddress

string

On-chain address.

destination.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

destination.details.txHash

string

On-chain transaction hash.

destination.details.blockchainAsset

object

BPN extension: resolved on-chain asset identity (protocol/chainId/tokenId).

Hide child attributes

destination.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

destination.details.blockchainAsset.chainId

string

required

destination.details.blockchainAsset.tokenId

string

required

destination.displayName

string

required

Opaque, render-only summary of this instrument for list/detail display (v0.12, #2665) — format is not contractual and may change without a version bump. Never a full account number/IBAN/PAN.

destination.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

destination.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

destination.party.customerId

string

required

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.party.entityType

enum<string>

Available options:

individual,

business

destination.payoutOrigin

Bank · object

Payout originates from a bank account. v0.10 wraps the fields in a details envelope (matches the precursor shape). accountNumber/routingNumber are full sending-account detail rendered on the Transaction only, null on Quote/Deposit Address (choice-only).

Bank
Blockchain

Hide child attributes

destination.payoutOrigin.type

enum<string>

required

Type discriminator.

Available options:

bank

destination.payoutOrigin.details

object

required

Bank payout-origin detail. accountHolder(+Name) is the chosen sender identity (echoed on Quote/DA too); accountNumber/routingNumber are the full sending-account coordinates (Transaction only, else null); virtualAccountId is the VA the funds were pulled from.

Hide child attributes

destination.payoutOrigin.details.accountHolder

enum<string>

Who holds the payout bank account (OMS closed enum). customer is the only valid value.

Available options:

customer

destination.payoutOrigin.details.accountHolderName

string

Name of the sending account holder.

destination.payoutOrigin.details.accountNumber

string | null

Bank account number.

destination.payoutOrigin.details.routingNumber

string | null

US ABA routing number.

destination.payoutOrigin.details.virtualAccountId

string | null

Virtual Account ID (va_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

returnDestination

object

Registered crypto return destination (v0.11-8), echoed when set.

Hide child attributes

returnDestination.type

enum<string>

required

Available options:

walletCrypto,

walletExternal

returnDestination.network

enum<string>

required

Return network. Must equal the DA's expectedSourceNetwork for the return to be usable.

Available options:

ethereum,

polygon,

base,

solana

returnDestination.id

string

required

walletCrypto: OMS wallet id (acc_…). walletExternal: registered ExternalAccount id (ext_…).

failureReason

enum<string>

Set when status = failed; closed enum identifying the failure category.

Available options:

provisioningTimeout,

systemError,

ereborRejected,

intlBankAccountCreateRejected,

noMatchingNetwork,

blockchainAddressInUse,

bankAccountInUse

sourceToDestination

enum<string>

Derived from the destination type: cryptoToFiatAccount for a bank destination, or cryptoToCrypto for a crypto-wallet destination.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

Whether OMS absorbs the on-chain gas cost for the destination delivery. Persisted from the create/update request (currently only true is accepted).

label

string

Partner display label.

metadata

object

Free-form key-value pairs supplied at creation or update.

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

When the deposit address was created.

updatedAt

string<date-time>

When the deposit address was last updated.

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Update a Deposit Address

Authorizations

Path Parameters

Body

Response