Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.
Path Parameters
withdrawalRequestId
string
required
Withdrawal request ID (wdr_ prefix).
Response
The request has succeeded.
A withdrawal submitted from a quote. When the project requires approval it waits for a second person, and approving creates the transaction; otherwise submitting creates the transaction at once.
The counterparty's name. A customer's name is on the customer resource.
destination.details
object
OMS crypto wallet details.
Hide child attributes
destination.details.address
string
On-chain address.
pricing
object
required
Pricing from the latest quote.
Hide child attributes
pricing.fees
object[]
required
Every fee charged across both sides. [] when there are none — never omitted, never null.
Hide child attributes
pricing.fees.type
string
required
Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: "developer", "oms", "gas", "retailer" (a cash provider's retail fee, on CashIn.providerFee), "exchange" (the exchange fee the crypto purchase realized, on the linked transaction once it completes).
pricing.fees.side
enum<string>
required
Which side this fee was deducted from.
Available options:
source,
destination
pricing.fees.asset
string
required
Currency this fee is denominated in — that side's asset.
pricing.fees.amount
string
required
Fee amount in asset, at the asset's precision.
pricing.source
object
The source side, in the source asset.
Hide child attributes
pricing.source.asset
string
required
Lowercase asset of this side, the same as the side's instrument asset.
pricing.source.amount
string
On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.
pricing.destination
object
The destination side, in the destination asset.
Hide child attributes
pricing.destination.asset
string
required
Lowercase asset of this side, the same as the side's instrument asset.
pricing.destination.amount
string
On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.
pricing.exchangeRate
string
Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.
pricing.fixedAmountSide
enum<string>
The side whose amount was fixed at creation. OMS calculated the other side.
Available options:
source,
destination
pricing.sponsorGas
boolean
Present and true when OMS absorbs the destination gas cost; omitted otherwise.
createdBy
object
required
Who submitted the request.
Hide child attributes
createdBy.type
enum<string>
required
Whether the actor is a person or an API key.
Available options:
user,
apiKey
createdBy.id
string
required
The actor's id.
createdAt
string<date-time>
required
When the request was created.
updatedAt
string<date-time>
required
When the request was last updated.
reviewedBy
object
Who approved or rejected the request.
Hide child attributes
reviewedBy.type
enum<string>
required
Whether the actor is a person or an API key.
Available options:
user,
apiKey
reviewedBy.id
string
required
The actor's id.
reviewedAt
string<date-time>
When the request was approved or rejected. Set for approved and rejected requests only.
transactionId
string
The transaction an approved request created (txn_ prefix).
Current lifecycle status. See subStatus for finer granularity.
Available options:
processing,
awaitingAction,
completed,
failed
transaction.subStatus
enum<string>
required
Status-scoped sub-state (e.g. processing.fundsPulled). Always present: each status carries a default member (e.g. processing.initiated) when no more specific value applies.
Available options:
processing.fundsPulled,
processing.cashPickupReady,
processing.underReview,
processing.payoutRetrying,
processing.payoutUnconfirmed,
processing.payoutHeld,
processing.returningToSender,
completed.cashPickupCollected,
completed.cashPickupExpired,
awaitingAction.informationRequested,
awaitingAction.awaitingSenderAttribution,
awaitingAction.payoutDestinationMissing,
awaitingAction.depositAddressFrozen,
failed.attributionTimeout,
failed.depositAddressFrozenTimeout,
failed.depositAddressInactiveTimeout,
failed.depositAddressClosed,
processing.awaitingCryptoOut,
processing.cryptoOut,
processing.awaitingFiatOut,
processing.fiatOut,
processing.inboundPending,
processing.inboundProcessing,
failed.inboundFailed,
failed.returnedToSender,
processing.initiated,
completed.settled,
failed.unspecified,
failed.expired,
failed.providerDeclined,
failed.outboundFailed
transaction.customer
object
required
The customer that owns this record — the sender on a transaction.
The counterparty's name. A customer's name is on the customer resource.
transaction.destination.details
object
OMS crypto wallet details.
Hide child attributes
transaction.destination.details.address
string
On-chain address.
transaction.pricing
object
required
Consolidated economics.
Hide child attributes
transaction.pricing.fees
object[]
required
Every fee charged across both sides. [] when there are none — never omitted, never null.
Hide child attributes
transaction.pricing.fees.type
string
required
Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: "developer", "oms", "gas", "retailer" (a cash provider's retail fee, on CashIn.providerFee), "exchange" (the exchange fee the crypto purchase realized, on the linked transaction once it completes).
transaction.pricing.fees.side
enum<string>
required
Which side this fee was deducted from.
Available options:
source,
destination
transaction.pricing.fees.asset
string
required
Currency this fee is denominated in — that side's asset.
transaction.pricing.fees.amount
string
required
Fee amount in asset, at the asset's precision.
transaction.pricing.source
object
The source side, in the source asset.
Hide child attributes
transaction.pricing.source.asset
string
required
Lowercase asset of this side, the same as the side's instrument asset.
transaction.pricing.source.amount
string
On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.
transaction.pricing.destination
object
The destination side, in the destination asset.
Hide child attributes
transaction.pricing.destination.asset
string
required
Lowercase asset of this side, the same as the side's instrument asset.
transaction.pricing.destination.amount
string
On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.
transaction.pricing.exchangeRate
string
Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.
transaction.pricing.fixedAmountSide
enum<string>
The side whose amount was fixed at creation. OMS calculated the other side.
Available options:
source,
destination
transaction.pricing.sponsorGas
boolean
Present and true when OMS absorbs the destination gas cost; omitted otherwise.
transaction.precursor
object
What created this transaction, as a uniform {type, id} reference — dereference the resource by id for its full record. A custodial-wallet deposit renders {type: walletDeposit}. Left out for a genuine out-of-band arrival with no recognised origin at all; the manual arm is reserved for a future operator-initiated transaction, distinct from either.
Hide child attributes
transaction.precursor.type
enum<string>
required
Available options:
quote,
depositAddress,
virtualAccount,
cashIn,
manual,
walletDeposit
transaction.precursor.id
string | null
required
qt_ / da_ / va_ / ci_. Null for manual and walletDeposit.
Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.
Available options:
customer,
paymentProvider,
partner
transaction.payoutOrigin.accountHolderName
string
The legal name the payment is sent under, resolved from accountHolder — the customer's own legal name for customer, the owning customer's legal name for partner (for now; a partner-level name may replace it later), or the payment provider's name for paymentProvider, which differs between a bank origin ("Coinme Inc FBO its Customers") and a blockchain origin. This is what the recipient sees as the sender. Like accountHolder and unlike id, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever accountHolder is, and when the customer's name cannot be read at that moment.
transaction.transfers
object[]
The transaction's transfers, in creation order: each movement of its money on one rail. Left out until the first transfer exists; fetch one with GET /transfers/{transferId}.
What a transfer does in its transaction. deposit brings money in, payout sends it out and refund sends it back to the sender. A bank return is the transfer's returned status, not a role.
Available options:
deposit,
payout,
refund
transaction.transfers.rail
enum<string>
required
How a transfer's money moved. instant is an RTP or FedNow payout, named in instantRail; intraBank stays inside the bank, named in intraBankRail. A record created before the umbrella names were introduced keeps rtp or bookTransfer.
Available options:
ach,
achSameDay,
wire,
internationalWire,
rtp,
bookTransfer,
instant,
intraBank,
blockchain,
card,
cash
transaction.transfers.attempt
integer<int32>
required
1 for the first send; a payout sent again after a confirmed failure is a new transfer with attempt + 1.
transaction.transfers.instantRail
enum<string>
Only when rail is instant.
Available options:
rtp,
fednow
transaction.transfers.intraBankRail
enum<string>
Only when rail is intraBank.
Available options:
bookTransfer,
crnow,
ereborRail
transaction.failure
object
Why the transaction failed. Present only when status is failed.
Hide child attributes
transaction.failure.code
enum<string>
required
What went wrong.
Available options:
providerError,
providerRejected,
providerTimeout,
expired,
systemError,
provisioningTimeout,
insufficientFunds,
providerAmountBelowMinimum,
limitExceeded,
outsideSellBounds,
outsideSellVelocityBounds,
unusableAmount,
unsupportedCorridor,
outgoingRailNotEnabled,
ssnNotVerified,
riskRejected,
cardDeclined,
bankSellDeclined,
payoutFailed,
priceMoved,
returningToSender,
returnedToSender,
returnFailed,
depositFailed,
attributionTimeout,
assetMismatch,
chainMismatch,
misattributedArrival,
depositAddressNotActive,
virtualAccountNotActive,
counterpartyArchived,
destinationUnavailable,
walletClaimed,
walletBoundToCustodialFlow,
projectSuspended,
memoInvalid,
cashDepositFailed,
noMatchingNetwork,
blockchainAddressInUse,
bankAccountInUse,
bankAccountRejected,
deletePendingTimeout,
providerAccountMissing,
cardInUse,
cardLimitReached,
countryProhibited,
countryNotSupported,
cardVerificationDeclined,
bankVerificationDeclined,
accountClosed,
accountFrozenByBank,
routingOrAccountNumberInvalid,
accountHolderDeceased,
accountDoesNotSupportTransfers,
payeeNameMismatch,
walletUnreachableOnNetwork,
billingAddressMismatch,
cardExpired,
cardClosedOrLostStolen,
pushToCardUnsupported,
cardDeclinedByIssuer
transaction.failure.message
string
required
A fixed, vendor-neutral sentence for code.
transaction.failure.retryable
boolean
required
Whether trying the same thing again can succeed.
transaction.failure.bankCode
string
The bank's own return code, only on an external account a bank return made invalid.
transaction.hold
object
What the partner must do while status is awaitingAction. Left out in every other status.
Hide child attributes
transaction.hold.code
enum<string>
required
Why the resource is held.
Available options:
senderAttribution,
payoutDestinationMissing
transaction.hold.message
string
required
A fixed, vendor-neutral sentence for code.
transaction.hold.deadline
string<date-time>
When the hold times out and the transaction fails. Only on senderAttribution.
transaction.hold.match
object
The sender's address and network to register to release the hold. Only on senderAttribution.
Hide child attributes
transaction.hold.match.address
string
required
The sender's on-chain address.
transaction.hold.match.network
enum<string>
required
The network family of the sender's address.
Available options:
evm,
solana,
tron
transaction.metadata
object
Free-form key-value pairs supplied at creation or update.
Hide child attributes
transaction.metadata.{key}
string
transaction.createdAt
string<date-time>
When the transaction was created.
transaction.updatedAt
string<date-time>
When the transaction was last updated.
transaction.completedAt
string<date-time>
When the transaction first reached completed: the source leg's completion for a single-leg transaction, the payout leg's for a multi-leg one. Written once and never moved by a later provider notification. Present only while status is completed: a completed transaction that is later reversed (for example a returned payout) drops it.
metadata
object
Free-form key-value pairs supplied at submission.
Hide child attributes
metadata.{key}
string
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polygon Developer Docs","colors":{"primary":"#670DE5","light":"#9551F5","dark":"#500AB2"},"logo":{"light":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f","dark":"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/dark.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=3b2b67f82ff1720328da11b176a86499"},"favicon":"https://mintcdn.com/polygon-labs/Xy_MJE0q00vmTroE/favicon.svg?fit=max\u0026auto=format\u0026n=Xy_MJE0q00vmTroE\u0026q=85\u0026s=3c26f9a9ab4a7a50ac3da5c9ad26c954","api":{"openapi":"api-reference/openapi.yaml","params":{"expanded":"all"},"playground":{"display":"interactive"},"mdx":{"server":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/resources/build-with-ai","label":"Build with AI"},{"href":"https://polygon.technology/get-access?utm_source=docs\u0026utm_medium=navbar\u0026utm_campaign=oms_access","label":"Request OMS Access"}]},"footer":{"socials":{"x":"https://x.com/0xPolygon","github":"https://github.com/0xPolygon","linkedin":"https://www.linkedin.com/company/polygonlabs","discord":"https://discord.com/invite/polygon-support-635865020172861441"},"links":[{"items":[{"label":"Support","href":"https://support.polygon.technology/support/home"}]}]},"fonts":{"family":"Fustat"},"integrations":{"ga4":{"measurementId":"G-RJ6JC0EEY5"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polygon-labs","hasAudioNarration":false,"actualSubdomain":"polygon-labs","customDomains":["docs.polygon.technology"],"gitSource":{"type":"github","owner":"0xpolygon","repo":"new-polygon-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"contextualFeedback":{"allowEmail":true},"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afd9a99dd0acd4b075b5f5f","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Developer Docs","count":481},{"language":"default","tag":"Polygon Chain","count":383},{"language":"default","tag":"Wallets","count":174},{"language":"default","tag":"Developer Tools","count":93},{"language":"default","tag":"API Reference","count":85},{"language":"default","tag":"Agglayer","count":73},{"language":"default","tag":"Platform","count":70},{"language":"default","tag":"Non-custodial","count":60},{"language":"default","tag":"Matic.js","count":59},{"language":"default","tag":"SDK","count":54}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@polygon.technology","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69cbd3d67f226f107dbd9b72","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"Can I move assets between different chains with OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:58.134Z","updatedAt":"2026-03-31T14:01:58.134Z","__v":0},{"_id":"69cbd3b07f226f107dbd9a9b","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"What are my options for integrating a wallet?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:01:20.206Z","updatedAt":"2026-03-31T14:01:20.206Z","__v":0},{"_id":"69cbd3737f226f107dbd9910","deploymentId":"69a9bcc427671ec5a2e05f92","questionText":"How does KYC / KYB work in OMS?","status":"active","generatedBy":"manual","createdAt":"2026-03-31T14:00:19.974Z","updatedAt":"2026-03-31T14:00:19.974Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":".nav-tabs{gap:0!important;align-items:center!important}div:has(>.nav-tabs){height:58px!important}.nav-tabs a.nav-tabs-item{padding:7px 12px!important;font-size:14px;font-weight:500;color:#64708F!important;transition:color 120ms ease, background 120ms ease}.nav-tabs a.nav-tabs-item:hover{color:#141635!important}html.dark .nav-tabs a.nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .nav-tabs a.nav-tabs-item:hover{color:#fff!important}.fam-grp{display:inline-flex;align-items:center;gap:4px}.fam-gap{width:1px;height:22px;background:#DFE3F0;margin:0 16px;flex-shrink:0}.fam-grp .nav-tabs-item>div{display:none!important}.fam-grp .nav-tabs-item{padding:7px 12px!important;border-radius:8px;font-size:14px;font-weight:500;color:#64708F!important;white-space:nowrap;text-decoration:none;transition:color 120ms ease, background 120ms ease!important}.fam-grp .nav-tabs-item:hover{color:#141635!important}.fam-grp .nav-tabs-item.fam-active-tab{background:#EAE4F5!important;color:#500AB2!important;font-weight:500!important}.fam-grp .nav-tabs-item.fam-active-tab svg{color:#500AB2!important}html.dark .fam-gap{background:rgba(255, 255, 255, 0.14)}html.dark .fam-grp .nav-tabs-item{color:rgba(255, 255, 255, 0.55)!important}html.dark .fam-grp .nav-tabs-item:hover{color:#fff!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab{background:rgba(103, 13, 229, 0.22)!important;color:#A78BFA!important}html.dark .fam-grp .nav-tabs-item.fam-active-tab svg{color:#A78BFA!important}#navbar a[href*=\"build-with-ai\"]{background:#fff!important;color:#141635!important;border:1px solid #C8CFE1!important;font-weight:600!important;transition:border-color 140ms ease, background 140ms ease!important}#navbar a[href*=\"build-with-ai\"]:hover{border-color:#141635!important;background:#F6F6FC!important}html.dark #navbar a[href*=\"build-with-ai\"]{background:transparent!important;color:#fff!important;border-color:rgba(255, 255, 255, 0.25)!important}html.dark #navbar a[href*=\"build-with-ai\"]:hover{border-color:#fff!important;background:rgba(255, 255, 255, 0.06)!important}#navbar a[href*=\"get-access\"]{background:#0B0814!important;color:#fff!important;border:1px solid #0B0814!important;transition:background 140ms ease!important}#navbar a[href*=\"get-access\"]:hover{background:#2A2640!important}html.dark #navbar a[href*=\"get-access\"]{background:#FFFFFF!important;color:#0B0814!important;border-color:#FFFFFF!important}html.dark #navbar a[href*=\"get-access\"]:hover{background:#E5E7EB!important;border-color:#E5E7EB!important}#sidebar-content a.text-primary,#sidebar-content a[class*=\"text-primary-light\"]{background-color:transparent!important}#sidebar-content a:not(.text-primary):not([class*=\"text-primary-light\"]):hover{background-color:rgba(103, 13, 229, 0.06)!important}#content-area:has(.api-section) #page-title{font-size:1.75rem;line-height:2.25rem}#content-area:has(.api-section) #header .prose{font-size:0.9375rem;line-height:1.6}@container page-header (min-width: 520px){#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow{display:flex;align-items:center;min-height:2.25rem;padding-right:11rem}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div:has(#page-context-menu){position:static}#content-area:has(.api-section) #header:has(.eyebrow) .eyebrow~div #page-context-menu{position:absolute;top:0;right:0;margin:0}}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title{font-size:0}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .api-section-heading-title::after{content:\"Authorization and headers\";font-size:1.125rem}.api-section[data-api-section=\"authorizations\"]+.api-section[data-api-section=\"headers\"] .api-section-heading{display:none}.api-section[data-api-section=\"authorizations\"]:has(+.api-section[data-api-section=\"headers\"]) .primitive-param-field:last-child{border-bottom-width:1px}.api-section .api-section-heading .border-b,.api-section .primitive-param-field{border-color:#D1D5DB}html.dark .api-section .api-section-heading .border-b,html.dark .api-section .primitive-param-field{border-color:#374151}.api-section .primitive-param-field>.py-6{padding-top:0.875rem;padding-bottom:0.875rem}.api-section .primitive-param-field .mt-4{margin-top:0.5rem}@media (min-width: 1600px){#body-content:has(.api-section){max-width:1760px}#body-content:has(.api-section) #content-container{max-width:1440px}}"},{"filePath":"oms-visuals.css","content":"@font-face{font-family:\"Fustat\";src:url(\"/fonts/Fustat-VariableFont_wght.woff2\") format(\"woff2\");font-weight:200 900;font-style:normal;font-display:swap}@font-face{font-family:\"Geist Mono\";src:url(\"/fonts/GeistMono-VariableFont_wght.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}.oms-v{--oms-purple-50: #f6f3fb;--oms-purple-100: #eae4f5;--oms-purple-200: #d5c4f2;--oms-purple-300: #b78eef;--oms-purple-400: #9551f5;--oms-purple-500: #670de5;--oms-purple-600: #500ab2;--oms-purple-700: #400a8e;--oms-slate-50: #f6f6fc;--oms-slate-100: #eef0f9;--oms-slate-200: #dfe3f0;--oms-slate-300: #c8cfe1;--oms-slate-400: #929eba;--oms-slate-500: #64708f;--oms-slate-600: #48526f;--oms-slate-700: #363e5c;--oms-slate-800: #222744;--oms-slate-900: #141635;--oms-slate-950: #090624;--oms-btn-primary: #090624;--oms-btn-primary-hover: #222744;--oms-btn-primary-text: #ffffff;--ss-font: \"Fustat\", \"Inter\", system-ui, sans-serif;--ss-mono: \"Geist Mono\", \"JetBrains Mono\", ui-monospace, monospace;--ss-accent: #670de5;--ss-accent-2: #9551f5;--ss-accent-soft: #eae4f5;--ss-accent-text: #500ab2;--ss-canvas: #f6f6fc;--ss-well: #f6f6fc;--ss-surface: #ffffff;--ss-raised: #ffffff;--ss-chrome: #ffffff;--ss-fill: #eef0f9;--ss-line: #c8cfe1;--ss-line-faint: #dfe3f0;--ss-text-strong: #141635;--ss-text: #48526f;--ss-text-faint: #64708f;--ss-icon: #48526f;--ss-icon-faint: #929eba;--ss-ink-1: rgba(20, 22, 53, 0.04);--ss-ink-2: rgba(20, 22, 53, 0.06);--ss-ink-3: rgba(20, 22, 53, 0.08);--ss-ink-4: rgba(20, 22, 53, 0.10);--ss-ink-5: rgba(20, 22, 53, 0.15);--ss-success: #10b981;--ss-success-soft: #ecfdf5;--ss-success-text: #047857;--ss-warning: #b45309;--ss-warning-soft: #fff7ed;--ss-warning-text: #b45309;--ss-danger: #dc2626;--ss-danger-soft: #fef2f2;--ss-danger-text: #b91c1c;--ss-radius-sm: 6px;--ss-radius-md: 8px;--ss-radius-lg: 12px;--ss-radius-window: 12px;--ss-radius-pill: 999px;--ss-shadow-window: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 4px 16px rgba(0, 0, 0, 0.08);--ss-shadow-float: 0px 4px 6px -4px rgba(0, 0, 0, 0.1), 0px 10px 15px -3px rgba(0, 0, 0, 0.1);--ss-shadow-card: 0 1px 2px rgba(0, 0, 0, 0.04);--ss-shadow-hero: 0 0 0 1px rgba(0, 0, 0, 0.06), 0 30px 60px -12px rgba(50, 50, 93, 0.25), 0 18px 36px -18px rgba(0, 0, 0, 0.3);--ss-shadow-lift: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 12px 28px -6px rgba(50, 50, 93, 0.28), 0 6px 12px -6px rgba(0, 0, 0, 0.16);--ss-shadow-satellite: 0 0 0 1px rgba(0, 0, 0, 0.04), 0 14px 32px -8px rgba(50, 50, 93, 0.24), 0 4px 10px -4px rgba(0, 0, 0, 0.1);--ss-shadow-ground: 0 0 0 1px rgba(50, 50, 93, 0.06), 0 24px 48px -24px rgba(50, 50, 93, 0.18);--ss-ease: cubic-bezier(0.16, 1, 0.3, 1);font-family:var(--ss-font);color:var(--ss-text);-webkit-font-smoothing:antialiased}html.dark .oms-v{--oms-btn-primary: #ffffff;--oms-btn-primary-hover: #e5e7eb;--oms-btn-primary-text: #090624;--ss-accent: #9551f5;--ss-accent-2: #b78eef;--ss-accent-soft: rgba(149, 81, 245, 0.16);--ss-accent-text: #b78eef;--ss-canvas: #0b0a10;--ss-well: #131218;--ss-surface: #1a1922;--ss-raised: #23212d;--ss-chrome: #16151d;--ss-fill: #2a2834;--ss-line: rgba(255, 255, 255, 0.10);--ss-line-faint: rgba(255, 255, 255, 0.06);--ss-text-strong: #eef0f9;--ss-text: #c8cfe1;--ss-text-faint: #929eba;--ss-icon: #c8cfe1;--ss-icon-faint: #64708f;--ss-ink-1: rgba(255, 255, 255, 0.05);--ss-ink-2: rgba(255, 255, 255, 0.07);--ss-ink-3: rgba(255, 255, 255, 0.10);--ss-ink-4: rgba(255, 255, 255, 0.13);--ss-ink-5: rgba(255, 255, 255, 0.20);--ss-success: #34d399;--ss-success-soft: rgba(16, 185, 129, 0.16);--ss-success-text: #34d399;--ss-shadow-window: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 4px 16px rgba(0, 0, 0, 0.4);--ss-shadow-float: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 4px 16px rgba(0, 0, 0, 0.4), 0 12px 32px rgba(0, 0, 0, 0.3);--ss-shadow-card: 0 0 0 1px rgba(255, 255, 255, 0.05);--ss-shadow-hero: 0 0 0 1px rgba(255, 255, 255, 0.08), 0 30px 60px -12px rgba(0, 0, 0, 0.6);--ss-shadow-lift: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 12px 28px -6px rgba(0, 0, 0, 0.6);--ss-shadow-satellite: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 14px 32px -8px rgba(0, 0, 0, 0.7), 0 4px 10px -4px rgba(0, 0, 0, 0.5);--ss-shadow-ground: 0 0 0 1px rgba(255, 255, 255, 0.1), 0 24px 48px -24px rgba(0, 0, 0, 0.6)}.oms-v-fit{position:relative;width:100%}.oms-v-stage{position:absolute;top:0;left:0;transform-origin:0 0;overflow:hidden}.oms-v *,.oms-v *::before,.oms-v *::after{box-sizing:border-box}.oms-v :where(h1,h2,h3,h4,p,ul,ol){margin:0}.oms-v .oms-badge{display:inline-flex;align-items:center;justify-content:center;gap:4px;padding:4px 8px;border-radius:16px;border:0.5px solid transparent;font-family:var(--ss-font);font-weight:500;font-size:12px;line-height:1;white-space:nowrap;text-box:trim-both cap alphabetic}.oms-v .oms-badge--info{background:#f6f3fb;border-color:#d5c4f2;color:#500ab2}.oms-v .oms-badge--neutral{background:#f6f6fc;border-color:#c8cfe1;color:#141635}.oms-v .oms-badge--success{background:#ecfdf5;border-color:#a7f3d0;color:#047857}.oms-v .oms-badge--warning{background:#fff7ed;border-color:#fed7aa;color:#b45309}.oms-v .oms-badge--danger{background:#fef2f2;border-color:#fecaca;color:#b91c1c}html.dark .oms-v .oms-badge--info{background:rgba(149, 81, 245, 0.14);border-color:rgba(183, 142, 239, 0.35);color:#c9b0f5}html.dark .oms-v .oms-badge--neutral{background:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.14);color:#c8cfe1}html.dark .oms-v .oms-badge--success{background:rgba(16, 185, 129, 0.14);border-color:rgba(52, 211, 153, 0.35);color:#6ee7b7}html.dark .oms-v .oms-badge--warning{background:rgba(251, 191, 36, 0.12);border-color:rgba(251, 191, 36, 0.3);color:#fcd34d}html.dark .oms-v .oms-badge--danger{background:rgba(248, 113, 113, 0.12);border-color:rgba(248, 113, 113, 0.3);color:#fca5a5}.oms-v .oms-phone{position:relative;flex-shrink:0;--oms-phone-glass: #0b0b0c;--oms-phone-rim: #2c2c2d;--oms-phone-band-1: #e3e3e6;--oms-phone-band-2: #9a9ba0;--oms-phone-band-3: #cfd0d4;--oms-phone-band-4: #85868b;--oms-phone-band-5: #c9cacd;box-shadow:0 calc(var(--ps) * 40) calc(var(--ps) * 80) calc(var(--ps) * -16) rgba(50, 50, 93, 0.25),\n 0 calc(var(--ps) * 24) calc(var(--ps) * 48) calc(var(--ps) * -24) rgba(0, 0, 0, 0.3)}html.dark .oms-v .oms-phone{--oms-phone-band-1: #5b5c61;--oms-phone-band-2: #2b2c2f;--oms-phone-band-3: #48494d;--oms-phone-band-4: #232427;--oms-phone-band-5: #404145}.oms-v .oms-phone__bands{position:absolute;inset:0;overflow:visible;pointer-events:none}.oms-v .oms-phone__glass{position:relative;height:100%}.oms-v .oms-phone__window{position:relative;overflow:hidden;isolation:isolate}.oms-v .oms-phone__screen{position:absolute;top:0;left:0;width:402px;height:874px;display:flex;flex-direction:column;overflow:hidden;background:#fff;color:#000;font-family:-apple-system, system-ui, sans-serif;font-size:15px;letter-spacing:-0.015em;transform-origin:0 0;-webkit-font-smoothing:antialiased}.oms-v .oms-phone[data-dark] .oms-phone__screen{background:#000;color:#fff}.oms-v .oms-phone__status{position:absolute;top:0;right:0;left:0;z-index:2;height:62px;transition:color 0.3s ease;will-change:transform}.oms-v .oms-phone__time{position:absolute;top:21.5px;left:0;width:138.5px;line-height:22px;text-align:center;font-family:\"SF Pro Text\", -apple-system, system-ui, sans-serif;font-variation-settings:\"opsz\" 17;font-size:17.67px;font-weight:590;letter-spacing:0}.oms-v .oms-phone__glyphs{position:absolute;top:25.33px;left:285.25px;display:flex;align-items:flex-start;gap:8px}.oms-v .oms-phone__glyphs svg{display:block}.oms-v .oms-phone__signal{margin-top:1px}.oms-v .oms-phone__battery{margin-top:0.33px}.oms-v .oms-phone__island{position:absolute;top:14px;left:50%;z-index:3;width:95px;height:37px;border-radius:18.5px;background:#000;transform:translateX(-50%)}.oms-v .oms-phone__content{position:relative;flex:1;min-height:0;padding-top:62px}.oms-v .oms-phone__home{position:absolute;bottom:8px;left:50%;z-index:2;width:144px;height:5px;border-radius:2.5px;background:currentColor;transform:translateX(-50%);transition:color 0.3s ease;will-change:transform}.obz{overflow:hidden;border-radius:14px;background:linear-gradient(110deg, rgba(255, 255, 255, 0.18) 0%, transparent 22%, transparent 32%, rgba(255, 255, 255, 0.1) 44%, transparent 60%),\n linear-gradient(135deg, var(--obz-from) 0%, var(--obz-to) 100%);--obz-ink: var(--ss-text-strong);--obz-faint: var(--oms-slate-500);--obz-app: var(--oms-slate-50);--obz-card: #fff;--obz-rule: var(--oms-slate-200)}.obz--payouts{--obz-from: #7c3aed;--obz-to: #3b0764}.obz--rewards{--obz-from: #10b981;--obz-to: #064e3b}html.dark .obz{--obz-faint: var(--oms-slate-400);--obz-app: #0b0a10;--obz-card: #1a1922;--obz-rule: rgba(255, 255, 255, 0.08)}.obz .obz-phone{position:absolute;top:30px;left:30px}.obz .obz-app{position:absolute;inset:0;padding-top:62px;background:var(--obz-app);color:var(--obz-ink);text-align:left;font-family:var(--ss-font)}.obz .obz-btn .obz-states,.obz .obz-status,.obz .obz-big--count{transition:opacity 0.38s ease}.obz .obz-app[data-fade] :is(.obz-btn .obz-states,.obz-status,.obz-big--count){opacity:0}.obz .obz-title{transition:opacity 0.2s ease}.obz .obz-app[data-notif] .obz-title{opacity:0}.obz .obz-head{display:flex;align-items:baseline;justify-content:space-between;padding:8px 36px 14px}.obz--payouts .obz-head{padding-bottom:10px}.obz--rewards .obz-head{padding-bottom:34px}.obz .obz-title{font-size:32px;font-weight:700;line-height:38px;letter-spacing:-0.02em;color:var(--obz-ink)}.obz .obz-head__meta{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-card{display:block;margin:0 16px 12px;border-radius:22px;background:var(--obz-card);box-shadow:0 0 0 0.5px var(--obz-rule)}.obz .obz-batch,.obz .obz-balance{display:grid;justify-items:start;padding:18px 20px 20px}.obz--payouts .obz-batch{padding-bottom:16px}.obz .obz-label{font-size:19px;line-height:25px;color:var(--obz-faint)}.obz .obz-big{margin-top:2px;font-size:50px;font-weight:700;line-height:58px;letter-spacing:-0.03em;color:var(--obz-ink)}.obz .obz-big--count{margin:4px 0 2px;font-size:60px;line-height:68px}.obz .obz-count{display:inline-flex;align-items:baseline;white-space:nowrap;font-variant-numeric:tabular-nums}.obz .obz-count__char{display:inline-block;font-variant-numeric:normal}.obz .obz-count__digit{display:inline-block;height:1em;overflow:hidden;line-height:1;vertical-align:baseline;mask-image:linear-gradient(to bottom, transparent, #000 8%, #000 92%, transparent)}.obz .obz-count__strip{display:flex;flex-direction:column;will-change:transform;transition:transform 900ms cubic-bezier(0.3, 0.75, 0.1, 1)}.obz .obz-count__strip>span{display:block;height:1em;line-height:1}.obz .obz-count__unit{display:inline-block;margin-left:8px;font-size:22px;font-weight:600;letter-spacing:0;color:var(--obz-faint)}.obz .obz-btn{position:relative;isolation:isolate;display:grid;place-items:center;justify-self:stretch;height:58px;margin-top:14px;border-radius:16px;color:var(--oms-btn-primary-text);font-size:20px;font-weight:600}.obz .obz-btn::before{content:\"\";position:absolute;inset:0;z-index:-1;border-radius:inherit;background:var(--oms-btn-primary);transition:transform 0.15s ease, background-color 0.2s ease}.obz .obz-btn[data-pressed]::before{transform:scale(0.97);background:var(--oms-btn-primary-hover)}.obz .obz-btn__group{display:inline-flex;align-items:center;justify-content:center;gap:8px;width:180px;height:26px}.obz .obz-btn__group--icon{justify-content:flex-start;padding-left:44px}.obz .obz-btn__group svg{flex:none}.obz .obz-spin{animation:obz-spin 0.8s linear infinite}@keyframes obz-spin{to{transform:rotate(360deg)}}.obz .obz-touch{position:absolute;left:50%;top:50%;width:44px;height:44px;margin:-22px 0 0 -22px;border-radius:50%;background:rgba(255, 255, 255, 0.35);box-shadow:0 0 0 1.5px rgba(255, 255, 255, 0.55);opacity:0;transform:scale(0.6);transition:opacity 0.3s ease, transform 0.3s ease;pointer-events:none}.obz .obz-touch[data-on]{opacity:1;transform:scale(1);transition:opacity 0.08s ease, transform 0.12s ease}.obz .obz-states{display:inline-grid;align-items:center;justify-items:center}.obz .obz-states__item{display:inline-flex;grid-area:1 / 1;align-items:center;opacity:0;filter:blur(2px);will-change:transform;transform:translate3d(0, 4px, 0);transition:opacity 0.15s ease, filter 0.15s ease, transform 0s 0.15s}.obz .obz-states__item[data-on]{opacity:1;filter:none;transform:translate3d(0, 0, 0);transition:opacity 0.25s ease-out 0.07s, filter 0.25s ease-out 0.07s, transform 0.3s cubic-bezier(0.22, 1, 0.36, 1) 0.07s}.obz .obz-status{display:inline-grid;justify-items:end;margin-right:10px;flex:none}.obz--payouts .obz-status{margin-right:6px}.obz--rewards .obz-status{width:96px}.obz .obz-list{padding:4px 0}.obz .obz-row{display:flex;align-items:center;gap:14px;padding:14px;will-change:transform}.obz .obz-list>.obz-row+.obz-row,.obz .obz-list>.obz-collapse+.obz-row{box-shadow:0 -0.5px 0 var(--obz-rule)}.obz .obz-row__body{display:flex;flex-direction:column;gap:2px;flex:1;min-width:0}.obz .obz-row__title{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:21px;font-weight:600;line-height:28px;color:var(--obz-ink)}.obz .obz-row__sub{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:19px;line-height:28px;color:var(--ss-text)}.obz--payouts .obz-row__sub{font-size:18px}.obz .obz-bar{display:block;border-radius:5px;background:var(--ss-ink-3)}.obz .obz-bar--title{height:11px;margin:8.5px 0;background:var(--ss-ink-4)}.obz .obz-bar--sub{height:9px;margin:9.5px 0}.obz .obz-avatar{display:inline-grid;flex:none;place-items:center;width:48px;height:48px;border-radius:50%;color:#fff;font-size:20px;font-weight:600;line-height:1;will-change:transform}.obz .obz-avatar>span{display:block;text-box:trim-both cap alphabetic}.obz .obz-avatar--plain{background:var(--ss-fill)}.obz .obz-tile{display:grid;flex:none;place-items:center;width:48px;height:48px;border-radius:14px;background:var(--ss-success-soft);color:var(--ss-success-text)}.obz .obz-tile--plain{background:var(--ss-ink-1)}html.dark .obz .obz-tile{background:rgba(16, 185, 129, 0.14);color:#34d399}html.dark .obz .obz-tile--plain{background:rgba(255, 255, 255, 0.06)}.obz .oms-badge.obz-badge{padding:5px 12px;border-radius:16px;font-size:19px;line-height:22px}.obz .obz-collapse{display:grid;grid-template-rows:0fr;opacity:0;transition:grid-template-rows 0.42s cubic-bezier(0.4, 0, 0.2, 1) 0.05s, opacity 0.42s cubic-bezier(0, 0.8, 0.5, 1)}.obz .obz-collapse[data-open]{grid-template-rows:1fr;opacity:1;transition:grid-template-rows 0.5s cubic-bezier(0.45, 0, 0.2, 1), opacity 0.3s ease 0.24s}.obz .obz-collapse__inner{min-height:0;overflow:visible}.obz .obz-collapse__inner>*{transform:translateY(-10px);transition:transform 0.3s ease}.obz .obz-collapse[data-open]>.obz-collapse__inner>*{transform:none;transition:transform 0.6s cubic-bezier(0.22, 1, 0.36, 1) 0.2s}.obz .obz-banner{position:absolute;inset:0;z-index:2;pointer-events:none;will-change:transform;transform:translateY(-52px) scale(0.96);opacity:0;transition:transform 0.45s cubic-bezier(0.4, 0, 0.6, 1), opacity 0.3s ease 0.1s}.obz .obz-banner[data-show]{transform:none;opacity:1;transition:transform 0.55s cubic-bezier(0.2, 0.9, 0.25, 1), opacity 0.2s ease}.obz .obz-notif{position:absolute;top:56px;left:18px;right:18px;display:flex;align-items:center;gap:13px;padding:14px 17px 14px 14px;border-radius:23px;background:rgba(255, 255, 255, 0.92);box-shadow:0 0 0 0.5px rgba(0, 0, 0, 0.08), 0 8px 24px rgba(0, 0, 0, 0.12);color:#000;text-align:left;will-change:transform}.obz .obz-banner[data-dark] .obz-notif{background:rgba(252, 252, 253, 0.76);backdrop-filter:blur(30px) saturate(1.25);box-shadow:0 4px 24px rgba(0, 0, 0, 0.06)}.obz .obz-notif__icon{display:grid;flex:none;place-items:center;width:38px;height:38px;border-radius:9px;overflow:hidden;background:linear-gradient(160deg, #10b981, #047857);color:#fff}.obz .obz-notif__text{display:flex;flex:1;flex-direction:column;min-width:0;font-size:15px;line-height:18px;letter-spacing:-0.016em}.obz .obz-notif__head{display:flex;align-items:baseline;gap:8px}.obz .obz-notif__title{flex:1;min-width:0;overflow:hidden;font-weight:600;white-space:nowrap;text-overflow:ellipsis}.obz .obz-notif__time{flex:none;font-size:12px;letter-spacing:-0.005em;color:rgba(60, 60, 67, 0.6)}.obz .obz-notif__body{display:-webkit-box;overflow:hidden;-webkit-line-clamp:3;-webkit-box-orient:vertical}@media (prefers-reduced-motion: reduce){.obz .obz-spin{animation:none}}"}],"page":{"pagePath":"api-reference/withdrawal-request/cancel-a-withdrawal-request","slug":"/api-reference/withdrawal-request/cancel-a-withdrawal-request","pageMetadata":{"title":"Cancel a Withdrawal Request","description":"Cancel a pending withdrawal request. Only the submitter can cancel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests/{withdrawalRequestId}/cancel","href":"/api-reference/withdrawal-request/cancel-a-withdrawal-request","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Cancel a pending withdrawal request. Only the submitter can cancel.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel a Withdrawal Request","description":"Cancel a pending withdrawal request. Only the submitter can cancel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests/{withdrawalRequestId}/cancel","href":"/api-reference/withdrawal-request/cancel-a-withdrawal-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/polygon-labs/3aef159c73509324/analytics.js","/_mintlify/custom/polygon-labs/0db36164dbb10780/custom.js"],"openApiReferenceData":{"operation":{"operationId":"cancelWithdrawalRequest","summary":"Cancel a Withdrawal Request","description":"Cancel a pending withdrawal request. Only the submitter can cancel.","parameters":["61dd7a89-c2bd-40df-b7d5-5e8d36872f11","8f516769-8410-4077-92c7-985768612a31"],"responses":{"200":"83942f66-26cd-4cb9-bc84-49682833efef","403":"1ff21658-71e3-416a-987f-4a8f2460fcdc","404":"da60e374-aeec-431e-a77b-7c38db9b77e0","409":"68be9fa1-bd5d-4732-b2c8-229450520162","500":"3c207fe4-4353-45d7-9c61-3a42941d9d42"},"tags":["Withdrawal Request"],"method":"post","type":"path","servers":["f1f89dd2-21a8-4fdc-a3bd-c30b233ac302","02fbca03-cd58-4fbe-8bb8-e29577dcbb42"],"security":["626e1624-cc8c-4f0e-89c6-9abc8f35f997"],"path":"/withdrawal-requests/{withdrawalRequestId}/cancel","baseUrlOptions":["https://sandbox-api.polygon.technology/v0.13","https://api.polygon.technology/v0.13"],"title":"Cancel a Withdrawal Request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"61dd7a89-c2bd-40df-b7d5-5e8d36872f11":{"name":"Idempotency-Key","in":"header","required":true,"description":"Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.","schema":{"type":"string","isRequired":true,"description":"Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.","uniqueKey":"","typeLabel":"string"}},"8f516769-8410-4077-92c7-985768612a31":{"name":"withdrawalRequestId","in":"path","required":true,"description":"Withdrawal request ID (`wdr_` prefix).","schema":{"type":"string","isRequired":true,"description":"Withdrawal request ID (`wdr_` prefix).","uniqueKey":"","typeLabel":"string"}}},"responses":{"83942f66-26cd-4cb9-bc84-49682833efef":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["id","quoteId","status","customer","source","destination","pricing","createdBy","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Withdrawal request ID (`wdr_` 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})$","x-go-type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"quoteId":{"type":"string","description":"The quote the request was submitted from (`qt_` prefix). Read it for the full destination, including the bank rail, when building the approval quote.","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"quoteId","typeLabel":"string"},"status":{"type":"string","description":"Current status.","enum":["pendingApproval","approved","rejected","cancelled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","description":"The customer the withdrawal is for.","required":["id"],"properties":{"id":{"type":"string","description":"The 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})$","x-go-type":"string","isRequired":true,"uniqueKey":"customer.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"source":{"oneOf":[{"type":"object","title":"OMS wallet","description":"The funding side, with resolved instrument detail.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"source.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","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})$","x-go-type":"string","uniqueKey":"source.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"source.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"source.oneOf.0.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"The funding side, with resolved instrument detail.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"source.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"source.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"source.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"source.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"source.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"source.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"source.oneOf.1.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.1","typeLabel":"External wallet · object"},{"type":"object","title":"Fiat wallet","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["walletFiat"],"isRequired":true,"uniqueKey":"source.oneOf.2.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Fiat currency of the balance. Only `usd` today.","isRequired":true,"uniqueKey":"source.oneOf.2.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^(wlt_fiat_|[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})$","description":"The fiat wallet (`wlt_`; an older wallet keeps its original `wlt_\u003cuuid>` id, and a `wlt_fiat_` id is also accepted on input). Left out on a book-transfer destination until its outbound leg exists.","uniqueKey":"source.oneOf.2.id","typeLabel":"string"},"network":{"type":"string","enum":["bookTransfer","intraBank"],"description":"On the destination of a virtual account or deposit address book-transfer credit: `intraBank`, or `bookTransfer` on a record created before the umbrella names were introduced.","uniqueKey":"source.oneOf.2.network","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `network` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"source.oneOf.2.intraBankRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.2.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.2.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.2.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.2.owner","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.2","typeLabel":"Fiat wallet · object"},{"type":"object","title":"US bank account","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankUs"],"isRequired":true,"uniqueKey":"source.oneOf.3.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.3.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"source.oneOf.3.id","typeLabel":"string"},"instantRail":{"type":"string","description":"Only when `network` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"source.oneOf.3.instantRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.3.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.3.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.3.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.3.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"source.oneOf.3.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"source.oneOf.3.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"source.oneOf.3.details.routingNumber","typeLabel":"string"},"accountType":{"type":"string","enum":["checking","savings"],"description":"Bank account sub-type for US accounts.","uniqueKey":"source.oneOf.3.details.accountType","typeLabel":"enum\u003cstring>"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"source.oneOf.3.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"source.oneOf.3.details.memo","typeLabel":"string"}},"description":"US bank account details.","uniqueKey":"source.oneOf.3.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.3","typeLabel":"US bank account · object"},{"type":"object","title":"IBAN bank account","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankIban"],"isRequired":true,"uniqueKey":"source.oneOf.4.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.4.asset","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"source.oneOf.4.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.4.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.4.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.4.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.4.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"source.oneOf.4.details.bankName","typeLabel":"string"},"ibanLast4":{"type":"string","uniqueKey":"source.oneOf.4.details.ibanLast4","typeLabel":"string"},"bic":{"type":"string","uniqueKey":"source.oneOf.4.details.bic","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the bank.","uniqueKey":"source.oneOf.4.details.countryCode","typeLabel":"string"},"bankAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"source.oneOf.4.details.bankAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"source.oneOf.4.details.bankAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"source.oneOf.4.details.bankAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"source.oneOf.4.details.bankAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"source.oneOf.4.details.bankAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"source.oneOf.4.details.bankAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"source.oneOf.4.details.bankAddress","typeLabel":"object"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"source.oneOf.4.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"source.oneOf.4.details.memo","typeLabel":"string"}},"description":"IBAN bank account details.","uniqueKey":"source.oneOf.4.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.4","typeLabel":"IBAN bank account · object"},{"type":"object","title":"Canadian bank account","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankCanada"],"isRequired":true,"uniqueKey":"source.oneOf.5.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd","cad"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.5.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"source.oneOf.5.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.5.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.5.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.5.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.5.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"source.oneOf.5.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"source.oneOf.5.details.accountNumberLast4","typeLabel":"string"},"institutionNumber":{"type":"string","uniqueKey":"source.oneOf.5.details.institutionNumber","typeLabel":"string"},"transitNumber":{"type":"string","uniqueKey":"source.oneOf.5.details.transitNumber","typeLabel":"string"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"source.oneOf.5.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"source.oneOf.5.details.memo","typeLabel":"string"}},"description":"Canadian bank account details.","uniqueKey":"source.oneOf.5.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.5","typeLabel":"Canadian bank account · object"},{"type":"object","title":"Card","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"source.oneOf.6.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.6.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`).","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})$","x-go-type":"string","uniqueKey":"source.oneOf.6.id","typeLabel":"string"},"network":{"type":"string","enum":["card"],"description":"The rail the money moves on.","uniqueKey":"source.oneOf.6.network","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.6.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.6.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.6.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.6.owner","typeLabel":"object"},"details":{"type":"object","properties":{"brand":{"type":"string","enum":["visa","mastercard","amex","discover"],"description":"Card network/brand. Derived server-side from the PAN; never accepted on a request.","uniqueKey":"source.oneOf.6.details.brand","typeLabel":"enum\u003cstring>"},"last4":{"type":"string","uniqueKey":"source.oneOf.6.details.last4","typeLabel":"string"},"cardType":{"type":"string","enum":["debit","credit","prepaid"],"description":"Card funding type, derived server-side from the PAN. Only `debit` is supported today; `credit` and `prepaid` are reserved for future push-to-card / pull-from-card support.","uniqueKey":"source.oneOf.6.details.cardType","typeLabel":"enum\u003cstring>"},"expiryMonth":{"type":"integer","format":"int32","uniqueKey":"source.oneOf.6.details.expiryMonth","typeLabel":"integer\u003cint32>"},"expiryYear":{"type":"integer","format":"int32","uniqueKey":"source.oneOf.6.details.expiryYear","typeLabel":"integer\u003cint32>"},"billingAddressSource":{"type":"string","enum":["provided","customerDefault"],"description":"Where a card's billing address came from. `provided` = supplied on the request; `customerDefault` = filled from the owning customer's address because the request omitted it.","uniqueKey":"source.oneOf.6.details.billingAddressSource","typeLabel":"enum\u003cstring>"}},"description":"Card details.","uniqueKey":"source.oneOf.6.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.6","typeLabel":"Card · object"},{"type":"object","title":"Cash","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["cash"],"isRequired":true,"uniqueKey":"source.oneOf.7.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.7.asset","typeLabel":"string"},"details":{"type":"object","properties":{"locationId":{"type":"string","uniqueKey":"source.oneOf.7.details.locationId","typeLabel":"string"},"locationName":{"type":"string","uniqueKey":"source.oneOf.7.details.locationName","typeLabel":"string"},"locationAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"source.oneOf.7.details.locationAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"source.oneOf.7.details.locationAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"source.oneOf.7.details.locationAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"source.oneOf.7.details.locationAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"source.oneOf.7.details.locationAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"source.oneOf.7.details.locationAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"source.oneOf.7.details.locationAddress","typeLabel":"object"},"locationProvider":{"type":"string","description":"The cash network the location belongs to, lowercase, such as `greendot`.","uniqueKey":"source.oneOf.7.details.locationProvider","typeLabel":"string"}},"description":"Cash location details.","uniqueKey":"source.oneOf.7.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.7","typeLabel":"Cash · object"},{"type":"object","title":"Deposit address","description":"The funding side, with resolved instrument detail.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["depositAddress"],"isRequired":true,"uniqueKey":"source.oneOf.8.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.8.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"source.oneOf.8.network","typeLabel":"string"},"id":{"type":"string","description":"The deposit address (`da_`).","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})$","x-go-type":"string","uniqueKey":"source.oneOf.8.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.8.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.8.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.8.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.8.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"source.oneOf.8.details.address","typeLabel":"string"}},"description":"Deposit address details.","uniqueKey":"source.oneOf.8.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.8","typeLabel":"Deposit address · object"},{"type":"object","title":"Virtual account","description":"The funding side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["virtualAccount"],"isRequired":true,"uniqueKey":"source.oneOf.9.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"source.oneOf.9.asset","typeLabel":"string"},"id":{"type":"string","description":"The virtual account (`va_`).","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})$","x-go-type":"string","uniqueKey":"source.oneOf.9.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"source.oneOf.9.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"source.oneOf.9.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"source.oneOf.9.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"source.oneOf.9.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"source.oneOf.9.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"source.oneOf.9.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"source.oneOf.9.details.routingNumber","typeLabel":"string"}},"description":"Virtual account details. The full account number is in the virtual account's deposit instructions.","uniqueKey":"source.oneOf.9.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"source.oneOf.9","typeLabel":"Virtual account · object"}],"isRequired":true,"uniqueKey":"source","typeLabel":"OMS wallet · object | External wallet · object | Fiat wallet · object | US bank account · object | IBAN bank account · object | Canadian bank account · object | Card · object | Cash · object | Deposit address · object | Virtual account · object"},"destination":{"oneOf":[{"type":"object","title":"OMS wallet","description":"The receiving side, with resolved instrument detail.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"destination.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"destination.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"destination.oneOf.0.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"The receiving side, with resolved instrument detail.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"destination.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"destination.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"destination.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"destination.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"destination.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"destination.oneOf.1.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.1","typeLabel":"External wallet · object"},{"type":"object","title":"Fiat wallet","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["walletFiat"],"isRequired":true,"uniqueKey":"destination.oneOf.2.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Fiat currency of the balance. Only `usd` today.","isRequired":true,"uniqueKey":"destination.oneOf.2.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^(wlt_fiat_|[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})$","description":"The fiat wallet (`wlt_`; an older wallet keeps its original `wlt_\u003cuuid>` id, and a `wlt_fiat_` id is also accepted on input). Left out on a book-transfer destination until its outbound leg exists.","uniqueKey":"destination.oneOf.2.id","typeLabel":"string"},"network":{"type":"string","enum":["bookTransfer","intraBank"],"description":"On the destination of a virtual account or deposit address book-transfer credit: `intraBank`, or `bookTransfer` on a record created before the umbrella names were introduced.","uniqueKey":"destination.oneOf.2.network","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `network` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"destination.oneOf.2.intraBankRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.2.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.2.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.2.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.2.owner","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.2","typeLabel":"Fiat wallet · object"},{"type":"object","title":"US bank account","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankUs"],"isRequired":true,"uniqueKey":"destination.oneOf.3.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.3.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.3.id","typeLabel":"string"},"instantRail":{"type":"string","description":"Only when `network` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"destination.oneOf.3.instantRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.3.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.3.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.3.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.3.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"destination.oneOf.3.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"destination.oneOf.3.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"destination.oneOf.3.details.routingNumber","typeLabel":"string"},"accountType":{"type":"string","enum":["checking","savings"],"description":"Bank account sub-type for US accounts.","uniqueKey":"destination.oneOf.3.details.accountType","typeLabel":"enum\u003cstring>"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"destination.oneOf.3.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"destination.oneOf.3.details.memo","typeLabel":"string"}},"description":"US bank account details.","uniqueKey":"destination.oneOf.3.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.3","typeLabel":"US bank account · object"},{"type":"object","title":"IBAN bank account","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankIban"],"isRequired":true,"uniqueKey":"destination.oneOf.4.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.4.asset","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.4.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.4.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.4.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.4.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.4.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"destination.oneOf.4.details.bankName","typeLabel":"string"},"ibanLast4":{"type":"string","uniqueKey":"destination.oneOf.4.details.ibanLast4","typeLabel":"string"},"bic":{"type":"string","uniqueKey":"destination.oneOf.4.details.bic","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the bank.","uniqueKey":"destination.oneOf.4.details.countryCode","typeLabel":"string"},"bankAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"destination.oneOf.4.details.bankAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"destination.oneOf.4.details.bankAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"destination.oneOf.4.details.bankAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"destination.oneOf.4.details.bankAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"destination.oneOf.4.details.bankAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"destination.oneOf.4.details.bankAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"destination.oneOf.4.details.bankAddress","typeLabel":"object"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"destination.oneOf.4.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"destination.oneOf.4.details.memo","typeLabel":"string"}},"description":"IBAN bank account details.","uniqueKey":"destination.oneOf.4.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.4","typeLabel":"IBAN bank account · object"},{"type":"object","title":"Canadian bank account","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankCanada"],"isRequired":true,"uniqueKey":"destination.oneOf.5.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd","cad"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.5.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.5.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.5.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.5.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.5.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.5.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"destination.oneOf.5.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"destination.oneOf.5.details.accountNumberLast4","typeLabel":"string"},"institutionNumber":{"type":"string","uniqueKey":"destination.oneOf.5.details.institutionNumber","typeLabel":"string"},"transitNumber":{"type":"string","uniqueKey":"destination.oneOf.5.details.transitNumber","typeLabel":"string"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"destination.oneOf.5.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"destination.oneOf.5.details.memo","typeLabel":"string"}},"description":"Canadian bank account details.","uniqueKey":"destination.oneOf.5.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.5","typeLabel":"Canadian bank account · object"},{"type":"object","title":"Card","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"destination.oneOf.6.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.6.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`).","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})$","x-go-type":"string","uniqueKey":"destination.oneOf.6.id","typeLabel":"string"},"network":{"type":"string","enum":["card"],"description":"The rail the money moves on.","uniqueKey":"destination.oneOf.6.network","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"destination.oneOf.6.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"destination.oneOf.6.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"destination.oneOf.6.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"destination.oneOf.6.owner","typeLabel":"object"},"details":{"type":"object","properties":{"brand":{"type":"string","enum":["visa","mastercard","amex","discover"],"description":"Card network/brand. Derived server-side from the PAN; never accepted on a request.","uniqueKey":"destination.oneOf.6.details.brand","typeLabel":"enum\u003cstring>"},"last4":{"type":"string","uniqueKey":"destination.oneOf.6.details.last4","typeLabel":"string"},"cardType":{"type":"string","enum":["debit","credit","prepaid"],"description":"Card funding type, derived server-side from the PAN. Only `debit` is supported today; `credit` and `prepaid` are reserved for future push-to-card / pull-from-card support.","uniqueKey":"destination.oneOf.6.details.cardType","typeLabel":"enum\u003cstring>"},"expiryMonth":{"type":"integer","format":"int32","uniqueKey":"destination.oneOf.6.details.expiryMonth","typeLabel":"integer\u003cint32>"},"expiryYear":{"type":"integer","format":"int32","uniqueKey":"destination.oneOf.6.details.expiryYear","typeLabel":"integer\u003cint32>"},"billingAddressSource":{"type":"string","enum":["provided","customerDefault"],"description":"Where a card's billing address came from. `provided` = supplied on the request; `customerDefault` = filled from the owning customer's address because the request omitted it.","uniqueKey":"destination.oneOf.6.details.billingAddressSource","typeLabel":"enum\u003cstring>"}},"description":"Card details.","uniqueKey":"destination.oneOf.6.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"destination.oneOf.6","typeLabel":"Card · object"},{"type":"object","title":"Cash","description":"The receiving side, with resolved instrument detail.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["cash"],"isRequired":true,"uniqueKey":"destination.oneOf.7.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"destination.oneOf.7.asset","typeLabel":"string"},"details":{"type":"object","properties":{"locationId":{"type":"string","uniqueKey":"destination.oneOf.7.details.locationId","typeLabel":"string"},"locationName":{"type":"string","uniqueKey":"destination.oneOf.7.details.locationName","typeLabel":"string"},"locationAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"destination.oneOf.7.details.locationAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"destination.oneOf.7.details.locationAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"destination.oneOf.7.details.locationAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"destination.oneOf.7.details.locationAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"destination.oneOf.7.details.locationAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"destination.oneOf.7.details.locationAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"destination.oneOf.7.details.locationAddress","typeLabel":"object"},"locationProvider":{"type":"string","description":"The cash network the location belongs to, lowercase, such as `greendot`.","uniqueKey":"destination.oneOf.7.details.locationProvider","typeLabel":"string"}},"description":"Cash location details.","uniqueKey":"destination.oneOf.7.details","typeLabel":"object"},"pickupCode":{"type":"string","description":"Retail pickup code for a cash payout.","uniqueKey":"destination.oneOf.7.pickupCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"destination.oneOf.7","typeLabel":"Cash · object"}],"isRequired":true,"uniqueKey":"destination","typeLabel":"OMS wallet · object | External wallet · object | Fiat wallet · object | US bank account · object | IBAN bank account · object | Canadian bank account · object | Card · object | Cash · object"},"pricing":{"type":"object","description":"Pricing from the latest quote.","required":["fees"],"properties":{"fees":{"type":"array","items":{"type":"object","required":["type","side","asset","amount"],"properties":{"type":{"type":"string","description":"Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: \"developer\", \"oms\", \"gas\", \"retailer\" (a cash provider's retail fee, on `CashIn.providerFee`), \"exchange\" (the exchange fee the crypto purchase realized, on the linked transaction once it completes).","isRequired":true,"uniqueKey":"pricing.fees.items.[INDEX].type","typeLabel":"string"},"side":{"type":"string","enum":["source","destination"],"description":"Which side this fee was deducted from.","isRequired":true,"uniqueKey":"pricing.fees.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Currency this fee is denominated in — that side's asset.","isRequired":true,"uniqueKey":"pricing.fees.items.[INDEX].asset","typeLabel":"string"},"amount":{"type":"string","description":"Fee amount in `asset`, at the asset's precision.","isRequired":true,"uniqueKey":"pricing.fees.items.[INDEX].amount","typeLabel":"string"}},"description":"A fee charged on one side of a quote, transaction or cash-in. A fee is listed only when it is not zero.","uniqueKey":"pricing.fees.items.[INDEX]","typeLabel":"object"},"description":"Every fee charged across both sides. `[]` when there are none — never omitted, never null.","isRequired":true,"uniqueKey":"pricing.fees","typeLabel":"object[]"},"source":{"type":"object","description":"The source side, in the source asset.","required":["asset"],"properties":{"asset":{"type":"string","description":"Lowercase asset of this side, the same as the side's instrument asset.","isRequired":true,"uniqueKey":"pricing.source.asset","typeLabel":"string"},"amount":{"type":"string","description":"On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.","uniqueKey":"pricing.source.amount","typeLabel":"string"}},"uniqueKey":"pricing.source","typeLabel":"object"},"destination":{"type":"object","description":"The destination side, in the destination asset.","required":["asset"],"properties":{"asset":{"type":"string","description":"Lowercase asset of this side, the same as the side's instrument asset.","isRequired":true,"uniqueKey":"pricing.destination.asset","typeLabel":"string"},"amount":{"type":"string","description":"On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.","uniqueKey":"pricing.destination.amount","typeLabel":"string"}},"uniqueKey":"pricing.destination","typeLabel":"object"},"exchangeRate":{"type":"string","description":"Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.","uniqueKey":"pricing.exchangeRate","typeLabel":"string"},"fixedAmountSide":{"type":"string","enum":["source","destination"],"description":"The side whose amount was fixed at creation. OMS calculated the other side.","uniqueKey":"pricing.fixedAmountSide","typeLabel":"enum\u003cstring>"},"sponsorGas":{"type":"boolean","description":"Present and `true` when OMS absorbs the destination gas cost; omitted otherwise.","uniqueKey":"pricing.sponsorGas","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"pricing","typeLabel":"object"},"createdBy":{"type":"object","description":"Who submitted the request.","required":["type","id"],"properties":{"type":{"type":"string","description":"Whether the actor is a person or an API key.","enum":["user","apiKey"],"isRequired":true,"uniqueKey":"createdBy.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The actor's id.","isRequired":true,"uniqueKey":"createdBy.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"createdBy","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the request was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the request was last updated.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"reviewedBy":{"type":"object","description":"Who approved or rejected the request.","required":["type","id"],"properties":{"type":{"type":"string","description":"Whether the actor is a person or an API key.","enum":["user","apiKey"],"isRequired":true,"uniqueKey":"reviewedBy.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The actor's id.","isRequired":true,"uniqueKey":"reviewedBy.id","typeLabel":"string"}},"uniqueKey":"reviewedBy","typeLabel":"object"},"reviewedAt":{"type":"string","format":"date-time","description":"When the request was approved or rejected. Set for approved and rejected requests only.","uniqueKey":"reviewedAt","typeLabel":"string\u003cdate-time>"},"transactionId":{"type":"string","description":"The transaction an approved request created (`txn_` 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})$","x-go-type":"string","uniqueKey":"transactionId","typeLabel":"string"},"transaction":{"type":"object","description":"The transaction an approved request created. Present on submit and approve responses only.","required":["id","status","subStatus","customer","source","destination","pricing"],"properties":{"id":{"type":"string","description":"Transaction ID (`txn_` 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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.id","typeLabel":"string"},"status":{"type":"string","description":"Current lifecycle status. See `subStatus` for finer granularity.","enum":["processing","awaitingAction","completed","failed"],"isRequired":true,"uniqueKey":"transaction.status","typeLabel":"enum\u003cstring>"},"subStatus":{"type":"string","description":"Status-scoped sub-state (e.g. `processing.fundsPulled`). Always present: each status carries a default member (e.g. `processing.initiated`) when no more specific value applies.","enum":["processing.fundsPulled","processing.cashPickupReady","processing.underReview","processing.payoutRetrying","processing.payoutUnconfirmed","processing.payoutHeld","processing.returningToSender","completed.cashPickupCollected","completed.cashPickupExpired","awaitingAction.informationRequested","awaitingAction.awaitingSenderAttribution","awaitingAction.payoutDestinationMissing","awaitingAction.depositAddressFrozen","failed.attributionTimeout","failed.depositAddressFrozenTimeout","failed.depositAddressInactiveTimeout","failed.depositAddressClosed","processing.awaitingCryptoOut","processing.cryptoOut","processing.awaitingFiatOut","processing.fiatOut","processing.inboundPending","processing.inboundProcessing","failed.inboundFailed","failed.returnedToSender","processing.initiated","completed.settled","failed.unspecified","failed.expired","failed.providerDeclined","failed.outboundFailed"],"isRequired":true,"uniqueKey":"transaction.subStatus","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","description":"The customer that owns this record — the sender on a transaction.","required":["id"],"properties":{"id":{"type":"string","description":"The 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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.customer.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.customer","typeLabel":"object"},"source":{"oneOf":[{"type":"object","title":"OMS wallet","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"transaction.source.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"transaction.source.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"transaction.source.oneOf.0.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"transaction.source.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"transaction.source.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"transaction.source.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"transaction.source.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"transaction.source.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"transaction.source.oneOf.1.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.1","typeLabel":"External wallet · object"},{"type":"object","title":"Fiat wallet","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["walletFiat"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.2.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Fiat currency of the balance. Only `usd` today.","isRequired":true,"uniqueKey":"transaction.source.oneOf.2.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^(wlt_fiat_|[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})$","description":"The fiat wallet (`wlt_`; an older wallet keeps its original `wlt_\u003cuuid>` id, and a `wlt_fiat_` id is also accepted on input). Left out on a book-transfer destination until its outbound leg exists.","uniqueKey":"transaction.source.oneOf.2.id","typeLabel":"string"},"network":{"type":"string","enum":["bookTransfer","intraBank"],"description":"On the destination of a virtual account or deposit address book-transfer credit: `intraBank`, or `bookTransfer` on a record created before the umbrella names were introduced.","uniqueKey":"transaction.source.oneOf.2.network","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `network` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"transaction.source.oneOf.2.intraBankRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.2.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.2.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.2.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.2.owner","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.2","typeLabel":"Fiat wallet · object"},{"type":"object","title":"US bank account","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankUs"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.3.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.3.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.3.id","typeLabel":"string"},"instantRail":{"type":"string","description":"Only when `network` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"transaction.source.oneOf.3.instantRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.3.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.3.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.3.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.3.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.source.oneOf.3.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"transaction.source.oneOf.3.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"transaction.source.oneOf.3.details.routingNumber","typeLabel":"string"},"accountType":{"type":"string","enum":["checking","savings"],"description":"Bank account sub-type for US accounts.","uniqueKey":"transaction.source.oneOf.3.details.accountType","typeLabel":"enum\u003cstring>"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.source.oneOf.3.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.source.oneOf.3.details.memo","typeLabel":"string"}},"description":"US bank account details.","uniqueKey":"transaction.source.oneOf.3.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.3","typeLabel":"US bank account · object"},{"type":"object","title":"IBAN bank account","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankIban"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.4.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.4.asset","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.4.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.4.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.4.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.4.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.4.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.source.oneOf.4.details.bankName","typeLabel":"string"},"ibanLast4":{"type":"string","uniqueKey":"transaction.source.oneOf.4.details.ibanLast4","typeLabel":"string"},"bic":{"type":"string","uniqueKey":"transaction.source.oneOf.4.details.bic","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the bank.","uniqueKey":"transaction.source.oneOf.4.details.countryCode","typeLabel":"string"},"bankAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"transaction.source.oneOf.4.details.bankAddress","typeLabel":"object"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.source.oneOf.4.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.source.oneOf.4.details.memo","typeLabel":"string"}},"description":"IBAN bank account details.","uniqueKey":"transaction.source.oneOf.4.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.4","typeLabel":"IBAN bank account · object"},{"type":"object","title":"Canadian bank account","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankCanada"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.5.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd","cad"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.5.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.5.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.5.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.5.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.5.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.5.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.source.oneOf.5.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"transaction.source.oneOf.5.details.accountNumberLast4","typeLabel":"string"},"institutionNumber":{"type":"string","uniqueKey":"transaction.source.oneOf.5.details.institutionNumber","typeLabel":"string"},"transitNumber":{"type":"string","uniqueKey":"transaction.source.oneOf.5.details.transitNumber","typeLabel":"string"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.source.oneOf.5.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.source.oneOf.5.details.memo","typeLabel":"string"}},"description":"Canadian bank account details.","uniqueKey":"transaction.source.oneOf.5.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.5","typeLabel":"Canadian bank account · object"},{"type":"object","title":"Card","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.6.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.6.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`).","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.6.id","typeLabel":"string"},"network":{"type":"string","enum":["card"],"description":"The rail the money moves on.","uniqueKey":"transaction.source.oneOf.6.network","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.6.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.6.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.6.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.6.owner","typeLabel":"object"},"details":{"type":"object","properties":{"brand":{"type":"string","enum":["visa","mastercard","amex","discover"],"description":"Card network/brand. Derived server-side from the PAN; never accepted on a request.","uniqueKey":"transaction.source.oneOf.6.details.brand","typeLabel":"enum\u003cstring>"},"last4":{"type":"string","uniqueKey":"transaction.source.oneOf.6.details.last4","typeLabel":"string"},"cardType":{"type":"string","enum":["debit","credit","prepaid"],"description":"Card funding type, derived server-side from the PAN. Only `debit` is supported today; `credit` and `prepaid` are reserved for future push-to-card / pull-from-card support.","uniqueKey":"transaction.source.oneOf.6.details.cardType","typeLabel":"enum\u003cstring>"},"expiryMonth":{"type":"integer","format":"int32","uniqueKey":"transaction.source.oneOf.6.details.expiryMonth","typeLabel":"integer\u003cint32>"},"expiryYear":{"type":"integer","format":"int32","uniqueKey":"transaction.source.oneOf.6.details.expiryYear","typeLabel":"integer\u003cint32>"},"billingAddressSource":{"type":"string","enum":["provided","customerDefault"],"description":"Where a card's billing address came from. `provided` = supplied on the request; `customerDefault` = filled from the owning customer's address because the request omitted it.","uniqueKey":"transaction.source.oneOf.6.details.billingAddressSource","typeLabel":"enum\u003cstring>"}},"description":"Card details.","uniqueKey":"transaction.source.oneOf.6.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.6","typeLabel":"Card · object"},{"type":"object","title":"Cash","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["cash"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.7.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.7.asset","typeLabel":"string"},"details":{"type":"object","properties":{"locationId":{"type":"string","uniqueKey":"transaction.source.oneOf.7.details.locationId","typeLabel":"string"},"locationName":{"type":"string","uniqueKey":"transaction.source.oneOf.7.details.locationName","typeLabel":"string"},"locationAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"transaction.source.oneOf.7.details.locationAddress","typeLabel":"object"},"locationProvider":{"type":"string","description":"The cash network the location belongs to, lowercase, such as `greendot`.","uniqueKey":"transaction.source.oneOf.7.details.locationProvider","typeLabel":"string"}},"description":"Cash location details.","uniqueKey":"transaction.source.oneOf.7.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.7","typeLabel":"Cash · object"},{"type":"object","title":"Deposit address","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["depositAddress"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.8.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.8.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"transaction.source.oneOf.8.network","typeLabel":"string"},"id":{"type":"string","description":"The deposit address (`da_`).","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.8.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.8.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.8.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.8.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.8.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"transaction.source.oneOf.8.details.address","typeLabel":"string"}},"description":"Deposit address details.","uniqueKey":"transaction.source.oneOf.8.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.8","typeLabel":"Deposit address · object"},{"type":"object","title":"Virtual account","description":"The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["virtualAccount"],"isRequired":true,"uniqueKey":"transaction.source.oneOf.9.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.source.oneOf.9.asset","typeLabel":"string"},"id":{"type":"string","description":"The virtual account (`va_`).","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})$","x-go-type":"string","uniqueKey":"transaction.source.oneOf.9.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.source.oneOf.9.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.source.oneOf.9.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.source.oneOf.9.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.source.oneOf.9.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.source.oneOf.9.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"transaction.source.oneOf.9.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"transaction.source.oneOf.9.details.routingNumber","typeLabel":"string"}},"description":"Virtual account details. The full account number is in the virtual account's deposit instructions.","uniqueKey":"transaction.source.oneOf.9.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.source.oneOf.9","typeLabel":"Virtual account · object"}],"isRequired":true,"uniqueKey":"transaction.source","typeLabel":"OMS wallet · object | External wallet · object | Fiat wallet · object | US bank account · object | IBAN bank account · object | Canadian bank account · object | Card · object | Cash · object | Deposit address · object | Virtual account · object"},"destination":{"oneOf":[{"type":"object","title":"OMS wallet","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletCrypto"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.0.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.0.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.0.network","typeLabel":"string"},"id":{"type":"string","description":"The wallet (`wlt_`); an older wallet keeps its original `wlt_\u003cuuid>` id. Left out while a deposit's receiving wallet is not resolved yet.","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.0.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.0.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.0.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.0.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.0.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"transaction.destination.oneOf.0.details.address","typeLabel":"string"}},"description":"OMS crypto wallet details.","uniqueKey":"transaction.destination.oneOf.0.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.0","typeLabel":"OMS wallet · object"},{"type":"object","title":"External wallet","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["walletExternal"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.1.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.1.asset","typeLabel":"string"},"network":{"type":"string","description":"Lowercase blockchain.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.1.network","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.1.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.1.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.1.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.1.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.1.owner","typeLabel":"object"},"details":{"type":"object","properties":{"address":{"type":"string","description":"On-chain address.","uniqueKey":"transaction.destination.oneOf.1.details.address","typeLabel":"string"},"custodian":{"type":"string","description":"Who custodies the wallet, in lowerCamelCase.","uniqueKey":"transaction.destination.oneOf.1.details.custodian","typeLabel":"string"},"otherCustodian":{"type":"string","description":"The custodian's name when `custodian` is `other`.","uniqueKey":"transaction.destination.oneOf.1.details.otherCustodian","typeLabel":"string"},"networkFamily":{"type":"string","enum":["evm","solana","tron"],"description":"Crypto network family for a registered external wallet. A walletExternal is registered per family (an EVM address is valid across every EVM chain), and the registration covers every served network in that family. A create for a family the provider that provisions this project's walletExternal accounts does not serve is refused before anything is written, with 422 `NetworkFamilyNotServed`; depending on the provider, the refusal can be 403 `VendorConfigMissing` instead.","uniqueKey":"transaction.destination.oneOf.1.details.networkFamily","typeLabel":"enum\u003cstring>"}},"description":"External wallet details.","uniqueKey":"transaction.destination.oneOf.1.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.1","typeLabel":"External wallet · object"},{"type":"object","title":"Fiat wallet","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["walletFiat"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.2.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Fiat currency of the balance. Only `usd` today.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.2.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^(wlt_fiat_|[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})$","description":"The fiat wallet (`wlt_`; an older wallet keeps its original `wlt_\u003cuuid>` id, and a `wlt_fiat_` id is also accepted on input). Left out on a book-transfer destination until its outbound leg exists.","uniqueKey":"transaction.destination.oneOf.2.id","typeLabel":"string"},"network":{"type":"string","enum":["bookTransfer","intraBank"],"description":"On the destination of a virtual account or deposit address book-transfer credit: `intraBank`, or `bookTransfer` on a record created before the umbrella names were introduced.","uniqueKey":"transaction.destination.oneOf.2.network","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `network` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"transaction.destination.oneOf.2.intraBankRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.2.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.2.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.2.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.2.owner","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.2","typeLabel":"Fiat wallet · object"},{"type":"object","title":"US bank account","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankUs"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.3.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.3.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.3.id","typeLabel":"string"},"instantRail":{"type":"string","description":"Only when `network` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"transaction.destination.oneOf.3.instantRail","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.3.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.3.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.3.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.3.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.destination.oneOf.3.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"transaction.destination.oneOf.3.details.accountNumberLast4","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"transaction.destination.oneOf.3.details.routingNumber","typeLabel":"string"},"accountType":{"type":"string","enum":["checking","savings"],"description":"Bank account sub-type for US accounts.","uniqueKey":"transaction.destination.oneOf.3.details.accountType","typeLabel":"enum\u003cstring>"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.destination.oneOf.3.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.destination.oneOf.3.details.memo","typeLabel":"string"}},"description":"US bank account details.","uniqueKey":"transaction.destination.oneOf.3.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.3","typeLabel":"US bank account · object"},{"type":"object","title":"IBAN bank account","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankIban"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.4.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.4.asset","typeLabel":"string"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.4.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.4.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.4.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.4.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.4.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.destination.oneOf.4.details.bankName","typeLabel":"string"},"ibanLast4":{"type":"string","uniqueKey":"transaction.destination.oneOf.4.details.ibanLast4","typeLabel":"string"},"bic":{"type":"string","uniqueKey":"transaction.destination.oneOf.4.details.bic","typeLabel":"string"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country of the bank.","uniqueKey":"transaction.destination.oneOf.4.details.countryCode","typeLabel":"string"},"bankAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"transaction.destination.oneOf.4.details.bankAddress","typeLabel":"object"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.destination.oneOf.4.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.destination.oneOf.4.details.memo","typeLabel":"string"}},"description":"IBAN bank account details.","uniqueKey":"transaction.destination.oneOf.4.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.4","typeLabel":"IBAN bank account · object"},{"type":"object","title":"Canadian bank account","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["bankCanada"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.5.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd","cad"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.5.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`). Left out for a sender OMS has no record of.","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.5.id","typeLabel":"string"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.5.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.5.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.5.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.5.owner","typeLabel":"object"},"details":{"type":"object","properties":{"bankName":{"type":"string","uniqueKey":"transaction.destination.oneOf.5.details.bankName","typeLabel":"string"},"accountNumberLast4":{"type":"string","uniqueKey":"transaction.destination.oneOf.5.details.accountNumberLast4","typeLabel":"string"},"institutionNumber":{"type":"string","uniqueKey":"transaction.destination.oneOf.5.details.institutionNumber","typeLabel":"string"},"transitNumber":{"type":"string","uniqueKey":"transaction.destination.oneOf.5.details.transitNumber","typeLabel":"string"},"holderName":{"type":"string","description":"The account holder: a counterparty's name, or the sender's name when the rail carries it.","uniqueKey":"transaction.destination.oneOf.5.details.holderName","typeLabel":"string"},"memo":{"type":"string","description":"The free-text message that travelled with the money on this side's rail.","uniqueKey":"transaction.destination.oneOf.5.details.memo","typeLabel":"string"}},"description":"Canadian bank account details.","uniqueKey":"transaction.destination.oneOf.5.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.5","typeLabel":"Canadian bank account · object"},{"type":"object","title":"Card","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.6.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","enum":["usd"],"description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.6.asset","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The external account (`ext_`).","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})$","x-go-type":"string","uniqueKey":"transaction.destination.oneOf.6.id","typeLabel":"string"},"network":{"type":"string","enum":["card"],"description":"The rail the money moves on.","uniqueKey":"transaction.destination.oneOf.6.network","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["counterparty","customer"],"description":"`counterparty`, or `customer` for another customer's account.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.6.owner.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The counterparty (`ctp_`) or customer (`cst_`).","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.destination.oneOf.6.owner.id","typeLabel":"string"},"name":{"type":"string","description":"The counterparty's name. A customer's name is on the customer resource.","uniqueKey":"transaction.destination.oneOf.6.owner.name","typeLabel":"string"}},"description":"Who owns an account that is not the resource's customer's.","uniqueKey":"transaction.destination.oneOf.6.owner","typeLabel":"object"},"details":{"type":"object","properties":{"brand":{"type":"string","enum":["visa","mastercard","amex","discover"],"description":"Card network/brand. Derived server-side from the PAN; never accepted on a request.","uniqueKey":"transaction.destination.oneOf.6.details.brand","typeLabel":"enum\u003cstring>"},"last4":{"type":"string","uniqueKey":"transaction.destination.oneOf.6.details.last4","typeLabel":"string"},"cardType":{"type":"string","enum":["debit","credit","prepaid"],"description":"Card funding type, derived server-side from the PAN. Only `debit` is supported today; `credit` and `prepaid` are reserved for future push-to-card / pull-from-card support.","uniqueKey":"transaction.destination.oneOf.6.details.cardType","typeLabel":"enum\u003cstring>"},"expiryMonth":{"type":"integer","format":"int32","uniqueKey":"transaction.destination.oneOf.6.details.expiryMonth","typeLabel":"integer\u003cint32>"},"expiryYear":{"type":"integer","format":"int32","uniqueKey":"transaction.destination.oneOf.6.details.expiryYear","typeLabel":"integer\u003cint32>"},"billingAddressSource":{"type":"string","enum":["provided","customerDefault"],"description":"Where a card's billing address came from. `provided` = supplied on the request; `customerDefault` = filled from the owning customer's address because the request omitted it.","uniqueKey":"transaction.destination.oneOf.6.details.billingAddressSource","typeLabel":"enum\u003cstring>"}},"description":"Card details.","uniqueKey":"transaction.destination.oneOf.6.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.6","typeLabel":"Card · object"},{"type":"object","title":"Cash","description":"The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.","required":["type","asset"],"properties":{"type":{"type":"string","enum":["cash"],"isRequired":true,"uniqueKey":"transaction.destination.oneOf.7.type","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Lowercase asset.","isRequired":true,"uniqueKey":"transaction.destination.oneOf.7.asset","typeLabel":"string"},"details":{"type":"object","properties":{"locationId":{"type":"string","uniqueKey":"transaction.destination.oneOf.7.details.locationId","typeLabel":"string"},"locationName":{"type":"string","uniqueKey":"transaction.destination.oneOf.7.details.locationName","typeLabel":"string"},"locationAddress":{"type":"object","properties":{"line1":{"type":"string","description":"Street address, line 1.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address, line 2.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State / province / region.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.state","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.country","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress.zipCode","typeLabel":"string"}},"description":"A postal address. country is an ISO 3166-1 alpha-2 country code.","uniqueKey":"transaction.destination.oneOf.7.details.locationAddress","typeLabel":"object"},"locationProvider":{"type":"string","description":"The cash network the location belongs to, lowercase, such as `greendot`.","uniqueKey":"transaction.destination.oneOf.7.details.locationProvider","typeLabel":"string"}},"description":"Cash location details.","uniqueKey":"transaction.destination.oneOf.7.details","typeLabel":"object"},"pickupCode":{"type":"string","description":"Retail pickup code for a cash payout.","uniqueKey":"transaction.destination.oneOf.7.pickupCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.destination.oneOf.7","typeLabel":"Cash · object"}],"isRequired":true,"uniqueKey":"transaction.destination","typeLabel":"OMS wallet · object | External wallet · object | Fiat wallet · object | US bank account · object | IBAN bank account · object | Canadian bank account · object | Card · object | Cash · object"},"pricing":{"type":"object","description":"Consolidated economics.","required":["fees"],"properties":{"fees":{"type":"array","items":{"type":"object","required":["type","side","asset","amount"],"properties":{"type":{"type":"string","description":"Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: \"developer\", \"oms\", \"gas\", \"retailer\" (a cash provider's retail fee, on `CashIn.providerFee`), \"exchange\" (the exchange fee the crypto purchase realized, on the linked transaction once it completes).","isRequired":true,"uniqueKey":"transaction.pricing.fees.items.[INDEX].type","typeLabel":"string"},"side":{"type":"string","enum":["source","destination"],"description":"Which side this fee was deducted from.","isRequired":true,"uniqueKey":"transaction.pricing.fees.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Currency this fee is denominated in — that side's asset.","isRequired":true,"uniqueKey":"transaction.pricing.fees.items.[INDEX].asset","typeLabel":"string"},"amount":{"type":"string","description":"Fee amount in `asset`, at the asset's precision.","isRequired":true,"uniqueKey":"transaction.pricing.fees.items.[INDEX].amount","typeLabel":"string"}},"description":"A fee charged on one side of a quote, transaction or cash-in. A fee is listed only when it is not zero.","uniqueKey":"transaction.pricing.fees.items.[INDEX]","typeLabel":"object"},"description":"Every fee charged across both sides. `[]` when there are none — never omitted, never null.","isRequired":true,"uniqueKey":"transaction.pricing.fees","typeLabel":"object[]"},"source":{"type":"object","description":"The source side, in the source asset.","required":["asset"],"properties":{"asset":{"type":"string","description":"Lowercase asset of this side, the same as the side's instrument asset.","isRequired":true,"uniqueKey":"transaction.pricing.source.asset","typeLabel":"string"},"amount":{"type":"string","description":"On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.","uniqueKey":"transaction.pricing.source.amount","typeLabel":"string"}},"uniqueKey":"transaction.pricing.source","typeLabel":"object"},"destination":{"type":"object","description":"The destination side, in the destination asset.","required":["asset"],"properties":{"asset":{"type":"string","description":"Lowercase asset of this side, the same as the side's instrument asset.","isRequired":true,"uniqueKey":"transaction.pricing.destination.asset","typeLabel":"string"},"amount":{"type":"string","description":"On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.","uniqueKey":"transaction.pricing.destination.amount","typeLabel":"string"}},"uniqueKey":"transaction.pricing.destination","typeLabel":"object"},"exchangeRate":{"type":"string","description":"Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.","uniqueKey":"transaction.pricing.exchangeRate","typeLabel":"string"},"fixedAmountSide":{"type":"string","enum":["source","destination"],"description":"The side whose amount was fixed at creation. OMS calculated the other side.","uniqueKey":"transaction.pricing.fixedAmountSide","typeLabel":"enum\u003cstring>"},"sponsorGas":{"type":"boolean","description":"Present and `true` when OMS absorbs the destination gas cost; omitted otherwise.","uniqueKey":"transaction.pricing.sponsorGas","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"transaction.pricing","typeLabel":"object"},"precursor":{"type":"object","description":"What created this transaction, as a uniform `{type, id}` reference — dereference the resource by `id` for its full record. A custodial-wallet deposit renders `{type: walletDeposit}`. Left out for a genuine out-of-band arrival with no recognised origin at all; the `manual` arm is reserved for a future operator-initiated transaction, distinct from either.","required":["type","id"],"properties":{"type":{"type":"string","enum":["quote","depositAddress","virtualAccount","cashIn","manual","walletDeposit"],"isRequired":true,"uniqueKey":"transaction.precursor.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"string","description":"`qt_` / `da_` / `va_` / `ci_`. Null for `manual` and `walletDeposit`.","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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.precursor.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"transaction.precursor.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"transaction.precursor.id","typeLabel":"string | null"}},"uniqueKey":"transaction.precursor","typeLabel":"object"},"payoutOrigin":{"type":"object","description":"Whose name the payout goes out under. Left out when nothing is paid out to a bank account, a card or a wallet.","required":["type"],"properties":{"type":{"type":"string","enum":["bank","blockchain"],"isRequired":true,"uniqueKey":"transaction.payoutOrigin.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","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})$","description":"Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`.","x-go-type":"string","uniqueKey":"transaction.payoutOrigin.id","typeLabel":"string"},"accountHolder":{"type":"string","description":"Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.","enum":["customer","paymentProvider","partner"],"uniqueKey":"transaction.payoutOrigin.accountHolder","typeLabel":"enum\u003cstring>"},"accountHolderName":{"type":"string","description":"The legal name the payment is sent under, resolved from `accountHolder` — the customer's own legal name for `customer`, the owning customer's legal name for `partner` (for now; a partner-level name may replace it later), or the payment provider's name for `paymentProvider`, which differs between a `bank` origin (\"Coinme Inc FBO its Customers\") and a `blockchain` origin. This is what the recipient sees as the sender. Like `accountHolder` and unlike `id`, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever `accountHolder` is, and when the customer's name cannot be read at that moment.","uniqueKey":"transaction.payoutOrigin.accountHolderName","typeLabel":"string"}},"uniqueKey":"transaction.payoutOrigin","typeLabel":"object"},"transfers":{"type":"array","items":{"type":"object","required":["id","role","rail","attempt"],"properties":{"id":{"type":"string","description":"Transfer ID (`trf_` 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})$","x-go-type":"string","isRequired":true,"uniqueKey":"transaction.transfers.items.[INDEX].id","typeLabel":"string"},"role":{"type":"string","enum":["deposit","payout","refund"],"description":"What a transfer does in its transaction. `deposit` brings money in, `payout` sends it out and `refund` sends it back to the sender. A bank return is the transfer's `returned` status, not a role.","isRequired":true,"uniqueKey":"transaction.transfers.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"rail":{"type":"string","enum":["ach","achSameDay","wire","internationalWire","rtp","bookTransfer","instant","intraBank","blockchain","card","cash"],"description":"How a transfer's money moved. `instant` is an RTP or FedNow payout, named in `instantRail`; `intraBank` stays inside the bank, named in `intraBankRail`. A record created before the umbrella names were introduced keeps `rtp` or `bookTransfer`.","isRequired":true,"uniqueKey":"transaction.transfers.items.[INDEX].rail","typeLabel":"enum\u003cstring>"},"attempt":{"type":"integer","format":"int32","description":"1 for the first send; a payout sent again after a confirmed failure is a new transfer with `attempt` + 1.","isRequired":true,"uniqueKey":"transaction.transfers.items.[INDEX].attempt","typeLabel":"integer\u003cint32>"},"instantRail":{"type":"string","description":"Only when `rail` is `instant`.","enum":["rtp","fednow"],"uniqueKey":"transaction.transfers.items.[INDEX].instantRail","typeLabel":"enum\u003cstring>"},"intraBankRail":{"type":"string","description":"Only when `rail` is `intraBank`.","enum":["bookTransfer","crnow","ereborRail"],"uniqueKey":"transaction.transfers.items.[INDEX].intraBankRail","typeLabel":"enum\u003cstring>"}},"description":"A transfer of a transaction.","uniqueKey":"transaction.transfers.items.[INDEX]","typeLabel":"object"},"description":"The transaction's transfers, in creation order: each movement of its money on one rail. Left out until the first transfer exists; fetch one with `GET /transfers/{transferId}`.","uniqueKey":"transaction.transfers","typeLabel":"object[]"},"failure":{"type":"object","description":"Why the transaction failed. Present only when `status` is `failed`.","required":["code","message","retryable"],"properties":{"code":{"type":"string","description":"What went wrong.","enum":["providerError","providerRejected","providerTimeout","expired","systemError","provisioningTimeout","insufficientFunds","providerAmountBelowMinimum","limitExceeded","outsideSellBounds","outsideSellVelocityBounds","unusableAmount","unsupportedCorridor","outgoingRailNotEnabled","ssnNotVerified","riskRejected","cardDeclined","bankSellDeclined","payoutFailed","priceMoved","returningToSender","returnedToSender","returnFailed","depositFailed","attributionTimeout","assetMismatch","chainMismatch","misattributedArrival","depositAddressNotActive","virtualAccountNotActive","counterpartyArchived","destinationUnavailable","walletClaimed","walletBoundToCustodialFlow","projectSuspended","memoInvalid","cashDepositFailed","noMatchingNetwork","blockchainAddressInUse","bankAccountInUse","bankAccountRejected","deletePendingTimeout","providerAccountMissing","cardInUse","cardLimitReached","countryProhibited","countryNotSupported","cardVerificationDeclined","bankVerificationDeclined","accountClosed","accountFrozenByBank","routingOrAccountNumberInvalid","accountHolderDeceased","accountDoesNotSupportTransfers","payeeNameMismatch","walletUnreachableOnNetwork","billingAddressMismatch","cardExpired","cardClosedOrLostStolen","pushToCardUnsupported","cardDeclinedByIssuer"],"isRequired":true,"uniqueKey":"transaction.failure.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A fixed, vendor-neutral sentence for `code`.","isRequired":true,"uniqueKey":"transaction.failure.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether trying the same thing again can succeed.","isRequired":true,"uniqueKey":"transaction.failure.retryable","typeLabel":"boolean"},"bankCode":{"type":"string","description":"The bank's own return code, only on an external account a bank return made invalid.","uniqueKey":"transaction.failure.bankCode","typeLabel":"string"}},"uniqueKey":"transaction.failure","typeLabel":"object"},"hold":{"type":"object","description":"What the partner must do while `status` is `awaitingAction`. Left out in every other status.","required":["code","message"],"properties":{"code":{"type":"string","description":"Why the resource is held.","enum":["senderAttribution","payoutDestinationMissing"],"isRequired":true,"uniqueKey":"transaction.hold.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A fixed, vendor-neutral sentence for `code`.","isRequired":true,"uniqueKey":"transaction.hold.message","typeLabel":"string"},"deadline":{"type":"string","format":"date-time","description":"When the hold times out and the transaction fails. Only on `senderAttribution`.","uniqueKey":"transaction.hold.deadline","typeLabel":"string\u003cdate-time>"},"match":{"type":"object","description":"The sender's address and network to register to release the hold. Only on `senderAttribution`.","required":["address","network"],"properties":{"address":{"type":"string","description":"The sender's on-chain address.","isRequired":true,"uniqueKey":"transaction.hold.match.address","typeLabel":"string"},"network":{"type":"string","description":"The network family of the sender's address.","enum":["evm","solana","tron"],"isRequired":true,"uniqueKey":"transaction.hold.match.network","typeLabel":"enum\u003cstring>"}},"uniqueKey":"transaction.hold.match","typeLabel":"object"}},"uniqueKey":"transaction.hold","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"transaction.metadata.additionalProperties","typeLabel":"string"},"description":"Free-form key-value pairs supplied at creation or update.","uniqueKey":"transaction.metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"When the transaction was created.","uniqueKey":"transaction.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the transaction was last updated.","uniqueKey":"transaction.updatedAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"type":"string","format":"date-time","description":"When the transaction first reached `completed`: the source leg's completion for a single-leg transaction, the payout leg's for a multi-leg one. Written once and never moved by a later provider notification. Present only while `status` is `completed`: a completed transaction that is later reversed (for example a returned payout) drops it.","uniqueKey":"transaction.completedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"transaction","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Free-form key-value pairs supplied at submission.","uniqueKey":"metadata","typeLabel":"object"}},"description":"A withdrawal submitted from a quote. When the project requires approval it waits for a second person, and approving creates the transaction; otherwise submitting creates the transaction at once.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","quoteId":"\u003cstring>","status":"pendingApproval","customer":{"id":"\u003cstring>"},"source":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"destination":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"pricing":{"fees":[{"type":"\u003cstring>","side":"source","asset":"\u003cstring>","amount":"\u003cstring>"}],"source":{"asset":"\u003cstring>","amount":"\u003cstring>"},"destination":{"asset":"\u003cstring>","amount":"\u003cstring>"},"exchangeRate":"\u003cstring>","fixedAmountSide":"source","sponsorGas":true},"createdBy":{"type":"user","id":"\u003cstring>"},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","reviewedBy":{"type":"user","id":"\u003cstring>"},"reviewedAt":"2023-11-07T05:31:56Z","transactionId":"\u003cstring>","transaction":{"id":"\u003cstring>","status":"processing","subStatus":"processing.fundsPulled","customer":{"id":"\u003cstring>"},"source":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"destination":{"type":"walletCrypto","asset":"\u003cstring>","network":"\u003cstring>","id":"\u003cstring>","owner":{"kind":"counterparty","id":"\u003cstring>","name":"\u003cstring>"},"details":{"address":"\u003cstring>"}},"pricing":{"fees":[{"type":"\u003cstring>","side":"source","asset":"\u003cstring>","amount":"\u003cstring>"}],"source":{"asset":"\u003cstring>","amount":"\u003cstring>"},"destination":{"asset":"\u003cstring>","amount":"\u003cstring>"},"exchangeRate":"\u003cstring>","fixedAmountSide":"source","sponsorGas":true},"precursor":{"type":"quote","id":"\u003cstring>"},"payoutOrigin":{"type":"bank","id":"\u003cstring>","accountHolder":"customer","accountHolderName":"\u003cstring>"},"transfers":[{"id":"\u003cstring>","role":"deposit","rail":"ach","attempt":123,"instantRail":"rtp","intraBankRail":"bookTransfer"}],"failure":{"code":"providerError","message":"\u003cstring>","retryable":true,"bankCode":"\u003cstring>"},"hold":{"code":"senderAttribution","message":"\u003cstring>","deadline":"2023-11-07T05:31:56Z","match":{"address":"\u003cstring>","network":"evm"}},"metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","completedAt":"2023-11-07T05:31:56Z"},"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"1ff21658-71e3-416a-987f-4a8f2460fcdc":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["WithdrawalActorNotAllowed"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10401],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["the caller is not allowed to act on this withdrawal request"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"WithdrawalActorNotAllowed","code":10401,"msg":"the caller is not allowed to act on this withdrawal request","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"da60e374-aeec-431e-a77b-7c38db9b77e0":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["WithdrawalRequestNotFound"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10406],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["withdrawal request not found"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"WithdrawalRequestNotFound","code":10406,"msg":"withdrawal request not found","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"68be9fa1-bd5d-4732-b2c8-229450520162":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["WithdrawalRequestNotPending"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10397],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["the withdrawal request is no longer pending approval"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"WithdrawalRequestNotPending","code":10397,"msg":"the withdrawal request is no longer pending approval","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3c207fe4-4353-45d7-9c61-3a42941d9d42":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","required":["error","code","msg"],"properties":{"error":{"type":"string","enum":["Internal"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"code":{"type":"number","enum":[10124],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cnumber>"},"msg":{"type":"string","enum":["internal error"],"isRequired":true,"uniqueKey":"msg","typeLabel":"enum\u003cstring>"},"cause":{"type":"string","uniqueKey":"cause","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Internal","code":10124,"msg":"internal error","cause":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"626e1624-cc8c-4f0e-89c6-9abc8f35f997":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"f1f89dd2-21a8-4fdc-a3bd-c30b233ac302":{"url":"https://sandbox-api.polygon.technology/v0.13","description":"Sandbox"},"02fbca03-cd58-4fbe-8bb8-e29577dcbb42":{"url":"https://api.polygon.technology/v0.13","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token from POST /auth/token","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token from POST /auth/token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"polygon-labs","siteName":"Polygon Developer Docs","title":"Cancel a Withdrawal Request - Polygon Developer Docs","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T12:31:35.057Z","originalFileLocation":"api-reference/withdrawal-request/cancel-a-withdrawal-request.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Cancel a pending withdrawal request. Only the submitter can cancel.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a Withdrawal Request - Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel a pending withdrawal request. Only the submitter can cancel.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Withdrawal+requests\u0026amp;title=Cancel+a+Withdrawal+Request\u0026amp;description=Cancel+a+pending+withdrawal+request.+Only+the+submitter+can+cancel.\u0026amp;theme=b36bd2d42ef34b1589e85268\u0026amp;signature=fc1b504d3c7cdfa47541ad648df1fc498e37a4e341dde10f254df4c9bd0cbad4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Cancel a Withdrawal Request - Polygon Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel a pending withdrawal request. Only the submitter can cancel.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polygon-labs.mintlify.site/_mintlify/api/og/v2?division=Withdrawal+requests\u0026amp;title=Cancel+a+Withdrawal+Request\u0026amp;description=Cancel+a+pending+withdrawal+request.+Only+the+submitter+can+cancel.\u0026amp;theme=b36bd2d42ef34b1589e85268\u0026amp;signature=fc1b504d3c7cdfa47541ad648df1fc498e37a4e341dde10f254df4c9bd0cbad4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/polygon-labs/mGaxVdHZf09e3t79/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polygon Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#670DE5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/withdrawal-request/cancel-a-withdrawal-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.polygon.technology/#organization\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polygon-labs/ll1LL3IdpC3YxXZu/logo/light.svg?fit=max\u0026auto=format\u0026n=ll1LL3IdpC3YxXZu\u0026q=85\u0026s=d54ddb30492807a0eadf38093c075f2f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polygon.technology#website\",\"name\":\"Polygon Developer Docs\",\"url\":\"https://docs.polygon.technology\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request#webpage\",\"url\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request\",\"name\":\"Cancel a Withdrawal Request\",\"description\":\"Cancel a pending withdrawal request. Only the submitter can cancel.\",\"dateModified\":\"2026-11-18T12:31:35.057Z\",\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Move money\",\"item\":\"https://docs.polygon.technology/api-reference/quote/create-a-payment-quote\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Withdrawal requests\",\"item\":\"https://docs.polygon.technology/api-reference/withdrawal-request/create-a-withdrawal-request\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel a Withdrawal Request\",\"item\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request#apireference\",\"headline\":\"Cancel a Withdrawal Request\",\"name\":\"Cancel a Withdrawal Request\",\"description\":\"Cancel a pending withdrawal request. Only the submitter can cancel.\",\"url\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polygon.technology/api-reference/withdrawal-request/cancel-a-withdrawal-request#webpage\"},\"dateModified\":\"2026-11-18T12:31:35.057Z\",\"publisher\":{\"@id\":\"https://docs.polygon.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polygon.technology#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/withdrawal-request/cancel-a-withdrawal-request.md","siteName":"Polygon Developer Docs","nav":{"global":null,"products":[{"product":"Developer Docs","icon":"code","description":"APIs, SDKs, and infrastructure guides for builders","tabs":[{"tab":"Platform","icon":"layer-group","pages":[{"title":"Platform","href":""}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/payments/overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Cross-chain","pages":[{"title":"Cross-chain","href":"/cross-chain"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Open Money Stack API","href":"/api-reference/overview"}]},{"group":"Move money","pages":[{"group":"Quotes","pages":[{"title":"Create a payment quote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /quotes","href":"/api-reference/quote/create-a-payment-quote"},{"title":"Get quote by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /quotes/{quoteId}","href":"/api-reference/quote/get-quote-by-id"}]},{"group":"Transactions","pages":[{"title":"Execute a transaction (send)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /transactions","href":"/api-reference/transaction/execute-a-transaction-send"},{"title":"List transactions with filters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions","href":"/api-reference/transaction/list-transactions-with-filters"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions/{transactionId}","href":"/api-reference/transaction/get-transaction-by-id"}]},{"group":"Withdrawal requests","pages":[{"title":"Create a Withdrawal Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests","href":"/api-reference/withdrawal-request/create-a-withdrawal-request"},{"title":"List Withdrawal Requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /withdrawal-requests","href":"/api-reference/withdrawal-request/list-withdrawal-requests"},{"title":"Get a Withdrawal Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /withdrawal-requests/{withdrawalRequestId}","href":"/api-reference/withdrawal-request/get-a-withdrawal-request"},{"title":"Approve a Withdrawal Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests/{withdrawalRequestId}/approve","href":"/api-reference/withdrawal-request/approve-a-withdrawal-request"},{"title":"Reject a Withdrawal Request","description":"Reject a pending withdrawal request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests/{withdrawalRequestId}/reject","href":"/api-reference/withdrawal-request/reject-a-withdrawal-request"},{"title":"Cancel a Withdrawal Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /withdrawal-requests/{withdrawalRequestId}/cancel","href":"/api-reference/withdrawal-request/cancel-a-withdrawal-request"}]},{"group":"Transfers","pages":[{"title":"Get transfer by ID","description":"Retrieves one transfer of a transaction by ID.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transfers/{transferId}","href":"/api-reference/transfer/get-transfer-by-id"}]},{"group":"Cash-In","pages":[{"title":"Create a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins","href":"/api-reference/cashins/create-a-cash-in-deposit-code"},{"title":"List cash-ins","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins","href":"/api-reference/cashins/list-cash-ins"},{"title":"Get a cash-in by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-ins/{cashInId}","href":"/api-reference/cashins/get-a-cash-in-by-id"},{"title":"Refresh a cash-in deposit code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/refresh","href":"/api-reference/cashins/refresh-a-cash-in-deposit-code"},{"title":"Cancel a cash-in","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/cancel","href":"/api-reference/cashins/cancel-a-cash-in"}]}]},{"group":"Routes","pages":[{"group":"Deposit Addresses","pages":[{"title":"Create a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /deposit-addresses","href":"/api-reference/depositaddress/create-a-deposit-address"},{"title":"List all Deposit Addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses","href":"/api-reference/depositaddress/list-all-deposit-addresses"},{"title":"Get a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/get-a-deposit-address"},{"title":"Update a Deposit Address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /deposit-addresses/{depositAddressId}","href":"/api-reference/depositaddress/update-a-deposit-address"}]},{"group":"Virtual Accounts","pages":[{"title":"Create a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts","href":"/api-reference/virtualaccount/create-a-virtual-account"},{"title":"List all Virtual Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts","href":"/api-reference/virtualaccount/list-all-virtual-accounts"},{"title":"Get a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/get-a-virtual-account"},{"title":"Update a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/update-a-virtual-account"},{"title":"Delete a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /virtual-accounts/{virtualAccountId}","href":"/api-reference/virtualaccount/delete-a-virtual-account"}]}]},{"group":"External Payment Methods","pages":[{"group":"Counterparties","pages":[{"title":"Create a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /counterparties","href":"/api-reference/counterparty/create-a-counterparty"},{"title":"List Counterparties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties","href":"/api-reference/counterparty/list-counterparties"},{"title":"Get a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /counterparties/{counterpartyId}","href":"/api-reference/counterparty/get-a-counterparty"},{"title":"Update a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /counterparties/{counterpartyId}","href":"/api-reference/counterparty/update-a-counterparty"},{"title":"Delete a Counterparty","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /counterparties/{counterpartyId}","href":"/api-reference/counterparty/delete-a-counterparty"}]},{"group":"External Accounts","pages":[{"title":"Create an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts","href":"/api-reference/externalaccount/create-an-external-account"},{"title":"Register a card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /external-accounts/cards","href":"/api-reference/externalaccount/register-a-card"},{"title":"List External Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts","href":"/api-reference/externalaccount/list-external-accounts"},{"title":"Get an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/get-an-external-account"},{"title":"Update an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/update-an-external-account"},{"title":"Delete an External Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /external-accounts/{externalAccountId}","href":"/api-reference/externalaccount/delete-an-external-account"}]}]},{"group":"Platform","pages":[{"group":"Auth","pages":[{"title":"Get bearer token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /auth/token","href":"/api-reference/auth/get-bearer-token"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get customer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /customers/{customerId}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}","href":"/api-reference/customers/delete-a-customer"},{"title":"Create a browser token for a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/token","href":"/api-reference/customertokens/create-a-browser-token-for-a-customer"},{"title":"Get browser risk configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /risk/config","href":"/api-reference/get-browser-risk-configuration"}]},{"group":"Business onboarding","pages":[{"title":"Create a business beneficiary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/beneficiaries","href":"/api-reference/business-onboarding/create-a-business-beneficiary"},{"title":"List business beneficiaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries","href":"/api-reference/business-onboarding/list-business-beneficiaries"},{"title":"Get a business beneficiary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/get-a-business-beneficiary"},{"title":"Update a business beneficiary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/update-a-business-beneficiary"},{"title":"Delete a business beneficiary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /customers/{customerId}/beneficiaries/{beneficiaryId}","href":"/api-reference/business-onboarding/delete-a-business-beneficiary"},{"title":"Submit a business onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/onboardings","href":"/api-reference/business-onboarding/submit-a-business-onboarding"},{"title":"List business onboardings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings","href":"/api-reference/business-onboarding/list-business-onboardings"},{"title":"Get a business onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /customers/{customerId}/onboardings/{onboardingId}","href":"/api-reference/business-onboarding/get-a-business-onboarding"}]},{"group":"Wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets","href":"/api-reference/wallet/list-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /wallets","href":"/api-reference/wallet/create-a-wallet"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/{id}","href":"/api-reference/wallet/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /wallets/{id}","href":"/api-reference/wallet/update-a-wallet"},{"title":"Get a wallet-provisioning operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /wallets/operations/{operationId}","href":"/api-reference/wallet/get-a-wallet-provisioning-operation"},{"title":"Associate an embedded wallet with a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /customers/{customerId}/wallets/associate","href":"/api-reference/wallets/associate-an-embedded-wallet-with-a-customer"}]},{"group":"Cash Locations","pages":[{"title":"List cash locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cash-locations","href":"/api-reference/cashlocation/list-cash-locations"}]},{"group":"Webhooks","pages":[{"title":"Webhook events","href":"/api-reference/webhook-events"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook-by-id"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /webhooks/{webhookId}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Enable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/enable","href":"/api-reference/webhooks/enable-a-webhook"},{"title":"Disable a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/disable","href":"/api-reference/webhooks/disable-a-webhook"},{"title":"Rotate the signing key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/rotate-key","href":"/api-reference/webhooks/rotate-the-signing-key"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/test","href":"/api-reference/webhooks/send-a-test-delivery"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries","href":"/api-reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Get a delivery with its attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /webhooks/{webhookId}/deliveries/{deliveryId}","href":"/api-reference/webhooks/get-a-delivery-with-its-attempts"},{"title":"Retry deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /webhooks/{webhookId}/deliveries/retry","href":"/api-reference/webhooks/retry-deliveries"}]},{"group":"Reference","pages":[{"title":"List supported networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /networks","href":"/api-reference/reference/list-supported-networks"},{"title":"Get account-type requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /reference/account-type-requirements","href":"/api-reference/reference/get-account-type-requirements"}]},{"group":"Sandbox Simulations","pages":[{"title":"Get inbound transfer simulation options for a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer","href":"/api-reference/sandbox/get-inbound-transfer-simulation-options-for-a-virtual-account"},{"title":"Simulate inbound transfer on a Virtual Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /virtual-accounts/{virtualAccountId}/simulate/inbound-transfer","href":"/api-reference/sandbox/simulate-inbound-transfer-on-a-virtual-account"},{"title":"Simulate cash-in present code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/present-code","href":"/api-reference/sandbox/simulate-cash-in-present-code"},{"title":"Simulate cash-in deposit cash","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/deposit-cash","href":"/api-reference/sandbox/simulate-cash-in-deposit-cash"},{"title":"Simulate cash-in cancel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cash-ins/{cashInId}/simulate/cancel","href":"/api-reference/sandbox/simulate-cash-in-cancel"}]}]},{"group":"Read onchain data","pages":[{"group":"Token Balances","pages":[{"title":"Get token balance summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesSummary","href":"/api-reference/indexer/get-token-balance-summary"},{"title":"Get token balance details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-token-balance-details"},{"title":"Get token balances by contract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenBalancesByContract","href":"/api-reference/indexer/get-token-balances-by-contract"},{"title":"Get native token balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetNativeTokenBalance","href":"/api-reference/indexer/get-native-token-balance"},{"title":"Get balance updates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetBalanceUpdates","href":"/api-reference/indexer/get-balance-updates"},{"title":"Get Solana token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/SolanaIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-solana-token-balances"},{"title":"Get Tron token balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/TronIndexerGateway/GetTokenBalancesDetails","href":"/api-reference/indexer/get-tron-token-balances"}]},{"group":"Token Prices","pages":[{"title":"Get token price","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrice","href":"/api-reference/indexer/get-token-price"},{"title":"Get token prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTokenPrices","href":"/api-reference/indexer/get-token-prices"}]},{"group":"Transaction History","pages":[{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetTransactionHistory","href":"/api-reference/indexer/get-transaction-history"}]},{"group":"Chains","pages":[{"title":"List chains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/IndexerGateway/GetChains","href":"/api-reference/indexer/list-chains"}]}]}]},{"tab":"Infrastructure","icon":"server","pages":[{"title":"Infrastructure","href":"/infrastructure"}]},{"tab":"Polygon Chain","pages":[{"title":"Polygon Chain","href":"/pos/overview"}]},{"tab":"Polygon CDK","pages":[{"title":"Polygon CDK","href":"/chain-development/cdk"}]},{"tab":"Agglayer","pages":[{"title":"Agglayer","href":"/interoperability/overview"}]},{"tab":"Agentic","pages":[{"title":"Agentic","href":"/payment-services/agentic-payments/agent-integration/intro"}]}]},{"product":"Help Center","icon":"life-ring","description":"Dashboard how-tos for admins and business teams","pages":[{"title":"Help Center","href":"/help-center"}]}]},"basePath":"","title":"Cancel a Withdrawal Request - Polygon Developer Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}