Create a Deposit Address

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.11/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.11/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.11/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.11/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.11/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.11/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.11/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",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "details": {
      "id": "ext_cc35pa5vgrq1tpsqm4bxy2dkrg",
      "asset": "usd",
      "network": "ach",
      "accountNumberLast4": "1234",
      "routingNumber": "021000021",
      "bankName": "Chase",
      "accountType": "checking"
    },
    "payoutOrigin": {
      "type": "bank",
      "details": {
        "accountHolder": "customer",
        "accountHolderName": "Jane Smith"
      }
    }
  },
  "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.11/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.11/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.11/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.11/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.11/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.11/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.11/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",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "details": {
      "id": "ext_cc35pa5vgrq1tpsqm4bxy2dkrg",
      "asset": "usd",
      "network": "ach",
      "accountNumberLast4": "1234",
      "routingNumber": "021000021",
      "bankName": "Chase",
      "accountType": "checking"
    },
    "payoutOrigin": {
      "type": "bank",
      "details": {
        "accountHolder": "customer",
        "accountHolderName": "Jane Smith"
      }
    }
  },
  "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

string

required

Network of the inbound crypto the DA expects. A closed allowlist — ethereum | base | solana. Any other value (arbitrum, optimism, polygon, ink, sui, …) is rejected with expectedSourceNetworkUnsupported.

destination

US bank account · object

required

Side-shaped destination. Fiat: bankUs / bankIban / bankCanada registered External Account (cryptoToFiatAccount). Crypto: walletOms (OMS wallet) or walletExternal (registered ExternalAccount) delivers crypto onward (cryptoToCrypto; routes-table gated to ethereum/base/solana). The server validates details (asset/network/accountHolder) against the resolved EA/wallet.

US bank account
IBAN bank account
Canadian bank account
OMS wallet
External wallet (registered)

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

walletOms,

walletExternal

returnDestination.network

string

required

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

returnDestination.id

string

required

walletOms: 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})$

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

string

Network of the inbound crypto the DA expects.

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

string

required

Same value as expectedSourceNetwork.

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:

walletOms

destination.category

enum<string>

required

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

Available options:

crypto

destination.details

object

required

WalletOms 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.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:

walletOms,

walletExternal

returnDestination.network

string

required

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

returnDestination.id

string

required

walletOms: 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.

Refresh a cash-in deposit code

List all Deposit Addresses

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Create a Deposit Address

Authorizations

Headers

Body

Response