> ## Documentation Index > Fetch the complete documentation index at: https://docs.polygon.technology/llms.txt > Use this file to discover all available pages before exploring further. # Get quote by ID > Retrieves a previously created quote by ID, including its locked rate, fee breakdown, and expiry. ## OpenAPI ````yaml /api-reference/openapi.yaml get /quotes/{quoteId} openapi: 3.0.3 info: title: Polygon OMS Public API version: v26.05.28-0001 description: >- Unified API for moving money between crypto and fiat. Three ways to move money: Transactions (instant, wallet or card funded, including Cash-In for in-person cash deposits), Deposit Addresses (reusable crypto deposit configurations), and Virtual Accounts (dedicated bank accounts that auto-convert fiat to crypto). Standard transactions follow a two-step flow: create a Quote (pricing), then create a Transaction (execution). Cash-in codes generate a one-time deposit code for in-person cash deposits at retail locations. contact: name: Polygon OMS url: https://oms.polygon.technology servers: - url: https://sandbox-api.polygon.technology/v0.13 description: Sandbox - url: https://api.polygon.technology/v0.13 description: Production security: - BearerAuth: [] tags: - name: Auth description: Authentication via FrontEgg - name: Customers description: Customer management and KYC - name: Customer - name: Wallet - name: Quote - name: Transaction - name: CashIns - name: CashLocation - name: Sandbox - name: VirtualAccount - name: Counterparty - name: ExternalAccount - name: Reference - name: DepositAddress paths: /quotes/{quoteId}: get: tags: - Quote summary: Get quote by ID description: |- Retrieves a previously created quote by ID, including its locked rate, fee breakdown, and expiry. operationId: getQuote parameters: - name: quoteId in: path required: true description: Quote ID (`qt_` prefix). schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Quote' components: schemas: Quote: type: object required: - id - object - status - customerId - source - destination - pricing properties: id: allOf: - $ref: '#/components/schemas/typeId' description: Quote ID (`qt_` prefix). object: type: string enum: - quote description: Resource type discriminator. Always "quote". status: allOf: - $ref: '#/components/schemas/QuoteStatus' description: Current status of the quote. sourceToDestination: allOf: - $ref: '#/components/schemas/SourceToDestination' description: Corridor composite derived from the two sides. customerId: allOf: - $ref: '#/components/schemas/typeId' description: The OMS customer that owns this record (`cst_` prefix). source: allOf: - $ref: '#/components/schemas/TransactionSide' description: >- The funding side, echoed from the request with resolved instrument detail. destination: allOf: - $ref: '#/components/schemas/TransactionDestination' description: >- The receiving side, echoed from the request with resolved instrument detail. pricing: allOf: - $ref: '#/components/schemas/Pricing' description: Consolidated economics. expiresAt: type: string format: date-time description: When the locked pricing expires. createdAt: type: string format: date-time description: When the quote was created. metadata: type: object additionalProperties: type: string description: Free-form key-value pairs supplied at creation or update. description: >- A price quote for moving money between two instruments. It locks an exchange rate and the amounts for a short window; execute it by creating a transaction that references this quote's id. example: id: qt_0gq9aesz4wb5etdv88z1j61qcm object: quote status: open sourceToDestination: cryptoToFiatAccount customerId: cst_vfa0nxw6zvyws9g237jrxn4y7k source: party: relationship: customer id: cst_vfa0nxw6zvyws9g237jrxn4y7k name: Jane Smith type: walletCrypto category: crypto id: wlt_5h4jzzpr9xre3bamd9ca7qyghn asset: usdc network: polygon displayName: '0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1' destination: party: relationship: externalRegistered id: ctp_yp5z8m7n22svc0vh6edqgcfdat name: Alice Smith type: bankUs category: fiatAccount id: ext_fky491gakzj0dd46qb6whsr2vq asset: usd network: ach displayName: ••••1234 payoutOrigin: type: bank id: null pricing: source: asset: usdc amountGross: '100.00' amountNet: '100.00' feesDeducted: total: '0.00' developer: '0.00' oms: '0.00' gas: '0.00' destination: asset: usd amountGross: '100.00' amountNet: '100.00' feesDeducted: total: '0.00' developer: '0.00' oms: '0.00' gas: '0.00' pair: usdc/usd exchangeRate: '1.0000' effectiveRate: '1.0000' fixedAmountSide: source sponsorGas: true sponsorGasCost: '0.00' expiresAt: '2026-03-14T19:15:00Z' createdAt: '2026-03-14T19:00:00Z' typeId: 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`; legacy UUID suffixes are accepted until non-v7 rows are retired. x-go-type: string QuoteStatus: type: string enum: - open - accepted - expired description: >- Status of a quote. open: pricing locked, awaiting acceptance. accepted: a transaction has been created from it. expired: the pricing window elapsed. SourceToDestination: type: string enum: - cryptoToCrypto - cryptoToCash - cryptoToFiatAccount - cashToCrypto - fiatAccountToCrypto - fiatAccountToFiatAccount description: >- Composite of source and destination instrument categories, inferred from each side. The cash corridors (`cryptoToCash`, `cashToCrypto`) are derived from a cash-pickup destination / cash-in source respectively; the rest map straight from the internal corridor type. TransactionSide: type: object oneOf: - $ref: '#/components/schemas/WalletCryptoInstrument' - $ref: '#/components/schemas/WalletExternalInstrument' - $ref: '#/components/schemas/WalletFiatInstrument' - $ref: '#/components/schemas/BankUsInstrument' - $ref: '#/components/schemas/BankIbanInstrument' - $ref: '#/components/schemas/BankCanadaInstrument' - $ref: '#/components/schemas/CardInstrument' - $ref: '#/components/schemas/CashInstrument' discriminator: propertyName: type mapping: walletCrypto: $ref: '#/components/schemas/WalletCryptoInstrument' walletExternal: $ref: '#/components/schemas/WalletExternalInstrument' walletFiat: $ref: '#/components/schemas/WalletFiatInstrument' bankUs: $ref: '#/components/schemas/BankUsInstrument' bankIban: $ref: '#/components/schemas/BankIbanInstrument' bankCanada: $ref: '#/components/schemas/BankCanadaInstrument' card: $ref: '#/components/schemas/CardInstrument' cash: $ref: '#/components/schemas/CashInstrument' description: >- The source side of a transaction/quote (v0.10): a typed instrument carrying identity (`party`) and instrument detail. Amounts live only in `pricing`. TransactionDestination: type: object oneOf: - $ref: '#/components/schemas/WalletCryptoDestination' - $ref: '#/components/schemas/WalletExternalDestination' - $ref: '#/components/schemas/WalletFiatDestination' - $ref: '#/components/schemas/BankUsDestination' - $ref: '#/components/schemas/BankIbanDestination' - $ref: '#/components/schemas/BankCanadaDestination' - $ref: '#/components/schemas/CardDestination' - $ref: '#/components/schemas/CashDestination' discriminator: propertyName: type mapping: walletCrypto: $ref: '#/components/schemas/WalletCryptoDestination' walletExternal: $ref: '#/components/schemas/WalletExternalDestination' walletFiat: $ref: '#/components/schemas/WalletFiatDestination' bankUs: $ref: '#/components/schemas/BankUsDestination' bankIban: $ref: '#/components/schemas/BankIbanDestination' bankCanada: $ref: '#/components/schemas/BankCanadaDestination' card: $ref: '#/components/schemas/CardDestination' cash: $ref: '#/components/schemas/CashDestination' description: >- The destination side of a transaction/quote (v0.10): a typed instrument plus `payoutOrigin`. Amounts live only in `pricing`. Pricing: type: object properties: source: allOf: - $ref: '#/components/schemas/PricingSide' description: Economics for the source side, denominated in the source asset. destination: allOf: - $ref: '#/components/schemas/PricingSide' description: >- Economics for the destination side, denominated in the destination asset. pair: type: string description: Asset pair, e.g. "usdc/usd". exchangeRate: type: string description: >- Mid-market rate between source and destination assets. Identity: source.amountNet × exchangeRate = destination.amountGross. effectiveRate: type: string description: >- All-in rate including all fees. Identity: source.amountGross × effectiveRate = destination.amountNet. fixedAmountSide: type: string enum: - source - destination description: >- The side you set `amount` on when creating the quote. OMS calculated the other side. sponsorGas: type: boolean description: >- When true, OMS absorbs the destination gas cost. Currently always true. sponsorGasCost: type: string description: >- Gas absorbed by the developer when sponsorGas is true. Currently always `0.00`. description: |- Consolidated economics for a quote/transaction: per-side amounts + fees, the rate pair, and gas sponsorship, all in one place. WalletCryptoInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletCrypto description: Type discriminator. category: type: string enum: - crypto description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- OMS wallet ID (`wlt_` prefix). DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, WalletCryptoInstrument): the ratified shape has `id` required and non-nullable. A row can classify as this arm (destination_type=walletCrypto/legacy walletOms, per #2528) before the wallet FK has actually resolved — the "in-flight deposit" window destInstrumentKind's own doc comment describes — so `id` is nullable rather than emitting an empty string that fails the `typeId` scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead, same class as the CardInstrument.id/WalletFiatInstrument.id/ BankUsInstrument.network deviations elsewhere in this same change. asset: type: string description: Canonical asset identifier. network: type: string description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. description: >- OMS-custodied crypto wallet instrument — a uniform reference. Dereference `GET /wallets/{id}` for the wallet record (on-chain address, custody type, balances). title: OMS wallet WalletExternalInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletExternal description: Type discriminator. category: type: string enum: - crypto description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string description: Canonical asset identifier. network: type: string description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: blockchainAddress: type: string description: On-chain sender address. required: - blockchainAddress nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. description: >- Externally-custodied crypto wallet instrument — a uniform reference. When registered, dereference the external account by `id`; when the sender is unregistered, `id` is null and `details.blockchainAddress` carries the minimal identifying fact. title: External wallet WalletFiatInstrument: type: object required: - type - category - id - asset - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletFiat description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string nullable: true description: >- OMS fiat wallet ID (`wlt_fiat_` prefix). Look up via `GET /wallets`. Plain string, not the `typeId` scalar: `wlt_fiat_` is a two-token prefix, which the single-underscore `typeId` pattern cannot validate. Null on a #2504 book-transfer destination leg's pre-outbound window: the wallet FK isn't committed until the outbound leg stamps its routing snapshot (a repoint can still change which wallet is credited until then), so there is genuinely no id to dereference yet — a deliberate BPN deviation from the ratified OMS v0.12 contract, which types this field required and non-nullable. asset: type: string enum: - usd description: Fiat currency of the balance. Only `usd` today. network: type: string enum: - bookTransfer description: |- `bookTransfer` when this walletFiat is the destination of a Virtual Account / Deposit Address book-transfer credit — an internal ledger movement at the partner bank, no external rail. Absent when the walletFiat is a funding source. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. description: >- Fiat balance wallet instrument — a USD balance held at a partner bank (e.g. Erebor Bank, N.A.). No on-chain address; an internal ledger balance — always OMS-owned, no unregistered case. Dereference `GET /wallets/{id}` for the wallet record. title: Fiat wallet BankUsInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankUs description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- External Account ID (`ext_` prefix). Null when externalUnregistered (e.g. an incoming wire from an unregistered sender). asset: type: string enum: - usd description: Canonical asset identifier. network: type: string enum: - ach - achSameDay - wire nullable: true description: >- Network identifier. DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, BankUsInstrument): the ratified shape has `network` required and non-nullable (no `null` option, unlike `id` on this same schema). Real legacy/#2528-era contamination means a bankUs row can carry a stored rail (`swift`, `international_wire`, `rtp`) that is not one of this enum's three members — rendering that as the Go zero value (`""`) reverses what #2528/#2666 were built to fix: a real generated client (this repo's own npm/zod package included) fails `z.enum([...]).parse()` on an empty string just as hard as on the raw invalid token, rejecting the whole response instead of one field. Making the field nullable lets a degraded row render `network: null` — schema-valid for a nullable field, same posture as the dropped/absent field a pre-#2660 client would have seen. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead. secCode: allOf: - $ref: '#/components/schemas/SecCode' description: >- ACH SEC code (populated only on ach/achSameDay). Server-derived from the destination owner's and the source customer's entityType, read directly from the DB/Customer record — not from this wire-facing instrument. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four digits of the account number. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. description: |- US bank account instrument — a uniform reference. Dereference the external account by `id` for routing number, account type, and full account number. title: US bank account BankIbanInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankIban description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string description: Canonical asset identifier. network: type: string enum: - swift description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four characters of the IBAN. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. `accountNumberLast4` carries the last 4 of the IBAN — no separate `ibanLast4` key on this slim shape. description: |- IBAN bank account instrument — a uniform reference. Dereference the external account by `id` for the BIC and bank address. title: IBAN bank account BankCanadaInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankCanada description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string enum: - usd - cad description: Canonical asset identifier. network: type: string enum: - swift - local description: USD uses `swift`; CAD uses `local`. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four digits of the account number. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. description: >- Canadian bank account instrument — a uniform reference. USD routes over SWIFT, CAD over local rails. Dereference the external account by `id` for institution/transit coordinates. title: Canadian bank account CardInstrument: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - card description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- Card External Account ID (`ext_` prefix). Null for a pre-#1917-migration card-sell row, whose external account id column was added nullable without a backfill. DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, CardInstrument): the ratified shape has `id` required and non-nullable, documented as "Always registered". BPN's own historical data contradicts that — the pre-#1917 legacy rows genuinely have no id — so this field is deliberately nullable rather than emitting an empty string that fails the `typeId` scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead. Follow-up: either backfill the pre-#1917 quote rows so `id` is always resolvable, or get this nullability formally signed off with OMS product as a permanent BPN deviation. asset: type: string enum: - usd description: Canonical asset identifier. network: type: string enum: - card description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. description: >- Card instrument — a uniform reference. Usually registered: dereference the external account by `id` for the card brand, last 4, and expiry. title: Card CashInstrument: type: object required: - type - category - asset - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - cash description: Type discriminator. category: type: string enum: - cash description: 'High-level grouping: always `cash` for cash pickups and drops.' asset: type: string description: Canonical asset identifier. cashLocationId: type: string description: Cash location ID from `GET /cash-locations`. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. description: |- Cash pickup/drop instrument — a uniform reference. Dereference the cash location by `cashLocationId` for its address. title: Cash WalletCryptoDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletCrypto description: Type discriminator. category: type: string enum: - crypto description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- OMS wallet ID (`wlt_` prefix). DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, WalletCryptoInstrument): the ratified shape has `id` required and non-nullable. A row can classify as this arm (destination_type=walletCrypto/legacy walletOms, per #2528) before the wallet FK has actually resolved — the "in-flight deposit" window destInstrumentKind's own doc comment describes — so `id` is nullable rather than emitting an empty string that fails the `typeId` scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead, same class as the CardInstrument.id/WalletFiatInstrument.id/ BankUsInstrument.network deviations elsewhere in this same change. asset: type: string description: Canonical asset identifier. network: type: string description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: OMS wallet WalletExternalDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletExternal description: Type discriminator. category: type: string enum: - crypto description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string description: Canonical asset identifier. network: type: string description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: blockchainAddress: type: string description: On-chain sender address. required: - blockchainAddress nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: External wallet WalletFiatDestination: type: object required: - type - category - id - asset - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - walletFiat description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string nullable: true description: >- OMS fiat wallet ID (`wlt_fiat_` prefix). Look up via `GET /wallets`. Plain string, not the `typeId` scalar: `wlt_fiat_` is a two-token prefix, which the single-underscore `typeId` pattern cannot validate. Null on a #2504 book-transfer destination leg's pre-outbound window: the wallet FK isn't committed until the outbound leg stamps its routing snapshot (a repoint can still change which wallet is credited until then), so there is genuinely no id to dereference yet — a deliberate BPN deviation from the ratified OMS v0.12 contract, which types this field required and non-nullable. asset: type: string enum: - usd description: Fiat currency of the balance. Only `usd` today. network: type: string enum: - bookTransfer description: |- `bookTransfer` when this walletFiat is the destination of a Virtual Account / Deposit Address book-transfer credit — an internal ledger movement at the partner bank, no external rail. Absent when the walletFiat is a funding source. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. description: >- Fiat balance wallet destination — the wallet-as-destination projection used to render an inbound fiat-wallet deposit (design §4.2/§16, #2363). RENDERING OUTPUT ONLY: this arm exists so a settled deposit into a customer's USD fiat wallet renders `destination.walletFiat`. It does NOT re-open walletFiat as a user-SPECIFIABLE input destination — that input deferral (crediting VA/DA deposits into a wallet, design §16) still holds; only the output shape is restored here. Over-cut from Task 1 (#2340); returned for Task 10. title: Fiat wallet BankUsDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankUs description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- External Account ID (`ext_` prefix). Null when externalUnregistered (e.g. an incoming wire from an unregistered sender). asset: type: string enum: - usd description: Canonical asset identifier. network: type: string enum: - ach - achSameDay - wire nullable: true description: >- Network identifier. DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, BankUsInstrument): the ratified shape has `network` required and non-nullable (no `null` option, unlike `id` on this same schema). Real legacy/#2528-era contamination means a bankUs row can carry a stored rail (`swift`, `international_wire`, `rtp`) that is not one of this enum's three members — rendering that as the Go zero value (`""`) reverses what #2528/#2666 were built to fix: a real generated client (this repo's own npm/zod package included) fails `z.enum([...]).parse()` on an empty string just as hard as on the raw invalid token, rejecting the whole response instead of one field. Making the field nullable lets a degraded row render `network: null` — schema-valid for a nullable field, same posture as the dropped/absent field a pre-#2660 client would have seen. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead. secCode: allOf: - $ref: '#/components/schemas/SecCode' description: >- ACH SEC code (populated only on ach/achSameDay). Server-derived from the destination owner's and the source customer's entityType, read directly from the DB/Customer record — not from this wire-facing instrument. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four digits of the account number. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: US bank account BankIbanDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankIban description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string description: Canonical asset identifier. network: type: string enum: - swift description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four characters of the IBAN. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. `accountNumberLast4` carries the last 4 of the IBAN — no separate `ibanLast4` key on this slim shape. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: IBAN bank account BankCanadaDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - bankCanada description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: External Account ID (`ext_` prefix). Null when externalUnregistered. asset: type: string enum: - usd - cad description: Canonical asset identifier. network: type: string enum: - swift - local description: USD uses `swift`; CAD uses `local`. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. details: type: object properties: accountNumberLast4: type: string description: Last four digits of the account number. bankName: type: string nullable: true description: Bank display name. required: - accountNumberLast4 - bankName nullable: true description: >- Populated only when `id` is null (unregistered external sender); null for registered instruments. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: Canadian bank account CardDestination: type: object required: - type - category - id - asset - network - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - card description: Type discriminator. category: type: string enum: - fiatAccount description: >- High-level grouping: `fiatAccount` for bank or card accounts, `crypto` for wallets. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- Card External Account ID (`ext_` prefix). Null for a pre-#1917-migration card-sell row, whose external account id column was added nullable without a backfill. DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, CardInstrument): the ratified shape has `id` required and non-nullable, documented as "Always registered". BPN's own historical data contradicts that — the pre-#1917 legacy rows genuinely have no id — so this field is deliberately nullable rather than emitting an empty string that fails the `typeId` scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead. Follow-up: either backfill the pre-#1917 quote rows so `id` is always resolvable, or get this nullability formally signed off with OMS product as a permanent BPN deviation. asset: type: string enum: - usd description: Canonical asset identifier. network: type: string enum: - card description: Network identifier. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: Card CashDestination: type: object required: - type - category - asset - displayName properties: party: allOf: - $ref: '#/components/schemas/Party' description: Structured identity of who is on this side. memo: type: string description: Free-text message travelling with the transfer on this side's rail. type: type: string enum: - cash description: Type discriminator. category: type: string enum: - cash description: 'High-level grouping: always `cash` for cash pickups and drops.' asset: type: string description: Canonical asset identifier. cashLocationId: type: string description: Cash location ID from `GET /cash-locations`. displayName: type: string description: >- Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN. payoutOrigin: $ref: '#/components/schemas/PayoutOrigin' pickupCode: type: string description: >- Retail pickup code for a cash payout. Populated only on cash-out (pickup) destinations. companyDiscretionaryData: type: string description: >- Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied. title: Cash PricingSide: type: object properties: asset: type: string description: >- Currency these amounts are in. Same as the side's instrument asset, repeated here so pricing is self-contained. amountGross: type: string description: Amount on this side before fees are applied. amountNet: type: string description: >- Amount after fees: what is actually pulled from a source, or delivered to a destination. feesDeducted: allOf: - $ref: '#/components/schemas/FeesDeducted' description: Itemized fees deducted on this side. description: |- Per-side economics for the `pricing` object: the side carries identity, the amounts and fees live here. Party: type: object required: - relationship - id - name properties: relationship: type: string enum: - customer - otherCustomer - externalRegistered - externalUnregistered description: Which kind of party this is. id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: >- `cst_` for customer/otherCustomer; `ctp_` for externalRegistered; null for externalUnregistered. name: type: string nullable: true description: >- Display name. Null only when genuinely unknown (an unattributed external sender). description: >- Response-only identity of who is on one side of a transaction — a uniform `{relationship, id, name}` reference. `id` is the Customer (`cst_`) for `customer`/`otherCustomer`, the Counterparty (`ctp_`) for `externalRegistered`, and null for `externalUnregistered`. Entity type and address live on the dereferenced Customer/Counterparty resource, not here. `name` is populated for every relationship except a genuinely-unknown external sender. SecCode: type: string enum: - ccd - ppd - web description: >- ACH SEC code. Populated only when the destination bank network is `ach`/`achSameDay`; null otherwise. Server-derived from the destination owner's and the source customer's `entityType`. PayoutOrigin: type: object required: - type - id properties: type: type: string enum: - bank - blockchain id: type: string allOf: - $ref: '#/components/schemas/typeId' nullable: true description: |- Where last-mile delivery is sent *from*, as a uniform `{type, id}` reference — response-only. `id` is the Virtual Account (`va_`) or OMS wallet (`wlt_`) funding the leg; null before execution (Quote / Deposit Address echo the choice only) or when the origin has no partner-visible resource. Rail identifiers for the last-mile transfer live in the top-level `tracking` array with `leg: destination` — not here. FeesDeducted: type: object required: - total - developer - oms - gas properties: total: type: string developer: type: string description: |- Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line. oms: type: string gas: type: string description: |- Per-side breakdown of fees deducted in-line from the transaction. End-of-month billable fees will be reported separately in the future (planned `feesInvoice` sibling). Denominated in that side's asset. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: Token from POST /auth/token ````