Create a Deposit Address

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.12/deposit-addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "expectedSourceAsset": "usdc",
  "expectedSourceNetwork": "ethereum",
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "ext_fky491gakzj0dd46qb6whsr2vq",
      "asset": "usd",
      "network": "ach",
      "accountHolder": "customer"
    }
  },
  "sponsorGas": true,
  "label": "Alice deposit address"
}
'

import requests

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

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "expectedSourceAsset": "usdc",
    "expectedSourceNetwork": "ethereum",
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "ext_fky491gakzj0dd46qb6whsr2vq",
            "asset": "usd",
            "network": "ach",
            "accountHolder": "customer"
        }
    },
    "sponsorGas": True,
    "label": "Alice deposit address"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    expectedSourceAsset: 'usdc',
    expectedSourceNetwork: 'ethereum',
    destination: {
      type: 'bankUs',
      details: {
        id: 'ext_fky491gakzj0dd46qb6whsr2vq',
        asset: 'usd',
        network: 'ach',
        accountHolder: 'customer'
      }
    },
    sponsorGas: true,
    label: 'Alice deposit address'
  })
};

fetch('https://sandbox-api.polygon.technology/v0.12/deposit-addresses', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'expectedSourceAsset' => 'usdc',
    'expectedSourceNetwork' => 'ethereum',
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => 'ext_fky491gakzj0dd46qb6whsr2vq',
                'asset' => 'usd',
                'network' => 'ach',
                'accountHolder' => 'customer'
        ]
    ],
    'sponsorGas' => true,
    'label' => 'Alice deposit address'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://sandbox-api.polygon.technology/v0.12/deposit-addresses")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}"

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

{
  "id": "da_jts3wrvsp6dz04fntj1v4g3hyy",
  "object": "depositAddress",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "status": "pending",
  "expectedSourceAsset": "usdc",
  "expectedSourceNetwork": "ethereum",
  "destination": {
    "party": {
      "relationship": "customer",
      "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "name": "Jane Smith"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "id": "ext_cc35pa5vgrq1tpsqm4bxy2dkrg",
    "asset": "usd",
    "network": "ach",
    "displayName": "••••1234",
    "payoutOrigin": {
      "type": "bank",
      "id": null
    }
  },
  "label": "Alice deposit address",
  "createdAt": "2026-05-14T10:00:00Z",
  "updatedAt": "2026-05-14T10:00:00Z"
}

{
  "error": "<string>",
  "code": "ereborValidationFailed",
  "details": {
    "provider": "<string>",
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ],
    "providerRequestId": "<string>"
  }
}

Deposit Addresses

Create a Deposit Address

Create a Deposit Address. Requires deposit addresses to be enabled for your project and the customer to be provisioned with the banking provider. The address starts pending and becomes active once the inbound on-chain address is assigned.

A destination the project is not permitted to deliver to is rejected with 403 destinationRailNotAllowed before any address is provisioned: the project’s outgoing-rail allow-list denies the bank rail, or the routes table has no permitted/enabled route for the requested crypto network. The error body carries details: { network } — the denied bank rail (e.g. wire) or crypto network (e.g. polygon). (Not modeled as a typed error arm here so the other 403 codes on this operation — e.g. vendorConfigMissing, ereborConfigMissing — keep their shape.)

POST

deposit-addresses

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.12/deposit-addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "expectedSourceAsset": "usdc",
  "expectedSourceNetwork": "ethereum",
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "ext_fky491gakzj0dd46qb6whsr2vq",
      "asset": "usd",
      "network": "ach",
      "accountHolder": "customer"
    }
  },
  "sponsorGas": true,
  "label": "Alice deposit address"
}
'

import requests

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

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "expectedSourceAsset": "usdc",
    "expectedSourceNetwork": "ethereum",
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "ext_fky491gakzj0dd46qb6whsr2vq",
            "asset": "usd",
            "network": "ach",
            "accountHolder": "customer"
        }
    },
    "sponsorGas": True,
    "label": "Alice deposit address"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    expectedSourceAsset: 'usdc',
    expectedSourceNetwork: 'ethereum',
    destination: {
      type: 'bankUs',
      details: {
        id: 'ext_fky491gakzj0dd46qb6whsr2vq',
        asset: 'usd',
        network: 'ach',
        accountHolder: 'customer'
      }
    },
    sponsorGas: true,
    label: 'Alice deposit address'
  })
};

