--- title: "List all Deposit Addresses" method: GET path: "/deposit-addresses" tags: ["DepositAddress"] --- # List all Deposit Addresses `GET /deposit-addresses` List all Deposit Addresses across the organization. Spans every customer in the caller's organization; optionally filter by status and/or customer. ## Query parameters - `limit` integer - `startingAfter` string - `endingBefore` string - `status` 'pending' | 'active' | 'frozen' | 'closed' | 'failed' | 'inactiveActionRequired' — Lifecycle of a Deposit Address. pending: awaiting on-chain address assignment. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable, re-point `destination` to recover. closed: permanently disabled. failed: provisioning failed. - `customerId` string ## Response `200` The request has succeeded. - DepositAddressList — Paginated list of DepositAddress resources. - `object` string — Resource type discriminator. - `hasMore` boolean — True when more rows exist beyond this page in the direction of travel (forward by default, backward when `endingBefore` was supplied). - `nextCursor` string — Opaque cursor pointing at the last item in this page. Present when `data` is non-empty. Pass as `startingAfter` to fetch the next page; `hasMore=false` signals no more pages forward. - `previousCursor` string — Opaque cursor pointing at the first item in this page. Present when `data` is non-empty. Pass as `endingBefore` to page backward; when this yields an empty response the client is at the start of the list. - `data` DepositAddress[] — The page of results. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `object` 'depositAddress' — Resource type discriminator. Always "depositAddress". - `customerId` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `status` 'pending' | 'active' | 'frozen' | 'closed' | 'failed' | 'inactiveActionRequired' — Lifecycle of a Deposit Address. pending: awaiting on-chain address assignment. active: accepting deposits. frozen: deposits held by compliance. inactiveActionRequired: destination unusable, re-point `destination` to recover. closed: permanently disabled. failed: provisioning failed. - `statusReason` string — Human-readable explanation of the current status. - `expectedSourceAsset` string — Asset of the inbound crypto the deposit address expects. - `expectedSourceNetwork` string — Network of the inbound crypto the deposit address expects. - `depositInstructions` DepositAddressDepositInstructions — The on-chain address senders deposit to, with its asset and network. - `asset` string, required — Same value as expectedSourceAsset. - `network` string, required — Same value as expectedSourceNetwork. - `address` string, required — OMS-owned on-chain inlet address for this deposit address. - `expiresAt` string, date-time — Placeholder for a future provider-imposed inlet expiry. Null today; surfaced now so adding it later is not a breaking change. - `destination` union — The destination side of a transaction/quote (v0.10): a typed instrument plus `payoutOrigin`. Amounts live only in `pricing`. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'walletOms', required — Type discriminator. - `category` 'crypto', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` WalletOmsDetails, required — WalletOms instrument details: an OMS-custodied crypto wallet. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `asset` string — Canonical asset identifier. - `network` string — Network identifier. - `blockchainAddress` string — On-chain address. - `custodyType` 'custodial' | 'embedded' — How the wallet is held: `custodial` or `embedded`. - `txHash` string — On-chain transaction hash. - `blockchainAsset` BlockchainAsset - `protocol` 'evm' | 'svm' | 'sui', required - `chainId` string, required - `tokenId` string, required - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'walletExternal', required — Type discriminator. - `category` 'crypto', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` WalletExternalDetails, required — WalletExternal instrument details: a crypto wallet held in external custody. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `asset` string — Canonical asset identifier. - `network` string — Network identifier. - `blockchainAddress` string — On-chain address. - `custodian` string — Custodian holding the funds. - `otherCustodian` string — Free-text custodian name when `custodian` is `other`. - `txHash` string — On-chain transaction hash. - `blockchainAsset` BlockchainAsset - `protocol` 'evm' | 'svm' | 'sui', required - `chainId` string, required - `tokenId` string, required - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'bankUs', required — Type discriminator. - `category` 'fiatAccount', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` BankUsDetails, required — US bank account instrument details. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `asset` 'usd' — Canonical asset identifier. - `network` 'ach' | 'achSameDay' | 'wire' | 'rtp' — Network identifier. - `secCode` 'ccd' | 'ppd' | 'web' — ACH SEC code. Populated only when the destination bank network is `ach`/`achSameDay`; null otherwise. Server-derived from the destination owner's and the source customer's `entityType`. - `accountNumberLast4` string — Last four digits of the account number. - `routingNumber` string — US ABA routing number. - `bankName` string — Bank display name. - `accountType` 'checking' | 'savings' — checking or savings. - `memo` string — Payment memo. - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'bankIban', required — Type discriminator. - `category` 'fiatAccount', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` BankIbanDetails, required — IBAN bank account instrument details. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `asset` string — Canonical asset identifier. - `network` 'swift' — Network identifier. - `ibanLast4` string — Last four characters of the IBAN. - `BIC` string — SWIFT BIC. - `bankAddress` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - `line1` string — Street address, line 1. - `line2` string — Street address, line 2. - `city` string — City. - `state` string — State / province / region. - `country` string — ISO 3166-1 alpha-2 - `zipCode` string — ZIP / postal code. - `countryCode` string — ISO 3166-1 alpha-2 country code. - `memo` string — Payment memo. - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'bankCanada', required — Type discriminator. - `category` 'fiatAccount', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` BankCanadaDetails, required — Canadian bank account instrument details. - `id` string — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `asset` 'usd' | 'cad' — Canonical asset identifier. - `network` 'swift' | 'local' — Network identifier. - `institutionNumber` string — Canadian 3-digit institution number. - `transitNumber` string — Canadian 5-digit transit number. - `accountNumberLast4` string — Last four digits of the account number. - `bankName` string — Bank display name. - `memo` string — Payment memo. - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'card', required — Type discriminator. - `category` 'fiatAccount', required — High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. - `details` CardDetails, required — Card instrument details. - `id` string — Unique identifier. - `asset` 'usd' — Canonical asset identifier. - `network` 'card' — Network identifier. - `cardNumberLast4` string — Last four digits of the card number. - `cardProvider` string — Card network/provider. - `memo` string — Payment memo. - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - object - `party` union - object — The owning OMS customer is on this side. - `relationship` 'customer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - object — A different OMS customer is on this side. - `relationship` 'otherCustomer', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `customerId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - object — A registered counterparty (saved third party) is on this side. - `relationship` 'externalRegistered', required — Relationship discriminator. - `entityType` 'individual' | 'business' - `counterpartyId` string, required — Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID suffixes are accepted until non-v7 rows are retired. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - object — An unrecognized external party (no saved record) is on this side. There is no OMS record behind it, so it carries no entityType. - `relationship` 'externalUnregistered', required — Relationship discriminator. - `name` string, nullable — Display name. - `address` Address — A postal address. country is an ISO 3166-1 alpha-2 country code. - … - `type` 'cash', required — Type discriminator. - `category` 'cash', required — High-level grouping: always `cash` for cash pickups and drops. - `details` CashDetails, required — Cash pickup/drop instrument details. - `asset` string — Canonical asset identifier. - `cashLocationId` string — Cash location ID from `GET /cash-locations`. - `cashLocationReference` string — Provider reference for the location, from `GET /cash-locations`. - `code` string — Machine-readable code. - `expiresAt` string, date-time — Expiration time. - `locationName` string — Display name of the retail location. - `locationAddress` string — Street address of the retail location. - `payoutOrigin` union — Where last-mile delivery is sent *from*. Tiered: Quote & Deposit Address echo the choice only; the Transaction carries full detail (`accountNumber`/`routingNumber`/`txHash`). At launch all payouts route through a single provider, so the field is forward-compatible but single-valued. - object — Payout originates from a bank account. the response 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). - `type` 'bank', required — Type discriminator. - `details` PayoutOriginBankDetails, 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. - … - object — Payout originates from an on-chain address. - `type` 'blockchain', required — Type discriminator. - `blockchainAddress` string — On-chain address. - `network` string — Network identifier. - `txHash` string — On-chain transaction hash. - `custodian` string — Custodian holding the funds. - `returnWallet` ReturnWallet — Registered crypto return destination for a Deposit Address (v0.11): where an operations-triggered return of a stranded inbound deposit is sent. `network` must be one of ethereum | base | solana; a custodial (non-multi-asset) walletOms target is rejected with 422 return_wallet_must_be_multi_asset. - `type` 'walletOms' | 'walletExternal', required - `network` string, required — Return network. Must equal the DA's expectedSourceNetwork for the return to be usable. - `id` string, required — walletOms: OMS wallet id (acc_…). walletExternal: registered ExternalAccount id (ext_…). - `failureReason` 'provisioningTimeout' | 'systemError' | 'ereborRejected' | 'intlBankAccountCreateRejected' | 'noMatchingNetwork' | 'blockchainAddressInUse' | 'bankAccountInUse' — Closed enum carried on DA when status = "failed". camelCase per partner channel naming convention. - `sourceToDestination` 'cryptoToCrypto' | 'cryptoToCash' | 'cryptoToFiatAccount' | 'cashToCrypto' | 'fiatAccountToCrypto' | 'fiatAccountToFiatAccount' — Composite of source and destination instrument categories, inferred from each side. The cash corridors (`cryptoToCash`, `cashToCrypto`) are derived from a cash-pickup destination / cash-in source respectively; the rest map straight from the internal corridor type. - `sponsorGas` boolean — 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. - `createdAt` string, date-time — When the deposit address was created. - `updatedAt` string, date-time — When the deposit address was last updated. --- [API](https://skmtc.net/polygon-technology/apis/polygon-oms-public-api.md) · [All operations](https://skmtc.net/polygon-technology/apis/polygon-oms-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polygon-technology/polygon-oms-public-api/revisions/18fdaebf64e5/schema)