fetch('https://sandbox-api.polygon.technology/v0.12/deposit-addresses', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'expectedSourceAsset' => 'usdc',
    'expectedSourceNetwork' => 'ethereum',
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => 'ext_fky491gakzj0dd46qb6whsr2vq',
                'asset' => 'usd',
                'network' => 'ach',
                'accountHolder' => 'customer'
        ]
    ],
    'sponsorGas' => true,
    'label' => 'Alice deposit address'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://sandbox-api.polygon.technology/v0.12/deposit-addresses")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"expectedSourceAsset\": \"usdc\",\n  \"expectedSourceNetwork\": \"ethereum\",\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\",\n      \"accountHolder\": \"customer\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"label\": \"Alice deposit address\"\n}"

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

{
  "id": "da_jts3wrvsp6dz04fntj1v4g3hyy",
  "object": "depositAddress",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "status": "pending",
  "expectedSourceAsset": "usdc",
  "expectedSourceNetwork": "ethereum",
  "destination": {
    "party": {
      "relationship": "customer",
      "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "name": "Jane Smith"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "id": "ext_cc35pa5vgrq1tpsqm4bxy2dkrg",
    "asset": "usd",
    "network": "ach",
    "displayName": "••••1234",
    "payoutOrigin": {
      "type": "bank",
      "id": null
    }
  },
  "label": "Alice deposit address",
  "createdAt": "2026-05-14T10:00:00Z",
  "updatedAt": "2026-05-14T10:00:00Z"
}

{
  "error": "<string>",
  "code": "ereborValidationFailed",
  "details": {
    "provider": "<string>",
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ],
    "providerRequestId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Headers

Idempotency-Key

string

required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Body

application/json

Create a Deposit Address: the expected inbound asset/network pair plus the bank destination that receives the converted funds.

customerId

string

required

Owning customer (cus_… or legacy public id).

expectedSourceAsset

string

required

Asset of the inbound crypto the DA expects. "usdc" | "usdt" (lowercase).

expectedSourceNetwork

enum<string>

required

Network of the inbound crypto the DA expects. CryptoNetwork is the wire vocabulary (ethereum/polygon/base/solana); availability here is narrower — a closed allowlist of ethereum | base | solana. Any other value (arbitrum, optimism, polygon, ink, sui, …) is rejected with expectedSourceNetworkUnsupported.

Available options:

ethereum,

polygon,

base,

solana

destination

US bank account · object

required

Side-shaped destination. Fiat: bankUs / bankIban / bankCanada registered External Account (cryptoToFiatAccount), or walletFiat — the customer's own Erebor fiat wallet, credited via internal book transfer (cryptoToFiatAccount; rendered destination network bookTransfer). Crypto: walletExternal (registered ExternalAccount) delivers crypto onward (cryptoToCrypto; routes-table gated to ethereum/base/solana). walletCrypto is NOT currently supported — 422 destinationWalletCryptoNotSupported; use walletExternal. The server validates details (asset/network/accountHolder) against the resolved EA/wallet.

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

Registered crypto return destination (v0.11-8), for operations-triggered returns of stranded inbound deposits.

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. Ignored for non-crypto destinations (no on-chain leg).

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

The request has succeeded and a new resource has been created as a result.

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.id

string | null

required

OMS wallet ID (wlt_ prefix).

DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, WalletCryptoInstrument): the ratified shape has id required and non-nullable. A row can classify as this arm (destination_type=walletCrypto/legacy walletOms, per #2528) before the wallet FK has actually resolved — the "in-flight deposit" window destInstrumentKind's own doc comment describes — so id is nullable rather than emitting an empty string that fails the typeId scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead, same class as the CardInstrument.id/WalletFiatInstrument.id/ BankUsInstrument.network deviations elsewhere in this same change.

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.asset

string

required

Canonical asset identifier.

destination.network

string

required

Network identifier.

destination.displayName

string

required

Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN.

destination.party

object

Structured identity of who is on this side.

Hide child attributes

destination.party.relationship

enum<string>

required

Which kind of party this is.

Available options:

customer,

otherCustomer,

externalRegistered,

externalUnregistered

destination.party.id

string | null

required

cst_ for customer/otherCustomer; ctp_ for externalRegistered; null for externalUnregistered.

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.name

string | null

required

Display name. Null only when genuinely unknown (an unattributed external sender).

destination.memo

string

Free-text message travelling with the transfer on this side's rail.

destination.payoutOrigin

object

Where last-mile delivery is sent from, as a uniform {type, id} reference — response-only. id is the Virtual Account (va_) or OMS wallet (wlt_) funding the leg; null before execution (Quote / Deposit Address echo the choice only) or when the origin has no partner-visible resource. Rail identifiers for the last-mile transfer live in the top-level tracking array with leg: destination — not here.

Hide child attributes

destination.payoutOrigin.type

enum<string>

required

Available options:

bank,

blockchain

destination.payoutOrigin.id

string | null

required

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

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.companyDiscretionaryData

string

Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied.

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

Create a Deposit Address

Authorizations

Headers

Body

Response