{"openapi":"3.1.0","info":{"description":"The bank's API on one host: customers and accounts, transfers on every rail, cards, lending, compliance, events and webhooks, reporting, operations, the ledger and identity. Writes use idempotency keys or persistent event references; lists page by cursor; errors are RFC 9457 problem details with stable codes.","title":"Corgi Bank API","version":"2026-09-05"},"servers":[{"url":"https://api.dev.bank.corgi.com","description":"this environment"},{"description":"production","url":"https://api.bank.corgi.com"}],"security":[{"bearer":[]}],"tags":[{"description":"An evidenced complaint investigation, independently reviewed response and retained delivery evidence.","name":"Complaint","x-object":"#/components/schemas/Complaint"},{"description":"An immutable bank-supplied deadline policy with independent approval.","name":"Complaint Policy","x-object":"#/components/schemas/ComplaintPolicy"},{"description":"The verified customer’s complaint intake, public status and exact published responses.","name":"Customer Complaint","x-object":"#/components/schemas/PublicComplaint"},{"description":"Independently reviewed person-bound spending authority or historical card binding.","name":"Cardholder Authority","x-object":"#/components/schemas/CardholderAuthority"},{"description":"A consumer deposit EFT error notice, captured policy deadlines, authenticated evidence and independently approved ledger corrections.","name":"Dispute","x-object":"#/components/schemas/Dispute"},{"description":"A person or a business the bank knows: identity, KYC status and risk rating. A customer must be KYC-verified before an account opens in their name.","name":"Customer","x-object":"#/components/schemas/Customer"},{"description":"A deposit account: one balance in the ledger, on one product version, owned by one or more customers and reachable through one or more account numbers.","name":"Account","x-object":"#/components/schemas/View"},{"description":"A multi-entity group: a parent business and the subsidiaries or affiliates under it, so the bank shows them together and money moves between them as inter-entity transfers under the group's policy (any member, or the parent only).","name":"Customer Group","x-object":"#/components/schemas/Group"},{"description":"A multi-entity group's position: every member entity's open accounts with balances, subtotals per entity and the group total.","name":"Account Group","x-object":"#/components/schemas/GroupBalances"},{"description":"Files business customers load into their treasury systems: the BAI format (version 2) balance and transaction report per business date, for one account or every account of a customer.","name":"Account Report"},{"description":"A garnishment, levy or child-support order served on the bank: the funds it reaches are frozen under a legal hold after the two-month federal-benefits lookback (31 CFR Part 212), then booked to an issuer payable for separately verified remittance, or released.","name":"Garnishment","x-object":"#/components/schemas/Garnishment"},{"description":"An abandoned balance closed into a state-specific unclaimed-property payable after the state's abandonment period and due-diligence notice; actual outward remittance is tracked separately.","name":"Escheatment","x-object":"#/components/schemas/Escheatment"},{"description":"The year's information returns: Form 1099-INT for interest of $10 or more or any backup withholding, Form 1042-S for foreign persons on a W-8.","name":"Tax Form","x-object":"#/components/schemas/TaxForm"},{"description":"A priced offer to convert one currency into another between a customer's own deposit accounts: the rate the bank struck on its current approved customer sheet, both amounts and when the rate lapses. A quote is held until it is booked, which makes the rate firm until it expires, cancelled, or expired by the clock. The bank's current customer rates and spreads per pair are read at /fx-rate-sheet.","name":"FX Quote","x-object":"#/components/schemas/FXQuoteResource"},{"description":"A routing and account number pair that lands payments on an account. Every account has a default number and can add more, one per payer or purpose, all on the same balance.","name":"Account Number","x-object":"#/components/schemas/AccountNumber"},{"description":"A deposit product as code: type, rates, fees, limits and statement cycle, versioned and reviewed like any change.","name":"Product","x-object":"#/components/schemas/Product"},{"description":"Every transfer on every rail in one list, newest first: the shape they share (type, direction, amount, status) with the rail's own object one level down.","name":"Transfer","x-object":"#/components/schemas/TransferSummary"},{"description":"An ACH credit or debit the bank originates: screened before it leaves, batched into a NACHA file at the window, settled or returned by the network.","name":"ACH Transfer","x-object":"#/components/schemas/Transfer"},{"description":"An international ACH credit or debit the bank originates (an IAT entry): the foreign receiver and its bank, any correspondent banks, the destination country and the currencies at the top level, with the seven addenda the Nacha Operating Rules require derived from them. Every party is screened before the entry leaves, the originator's international class and exposure limits apply, Same Day settlement is refused, and an entry can be withdrawn until it joins a file.","name":"International Transfer","x-object":"#/components/schemas/IATTransfer"},{"description":"The ODFI's record of a customer that originates ACH entries: the company identification its batches carry, the classes it may use (PPD, CCD, IAT), whether it must prenote, and the exposure limits the Nacha Operating Rules have the ODFI set, enforce and periodically review (per-day credit and debit limits and a rolling exposure limit); a record is created with the bank's default limits on the first origination. Its exposure and its debit return rates against the Nacha thresholds are read alongside it.","name":"ACH Originator","x-object":"#/components/schemas/Originator"},{"description":"A notification of change (COR): one an RDFI sent about an entry the bank originated, applied to the next entries to the same account and refusable within fifteen days (C61 to C69), or one the bank sent as the RDFI about an entry it received under the wrong transaction code (C05).","name":"ACH Change","x-object":"#/components/schemas/Change"},{"description":"The outcome of one entry the bank received as the RDFI: posted, returned, accepted without posting (a prenotification), held on the transit account for review (an international entry with a screening match or the Gateway Operator's OFAC indicator) or blocked there.","name":"ACH Receipt","x-object":"#/components/schemas/Receipt"},{"description":"An instant move between two accounts at the bank, posted as one journal.","name":"Book Transfer","x-object":"#/components/schemas/BookTransfer"},{"description":"A Fedwire in or out: screened, sent through the gateway, settled with an IMAD and OMAD.","name":"Wire Transfer","x-object":"#/components/schemas/Wire"},{"description":"A FedNow or RTP credit transfer, ISO 20022 pacs.008 out and pacs.002 back, final within seconds. A payment the bank sends can be accepted without posting and later posted or blocked by the receiver, asked about with pacs.028 when the answer never came, and asked back with a return request; a payment the bank receives is posted, or held on the transit account (accepted without posting) and then posted, blocked or returned (pacs.004 on FedNow, a returning credit transfer on RTP). Liquidity management transfers (pacs.009) move the bank's position, including into the RTP joint account.","name":"Realtime Transfer","x-object":"#/components/schemas/InstantPayment"},{"description":"A cross-border payment in or out, carried as an ISO 20022 CBPR+ message (pacs.008) over the international messaging network: the creditor with an IBAN or account number, the creditor agent's BIC and address, an optional intermediary agent, the charge bearer that decides which side pays which fee, a purpose code and remittance information, and the end-to-end reference (UETR) the payment keeps through the chain. The bank sends only to the destination countries and currencies it serves. Screened both ways, queued to the currency's window, tracked to the credit, and repairable, cancellable (camt.056) or returnable (pacs.004). Until the bank is a member of the network, the network is a simulator and no acknowledgement it returns is a real one.","name":"International Wire","x-object":"#/components/schemas/SwiftPayment"},{"description":"A request to return a settled wire: one the bank sends about a wire it sent (camt.056, answered by camt.029 and, when honoured, a pacs.004 that credits the account back), or one another participant sends about a wire the bank received, which operations honour with a return or refuse.","name":"Wire Return Request","x-object":"#/components/schemas/WireReturnRequest"},{"description":"A request for payment on FedNow or RTP (pain.013): one the bank's customer sends to a payer at another institution, answered by pain.014 (received, presented, accepted or rejected) and settled by the payer's credit transfer carrying the request's identification; or one another institution's customer sends to the bank's customer, who pays or declines. An open request can be cancelled (camt.055) and expires at its expiry time.","name":"Payment Request","x-object":"#/components/schemas/PaymentRequest"},{"description":"A request to return an instant payment: one the bank sends about a payment it sent (camt.056, answered by camt.029 and, when honoured, the return that credits the account back), or one another participant sends about a payment the bank received, which operations honour with a return or refuse.","name":"Realtime Return Request","x-object":"#/components/schemas/InstantReturnRequest"},{"description":"A check the bank handles: a deposit (MICR line, amount and images, on the account at once under its Reg CC hold and collected through an image cash letter under Check 21, charged back if the payor returns it), an official check the bank issued (a cashier's check outstanding until presented, voided or stopped), or a check drawn on the bank that the operator presented (paid, returned with a reason, or held as a positive pay exception until the customer pays or returns it or the deadline applies the account's default). Listed by kind: deposit, issue, inclearing.","name":"Check Transfer","x-object":"#/components/schemas/CheckDeposit"},{"description":"A check a customer captured remotely: front and back images, the MICR line and amounts the bank read, held for maker-checker risk review or credited as a mobile check under Reg CC and collected through the next image cash letter.","name":"Remote Deposit","x-object":"#/components/schemas/RemoteDeposit"},{"description":"The bank's per-customer, per-product cap on remotely captured items: one item, the day's total, the day's count, and the amount at which an item waits for review. Tightening is the operations desk's to do; raising any bound waits for a second operator.","name":"Remote Deposit Limit","x-object":"#/components/schemas/RemoteDepositLimit"},{"description":"An order not to pay a check or a range of checks on an account: a written order lasts six months, an oral one fourteen days unless confirmed in writing (UCC 4-403); a presentment it covers is returned with reason C and the order counts its matches.","name":"Stop Payment","x-object":"#/components/schemas/StopPayment"},{"description":"Positive pay on an account: its terms (payee matching, the default decision and the deadline), the checks the customer issued, and the presented checks that did not match an issue, held for a pay or return decision.","name":"Positive Pay","x-object":"#/components/schemas/PositivePayAccount"},{"description":"A remittance address the bank opens for a customer: each day's mail is deposited to the account, one check deposit per item, and reported in the bank's BAI lockbox layout with the invoices each check pays.","name":"Lockbox","x-object":"#/components/schemas/Lockbox"},{"description":"One day's lockbox mail: its batches, checks and invoices, and the remittance file for the customer's receivables.","name":"Lockbox Remittance","x-object":"#/components/schemas/LockboxRemittance"},{"description":"A counterparty a customer saved to pay again: a bank account paid by ACH credit, instant payment or wire, an account at this bank paid by book transfer, an address a check is mailed to, or a bank abroad named by BIC and paid by international wire.","name":"Counterparty","x-object":"#/components/schemas/SavedCounterparty"},{"description":"A bill payment or transfer that runs today, on a date or on a recurrence (weekly, biweekly, semimonthly, monthly, quarterly, annually) over the counterparty's rail; dates that are not banking days move to the previous or next one; a failed run is retried the next banking day and three failures in a row pause the schedule; under the account's approval policy a schedule waits as pending_approval.","name":"Scheduled Transfer","x-object":"#/components/schemas/ScheduledTransfer"},{"description":"Bank-controlled gross initiation limits per payment, account and user; retries count once.","name":"Payment Limit","x-object":"#/components/schemas/PaymentLimit"},{"description":"The approval policy an account puts in front of its payments (a threshold, one to three approvers, whether the requester may approve, how long a request waits) and the requests it opens; a policy also refuses payments sent to the rails directly.","name":"Payment Approval","x-object":"#/components/schemas/PaymentApproval"},{"description":"The operator side of the rails: outbound NACHA files and their settlement, inbound files, wires and the Fedwire ISO 20022 messages (pacs.008, pacs.009, pacs.004, camt.056, camt.029 in; pacs.002, admi.007, admi.002 back), and the FedNow and RTP messages (pacs.008, pacs.002, pacs.004, pacs.009 liquidity management transfers, pacs.028, pain.013 and pain.014 requests for payment, camt.055, camt.056, camt.029, camt.054 notifications, admi.007 and admi.002) under the FedNow envelope, bare on RTP until The Clearing House's specifications are loaded. Called by the connectivity zone, never by a customer.","name":"Rail"},{"description":"A debit card on the bank's BIN linked to an account: lifecycle, controls, and the PAN behind a token.","name":"Card","x-object":"#/components/schemas/Card"},{"description":"The bank's decision on one purchase, with the network response code, the hold it placed and the clearing that posted it.","name":"Authorization","x-object":"#/components/schemas/Authorization"},{"description":"A loan from application through underwriting, disbursement, accrual, payments and payoff; a mortgage carries its escrow, an SBA loan its guarantee, and a share of a loan can be sold to or bought from another bank.","name":"Loan","x-object":"#/components/schemas/Loan"},{"description":"Staff-reviewed mortgage intake, calculated disclosures, delivery evidence and binding to the approved loan.","name":"Mortgage Origination","x-object":"#/components/schemas/Origin"},{"description":"A credit facility: a revolving line (a credit card line, a HELOC, an overdraft line, a borrowing-base revolver), a construction loan that converts to its permanent mortgage, a standby letter of credit, factoring, a floor plan, a warehouse line or a merchant cash advance. Underwritten, activated, drawn, billed and paid, and swept for delinquency, nonaccrual and charge-off like a loan; the undrawn commitment is off balance sheet (Schedule RC-L).","name":"Facility","x-object":"#/components/schemas/LendingFacility"},{"description":"A loan product as code: term, rate, fees, underwriting limits.","name":"Loan Product","x-object":"#/components/schemas/Product"},{"description":"A name screened against the sanctions lists: clear, review or hit, with the matches.","name":"Screening","x-object":"#/components/schemas/Screening"},{"description":"A customer verification run through the KYC provider and recorded on the customer.","name":"KYC Check","x-object":"#/components/schemas/KYCCheck"},{"description":"A money movement reported to transaction monitoring; the rules that fire raise alerts.","name":"Monitoring Event","x-object":"#/components/schemas/MonitoringEvent"},{"description":"A rule that fired on a movement, open until an analyst disposes of it.","name":"Alert","x-object":"#/components/schemas/Alert"},{"description":"The lists loaded for screening.","name":"Sanctions List","x-object":"#/components/schemas/SanctionsList"},{"description":"Sandbox endpoints that play the operators and the issuer-processor, so inbound flows can be exercised against the same code that handles the real rails. Absent in production.","name":"Simulation"},{"description":"A fact the bank published: type, source and data, delivered to subscribed webhook endpoints.","name":"Event","x-object":"#/components/schemas/Event"},{"description":"A partner URL subscribed to event types. Deliveries carry a Corgi-Signature header, HMAC-SHA256 over the timestamp and body under the endpoint's secret, shown once at creation.","name":"Webhook Endpoint","x-object":"#/components/schemas/WebhookEndpoint"},{"description":"One event on its way to one endpoint: attempts, the last response, and when it is next tried (a minute, doubling, up to 25 attempts over about three days).","name":"Webhook Delivery","x-object":"#/components/schemas/WebhookDelivery"},{"description":"A message rendered from a template for one customer on one channel, with its delivery status.","name":"Notification","x-object":"#/components/schemas/Notification"},{"description":"Audited delivery blocks and consent-backed releases for an address.","name":"Notification Suppression","x-object":"#/components/schemas/Suppression"},{"description":"A customer's setting for one channel.","name":"Notification Preference","x-object":"#/components/schemas/Preference"},{"description":"A report the bank produces on request: today the settlement report, scheduled over a window of business dates for a customer's own accounts or bank-wide, built once by the scheduler and served as stored documents. The resource is shaped so further report types are added beside it.","name":"Report","x-object":"#/components/schemas/SettlementReport"},{"description":"The bank's assets, liabilities and equity as of a business date, every figure reconciling to the ledger.","name":"Balance Sheet"},{"description":"Interest and non-interest income and expense over a period, every figure reconciling to the ledger.","name":"Income Statement"},{"description":"Transfer and posting volumes over a period, by rail and by product.","name":"Activity Report"},{"description":"The deposit book by product, category and insurance status.","name":"Deposit Report"},{"description":"One business date's balances, flows and exceptions against the prior date, read the morning after close.","name":"Daily Flash"},{"description":"The weekly deposit report the Federal Reserve collects, with the week ending date it covers.","name":"FR 2900 Report"},{"description":"The bank's position at the Federal Reserve against its net debit cap.","name":"Fed Position"},{"description":"One Call Report schedule (RC, RC-C, RC-E, RC-L, RC-N, RI) and the mapping from the chart of accounts that produces it.","name":"Call Report Schedule"},{"description":"One reading of the bank's position at the Federal Reserve: the master account on the ledger less the outbound payments accepted and not yet settled, against the net debit cap. The day's lowest reading is the peak daylight overdraft.","name":"Fed Position Sample","x-object":"#/components/schemas/FedSample"},{"description":"Pulls of the ledger into the read models and event ingestion over HTTP.","name":"Reporting Run"},{"description":"External reconciliation: a statement from the Fed master account, the RTP network or a card network matched against what the bank's services settled, by the rail's reference, then amount and direction. Every run is kept.","name":"Reconciliation","x-object":"#/components/schemas/ReconciliationRun"},{"description":"An item on one side only, or on both with different amounts, or a closing balance that differs from the ledger. Open until explained or resolved; ages by the day; clears itself when a later run matches it.","name":"Reconciliation Break","x-object":"#/components/schemas/ReconciliationBreak"},{"description":"A maker-checker request: a privileged action proposed by one person and approved or rejected by another before it is applied.","name":"Request","x-object":"#/components/schemas/Request"},{"description":"The kinds of request the console supports.","name":"Request Kind","x-object":"#/components/schemas/RequestKind"},{"description":"A piece of work for the back office: a dispute, an alert, a customer request, with notes and an outcome.","name":"Case","x-object":"#/components/schemas/Case"},{"description":"An append-only record of a privileged action.","name":"Audit Event","x-object":"#/components/schemas/AuditEvent"},{"description":"One balance in the double-entry ledger, addressed by legal entity, namespace, name, currency and owner, on one GL code.","name":"Ledger Account","x-object":"#/components/schemas/LedgerAccount"},{"description":"A balanced set of debit and credit entries, append-only, with an idempotency key and an effective business date.","name":"Journal","x-object":"#/components/schemas/LedgerJournal"},{"description":"An amount set aside on a ledger account (card authorization, Reg CC availability, pending debit, legal) so available is posted less holds.","name":"Hold","x-object":"#/components/schemas/LedgerHold"},{"description":"An accounting month, sealed by month-end close once every banking day in it is closed.","name":"Period","x-object":"#/components/schemas/LedgerPeriodReport"},{"description":"Money the bank itself borrowed: a Federal Home Loan Bank advance (GL 2410) or a discount window advance (GL 2420), cash in against a liability at the advance's rate, repaid in part or in full.","name":"Borrowing","x-object":"#/components/schemas/LedgerBorrowing"},{"description":"Securities purchased under agreements to resell: a bilateral reverse repo, a tri-party reverse repo or a buy-sell-back (GL 1150), cash out against a resale asset earning fixed interest, haircut collateral covering the repurchase amount.","name":"Reverse Repo","x-object":"#/components/schemas/LedgerReverseRepo"},{"description":"Business dates, end of day, the trial balance, the chart of accounts and GL exports.","name":"Ledger"},{"description":"A service token issued by client credentials.","name":"Token","x-object":"#/components/schemas/TokenResponse"},{"description":"OIDC authorization-code sign-in with PKCE, encrypted state and a separate browser binding.","name":"Staff Authorization","x-object":"#/components/schemas/StaffAuthorization"},{"description":"Provisioned staff identity with recent upstream MFA, short-lived access and rotating refresh tokens.","name":"Staff Session","x-object":"#/components/schemas/StaffTokens"},{"description":"SCIM User provisioning with immutable OIDC subjects, version checks and session revocation on deactivation or role changes.","name":"Staff Provisioning","x-object":"#/components/schemas/StaffUser"},{"description":"The public keys that verify tokens.","name":"Key Set"},{"description":"A customer login.","name":"User","x-object":"#/components/schemas/User"},{"description":"A customer session: password or passkey login with device signals, refresh-token rotation, revocation.","name":"Session","x-object":"#/components/schemas/Tokens"},{"description":"A device a customer signed in from, recognised by a server-side fingerprint and trusted explicitly.","name":"Device","x-object":"#/components/schemas/Device"},{"description":"A WebAuthn credential registered to a customer.","name":"Passkey","x-object":"#/components/schemas/Passkey"},{"description":"Proof of presence by PIN or passkey; the token it returns unlocks sensitive routes for a few minutes.","name":"Step-up"},{"description":"Liveness.","name":"Health"},{"description":"Complete signed independent account statement, retained source revision and encrypted actual document.","name":"Independent Bank Statement","x-object":"#/components/schemas/RetainedStatement"},{"description":"Independently reviewed actual journal allocation against one complete external statement line.","name":"Bank Cash Match","x-object":"#/components/schemas/BankcashMatch"},{"description":"Immutable current bank-owned source inventory, actual managed balances and journal fingerprints, requested close coverage and explicit reconciliation blockers.","name":"Bank Securities Snapshot","x-object":"#/components/schemas/Snapshot"},{"description":"Signed actual full Treasury repayment, original custody provenance and recoverable native accounting.","name":"Bank Treasury Redemption","x-object":"#/components/schemas/RedemptionRecord"},{"description":"Independently reviewed bank-owned USD AFS Treasury authority, accounting policy and actual master cash identity.","name":"Bank Securities Program","x-object":"#/components/schemas/Control"},{"description":"Exact zero-coupon Treasury bill terms, fixed unit/price precision and issue/maturity dates.","name":"Bank Securities Instrument","x-object":"#/components/schemas/Control"},{"description":"Signed bank beneficial ownership of a dedicated originally empty external custody account.","name":"Bank Custody Account","x-object":"#/components/schemas/Control"},{"description":"Immutable source authority with independent exact-content review.","name":"Bank Securities Control","x-object":"#/components/schemas/Control"},{"description":"Full bank-owned Treasury trade with separate trade-date accounting and actual signed cash/DVP evidence.","name":"Bank Securities Order","x-object":"#/components/schemas/Order"},{"description":"Bank-owned AFS cost, contractual effective-interest schedule, custody, valuation, tax and credit evidence.","name":"Bank Securities Lot","x-object":"#/components/schemas/Lot"},{"description":"Independent review of exact dated custody price and explicit allocated tax and credit balances.","name":"Bank Securities Valuation","x-object":"#/components/schemas/ValuationRecord"},{"description":"An instrument's effective-dated accounting designation, Schedule RC-B item, rate type and structured-note attribute, bound to the approved instrument's exact content and independently reviewed.","name":"Bank Securities Classification","x-object":"#/components/schemas/ClassificationRecord"},{"description":"Every bank-owned lot at the original closing of a completed business date: closing cost, adjustment and allowance, accrual checked against its schedule, approved completed-day fair value and the classification in force.","name":"Bank Securities Position","x-object":"#/components/schemas/PositionSet"},{"description":"The bank's card cryptography: the HSM adapter, the dual-control key ceremonies that create, import, export, rotate and retire keys, and each card's personalisation and PIN record. Clear keys, PINs and key blocks never appear.","name":"Card Security","x-object":"#/components/schemas/SecurityKey"},{"description":"An independently reviewed lender the bank borrows from (a Federal Home Loan Bank, the discount window or a repo counterparty) with the keys it signs collateral statements with.","name":"Collateral Lender","x-object":"#/components/schemas/LedgerCollateralLender"},{"description":"One bank-owned Treasury lot or loan pledged to exactly one lender, with the schedule's latest judgement of it.","name":"Collateral Pledge","x-object":"#/components/schemas/LedgerCollateralPledge"},{"description":"A loan's collateral facts read from its record and the collateral register's encumbrance on it.","name":"Collateral Loan","x-object":"#/components/schemas/CollateralLoan"},{"description":"A bank that holds the bank's money in another currency or market, proposed and approved by different people, with its control status.","name":"Correspondent Bank","x-object":"#/components/schemas/Correspondent"},{"description":"The bank's own account at a correspondent, on its own ledger account under the due-from control, with its reviewed terms, movements, statements, charges, interest and reconciliation.","name":"Nostro Account","x-object":"#/components/schemas/NostroAccount"},{"description":"An item the reconciliation could not explain, resolved only by a proposal and a different person's approval.","name":"Nostro Break","x-object":"#/components/schemas/Break"},{"description":"A correspondent's periodic invoice, matched line by line to the accrued charges and settled from its statement debit.","name":"Correspondent Invoice","x-object":"#/components/schemas/CorrespondentInvoice"},{"description":"A nostro balance beyond the account's minimum, zero or maximum, with the funding that restores the target.","name":"Nostro Liquidity Alert","x-object":"#/components/schemas/LiquidityAlert"},{"description":"A Metro 2 furnishing file's lifecycle: build a cycle's loan and facility tradelines, submit to the consumer reporting agency, ingest the acknowledgment, retain sealed consumer identity, and a bounded FCRA dispute/correction hook.","name":"Credit Bureau Furnishing","x-object":"#/components/schemas/FurnishingPacket"},{"description":"A ChexSystems inquiry at deposit-account opening: prior closed-for-cause activity, a consumer score and a clear/refer/decline recommendation. Decline and refer refuse the opening. Consumer identity is sealed at rest.","name":"Deposit Screening","x-object":"#/components/schemas/DepositScreening"},{"description":"A closed-for-cause deposit-account report furnished to ChexSystems. Identity is reused from a prior inquiry and sealed.","name":"Deposit Abuse Report","x-object":"#/components/schemas/AbuseReport"},{"description":"Immutable dated customer securities and actual cash source, separate from bank assets and insured deposits.","name":"Custody Position Snapshot","x-object":"#/components/schemas/SnapshotRecord"},{"description":"Independently reviewed broker/custodian agency authority for customer-owned securities, with actual tax and confirmation responsibility.","name":"Investment Program","x-object":"#/components/schemas/InvestmentsControl"},{"description":"A reviewed Treasury bill or government no-load MMF with exact security identity, unit basis, precision and eligibility evidence.","name":"Investment Instrument","x-object":"#/components/schemas/InvestmentsControl"},{"description":"A signed external custodian relationship bound to one customer and the original deposit account, independently reviewed before use.","name":"Investment Custody Account","x-object":"#/components/schemas/InvestmentsControl"},{"description":"Immutable agency program, instrument or actual custody account content with independent exact-content review.","name":"Investment Control","x-object":"#/components/schemas/InvestmentsControl"},{"description":"A customer-consented securities trade, exclusive cash or lot reservations, immutable instruction and actual signed execution/DVP settlement.","name":"Investment Order","x-object":"#/components/schemas/InvestmentsOrder"},{"description":"An externally held customer securities lot with actual acquisition cash cost, explicit unknown tax basis and signed custody reconciliation.","name":"Investment Lot","x-object":"#/components/schemas/InvestmentsLot"},{"description":"Actual signed customer fund income or Treasury maturity evidence and retained cash accounting recovery state.","name":"Investment Distribution","x-object":"#/components/schemas/DistributionRecord"},{"description":"Reviewed external beneficiary, source context and signature trust for payable remittance.","name":"Payable Recipient","x-object":"#/components/schemas/Recipient"},{"description":"Reviewed source allocations, cash reservation, exact outbound instruction and signed actual payable settlement evidence.","name":"Payable Remittance","x-object":"#/components/schemas/Remittance"},{"description":"Registered payable source and actual reserved, paid, returned and unpaid allocations.","name":"Payable Obligation","x-object":"#/components/schemas/ObligationStatus"},{"description":"A sealed obligor SSN or levied taxpayer TIN copied from a served order; only its identity and last four digits are returned.","name":"Agency Identifier","x-object":"#/components/schemas/Identifier"},{"description":"The agency view of a payable remittance: protocol, sealed message digests, submissions, verified acknowledgments and source-and-cash reconciliation. An acknowledgment is not cash settlement.","name":"Agency Remittance","x-object":"#/components/schemas/AgencyRemittance"},{"description":"Computed federal tax deposit periods, due dates and unpaid amounts for an approved EFTPS recipient's form and tax year. Computation does not move money.","name":"Agency Tax Deposit","x-object":"#/components/schemas/TaxDepositSchedule"},{"description":"A NAUPA standard electronic holder report of registered escheat obligations, independently reviewed, submitted to the state's portal and acknowledged with a remittance reference.","name":"Unclaimed Property Report","x-object":"#/components/schemas/UnclaimedPropertyReport"},{"description":"A state's cited holder-report and remittance window for a report year.","name":"Unclaimed Property Schedule","x-object":"#/components/schemas/HolderReportSchedule"},{"description":"Maker-checker reverse or adjustment of a fee the payments service assessed, posted as a balanced ledger correction against the retained fee journal.","name":"Fee Correction","x-object":"#/components/schemas/FeeCorrection"},{"description":"Deterministic reconstruction of an account's payment-and-fee journals tied to the ledger running balance, for audit and dispute.","name":"Payment History","x-object":"#/components/schemas/PaymentHistory"},{"description":"Immutable current actual repo debt, original collateral, bank cash and journal evidence with requested close-date coverage and explicit readiness blockers.","name":"Bank Repo Snapshot","x-object":"#/components/schemas/BankrepoSnapshot"},{"description":"Independently reviewed bank-borrower secured funding authority, actual lender and custody identity, fixed interest policy and legal/accounting evidence.","name":"Bank Repo Program","x-object":"#/components/schemas/BankrepoControl"},{"description":"Bank borrowing secured by full settled bank-owned AFS Treasury lots with separate actual funding, repayment and original-custodian pledge/release evidence.","name":"Bank Repo","x-object":"#/components/schemas/Transaction"},{"description":"The ledger's connection to the Fedwire Securities Service (a simulator until a certified FedLine connector replaces it): operator advices that settle bank-owned Treasury trades, transfers the bank sends under maker-checker, and holdings statements reconciled against the book.","name":"Fedwire Securities Connection","x-object":"#/components/schemas/LedgerFedSecuritiesAdvice"},{"description":"An advance requested through a secured lender's connection (the discount window or Federal Home Loan Bank simulator) and booked from the lender's signed confirmation.","name":"Lender Advance","x-object":"#/components/schemas/LedgerLenderAdvance"},{"description":"Independently reviewed curves, behavioral assumptions and contingency triggers for a reproducible monthly runoff model.","name":"Treasury Scenario","x-object":"#/components/schemas/AlmRecord"},{"description":"Captured historical source balances, evidenced cash-flow assumptions and calculated liquidity, NII and EVE projections with independent review.","name":"Treasury Run","x-object":"#/components/schemas/AlmRecord"},{"description":"Reviewed, dated risk classifications and bank minimum capital ratios with retained methodology evidence.","name":"Capital Policy","x-object":"#/components/schemas/AlmRecord"},{"description":"Reproducible capital and risk-weighted-asset calculations tied to a retained quarter-end or month-end ledger closing and independently reviewed evidenced inputs.","name":"Capital Run","x-object":"#/components/schemas/AlmRecord"},{"description":"Reviewed dated bank identity, FDIC rule version and applicability evidence.","name":"Insurance Policy","x-object":"#/components/schemas/AlmRecord"},{"description":"Cross-account estimates by beneficial owner and right/capacity, original dated source data and explicit title/amount exceptions.","name":"Insurance Run","x-object":"#/components/schemas/AlmRecord"},{"description":"Independently reviewed, versioned stress events with GL runoff and haircut assumptions, register lender stress terms and early-warning thresholds.","name":"Contingency Funding Scenario","x-object":"#/components/schemas/AlmRecord"},{"description":"Reproducible daily and intramonth sources and uses of funds from a retained closing, dated advances and the collateral register's capacity, with independent review.","name":"Contingency Funding Run","x-object":"#/components/schemas/AlmRecord"},{"description":"Proposed loosenings of account payment limits and ACH originator controls, applied only with an independent approval.","name":"Payment Control Change","x-object":"#/components/schemas/ControlChange"},{"description":"An outbound payment the fraud rules held before it was claimed for sending (a first payment to new details at or above the first-use amount, a wire at or above the call-back threshold, velocity, an amount anomaly, a payee saved inside the cooling-off window, changed details for a known payee), with the rules hit, the parameters and history judged, the call-backs to the number on the customer record and the one staff decision. Its initiator never decides it, and a release that needs a call-back needs a verified one recorded by a different staff member.","name":"Fraud Review","x-object":"#/components/schemas/FraudReview"},{"description":"The outbound fraud thresholds as effective-dated rows: a change is proposed from a later business date by fraud staff and is in force only once a second staff member holding operations:approve approves it; decisions are immutable.","name":"Fraud Parameter","x-object":"#/components/schemas/FraudParameterChange"},{"description":"The scheduler's daily evaluation of every Originator's debit return rates against the Nacha thresholds; a breach alerts and suspends the Originator pending staff review.","name":"ACH Return Rate Evaluation","x-object":"#/components/schemas/ReturnRateEvaluation"},{"description":"The comprehensively sanctioned jurisdictions and areas (ISO 3166-2 regions and postal prefixes) card authorisations are declined in, whatever form the network sends the country in (alpha-2, alpha-3 or numeric); changes are proposed and approved by two staff members.","name":"Sanctioned Jurisdiction","x-object":"#/components/schemas/JurisdictionList"},{"description":"The screening of every cleared merchant against the sanctions lists after the clearing commits; an outage flags the clearing unscreened and the retry picks it up.","name":"Merchant Screening","x-object":"#/components/schemas/MerchantScreenRetry"},{"description":"A merchant identity blocked after its screening at clearing was not clear, with the compliance alert it raised; a block is cleared only by a staff member's request and a second staff member's approval.","name":"Merchant Block","x-object":"#/components/schemas/MerchantBlock"},{"description":"The transaction-monitoring thresholds as effective-dated rows within statutory bounds: a change is proposed from a later business date and is in force only once a second person approves it.","name":"Monitoring Parameter","x-object":"#/components/schemas/ThresholdChange"},{"description":"The CTR exemption and 314(b) programme parameters, changed under the same two-person rule as the monitoring thresholds.","name":"BSA Parameter","x-object":"#/components/schemas/ThresholdChange"},{"description":"A CTR exempt-person designation (31 CFR 1020.315) with its eligibility facts, FinCEN 110 filing, second-person approval, annual reviews and revocation. Only cash within the exemption's accounts and directions is skipped, so structuring in the customer's non-exempt cash still alerts; a lapsed review re-enables the CTR.","name":"CTR Exemption","x-object":"#/components/schemas/CTRExemption"},{"description":"The bank's 314(b) registrations, the registry of counterparty institutions' verified registration periods, and the immutable log of exchanges; an exchange is refused unless both registrations are in force that day.","name":"Information Sharing","x-object":"#/components/schemas/InfoSharingEntry"},{"description":"Alloy's signed journey decisions, delivered outside the bank's bearer gate.","name":"KYC Provider Webhook"},{"description":"Interest on reserve balances: the IORB rate recorded by a treasury officer and approved by a second, the daily accrual on the master account (Dr 1470 / Cr 4020, actual/360) at end of day, and the Federal Reserve's credit matched against it.","name":"Reserve Interest","x-object":"#/components/schemas/ReserveRate"},{"description":"The operations audit log's hash chain, verified end to end with signed checkpoints kept outside the database (?anchor=).","name":"Audit Log","x-object":"#/components/schemas/AuditVerification"},{"description":"Identity's security and staff audit hash chains, verified end to end with signed checkpoints kept outside the database (?anchor=).","name":"Staff Audit Log","x-object":"#/components/schemas/StaffAuditVerification"},{"description":"Bank-owned terminals and shared-network traffic: a documented CADP1 device protocol modelled on NDC-style states (NCR NDC is proprietary and is not implemented), on-us authorisation, Pulse/STAR-style acquiring and issuing, surcharge disclosure, electronic journal and cash reconciliation to per-unit ATM custody on GL 1020, and replenishment handed to an armored-carrier module. Simulators and software PIN security are refused in production.","name":"ATM","x-object":"#/components/schemas/Terminal"},{"description":"Actual vault, teller and ATM custody balances, independently reviewed movements, complete count evidence, armored carrier shipments and close blockers. Hardware dispensing/PIN certification is a separate provider contract. The armoredcarrier package is a local simulator, not a licensed carrier.","name":"Physical Cash","x-object":"#/components/schemas/Movement"},{"description":"Approved version 2 plans capture actual lending obligations before the cutoff, with leased steps and retained results. Preparation cannot manufacture a missed historical source.","name":"Close Preparation","x-object":"#/components/schemas/CloseRun"},{"description":"An independently approved operating plan. Submit bank_close_plan through /requests with version, enabled, start_date, lending, no_lending_reason, reconciliation_sources, no_reconciliation_reason, policy_evidence and, on version 3, products (deposit_placements, customer_investments) or no_products_reason. Its scheduler uses the ledger's Federal Reserve calendar and cutoff; no plan means no scheduled close.","name":"Bank Close Plan","x-object":"#/components/schemas/ActiveClosePlan"},{"description":"A captured banking date and ordered dependencies, with immutable attempt evidence and recoverable checkpoints. Missing reconciliations, variances or unresolved statement deliveries block completion and later dates.","name":"Bank Close","x-object":"#/components/schemas/CloseRun"},{"description":"Immutable bank-supplied agreement and E-SIGN text, exact product fingerprint and computed opening APY; an independent staff decision activates a dated revision.","name":"Opening Disclosure Policy","x-object":"#/components/schemas/DisclosuresPolicy"},{"description":"Bank-owned correspondent currency units, reviewed spot cash operations, atomic USD carrying value, signed bridge evidence and exact reconciliation; the maker-checker rate sheets, customer conversion quotes and the close's dated USD equivalents of foreign-currency accounts.","name":"Foreign Currency Inventory","x-object":"#/components/schemas/Book"},{"description":"Independently reviewed entire-beneficial-interest eligibility, pinned customer identity and exact account title, with immutable admission evidence.","name":"NOW Eligibility","x-object":"#/components/schemas/NowReview"}],"x-tagGroups":[{"name":"Operations","tags":["Complaint","Complaint Policy","Customer Complaint","Request","Request Kind","Case","Audit Event","Audit Log","Close Preparation","Bank Close Plan","Bank Close"]},{"name":"Cards","tags":["Cardholder Authority","Card","Authorization","Card Security","Sanctioned Jurisdiction","Merchant Screening","Merchant Block","ATM"]},{"name":"Compliance","tags":["Dispute","Screening","KYC Check","Monitoring Event","Alert","Sanctions List","Monitoring Parameter","BSA Parameter","CTR Exemption","Information Sharing","KYC Provider Webhook"]},{"name":"Customers and accounts","tags":["Customer","Account","Customer Group","Account Group","Account Report","Garnishment","Escheatment","Tax Form","FX Quote","Account Number","Product","Deposit Screening","Deposit Abuse Report","Physical Cash","Opening Disclosure Policy","NOW Eligibility"]},{"name":"Transfers","tags":["Transfer","ACH Transfer","International Transfer","ACH Originator","ACH Change","ACH Receipt","Book Transfer","Wire Transfer","Realtime Transfer","International Wire","Wire Return Request","Payment Request","Realtime Return Request","Check Transfer","Remote Deposit","Remote Deposit Limit","Stop Payment","Positive Pay","Lockbox","Lockbox Remittance","Counterparty","Scheduled Transfer","Payment Limit","Payment Approval","Rail","Fraud Review","Fraud Parameter","ACH Return Rate Evaluation"]},{"name":"Lending","tags":["Loan","Mortgage Origination","Facility","Loan Product","Collateral Loan","Credit Bureau Furnishing"]},{"name":"Sandbox","tags":["Simulation"]},{"name":"Events and webhooks","tags":["Event","Webhook Endpoint","Webhook Delivery"]},{"name":"Notifications","tags":["Notification","Notification Suppression","Notification Preference"]},{"name":"Reporting","tags":["Report","Balance Sheet","Income Statement","Activity Report","Deposit Report","Daily Flash","FR 2900 Report","Fed Position","Call Report Schedule","Fed Position Sample","Reporting Run","Custody Position Snapshot","Treasury Scenario","Treasury Run","Capital Policy","Capital Run","Insurance Policy","Insurance Run","Contingency Funding Scenario","Contingency Funding Run"]},{"name":"Reconciliation","tags":["Reconciliation","Reconciliation Break"]},{"name":"Ledger","tags":["Ledger Account","Journal","Hold","Period","Borrowing","Reverse Repo","Ledger","Collateral Lender","Collateral Pledge","Fedwire Securities Connection","Lender Advance","Reserve Interest"]},{"name":"Identity","tags":["Token","Staff Authorization","Staff Session","Staff Provisioning","Key Set","User","Session","Device","Passkey","Step-up","Staff Audit Log"]},{"name":"Platform","tags":["Health"]},{"name":"Bank Cash Sources","tags":["Independent Bank Statement","Bank Cash Match"]},{"name":"Bank Securities","tags":["Bank Securities Snapshot","Bank Treasury Redemption","Bank Securities Program","Bank Securities Instrument","Bank Custody Account","Bank Securities Control","Bank Securities Order","Bank Securities Lot","Bank Securities Valuation","Bank Securities Classification","Bank Securities Position"]},{"name":"Correspondent banking","tags":["Correspondent Bank","Nostro Account","Nostro Break","Correspondent Invoice","Nostro Liquidity Alert"]},{"name":"Investments","tags":["Investment Program","Investment Instrument","Investment Custody Account","Investment Control","Investment Order","Investment Lot","Investment Distribution"]},{"name":"Payables","tags":["Payable Recipient","Payable Remittance","Payable Obligation","Agency Identifier","Agency Remittance","Agency Tax Deposit","Unclaimed Property Report","Unclaimed Property Schedule","Fee Correction","Payment History"]},{"name":"Bank Repos","tags":["Bank Repo Snapshot","Bank Repo Program","Bank Repo"]},{"name":"Payments","tags":["Payment Control Change"]},{"name":"Ledger and accounting","tags":["Foreign Currency Inventory"]}],"paths":{"/.well-known/jwks.json":{"get":{"operationId":"getWellKnownJwksJson","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Public keys for verifying tokens","tags":["Key Set"]}},"/.well-known/revoked-sessions.json":{"get":{"operationId":"getWellKnownRevokedSessionsJson","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sessions revoked recently enough that a token they minted may still be live","tags":["Key Set"]}},"/account-groups/{id}":{"get":{"description":"A multi-entity group's position: every member entity's open accounts with balances, subtotals per entity and the group total","operationId":"getAccountGroupsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupBalances"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an account group by ID","tags":["Account Group"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/account-numbers":{"get":{"description":"List account numbers","operationId":"getAccountNumbers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"number","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AccountNumber"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all account numbers","tags":["Account Number"]}},"/account-numbers/{id}":{"delete":{"description":"Close an account number","operationId":"deleteAccountNumbersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNumber"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Delete an account number","tags":["Account Number"]},"get":{"description":"Get an account number","operationId":"getAccountNumbersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNumber"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an account number by ID","tags":["Account Number"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/account-reports/bai2/{date}":{"get":{"operationId":"getAccountReportsBai2Date","parameters":[{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A customer's (customer_id) or one account's (account_id) balance and transaction report for a business date in the BAI format, version 2: opening and closing ledger and available balances, total credits and debits, a 16 record per entry with its uniform type code; a past date is final previous-day data, the business date interim same-day data","tags":["Account Report"]},"parameters":[{"in":"path","name":"date","required":true,"schema":{"type":"string"}}]},"/accounts":{"get":{"description":"List accounts","operationId":"getAccounts","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AccountsAccount"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all accounts","tags":["Account"]},"post":{"description":"Open an account; a consumer (person) product needs the acknowledgement of its opening documents, and electronic delivery the E-SIGN consent","operationId":"postAccounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an account","tags":["Account"]}},"/accounts/cycles":{"post":{"operationId":"postAccountsCycles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CycleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CycleReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run the monthly fee, withholding and statement cycle for a period","tags":["Account"]}},"/accounts/cycles/periods/{period}":{"get":{"operationId":"getAccountsCyclesPeriodsPeriod","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CycleReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the retained cycle progress or complete report","tags":["Account"]},"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/cycles/periods/{period}/accounts":{"get":{"operationId":"getAccountsCyclesPeriodsPeriodAccounts","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CycleAccountResult"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained per-account cycle outcomes, optionally by status (pending, complete, failed)","tags":["Account"]},"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/cycles/periods/{period}/accounts/{id}/reconciliations":{"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsCyclesPeriodsPeriodAccountsIdReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Rerun one failed cycle account after its cause is fixed; completes the cycle when it was the last outstanding","tags":["Account"]}},"/accounts/deposit-sweep-returns":{"post":{"operationId":"postAccountsDepositSweepReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return every outstanding sweep from an earlier business date to its demand deposit","tags":["Account"]}},"/accounts/deposit-sweep-runs":{"post":{"operationId":"postAccountsDepositSweepRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sweep every configured account's end-of-day balance above its target into the internal sweep vehicle","tags":["Account"]}},"/accounts/dormancy-runs":{"post":{"operationId":"postAccountsDormancyRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"},"operator":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DormancyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Review every account for dormancy and list escheat candidates by state","tags":["Account"]}},"/accounts/information-requests/search":{"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postAccountsInformationRequestsSearch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture exact confidential account ownership and time coverage for an approved request and native candidate set","tags":["Account"]}},"/accounts/maturities":{"post":{"operationId":"postAccountsMaturities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"},"operator":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaturityReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Renew or pay out every certificate past its maturity and grace period, recording the Reg DD maturity notice that preceded each renewal","tags":["Account"]}},"/accounts/maturity-notice-runs":{"post":{"operationId":"postAccountsMaturityNoticeRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue the Reg DD 1030.5(b) maturity notice for renewing certificates maturing 30 to 60 days out","tags":["Account"]}},"/accounts/overdraft-confirmations":{"get":{"operationId":"getAccountsOverdraftConfirmations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OverdraftConsent"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List current opt-ins awaiting confirmation delivery","tags":["Account"]}},"/accounts/overdraft-repayments":{"post":{"operationId":"postAccountsOverdraftRepayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"repaid":{"format":"int64","type":"integer"}},"required":["repaid"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Repay outstanding advances from available deposits","tags":["Account"]}},"/accounts/privacy-relationship-runs":{"post":{"description":"Deposit servicing staff with accounts:servicing:write or service with accounts:write required. At most 200 immutable account opening/closure instructions are retried with durable attempt evidence and stable customer idempotency keys; former evidence waits for active acknowledgment. A singleton worker also retries every minute. Legacy consumer accounts are backfilled from captured opening/closure dates and product contracts.","operationId":"postAccountsPrivacyRelationshipRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRelationshipRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRelationshipRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retry a bounded batch of durable consumer deposit privacy relationship deliveries","tags":["Account"]}},"/accounts/product-notice-runs":{"post":{"operationId":"postAccountsProductNoticeRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report notice deadlines and activate a bounded page of due notices","tags":["Account"]}},"/accounts/product-notices":{"get":{"operationId":"getAccountsProductNotices","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"pending","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductNotice"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List product notices and outstanding notice work","tags":["Account"]}},"/accounts/protected-movement-proofs":{"post":{"description":"Internal actual svc_ledger service identity with only accounts:protected:verify and no API key. Read-only exact immutable retirement command or captured contractual fee proof; generic relabelled interest, fee, transfer, reversal and cash instructions cannot bypass classification.","operationId":"postAccountsProtectedMovementProofs","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProofRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementProof"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify an exact retained retirement or contractual-fee journal for the restricted ledger verifier","tags":["Account"]}},"/accounts/statement-deliveries":{"get":{"operationId":"getAccountsStatementDeliveries","parameters":[{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StatementDeliveryJob"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List statement deliveries by status for dispatch and paper fulfilment","tags":["Account"]}},"/accounts/statement-runs":{"post":{"operationId":"postAccountsStatementRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Generate, issue and dispatch a bounded page of account statements","tags":["Account"]}},"/accounts/{id}":{"get":{"description":"Get an account","operationId":"getAccountsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an account by ID","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/access-checks":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdAccessChecks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Check an original customer identity's account permission (internal)","tags":["Account"]}},"/accounts/{id}/account-numbers":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdAccountNumbers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"}},"required":["description"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNumber"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an account number","tags":["Account"]}},"/accounts/{id}/analysis/{period}":{"get":{"operationId":"getAccountsIdAnalysisPeriod","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A business checking account's analysis for a period: fees, earnings credit and the net charged","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/card-overdraft-fees":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdCardOverdraftFees","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardOverdraftFeeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Assess an eligible fee for a committed card clearing","tags":["Account"]}},"/accounts/{id}/cardholder-eligibility":{"get":{"operationId":"getAccountsIdCardholderEligibility","parameters":[{"in":"query","name":"customer_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainCardholderEligibility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read minimal verified cardholder eligibility","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reasonBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an empty account (optional Idempotency-Key replays the recorded outcome)","tags":["Account"]}},"/accounts/{id}/closure":{"get":{"operationId":"getAccountsIdClosure","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountClosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read closure and payout evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdClosure","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosureRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountClosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Settle final interest and pay the remaining balance to the same owner's account","tags":["Account"]}},"/accounts/{id}/closure-payout":{"get":{"operationId":"getAccountsIdClosurePayout","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosurePayout"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured official-check instructions for bank processing","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/credits":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdCredits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsCreditRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a credit (branch, teller or ITM deposit; Reg CC availability by kind)","tags":["Account"]}},"/accounts/{id}/death-controls":{"get":{"description":"Staff evidence only. Writes require accounts:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"getAccountsIdDeathControls","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeathControl"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List staff evidence and decisions for account death controls","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require accounts:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postAccountsIdDeathControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControlRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an account debit restriction or its release after reviewing a confirmed death","tags":["Account"]}},"/accounts/{id}/death-controls/{control}":{"get":{"description":"Staff evidence only. Writes require accounts:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"getAccountsIdDeathControlsControl","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an account death control and independent decision","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"control","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/death-controls/{control}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"control","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require accounts:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postAccountsIdDeathControlsControlDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControlDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject an account death control","tags":["Account"]}},"/accounts/{id}/early-withdrawals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdEarlyWithdrawals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarlyWithdrawalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarlyWithdrawal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withdraw from a certificate inside its term, forfeiting the product's days of interest","tags":["Account"]}},"/accounts/{id}/escheat-notices":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdEscheatNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"sent_at":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the due-diligence notice sent to a dormant account's owner","tags":["Account"]}},"/accounts/{id}/escheatments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdEscheatments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"operator":{"type":"string"},"state":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Escheatment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an abandoned account into an exact state payable for separately evidenced outward remittance","tags":["Account"]}},"/accounts/{id}/estate-disbursements":{"get":{"description":"Fresh dedicated accounts:estate:read staff identity. Returns at most 200 commands in ID order; after is the final command ID. All authority, identity, allocation, decision, execution and cancellation evidence is append-only.","operationId":"getAccountsIdEstateDisbursements","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Command"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List evidenced estate/POD cash disbursements and retained ledger receipts","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated accounts:estate:write staff identity; then different accounts:estate:approve reviewer. Source is an ordinary single-owner USD individual/POD cash account with a current confirmed death report/revision and an active independently approved death restriction whose captured title matches. Requires jurisdiction, reviewed policy hash, current probate/POD authority hash and recipient identity evidence. Every POD beneficiary must receive its captured share; executor personal accounts cannot receive individual-estate payouts. No state-law entitlement is invented.","operationId":"postAccountsIdEstateDisbursements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an evidenced estate or complete POD allocation for independent review","tags":["Account"]}},"/accounts/{id}/estate-disbursements/{command}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh independent estate reviewer must resolve/fence the svc_accounts-owned ledger cancellation key before cancelling. Already committed money is recovered as executed. Retry must match exact retained reviewer/key/evidence.","operationId":"postAccountsIdEstateDisbursementsCommandCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently fence an unposted estate instruction or recover already committed money","tags":["Account"]}},"/accounts/{id}/estate-disbursements/{command}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdEstateDisbursementsCommandDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a succession disbursement with exact authority and recipient evidence","tags":["Account"]}},"/accounts/{id}/estate-disbursements/{command}/executions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"description":"Captures an immutable exact balanced estate_disbursement journal before posting. RequireAvailable enforces atomic available funds; unrelated freezes/holds remain effective. Death restriction stays active. Current death, authority expiry, recipient eligibility and ownership/allocation are rechecked before unposted money. Exact key/evidence retry recovers a lost acknowledgment by the retained ledger key. No wire, check or external remittance is implied.","operationId":"postAccountsIdEstateDisbursementsCommandExecutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute or recover actual estate/POD book entries while retaining death restrictions","tags":["Account"]}},"/accounts/{id}/exception-holds":{"get":{"operationId":"getAccountsIdExceptionHolds","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ExceptionHold"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List exception holds and notices","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdExceptionHolds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Place a Reg CC exception hold","tags":["Account"]}},"/accounts/{id}/fees":{"get":{"operationId":"getAccountsIdFees","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FeePosting"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an account's fees","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/freeze":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdFreeze","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reasonBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Freeze an account (optional Idempotency-Key replays the recorded outcome)","tags":["Account"]}},"/accounts/{id}/fx-conversions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The customer who obtained the quote on this account converts it, with authentication within five minutes (step_up_required, 403) and an Idempotency-Key bound to the quote. Both accounts are checked again under their control locks, so a freeze, debit restriction or closure placed after the quote refuses the conversion before the ledger is asked. The instruction is retained with the customer's identity before the ledger posts one journal through the FX positions; a lost ledger response is recovered by the service's ledger key, and a replay of the customer's key answers the same conversion with 200. A quote converts once: another key for it is refused 409, and an expired quote is ledger.fx_quote_expired (409).","operationId":"postAccountsIdFxConversions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXConversionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXConversion"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXConversion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Convert on an unexpired quote the same customer was given on this account, once (fresh step-up; Idempotency-Key bound to the quote)","tags":["Account"]}},"/accounts/{id}/fx-conversions/{conversion}":{"get":{"description":"Read permission on this account, which must be the conversion's source or target. A conversion instruction whose ledger posting was not recorded answers 409: retry it under its key.","operationId":"getAccountsIdFxConversionsConversion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXConversion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a posted currency conversion from or to this account","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"conversion","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/fx-quotes":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The customer's own instruction: a customer token (not an API key) with initiate permission on this account and on target_account_id; staff and services are refused 403. Both accounts are open, belong to the same primary customer, are held under an individual, joint or payable-on-death title as checking, savings or money market deposits, and are in different currencies; the source must be withdrawable and not debit-restricted. Exactly one of source_amount or target_amount is fixed, in its own account currency's minor units (JPY has none, KWD three). The accounts service asks the ledger under its ledger:fx:convert credential alone: the ledger prices on the treasury's independently approved customer sheet, applies its per-conversion and daily customer limits (ledger.fx_limit_exceeded, 422) and refuses a currency it does not hold (ledger.currency_unsupported, 422) or the absence of a valid sheet (ledger.fx_rate_unavailable, 409). The quote expires after the ledger's FX_QUOTE_TTL. The Idempotency-Key is scoped to the customer and account and bound to the request body; a replay returns the retained quote with 200.","operationId":"postAccountsIdFxQuotes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuote"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuote"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Quote a conversion from this account to another of the customer's deposit accounts in a different currency, on the bank's approved customer rate sheet (the customer's own instruction; Idempotency-Key bound to the request)","tags":["Account"]}},"/accounts/{id}/garnishments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdGarnishments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GarnishmentOrder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Garnishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a served garnishment, levy or child-support order once (Idempotency-Key; an issuer's reference is served once) and freeze what it reaches after the federal benefits found in the lookback","tags":["Account"]}},"/accounts/{id}/maturity-notices":{"get":{"operationId":"getAccountsIdMaturityNotices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an account's archived certificate maturity notices","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/maturity-notices/{notice}/pdf":{"get":{"operationId":"getAccountsIdMaturityNoticesNoticePdf","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download an archived maturity notice","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/opening-evidence":{"get":{"operationId":"getAccountsIdOpeningEvidence","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningEvidence"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The immutable acknowledgement a consumer account opened on: document versions and hashes, method, delivery, E-SIGN consent, verified actor and time (staff or service identity)","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/overdraft-consent":{"get":{"operationId":"getAccountsIdOverdraftConsent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read account-wide overdraft consent and confirmation","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putAccountsIdOverdraftConsent","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftConsentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Opt in or revoke ATM and one-time debit overdraft consent","tags":["Account"]}},"/accounts/{id}/overdraft-consent/offers":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdOverdraftConsentOffers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftOffer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an overdraft opt-in disclosure","tags":["Account"]}},"/accounts/{id}/overdraft-consent/offers/{offer}/pdf":{"get":{"operationId":"getAccountsIdOverdraftConsentOffersOfferPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the overdraft disclosure PDF","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"offer","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/overdraft-consent/{consent}/confirmation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"consent","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdOverdraftConsentConsentConfirmation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftConfirmationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record customer receipt or staff evidence of confirmation delivery","tags":["Account"]}},"/accounts/{id}/overdraft-consent/{consent}/pdf":{"get":{"operationId":"getAccountsIdOverdraftConsentConsentPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the opt-in confirmation PDF","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"consent","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/overdraft-decisions":{"get":{"operationId":"getAccountsIdOverdraftDecisions","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OverdraftDecision"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List overdraft decisions","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdOverdraftDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cover or return an item","tags":["Account"]}},"/accounts/{id}/overdraft-protection":{"get":{"operationId":"getAccountsIdOverdraftProtection","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftProtection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read overdraft protection","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putAccountsIdOverdraftProtection","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftProtection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverdraftProtection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set overdraft protection","tags":["Account"]}},"/accounts/{id}/ownership":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdOwnership","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ownership"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retitle an account: payable-on-death beneficiaries, trust, estate, UTMA, IOLTA, HSA, IRA, custodial","tags":["Account"]}},"/accounts/{id}/product-notices":{"get":{"operationId":"getAccountsIdProductNotices","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"pending","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductNotice"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an account's product notices","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdProductNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare and archive a fee or limit change notice","tags":["Account"]}},"/accounts/{id}/product-notices/{notice}":{"get":{"operationId":"getAccountsIdProductNoticesNotice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured terms and notice evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/product-notices/{notice}/activation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdProductNoticesNoticeActivation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Activate delivered product terms on their effective date","tags":["Account"]}},"/accounts/{id}/product-notices/{notice}/approval":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdProductNoticesNoticeApproval","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve a notice with a different authenticated staff identity","tags":["Account"]}},"/accounts/{id}/product-notices/{notice}/cancellation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdProductNoticesNoticeCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel a notice before activation","tags":["Account"]}},"/accounts/{id}/product-notices/{notice}/delivery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdProductNoticesNoticeDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNoticeDelivery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an owner's actual notice delivery evidence","tags":["Account"]}},"/accounts/{id}/product-notices/{notice}/pdf":{"get":{"operationId":"getAccountsIdProductNoticesNoticePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the archived product notice","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"notice","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/retirement-annual-positions":{"get":{"operationId":"getAccountsIdRetirementAnnualPositions","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AnnualPosition"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained final year-end cash positions","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh retirement writer then independent retirement approver. Captures completed-year December 31 cash FMV including posted interest from the exact sealed ledger statement cut, or a proved zero-balance final closure. Retains as-of/source dates, ledger and ownership revision; source changes require a new review.","operationId":"postAccountsIdRetirementAnnualPositions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnualPositionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnualPosition"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnualPosition"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture final December ledger cut for independent retirement FMV review","tags":["Account"]}},"/accounts/{id}/retirement-annual-positions/{position}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"position","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementAnnualPositionsPositionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnualPosition"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an exact year-end ledger position","tags":["Account"]}},"/accounts/{id}/retirement-commands":{"get":{"operationId":"getAccountsIdRetirementCommands","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RetirementCommand"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed classified retirement monetary commands and ledger receipts","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated retirement writer, then different retirement approver. Single-owner USD traditional/Roth IRA or HSA cash deposits only. Contribution, distribution, timely return_excess and rollover use the same consumer's ordinary bank account. trustee_transfer instead names a same-owner retirement destination with the identical wrapper/IRA type. Exact current eligibility/rule, owner instruction/policy evidence, account ownership and tax classification are rechecked. Rollovers name the actually executed original distribution, preserve its calendar receipt date, require current complete outside inventory, conserve original gross cash across bank/outside portions, and enforce the 60-day and one-year receipt windows. All IRAs share the IRA count. The bounded HSA flow accepts one complete return; traditional RMD-age sources, split HSA returns, waivers, inherited and external-custody cases refuse. A conversion instead requires a same-owner traditional-to-Roth cash pair, reviewed exact owner instruction/policy and zero-withholding election. Verified DOB and a reviewed effective RMD policy determine age; every supported required year needs current approved source-complete RMD clearance before conversion, even when the first-year deadline is deferred. Pre-2026 required-year history refuses until reconciled. Direct trustee transfers do not count as paid distributions or regular contributions. beneficiary_distribution uses separate death/contract/election/tax evidence: original pre-death traditional cash IRA title, one verified adult 100-percent beneficiary, death before RBD, and full cash settlement by the end of the following year. Current sole beneficiary destination ownership and active reviewed death restriction are required; native ledger locks enforce the entire actual source balance, with optional withholding. death_transfer, death_distribution and inherited_distribution instead move a deceased holder's cash under approved beneficiary classifications (see the classification route): a transfer moves the entire protected balance into same-wrapper separate accounts pro rata and reports nothing, an HSA that ceased at death is distributed with Form 1099-SA codes 4 or 6 and the date-of-death value, and an inherited distribution pays a beneficiary with Form 1099-R code 4. recharacterization moves an executed contribution and its reviewed net income to the owner's IRA of the other type by the reviewed return due date, reporting box 1, zero in box 2a and code N or R, with the receiving IRA's Form 5498 box 4 for the year it received the amount (Notice 2000-30, Example 2). custodian_transfer sends cash directly to a receiving trustee into the source's own plan type (receiving_plan_type; a conversion or another plan type refuses), credits the payments-in-transit liability and registers a payable for the payments remittance, reporting nothing; an inherited account may only move to an inherited title, an owner at the applicable age needs paid RMD clearance, and a final distribution year refuses. rollover may instead repay another custodian's evidenced distribution the owner received (outside_original), reported as a rollover receipt. custodian_transfer_in applies one actual wire or ACH receipt payments parked on transit for this protected account to an approved inbound transfer instruction the delivering custodian accepted: the receipt must come from the confirmed sending institution on the confirmed rail, quote the instruction's match reference, arrive on or after the custodian's distribution date and fit the reviewed maximum with the instruction's other receipts. It carries no eligibility, withholding or contribution attributes, claims the receipt at payments before posting, debits GL 2320 and credits the protected account, and reports nothing on Form 5498 or 5498-SA. Cash a traditional IRA custodian released in an earlier year needs the December 31 balance adjustment of 26 CFR 1.408-8(d), which is not serviced: such a transfer refuses when that year's requirement is already approved, and later requirement reviews for the year refuse while it stands.","operationId":"postAccountsIdRetirementCommands","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementCommand"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementCommand"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a classified cash contribution, distribution, excess return, original-receipt rollover or same-wrapper trustee transfer","tags":["Account"]}},"/accounts/{id}/retirement-commands/{command}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh retirement approver distinct from maker. Resolves and fences the ledger key before releasing annual capacity; an already committed instruction is recovered as executed. Posted commands require a corrective command. Cancellation retry must match retained reviewer, key and evidence.","operationId":"postAccountsIdRetirementCommandsCommandCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementExecutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementCommand"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently cancel an unposted retirement command after resolving the ledger idempotency key","tags":["Account"]}},"/accounts/{id}/retirement-commands/{command}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementCommandsCommandDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementCommand"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject an IRA/HSA cash movement with tax classification","tags":["Account"]}},"/accounts/{id}/retirement-commands/{command}/executions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"command","required":true,"schema":{"type":"string"}}],"post":{"description":"Captures immutable exact journal and capacity reservation before posting. Ledger independently verifies protected account IDs, full request hash and command/key against accounts online, enforcing available funds on both accounts. Retry uses the same execution key/evidence and recovers the original receipt after lost acknowledgment. No external settlement is fabricated.","operationId":"postAccountsIdRetirementCommandsCommandExecutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementExecutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementCommand"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute or repair a reviewed retirement command through a journal-bound protected ledger proof","tags":["Account"]}},"/accounts/{id}/retirement-inbound-transfers":{"get":{"operationId":"getAccountsIdRetirementInboundTransfers","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InboundTransfer"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List inbound direct transfer instructions from other custodians and their confirmations","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated retirement writer, then a different retirement approver. Reviews receiving a direct trustee-to-trustee transfer of cash from another IRA or HSA custodian into this open single-owner protected account: the delivering custodian, the routing number it sends cash from, its account reference, plan type and title hash, the holder, the signed transfer request, this bank's acceptance, the reviewed policy, a full or partial scope with the expected amount and a reviewed maximum, and an expiry within 180 days. A direct transfer keeps its plan type: a traditional or Roth IRA into the same IRA type, an HSA or Archer MSA into an HSA, and another trustee's inherited traditional IRA only into the inherited IRA already classified here for the same decedent and beneficiary and funded by its death transfer. SEP and SIMPLE plans, conversions and IRA-to-HSA funding distributions refuse. The response carries the fifteen-character match_reference the delivering custodian quotes on the cash. It is not a contribution or a rollover.","operationId":"postAccountsIdRetirementInboundTransfers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransferRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransfer"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose receiving a direct trustee-to-trustee transfer from another custodian for independent review","tags":["Account"]}},"/accounts/{id}/retirement-inbound-transfers/{transfer}/custodian-requests":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"transfer","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh retirement writer. Sends the independently approved instruction, re-validated against the current account, holder and classification, to the delivering custodian and retains its validation or exception. The request id is the instruction id, so a retry after a lost answer receives the same confirmation, and a retained confirmation is returned rather than requested again. Locally the adapter is the delivering-custodian simulator, whose answers are marked simulated and are relied on only in the local environment; real transfers are bilateral or run through DTCC's ACATS for NSCC participants, whose formats are proprietary, and no certified integration exists. An accepted answer above the reviewed maximum or from another sending routing number refuses.","operationId":"postAccountsIdRetirementInboundTransfersTransferCustodianRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransferCustodianRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransferConfirmation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the approved transfer request to the delivering custodian and retain its validation or exception","tags":["Account"]}},"/accounts/{id}/retirement-inbound-transfers/{transfer}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"transfer","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementInboundTransfersTransferDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject an inbound transfer instruction","tags":["Account"]}},"/accounts/{id}/retirement-inheritances":{"get":{"operationId":"getAccountsIdRetirementInheritances","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Inheritance"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List beneficiary classifications of a deceased holder's IRA or HSA","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated retirement writer, then a different retirement approver. Classifies one captured beneficiary of a deceased holder's traditional cash IRA or HSA: the confirmed death report/revision, an active independently approved death restriction retaining the original title, the reviewed contract and jurisdiction recipient-age policy, and category evidence (marriage or parentage; dated disability or chronic-illness documentation already received, which 26 CFR 1.408-8(b)(4)(i) does not hold to the plan-administrator October 31 deadline for an IRA). Verified dates of birth decide whether the beneficiary is not more than ten years younger, a minor child, or a designated beneficiary who is not eligible; a classification that disagrees with them refuses. The schedule is fixed here: life expectancy (a spouse's recalculated, with the owner's applicable-age delay), the 10-year rule with annual amounts where the owner died on or after the required beginning date, the 5-year rule or the owner's remaining life expectancy for an estate or a trust the reviewer determined is not a see-through trust (retaining the trust instrument, the determination and the trust entity's own cash account), a spouse's treat-as-own election, HSA spouse succession or an HSA that ceased at death. Death on or after the required beginning date names the owner's approved RMD review for the year of death (which may be made after death is confirmed) and allocates what the owner had not taken to this beneficiary as death_year_required_minor, by the IRA's share of the owner's requirement and the captured beneficiary shares; a successor takes the predecessor's unpaid inherited requirement the same way, or the entire interest when it was due that year. A sole spouse of an owner who died before the required beginning date who dies before distributions were required to commence refuses as the owner's case. Inherited Roth IRAs, see-through trusts, charities, foreign and under-age recipients, contract default beneficiaries and establishment after the year following death refuse.","operationId":"postAccountsIdRetirementInheritances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inheritance"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inheritance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Classify one captured beneficiary and fix the inherited distribution schedule for independent review","tags":["Account"]}},"/accounts/{id}/retirement-inheritances/{inheritance}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"inheritance","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementInheritancesInheritanceDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inheritance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a beneficiary classification","tags":["Account"]}},"/accounts/{id}/retirement-inherited-rmd-reviews":{"get":{"operationId":"getAccountsIdRetirementInheritedRmdReviews","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InheritedRMDReview"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List inherited IRA required minimum distribution reviews","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh retirement writer then independent approver. Calculates one inherited IRA's annual requirement from the approved prior December 31 position of the account that held the interest (the source's pro rata share when the separate account was funded during the year) and the reviewed Single Life Table, rounding up to the cent and never exceeding the balance. The final distribution year requires the entire interest. While the decedent's IRA held residual cash for the interest at the prior year end, source_position_id names that IRA's approved December 31 position and the beneficiary's share is added to the base. For the year of death the requirement is the classification's death_year_required_minor, with no year-end position; a remainder paid in a later year counts late toward the year of death and not again toward the later year. Inherited requirements are per account: they are not aggregated with the beneficiary's own IRAs or with another decedent's.","operationId":"postAccountsIdRetirementInheritedRmdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritedRMDReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritedRMDReview"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritedRMDReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Calculate an inherited IRA's annual requirement from the prior year-end position and reviewed Single Life Table","tags":["Account"]}},"/accounts/{id}/retirement-inherited-rmd-reviews/{review}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"review","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementInheritedRmdReviewsReviewDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritedRMDReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject an inherited RMD review","tags":["Account"]}},"/accounts/{id}/retirement-inherited-rmd-reviews/{review}/status":{"get":{"description":"Counts executed inherited distributions with captured cash dates in the requirement year; unresolved attempts refuse a determination. A final year reports the current protected balance instead. Late remediation of an earlier year's shortfall is not tracked here.","operationId":"getAccountsIdRetirementInheritedRmdReviewsReviewStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InheritedRMDStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile an inherited requirement to executed inherited distributions and the final-year balance","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"review","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/retirement-tax-delivery-consent":{"get":{"operationId":"getAccountsIdRetirementTaxDeliveryConsent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDeliveryConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the current owner tax-specific electronic delivery election","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Actual bound sole-owner session only. Tax-specific consent is independent of marketing and ordinary statement elections. A current policy and fresh one-use format-access proof are required to consent. Withdrawal needs no proof, takes effect immediately and retains the reviewed written confirmation. Idempotent replay cannot restore an earlier election; sequence order defines current status.","operationId":"postAccountsIdRetirementTaxDeliveryConsent","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDeliveryConsentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDeliveryConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record affirmative owner tax-specific format-access consent or a written withdrawal confirmation","tags":["Account"]}},"/accounts/{id}/retirement-tax-delivery-notice":{"get":{"description":"Actual bound sole-owner session with accounts:read and policy_id required. Serves the current reviewed disclosure in printable HTML, with a one-use capability identifier bound to account, customer, session, policy hash and exact served bytes. Consent requires that identifier plus an affirmative format-access acknowledgment within 24 hours.","operationId":"getAccountsIdRetirementTaxDeliveryNotice","parameters":[{"in":"query","name":"policy_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Serve the reviewed electronic tax disclosure in the delivery format and retain bound access evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/retirement-tax-furnishings":{"get":{"operationId":"getAccountsIdRetirementTaxFurnishings","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaxFurnishing"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List separately reviewed paper or electronic tax-furnishing evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh retirement writer, then different retirement approver. Retains actual paper dispatch or electronic availability-notification evidence for the exact approved recipient hash. Electronic furnishing rechecks current unwithdrawn tax-specific consent at proposal and approval. Beneficiary packets support reviewed paper furnishing only; deceased-owner electronic consent cannot authorize beneficiary delivery. Late reviewed deadlines remain visible. This endpoint records independently reviewed evidence; it does not send mail, email or a vendor request, and it makes no IRS filing claim.","operationId":"postAccountsIdRetirementTaxFurnishings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFurnishingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFurnishing"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFurnishing"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual paper dispatch or electronic availability-notification evidence for the exact approved copy","tags":["Account"]}},"/accounts/{id}/retirement-tax-furnishings/{furnishing}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"furnishing","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdRetirementTaxFurnishingsFurnishingDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFurnishing"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide tax-furnishing evidence after rechecking the approved packet and active electronic consent","tags":["Account"]}},"/accounts/{id}/retirement-tax-packets":{"get":{"operationId":"getAccountsIdRetirementTaxPackets","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaxPacket"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable retirement annual packets and their review status","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Assembles supported 5498, 5498-SA, 1099-R and 1099-SA boxes from an approved sealed year-end cash position, actual classified journal receipts and a separately encrypted immutable taxpayer-identity snapshot. Traditional IRAs held at year-end require the next-year reviewed RMD source. Legacy uncertain cash dates and unresolved relevant execution plans refuse. A previously furnished packet requires an explicit correction linked to the latest approved packet. Retained recipient HTML contains only a masked TIN. beneficiary_customer_id instead selects an executed sole-beneficiary traditional IRA cash payout and assembles only that beneficiary's code-4 1099-R, with a separate recipient-specific packet version, actual sealed full-distribution proof and prepared beneficiary identity. It cannot substitute an owner FMV/RMD position; corrected death evidence refuses until tax-source reconciliation.","operationId":"postAccountsIdRetirementTaxPackets","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPacketRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPacket"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPacket"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Assemble complete supported annual retirement form boxes from proved cash sources and retained taxpayer identity","tags":["Account"]}},"/accounts/{id}/retirement-tax-packets/{packet}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"packet","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated retirement approver different from the maker. Approval reassembles and compares the exact current source and recipient hashes; later source changes require a reviewed replacement/correction. Existing approved output remains immutable.","operationId":"postAccountsIdRetirementTaxPacketsPacketDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPacket"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact annual retirement form and recipient-copy bytes","tags":["Account"]}},"/accounts/{id}/retirement-tax-packets/{packet}/export":{"get":{"description":"Fresh human retirement reader also holding customers:tax:read. API keys, consumers and services refuse. The current approved packet and source must still agree; the full retained TIN is read under the verified staff identity and access/export evidence is recorded before release. Returns assembled JSON with full identity, not an IRS e-file or filing acknowledgment.","operationId":"getAccountsIdRetirementTaxPacketsPacketExport","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPacketExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Export approved annual form boxes and exact retained full taxpayer identity under fresh tax authority","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"packet","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/retirement-tax-packets/{packet}/recipient-copy":{"get":{"description":"Actual bound sole owner may retrieve the exact approved historical printable HTML, including after a correction or delivery-consent withdrawal. Fresh dedicated retirement reader may inspect retained draft copies. Reading does not record furnishing. Separate recipient copies and reviewed instructions are rendered; this is not IRS Copy A.","operationId":"getAccountsIdRetirementTaxPacketsPacketRecipientCopy","responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the exact retained printable recipient copy without claiming delivery or IRS filing","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"packet","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/retirement-tax-records":{"get":{"description":"Fresh dedicated retirement reader or actual svc_reporting with accounts:retirement:read. Up to 200 underlying commands per page with next_cursor, including pages with no matching-year rows. Posted source evidence for Form 5498 boxes 1/10 and rollover box 2; Form 5498-SA cash-year box 2/subsequent-year box 3 and rollover box 4; distributions on 1099-R/1099-SA. Beneficiary cash distributions identify the actual beneficiary as tax recipient with 1099-R code 4. Conversions appear as traditional 1099-R code 2/7 and Roth 5498 box 3, each on its own account, with one underlying cash journal. Trustee transfers create no contribution/distribution row. Gross contribution reporting is not netted by timely returns. These are inputs to the separately reviewed annual packet workflow; no tax remittance or IRS filing is claimed.","operationId":"getAccountsIdRetirementTaxRecords","parameters":[{"in":"query","name":"tax_year","schema":{"type":"string"}},{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRecords"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read posted retirement contribution/distribution source evidence for information reporting","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statement-consent":{"get":{"operationId":"getAccountsIdStatementConsent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read electronic statement consent","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putAccountsIdStatementConsent","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementConsent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Grant or withdraw electronic statement consent","tags":["Account"]}},"/accounts/{id}/statement-consent/challenges":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementConsentChallenges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentChallenge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a PDF access challenge with electronic delivery disclosures","tags":["Account"]}},"/accounts/{id}/statement-consent/challenges/{challenge}/pdf":{"get":{"operationId":"getAccountsIdStatementConsentChallengesChallengePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the electronic consent verification PDF","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"challenge","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}":{"get":{"operationId":"getAccountsIdStatementsPeriod","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a period statement","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/archive":{"get":{"operationId":"getAccountsIdStatementsPeriodArchive","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementArchive"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the issued statement and its hash","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/corrections":{"get":{"operationId":"getAccountsIdStatementsPeriodCorrections","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StatementCorrection"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List staff correction evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodCorrections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementCorrectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare an immutable correction for independent review","tags":["Account"]}},"/accounts/{id}/statements/{period}/corrections/{correction}":{"get":{"operationId":"getAccountsIdStatementsPeriodCorrectionsCorrection","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a correction proposal and review","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"correction","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/corrections/{correction}/pdf":{"get":{"operationId":"getAccountsIdStatementsPeriodCorrectionsCorrectionPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download a proposed correction PDF","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"correction","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/corrections/{correction}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"correction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodCorrectionsCorrectionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementCorrectionReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve and issue or reject a correction","tags":["Account"]}},"/accounts/{id}/statements/{period}/delivery":{"get":{"operationId":"getAccountsIdStatementsPeriodDelivery","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read statement delivery status","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver an issued statement notice or queue paper delivery","tags":["Account"]}},"/accounts/{id}/statements/{period}/delivery/evidence":{"get":{"operationId":"getAccountsIdStatementsPeriodDeliveryEvidence","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DeliveryEvidence"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read statement delivery evidence","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodDeliveryEvidence","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a provider or paper delivery outcome","tags":["Account"]}},"/accounts/{id}/statements/{period}/generations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodGenerations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Generate a draft statement from the ledger","tags":["Account"]}},"/accounts/{id}/statements/{period}/issues":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodIssues","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementArchive"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue and archive an immutable statement PDF","tags":["Account"]}},"/accounts/{id}/statements/{period}/pdf":{"get":{"operationId":"getAccountsIdStatementsPeriodPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the latest issued statement PDF","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/versions":{"get":{"operationId":"getAccountsIdStatementsPeriodVersions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StatementArchive"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List issued statement versions","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/versions/{version}":{"get":{"operationId":"getAccountsIdStatementsPeriodVersionsVersion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementArchive"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a specific issued statement version","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/statements/{period}/versions/{version}/delivery":{"get":{"operationId":"getAccountsIdStatementsPeriodVersionsVersionDelivery","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read delivery for a specific statement version","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodVersionsVersionDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Dispatch a specific statement version","tags":["Account"]}},"/accounts/{id}/statements/{period}/versions/{version}/delivery/evidence":{"get":{"operationId":"getAccountsIdStatementsPeriodVersionsVersionDeliveryEvidence","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DeliveryEvidence"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read delivery evidence for a specific version","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdStatementsPeriodVersionsVersionDeliveryEvidence","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record delivery evidence against an exact version","tags":["Account"]}},"/accounts/{id}/statements/{period}/versions/{version}/pdf":{"get":{"operationId":"getAccountsIdStatementsPeriodVersionsVersionPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download an immutable issued statement version","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/sweep-configuration":{"get":{"operationId":"getAccountsIdSweepConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an account's investment-sweep configuration","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putAccountsIdSweepConfiguration","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set or replace a demand-deposit account's investment-sweep configuration (enabled, target balance, internal vehicle)","tags":["Account"]}},"/accounts/{id}/sweep-movements":{"get":{"operationId":"getAccountsIdSweepMovements","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an account's end-of-day sweep movements and their next-morning returns","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/transactions":{"get":{"operationId":"getAccountsIdTransactions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transactions"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an account's transactions with running balance","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/unfreeze":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAccountsIdUnfreeze","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reasonBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Unfreeze an account (optional Idempotency-Key replays the recorded outcome)","tags":["Account"]}},"/accounts/{id}/users":{"get":{"operationId":"getAccountsIdUsers","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BusinessUser"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List business account users and permissions","tags":["Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/accounts/{id}/users/{user}":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"user","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putAccountsIdUsersUser","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUser"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set or revoke a business account user's role and payment limit","tags":["Account"]}},"/ach-changes":{"get":{"description":"List notifications of change received about the bank's entries and sent about entries it received","operationId":"getAchChanges","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"direction","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"transfer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Change"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all ACH changes","tags":["ACH Change"]}},"/ach-changes/{id}":{"get":{"description":"Read a notification of change","operationId":"getAchChangesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Change"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an ACH change by ID","tags":["ACH Change"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ach-changes/{id}/refuse":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAchChangesIdRefuse","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefuseChangeBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Change"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Refuse a notification of change the bank received (C61 to C69), within fifteen days","tags":["ACH Change"]}},"/ach-originators":{"get":{"description":"List ACH Originators","operationId":"getAchOriginators","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Originator"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all ACH originators","tags":["ACH Originator"]},"post":{"description":"Set a customer up as an ACH Originator with its exposure limits and classes","operationId":"postAchOriginators","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OriginatorRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Originator"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an ACH originator","tags":["ACH Originator"]}},"/ach-originators/{id}":{"get":{"description":"Read an ACH Originator","operationId":"getAchOriginatorsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Originator"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an ACH originator by ID","tags":["ACH Originator"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"description":"Replace an Originator's limits, classes and status. The reviewer is the verified operator on the token, never a name the body asserts. Lifting a suspension (`status` `suspended` to `active`) is the staff review the suspension waits for: without `operator` it is refused 400 `validation_failed` on `operator`. With an operator, the periodic review of the exposure limits the Nacha Operating Rules have the ODFI make is recorded against them.","operationId":"putAchOriginatorsId","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OriginatorRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Originator"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Replace an Originator's limits, classes and status; with an operator, record the periodic review","tags":["ACH Originator"]}},"/ach-originators/{id}/exposure":{"get":{"operationId":"getAchOriginatorsIdExposure","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exposure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The Originator's entries against its limits as of a business date","tags":["ACH Originator"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ach-originators/{id}/return-rates":{"get":{"operationId":"getAchOriginatorsIdReturnRates","parameters":[{"in":"query","name":"to","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnRates"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The Originator's debit return rates over sixty days against the Nacha thresholds","tags":["ACH Originator"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ach-receipts/{id}":{"get":{"description":"Read an inbound entry's outcome","operationId":"getAchReceiptsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an ACH receipt by ID","tags":["ACH Receipt"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ach-receipts/{id}/return":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAchReceiptsIdReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return a posted debit the Receiver says was unauthorized (R10, R11 or another extended-window reason) within sixty days of settlement: the account has its money back and the return goes to the ODFI","tags":["ACH Receipt"]}},"/ach-receipts/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAchReceiptsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewReceiptBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide an international entry held on the transit account: approve, block or return (optional Idempotency-Key replays the recorded decision)","tags":["ACH Receipt"]}},"/ach-return-rate-evaluations":{"get":{"description":"The scheduler's daily evaluations of every Originator's return rates against the Nacha thresholds, newest first (originator_id narrows to one; breached=true lists the alerts)","operationId":"getAchReturnRateEvaluations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"originator_id","schema":{"type":"string"}},{"in":"query","name":"breached","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnRateEvaluation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all ACH return rate evaluations","tags":["ACH Return Rate Evaluation"]}},"/affiliate-controls/collateral-adjustments":{"get":{"description":"Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.","operationId":"getAffiliateControlsCollateralAdjustments","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable bank-affiliate controls and review evidence","tags":["Other"]},"post":{"description":"Fresh verified staff with compliance:affiliate:write required. Immutable proposal binds idempotency to exact actor and input. Registries retain actual customer identity plus evidenced relationship; missing classification never means nonaffiliate. Capital uses evidenced filed consolidated Call Report amounts and dated complete external exposures, not an unfiled analytical estimate. Exact transaction plans retain attribution, comparable terms and collateral evidence. Approval is a separate action.","operationId":"postAffiliateControlsCollateralAdjustments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollateralAdjustmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable evidenced bank-affiliate controls for independent approval","tags":["Other"]}},"/affiliate-controls/collateral-adjustments/{id}":{"get":{"description":"Verified affiliate-control staff/service reader required; returns retained evidence and content hash.","operationId":"getAffiliateControlsCollateralAdjustmentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained bank-affiliate control and independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/collateral-adjustments/{id}/execution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh affiliate approver executes an independently reviewed additional cash pledge. Actual individual account owner/currency/status and available funds are verified; an immutable compliance-owned legal hold is placed without expiry. Retry retains the same hold and pledge. Existing pledged funds remain restricted until independently reviewed obligation termination and actual repayment evidence.","operationId":"postAffiliateControlsCollateralAdjustmentsIdExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollateralAdjustment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute an independently reviewed additional earmarked cash pledge","tags":["Other"]}},"/affiliate-controls/collateral-adjustments/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with compliance:affiliate:write and compliance:affiliate:approve required. A different actor decides the exact content SHA256. Identical decisions replay; changed identity, content or evidence conflicts.","operationId":"postAffiliateControlsCollateralAdjustmentsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact bank-affiliate control content","tags":["Other"]}},"/affiliate-controls/current-registry/{customer_id}":{"get":{"description":"Verified affiliate reader only. Reads the latest independently approved dated classification, fetches actual current customer identity and requires its digest to match the reviewed snapshot, then rechecks that classification was not superseded during collection. Missing, expired or changed identity refuses. The retained observation is a current source check, not a distributed ownership-change fence.","operationId":"getAffiliateControlsCurrentRegistryCustomer_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryObservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read current independently reviewed affiliation and unchanged authoritative customer identity","tags":["Other"]},"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/monitoring-runs":{"get":{"description":"Verified affiliate reader lists immutable dated observations and original source evidence.","operationId":"getAffiliateControlsMonitoringRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MonitorRun"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained affiliate exposure and collateral observations","tags":["Other"]},"post":{"description":"Verified affiliate reader captures a current observation after lending accrual. BusinessDate names the requested completed close, ObservationDate names the current business date, and each lending source must be accrued through the requested close. This does not reconstruct historical obligations. The service retains actual source obligations including all accrued/uncollected interest and unpaid fees, current relationship reviews, original and additional cash holds, and capital comparisons. Source and ledger inconsistency, missing/expired evidence, unresolved funding, or collateral shortfall remain explicit close blockers. Full original commitment remains counted until reviewed release. Source calls occur outside the bankwide lock, then the unchanged reservation inventory and nonlocking source revisions are checked before capture. The exact current attribution plan is retained. Readiness records a collected observation; revision checks are not a distributed write fence. This observation is dated exception evidence, not a guarantee of uninterrupted compliance or external exposure completeness.","operationId":"postAffiliateControlsMonitoringRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture actual current lending obligations and collateral; retain close blockers","tags":["Other"]}},"/affiliate-controls/monitoring-runs/{id}":{"get":{"description":"Verified affiliate reader reads original dated source, actual hold observations and close blockers; never reconstructs old results from current state.","operationId":"getAffiliateControlsMonitoringRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read original affiliate monitoring source evidence and exceptions","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/plans":{"get":{"description":"Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.","operationId":"getAffiliateControlsPlans","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable bank-affiliate controls and review evidence","tags":["Other"]},"post":{"description":"Fresh verified staff with compliance:affiliate:write required. Immutable proposal binds idempotency to exact actor and input. Registries retain actual customer identity plus evidenced relationship; missing classification never means nonaffiliate. Capital uses evidenced filed consolidated Call Report amounts and dated complete external exposures, not an unfiled analytical estimate. Exact transaction plans retain attribution, comparable terms and collateral evidence. Approval is a separate action.","operationId":"postAffiliateControlsPlans","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable evidenced bank-affiliate controls for independent approval","tags":["Other"]}},"/affiliate-controls/plans/{id}":{"get":{"description":"Verified affiliate-control staff/service reader required; returns retained evidence and content hash.","operationId":"getAffiliateControlsPlansId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained bank-affiliate control and independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/plans/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with compliance:affiliate:write and compliance:affiliate:approve required. A different actor decides the exact content SHA256. Identical decisions replay; changed identity, content or evidence conflicts.","operationId":"postAffiliateControlsPlansIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact bank-affiliate control content","tags":["Other"]}},"/affiliate-controls/policies":{"get":{"description":"Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.","operationId":"getAffiliateControlsPolicies","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable bank-affiliate controls and review evidence","tags":["Other"]},"post":{"description":"Fresh verified staff with compliance:affiliate:write required. Immutable proposal binds idempotency to exact actor and input. Registries retain actual customer identity plus evidenced relationship; missing classification never means nonaffiliate. Capital uses evidenced filed consolidated Call Report amounts and dated complete external exposures, not an unfiled analytical estimate. Exact transaction plans retain attribution, comparable terms and collateral evidence. Approval is a separate action.","operationId":"postAffiliateControlsPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable evidenced bank-affiliate controls for independent approval","tags":["Other"]}},"/affiliate-controls/policies/{id}":{"get":{"description":"Verified affiliate-control staff/service reader required; returns retained evidence and content hash.","operationId":"getAffiliateControlsPoliciesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained bank-affiliate control and independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/policies/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with compliance:affiliate:write and compliance:affiliate:approve required. A different actor decides the exact content SHA256. Identical decisions replay; changed identity, content or evidence conflicts.","operationId":"postAffiliateControlsPoliciesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact bank-affiliate control content","tags":["Other"]}},"/affiliate-controls/readiness":{"get":{"description":"Executing service with compliance:affiliate:use required. False means no approved policy only; an expired or not-yet-effective policy is an error. Nonlocal lending must require true.","operationId":"getAffiliateControlsReadiness","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"active":{"type":"boolean"}},"required":["active"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Executing service checks current affiliate policy; an expired policy is an error","tags":["Other"]}},"/affiliate-controls/registry":{"get":{"description":"Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.","operationId":"getAffiliateControlsRegistry","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable bank-affiliate controls and review evidence","tags":["Other"]},"post":{"description":"Fresh verified staff with compliance:affiliate:write required. Immutable proposal binds idempotency to exact actor and input. Registries retain actual customer identity plus evidenced relationship; missing classification never means nonaffiliate. Capital uses evidenced filed consolidated Call Report amounts and dated complete external exposures, not an unfiled analytical estimate. Exact transaction plans retain attribution, comparable terms and collateral evidence. Approval is a separate action.","operationId":"postAffiliateControlsRegistry","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registry"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable evidenced bank-affiliate controls for independent approval","tags":["Other"]}},"/affiliate-controls/registry/{id}":{"get":{"description":"Verified affiliate-control staff/service reader required; returns retained evidence and content hash.","operationId":"getAffiliateControlsRegistryId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained bank-affiliate control and independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/registry/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with compliance:affiliate:write and compliance:affiliate:approve required. A different actor decides the exact content SHA256. Identical decisions replay; changed identity, content or evidence conflicts.","operationId":"postAffiliateControlsRegistryIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact bank-affiliate control content","tags":["Other"]}},"/affiliate-controls/releases":{"get":{"description":"Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.","operationId":"getAffiliateControlsReleases","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable bank-affiliate controls and review evidence","tags":["Other"]},"post":{"description":"Fresh verified staff with compliance:affiliate:write required. Immutable proposal binds idempotency to exact actor and input. Registries retain actual customer identity plus evidenced relationship; missing classification never means nonaffiliate. Capital uses evidenced filed consolidated Call Report amounts and dated complete external exposures, not an unfiled analytical estimate. Exact transaction plans retain attribution, comparable terms and collateral evidence. Approval is a separate action.","operationId":"postAffiliateControlsReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable evidenced bank-affiliate controls for independent approval","tags":["Other"]}},"/affiliate-controls/releases/{id}":{"get":{"description":"Verified affiliate-control staff/service reader required; returns retained evidence and content hash.","operationId":"getAffiliateControlsReleasesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained bank-affiliate control and independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/affiliate-controls/releases/{id}/execution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh affiliate approver required. Release needs an independently approved termination record, every authorized funding reconciled to actual ledger, and zero actual principal balances before capacity and collateral release. Funded affiliate payoff must also show zero accrued interest, unpaid fees and undrawn obligation; a nonlocking revision callback detects source changes before release, and the actual payoff payload is retained. Original and additional cash holds all release through the reviewed termination. No automatic expiry.","operationId":"postAffiliateControlsReleasesIdExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegwReservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute independently reviewed obligation termination after actual repayment and funding reconciliation","tags":["Other"]}},"/affiliate-controls/releases/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with compliance:affiliate:write and compliance:affiliate:approve required. A different actor decides the exact content SHA256. Identical decisions replay; changed identity, content or evidence conflicts.","operationId":"postAffiliateControlsReleasesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact bank-affiliate control content","tags":["Other"]}},"/affiliate-controls/reservations":{"post":{"description":"Executing service subject must be allowed by current independently reviewed policy. Reserve before binding legal commitment, at full gross amount. Resolve exact approved plan and current borrower/attribution classifications; serialize single/all-affiliate limits using filed capital and all unreleased commitments. Supported affiliate execution is a USD term loan secured by actual nonexpiring earmarked cash held in the ledger. Affiliate revolvers and other unsupported covered types refuse. Reference, actor and terms replays never consume capacity twice. New covered execution honors the latest failed observation; funded affiliate obligations require a current-policy observation no older than five minutes with source revisions revalidated, and observed exposure growth is added before limit checks.","operationId":"postAffiliateControlsReservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegwReservation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegwReservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reserve full legally binding bank-credit commitment before approval","tags":["Other"]}},"/affiliate-controls/usages":{"post":{"description":"Executing service rechecks current policy, plan, classifications and actual collateral before a new exact funding journal. Affiliate term funding must pay the full gross amount to the borrower; netted fees/escrow refuse. Nonaffiliate facility settlement payables require a reviewed GL mapping. Uncertain posting retains usage and capacity; never release on timeout.","operationId":"postAffiliateControlsUsages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recheck classification, policy and collateral before one exact funding journal","tags":["Other"]}},"/affiliate-controls/usages/{id}/confirmation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the executing service confirms. Reads the saved idempotency key from the authoritative ledger and verifies source service, kind, source reference, gross debit and exact destination credit. Already confirmed results replay without authorizing another post.","operationId":"postAffiliateControlsUsagesIdConfirmation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Confirm funding from the actual authoritative ledger journal","tags":["Other"]}},"/agency-identifiers":{"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Seal an obligor social security number or a levied taxpayer identification number copied from a served order and return only its identity and last four digits. The full identifier never appears on a recipient, remittance, holder report or ledger view. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postAgencyIdentifiers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentifierRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identifier"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Identifier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an agency identifier","tags":["Agency Identifier"]}},"/agency-remittances/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read the agency view of a payable remittance: protocol, message digests, submissions, verified acknowledgments and the latest reconciliation. An agency acknowledgment is not cash. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getAgencyRemittancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgencyRemittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an agency remittance by ID","tags":["Agency Remittance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/agency-remittances/{id}/acknowledgments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Read, verify and retain the agency's signed acknowledgments of the remittance's submissions. Simulated acknowledgments are refused outside the local environment. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postAgencyRemittancesIdAcknowledgments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgencyRemittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read, verify and retain the agency's signed acknowledgments of the remittance's submissions","tags":["Agency Remittance"]}},"/agency-remittances/{id}/reconciliations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Reconcile the remittance to its payable sources, its transmitted message, the native ledger's booked cash and the agency's confirming acknowledgments. Matched means every source allocation is settled, the message carries that amount and the agency confirmed that amount. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postAgencyRemittancesIdReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgencyReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile the remittance to its payable sources, its transmitted message, the native ledger's booked cash and the agency's acknowledgments, retaining a new version when the result changed","tags":["Agency Remittance"]}},"/agency-remittances/{id}/submissions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Hand the issued remittance's exact transmitted agency message to its agency through the configured adapter. A retry after a lost response recovers under the same submission reference. Deployed payments with AGENCY_ADAPTER=unconfigured refuses the hand-off and the remittance stays issued. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postAgencyRemittancesIdSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgencyRemittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hand the issued remittance's exact transmitted agency message to its agency through the configured adapter, recovering a lost response under the same submission reference","tags":["Agency Remittance"]}},"/agency-tax-deposits":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Compute the federal tax deposit periods, due dates and unpaid amounts for an approved EFTPS recipient's form and tax year. This read does not move money. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getAgencyTaxDeposits","parameters":[{"in":"query","name":"recipient_id","schema":{"type":"string"}},{"in":"query","name":"through","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDepositSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all agency tax deposits","tags":["Agency Tax Deposit"]}},"/alerts":{"get":{"description":"List alerts","operationId":"getAlerts","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"subject","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Alert"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all alerts","tags":["Alert"]},"post":{"description":"Raise an alert from another service (a service identity holding compliance:write; Idempotency-Key required); one alert per rule, subject and business date; 201 {id}","operationId":"postAlerts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RaisedAlert"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RaisedAlertID"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an alert","tags":["Alert"]}},"/alerts/{id}":{"get":{"description":"Read an alert","operationId":"getAlertsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an alert by ID","tags":["Alert"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/alerts/{id}/dispose":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAlertsIdDispose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"by":{"type":"string"},"note":{"type":"string"},"status":{"type":"string"}},"required":["by","note","status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide an alert as the verified staff member; clearing and SAR filing wait for a second person","tags":["Alert"]}},"/alerts/{id}/dispositions":{"get":{"operationId":"getAlertsIdDispositions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Disposition"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an alert's immutable decision history","tags":["Alert"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/audit-events":{"get":{"description":"Audit log for a subject","operationId":"getAuditEvents","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"subject","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AuditEvent"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all audit events","tags":["Audit Event"]}},"/audit-log/verify":{"get":{"operationId":"getAuditLogVerify","parameters":[{"in":"query","name":"anchor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditVerification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Walk the audit log's hash chain and report the first break","tags":["Audit Log"]}},"/authorizations":{"get":{"description":"List authorizations","operationId":"getAuthorizations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"card_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Authorization"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all authorizations","tags":["Authorization"]},"post":{"description":" An authorization may carry network_token (token_reference, token_requestor_id, assurance_method, cryptogram_result) when the network detokenized it: the token must map to this card and requestor, be active and unexpired, the channel and merchant within its domain, a wallet token's cryptogram valid, its wallet consent enabled and its own controls met, or the authorization is declined with the token reason (05, 54, 57, 61, 62 or 63). Which token was used and what the check found is retained.","operationId":"postAuthorizations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardsDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an authorization","tags":["Authorization"]}},"/authorizations/expirations":{"post":{"operationId":"postAuthorizationsExpirations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Expire pending authorisations past their merchant-class window","tags":["Authorization"]}},"/authorizations/{id}":{"get":{"description":"Read an authorisation","operationId":"getAuthorizationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an authorization by ID","tags":["Authorization"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/authorizations/{id}/clear":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAuthorizationsIdClear","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"amount":{"format":"int64","type":"integer"}},"required":["amount"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Clear an authorisation (post the purchase)","tags":["Authorization"]}},"/authorizations/{id}/increments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAuthorizationsIdIncrements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Raise an open authorisation (incremental authorisation)","tags":["Authorization"]}},"/authorizations/{id}/merchant-screening":{"get":{"operationId":"getAuthorizationsIdMerchantScreening","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantScreening"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The authorisation's merchant-screening flag from clearing and every screening attempt","tags":["Authorization"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/authorizations/{id}/reverse":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postAuthorizationsIdReverse","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reverse an authorisation","tags":["Authorization"]}},"/bank-records/controls":{"get":{"operationId":"getBankRecordsControls","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List archive controls and actual/pending source preservation acknowledgments with an audited purpose","tags":["Other"]},"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Immediately preserve supported archive evidence or propose reviewed source policy, release or disposition","tags":["Other"]}},"/bank-records/controls/{control}":{"get":{"operationId":"getBankRecordsControlsControl","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained archive control and source acknowledgment evidence","tags":["Other"]},"parameters":[{"in":"path","name":"control","required":true,"schema":{"type":"string"}}]},"/bank-records/controls/{control}/decisions":{"parameters":[{"in":"path","name":"control","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsControlsControlDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide archive policy, retention event, legal hold release or eligible payload disposition","tags":["Other"]}},"/bank-records/controls/{control}/repair":{"parameters":[{"in":"path","name":"control","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsControlsControlRepair","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retry pending source preservation acknowledgments from the actual retained hold/release instructions","tags":["Other"]}},"/bank-records/discoveries":{"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDiscoveries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discovery"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discovery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Freeze an auditable complete discovery result across supported archived sources with retained filters, high-water and chain root","tags":["Other"]}},"/bank-records/discoveries/{discovery}/pages":{"parameters":[{"in":"path","name":"discovery","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDiscoveriesDiscoveryPages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryPage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read complete ordinal discovery pages with captured metadata, current preservation/disposition and immutable access evidence","tags":["Other"]}},"/bank-records/documents":{"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open an evidenced ingest of one full external document or exported email with declared SHA-256, length, custodian and reviewed retention category","tags":["Other"]}},"/bank-records/documents/{document}":{"get":{"operationId":"getBankRecordsDocumentsDocument","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an external document ingest's declared metadata, received parts and archived record with an audited purpose","tags":["Other"]},"parameters":[{"in":"path","name":"document","required":true,"schema":{"type":"string"}}]},"/bank-records/documents/{document}/cancellation":{"parameters":[{"in":"path","name":"document","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDocumentsDocumentCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an incomplete external document ingest and remove its retained parts","tags":["Other"]}},"/bank-records/documents/{document}/completion":{"parameters":[{"in":"path","name":"document","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDocumentsDocumentCompletion","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify every part against the declared length and SHA-256 and archive the document under its current approved schedule","tags":["Other"]}},"/bank-records/documents/{document}/parts":{"parameters":[{"in":"path","name":"document","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsDocumentsDocumentParts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Upload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain one exact 512 KiB encrypted part of an open external document ingest","tags":["Other"]}},"/bank-records/ingests":{"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsIngests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a durable source-verified evidence ingestion under an independently reviewed source retention policy","tags":["Other"]}},"/bank-records/ingests/{ingest}":{"get":{"operationId":"getBankRecordsIngestsIngest","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read complete ingestion custody, source snapshot, verified cursor and completion state","tags":["Other"]},"parameters":[{"in":"path","name":"ingest","required":true,"schema":{"type":"string"}}]},"/bank-records/ingests/{ingest}/attachment-failures":{"parameters":[{"in":"path","name":"ingest","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsIngestsIngestAttachmentFailures","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFailureRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Declare a declared source attachment unretrievable after exhausted transport fetches so the rest of the ingest can complete","tags":["Other"]}},"/bank-records/ingests/{ingest}/pages":{"parameters":[{"in":"path","name":"ingest","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.","operationId":"postBankRecordsIngestsIngestPages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fetch and atomically archive the next actual source page, retaining encrypted contents, provenance and exact custody chain","tags":["Other"]}},"/bank-records/legal-requests":{"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsLegalRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRequestInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRequest"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record legal process with its basis evidence and scope, and open its first production with automatic archive holds","tags":["Other"]}},"/bank-records/legal-requests/{request}":{"get":{"operationId":"getBankRecordsLegalRequestsRequest","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a legal request and its productions with an audited purpose","tags":["Other"]},"parameters":[{"in":"path","name":"request","required":true,"schema":{"type":"string"}}]},"/bank-records/legal-requests/{request}/productions":{"parameters":[{"in":"path","name":"request","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsLegalRequestsRequestProductions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplementalInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open a supplemental production with its own automatic holds once earlier productions are closed","tags":["Other"]}},"/bank-records/productions/{production}":{"get":{"operationId":"getBankRecordsProductionsProduction","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a production's state, holds, collection, required determinations and package summary","tags":["Other"]},"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}]},"/bank-records/productions/{production}/collection":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionCollection","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Freeze the production's archive collection with exact hashes, BSA indicator flags and automatic BSA-confidential exclusions","tags":["Other"]}},"/bank-records/productions/{production}/decisions":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductionDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a sealed production package","tags":["Other"]}},"/bank-records/productions/{production}/determinations":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionDeterminations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Determination"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the evidenced FinCEN or OCC notice determination a withholding basis requires before release","tags":["Other"]}},"/bank-records/productions/{production}/events":{"get":{"operationId":"getBankRecordsProductionsProductionEvents","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProductionEvent"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the production's complete internal hash-chained custody log, including BSA-confidential review decisions","tags":["Other"]},"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}]},"/bank-records/productions/{production}/items":{"get":{"operationId":"getBankRecordsProductionsProductionItems","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductionItemPage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page the frozen collection with reviewer decisions and production numbers","tags":["Other"]},"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}]},"/bank-records/productions/{production}/package":{"get":{"operationId":"getBankRecordsProductionsProductionPackage","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Package"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the sealed manifest and, after independent approval, page the encrypted package parts","tags":["Other"]},"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionPackage","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Number produced items and seal their verified archive content, manifest, privilege log and custody log under a new package key","tags":["Other"]}},"/bank-records/productions/{production}/releases":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Release"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the audited handoff of an approved package to the named counsel and return its package key; nothing is transmitted","tags":["Other"]}},"/bank-records/productions/{production}/review-completion":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionReviewCompletion","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsEvidence"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close review once every flagged item is decided, fixing the determinations release requires","tags":["Other"]}},"/bank-records/productions/{production}/reviews":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductionItem"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withhold one collected item on a stated basis, or clear an item flagged for a BSA indicator","tags":["Other"]}},"/bank-records/productions/{production}/withdrawal":{"parameters":[{"in":"path","name":"production","required":true,"schema":{"type":"string"}}],"post":{"description":"Reviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.","operationId":"postBankRecordsProductionsProductionWithdrawal","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdrawal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Production"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an unapproved production whose process was withdrawn or quashed; its holds stay until independently released","tags":["Other"]}},"/bank-records/records/{record}":{"get":{"operationId":"getBankRecordsRecordsRecord","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read integrity-verified encrypted archive content with fresh dedicated authority and audited purpose","tags":["Other"]},"parameters":[{"in":"path","name":"record","required":true,"schema":{"type":"string"}}]},"/bank-records/records/{record}/attachments/{attachment}/parts/{part}":{"get":{"operationId":"getBankRecordsRecordsRecordAttachmentsAttachmentPartsPart","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartContent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one integrity-verified encrypted content part of a captured attachment or external document with an audited purpose","tags":["Other"]},"parameters":[{"in":"path","name":"record","required":true,"schema":{"type":"string"}},{"in":"path","name":"attachment","required":true,"schema":{"type":"string"}},{"in":"path","name":"part","required":true,"schema":{"type":"string"}}]},"/bank-records/sources":{"get":{"operationId":"getBankRecordsSources","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BankrecordsSource"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List supported archive source projections, configured connections and reviewed retention mappings","tags":["Other"]}},"/bank-repo-programs":{"post":{"description":"Fresh verified staff with ledger:repo:write is required. Retains actual bank legal entity, master ledger/external identity, lender/intermediary identities, cash keys, original custody identity, supported fixed simple interest terms and current reviewed legal/accounting authority. Bank-borrower secured borrowing only; no reverse repo, customer deposit, asset sale, reuse, substitution, automatic renewal or certification is implied. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankRepoPrograms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoProgram"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank repo program","tags":["Bank Repo Program"]}},"/bank-repo-programs/{id}":{"get":{"description":"Verified staff/service with ledger:repo:read reads the retained immutable program and exact independent decision. Bridge authority alone cannot read general programs. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"getBankRepoProgramsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank repo program by ID","tags":["Bank Repo Program"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/bank-repo-programs/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with both ledger:repo:write and ledger:repo:approve is required; the reviewer differs from the maker. The decision binds the exact full program digest. It does not invent lender classification, custody or actual bank cash. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankRepoProgramsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve the exact repo authority and contract evidence","tags":["Bank Repo Program"]}},"/bank-repo-snapshots":{"post":{"description":"Verified staff/service with ledger:repo:read captures immutable current observed repo evidence with requested close-date coverage. This read authority cannot trade, pay money or release collateral. Actor/key replay retains the original source, actual observation date and time, bank legal entity, debt/collateral, exact accounting journals and explicit blockers. Dated accrued interest and original-custodian bid sources must cover the requested close; later current observations do not reconstruct old books. Provider-signed cash remains distinct from independently reconciled actual master-statement evidence. Bridge authority alone grants no all-book capture. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankRepoSnapshots","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"legal_entity":{"type":"string"}},"required":["business_date","legal_entity"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank repo snapshot","tags":["Bank Repo Snapshot"]}},"/bank-repo-snapshots/{id}":{"get":{"description":"Verified staff/service with ledger:repo:read reads the retained immutable source and digest, current observation date separately from requested close coverage, actual journals, debt, full-lot collateral and explicit unresolved readiness blockers. Bridge authority alone cannot read bank-wide source snapshots. Missing or unknown evidence cannot be silently replaced by projected cash, zero default cost or released collateral. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"getBankRepoSnapshotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankrepoSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank repo snapshot by ID","tags":["Bank Repo Snapshot"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/bank-repos":{"post":{"description":"Fresh verified staff with ledger:repo:write is required. Retains exact actor/key/request replay, fixed principal/rate/start/maturity, proceeds use and full original settled AFS Treasury lots. Requires repo repayment before every bill maturity, actual original custody mapping and signed bid valuation. Collateral remains a bank asset; no funds are recognized merely from proposal. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankRepos","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank repo","tags":["Bank Repo"]}},"/bank-repos/{id}":{"get":{"description":"Verified staff/service with ledger:repo:read reads actual instructions, debt, immutable cash and custody proof. A service with ledger:repo:bridge may read only a repo owned by its retained exact cash or original custody bridge identity, never general inventory. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"getBankReposId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank repo by ID","tags":["Bank Repo"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/bank-repos/{id}/accruals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with ledger:repo:write is required. Accrues fixed simple actual/360 or actual/365 interest using cumulative integer cent rounding to the exclusive start of to_date. Closing D requires D+1. Contractual dates never reset to a delayed funding receipt; unknown default accrual is not silently zero. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdAccruals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["to_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accrue fixed contractual interest through an exclusive start-of-day boundary","tags":["Bank Repo"]}},"/bank-repos/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with ledger:repo:write is required. Only an undispatched proposed or approved repo can cancel and release local reservations. Exact cancellation actor and reason are retained for immutable replay. A dispatched borrowing, actual debt or actual custody pledge cannot be canceled into a fictional return of cash or collateral. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel an undispatched bank repo and release only local reservations","tags":["Bank Repo"]}},"/bank-repos/{id}/custody":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified service with ledger:repo:bridge must be the exact original custody bridge. Both the repo-specific pledge/reference and embedded actual custody observation verify against the original bank-securities program keys. Full pledged units remain native bank assets. Actual zero-lien full-lot release can unlock only after exact accounted repayment; a recently received historical zero-lien report cannot prove post-repayment release. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdCustody","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustodyProof"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain original-custodian signed pledge or release of the exact full collateral lot","tags":["Bank Repo"]}},"/bank-repos/{id}/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with ledger:repo:write is required. Rechecks current source authority and exclusive collateral, then durably issues the exact independently reviewed borrowing instruction. A dispatch acknowledgment is not actual cash or custody. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue exact reviewed borrowing after current nonaffiliate and collateral checks","tags":["Bank Repo"]}},"/bank-repos/{id}/funding":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified service with ledger:repo:bridge must be the exact retained cash bridge. Signed actual funding binds the issued command, lender, bank master account, actual statement/line, dates and cash components. The source is retained before automatic supported accounting; authentic late/partial/fee mismatches remain explicit exceptions. Cash and custody are separate facts. Provider signature does not establish independent bank-statement reconciliation. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdFunding","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Funding"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain actual signed master-account funding independently of custody proof","tags":["Bank Repo"]}},"/bank-repos/{id}/repayment":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified service with ledger:repo:bridge must be the exact retained cash bridge. The signed actual bank statement debit binds both the original borrowing and separate cash-reserved repayment instruction. Native accounting reduces proved debt with permanent source protection. Collateral remains reserved until actual original-custodian full release; paid cash alone cannot imply release. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdRepayment","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Repayment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain actual signed repayment while collateral awaits actual custody release","tags":["Bank Repo"]}},"/bank-repos/{id}/repayment-dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with ledger:repo:write is required. Reserves actual available bank master cash when the supported debt is due and issues a separate immutable repayment command binding actual funding, original principal/interest and hold. The initial borrowing cannot authorize an unreserved future debit. Existing proven debt can be reduced despite collateral monitoring exceptions; unsupported changed contract/default amounts refuse. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdRepaymentDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reserve available master cash and issue exact existing-debt repayment","tags":["Bank Repo"]}},"/bank-repos/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with both ledger:repo:write and ledger:repo:approve is required; the reviewer differs from the maker. Rechecks actual current nonaffiliate lender, intermediaries and proceeds beneficiaries, signed bid collateral and governed two-sided coverage. Approval atomically reserves all full lots against another repo, sale or maturity disposition; the exact review digest is retained. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.","operationId":"postBankReposIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review borrowing and atomically reserve every full collateral lot","tags":["Bank Repo"]}},"/bsa-filings":{"post":{"description":"Confidential filing API: dedicated compliance:filings staff scope, actual verified staff identity and no API keys. Writes, approval and export require step-up within five minutes; independent approval binds exact immutable content and successful full schema/business-rule validation. XML/source and actual response bytes are encrypted and excluded from ordinary bank records/audit exports. Preparing, downloading or reporting transmission does not establish FinCEN acceptance; exact complete authenticated acknowledgment and matching transmission correlation are required. Test-environment acknowledgments remain explicitly test-only. Bounded profile: complete CTR/SAR batch XML for the configured native rules ID (CTR v1/v2/v3, SAR v1/v2); joint SARs remain unsupported. Manifest inspection is not complete XSD validation. Choose exactly one native ctr or sar request, or imported xml plus explicit sources. Native CTR profiles are own-account US teller cash (v1), aggregated US custody cash (v2) and the extended cash cut (v3: vault, non-individual titles, non-customer and agent conductors, FX, foreign identity, delivery methods, aggregate indicator and FinCEN-directed backfiling). Native SAR profiles remain the documented v1/v2 shapes. The service derives amounts, account facts and source membership, runs the pinned full XSD1.1 engine and versioned business rules, and retains separate exact-byte validation evidence. Missing facts, unsupported shapes, unavailable runtime or a changed source refuse. Native input and source metadata stay encrypted. Imported XML keeps distinct provenance and requires authenticated external full validation; manifest inspection alone is insufficient. Native approval/release rechecks the financial source, and release reruns the schema engine.","operationId":"postBsaFilings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrepareRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare encrypted complete FinCEN batch bytes with frozen alert sources for independent review","tags":["Other"]}},"/bsa-filings/continuing-candidates":{"get":{"description":"Confidential elective continuing-activity SAR convention (FinCEN SAR FAQs, October 9, 2025, Questions 2 and 3): no separate post-SAR review is required, and a bank that elects the guidance files after a 90-day period with the deadline 120 calendar days after the previously related SAR filing. Dedicated compliance:filings staff authority; proposals need recent step-up, a future effective date after the current approved version and the exact approved base; a different reviewer approves the exact proposal before it takes effect. With no approved opt-in in force nothing is created. Database admission creates one immutable candidate when a production SAR activity is acknowledged and its authenticated transmission day falls under an elected policy: an initial report's period starts the next day, a native continuing report's the day after the period it continued; corrections, imported continuing activities and test acknowledgments create none. A candidate is not an obligation until a reviewed determination on the continued activity references it. Cursor paging over packet_id:sequence.","operationId":"getBsaFilingsContinuingCandidates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_a42b895f9713"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the complete queue of continuing-activity review clocks created by accepted production SARs","tags":["Other"]}},"/bsa-filings/continuing-candidates/{packet_id}/{sequence}":{"get":{"description":"Confidential elective continuing-activity SAR convention (FinCEN SAR FAQs, October 9, 2025, Questions 2 and 3): no separate post-SAR review is required, and a bank that elects the guidance files after a 90-day period with the deadline 120 calendar days after the previously related SAR filing. Dedicated compliance:filings staff authority; proposals need recent step-up, a future effective date after the current approved version and the exact approved base; a different reviewer approves the exact proposal before it takes effect. With no approved opt-in in force nothing is created. Database admission creates one immutable candidate when a production SAR activity is acknowledged and its authenticated transmission day falls under an elected policy: an initial report's period starts the next day, a native continuing report's the day after the period it continued; corrections, imported continuing activities and test acknowledgments create none. A candidate is not an obligation until a reviewed determination on the continued activity references it. Cursor paging over packet_id:sequence.","operationId":"getBsaFilingsContinuingCandidatesPacket_idSequence","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingCandidateView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one verified continuing-activity clock and the determinations that reference it","tags":["Other"]},"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}]},"/bsa-filings/continuing-policy":{"get":{"description":"Confidential elective continuing-activity SAR convention (FinCEN SAR FAQs, October 9, 2025, Questions 2 and 3): no separate post-SAR review is required, and a bank that elects the guidance files after a 90-day period with the deadline 120 calendar days after the previously related SAR filing. Dedicated compliance:filings staff authority; proposals need recent step-up, a future effective date after the current approved version and the exact approved base; a different reviewer approves the exact proposal before it takes effect. With no approved opt-in in force nothing is created. Database admission creates one immutable candidate when a production SAR activity is acknowledged and its authenticated transmission day falls under an elected policy: an initial report's period starts the next day, a native continuing report's the day after the period it continued; corrections, imported continuing activities and test acknowledgments create none. A candidate is not an obligation until a reviewed determination on the continued activity references it. Cursor paging over packet_id:sequence.","operationId":"getBsaFilingsContinuingPolicy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingPolicyView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the reviewed elective continuing-activity SAR policy history and the version in force","tags":["Other"]}},"/bsa-filings/continuing-policy/versions":{"post":{"description":"Confidential elective continuing-activity SAR convention (FinCEN SAR FAQs, October 9, 2025, Questions 2 and 3): no separate post-SAR review is required, and a bank that elects the guidance files after a 90-day period with the deadline 120 calendar days after the previously related SAR filing. Dedicated compliance:filings staff authority; proposals need recent step-up, a future effective date after the current approved version and the exact approved base; a different reviewer approves the exact proposal before it takes effect. With no approved opt-in in force nothing is created. Database admission creates one immutable candidate when a production SAR activity is acknowledged and its authenticated transmission day falls under an elected policy: an initial report's period starts the next day, a native continuing report's the day after the period it continued; corrections, imported continuing activities and test acknowledgments create none. A candidate is not an obligation until a reviewed determination on the continued activity references it. Cursor paging over packet_id:sequence.","operationId":"postBsaFilingsContinuingPolicyVersions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingPolicyProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingPolicyView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose opting in to or out of the elective continuing-activity SAR timeline from a future date","tags":["Other"]}},"/bsa-filings/continuing-policy/versions/{version}/reviews":{"parameters":[{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential elective continuing-activity SAR convention (FinCEN SAR FAQs, October 9, 2025, Questions 2 and 3): no separate post-SAR review is required, and a bank that elects the guidance files after a 90-day period with the deadline 120 calendar days after the previously related SAR filing. Dedicated compliance:filings staff authority; proposals need recent step-up, a future effective date after the current approved version and the exact approved base; a different reviewer approves the exact proposal before it takes effect. With no approved opt-in in force nothing is created. Database admission creates one immutable candidate when a production SAR activity is acknowledged and its authenticated transmission day falls under an elected policy: an initial report's period starts the next day, a native continuing report's the day after the period it continued; corrections, imported continuing activities and test acknowledgments create none. A candidate is not an obligation until a reviewed determination on the continued activity references it. Cursor paging over packet_id:sequence.","operationId":"postBsaFilingsContinuingPolicyVersionsVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingPolicyReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuingPolicyView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact continuing policy proposal before it takes effect","tags":["Other"]}},"/bsa-filings/corrections":{"get":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"getBsaFilingsCorrections","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_3f0c64ab2dd9"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the confidential queue of corrected and amended report obligations on accepted production filings","tags":["Other"]}},"/bsa-filings/corrections/{packet_id}/{sequence}":{"get":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"getBsaFilingsCorrectionsPacket_idSequence","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one correction obligation, its predecessor's BSA identifier and warnings, determinations and correction packets","tags":["Other"]},"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"postBsaFilingsCorrectionsPacket_idSequence","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a correction candidate for an accepted production activity without asserting an error or a clock","tags":["Other"]}},"/bsa-filings/corrections/{packet_id}/{sequence}/documents":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"postBsaFilingsCorrectionsPacket_idSequenceDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationDocumentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain confidential review access before returning the exact encrypted correction basis","tags":["Other"]}},"/bsa-filings/corrections/{packet_id}/{sequence}/links":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"postBsaFilingsCorrectionsPacket_idSequenceLinks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationLinkRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bind an approved correction determination to the production packet correcting the predecessor's exact BSA identifier","tags":["Other"]}},"/bsa-filings/corrections/{packet_id}/{sequence}/versions":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"postBsaFilingsCorrectionsPacket_idSequenceVersions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an evidenced corrected-or-amended report determination against the exact accepted predecessor","tags":["Other"]}},"/bsa-filings/corrections/{packet_id}/{sequence}/versions/{version}/reviews":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential corrected and amended report obligations on an accepted production CTR or SAR activity, keyed by the predecessor packet and activity sequence, with dedicated compliance:filings staff authority and recent step-up for controls and export. A production acknowledgment carrying warnings, a packet-level correction or explicit staff action records a candidate; none asserts an error or a clock. Test acceptances, rejections and unacknowledged packets are refused. A different reviewer approves each evidenced determination. Only primary_error_notification has a due date: 30 calendar days after the acknowledgment day, as FinCEN's CTR 1.8 and SAR 1.6 XML guides (Attachment B) recommend; errors_discovered and additional_data_discovered are tracked with due_date_rule no_fincen_due_date. The software does not classify FinCEN error codes. A link needs a production packet naming the predecessor and its exact BSA identifier.","operationId":"postBsaFilingsCorrectionsPacket_idSequenceVersionsVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact correction determination","tags":["Other"]}},"/bsa-filings/corrective-actions":{"get":{"operationId":"getBsaFilingsCorrectiveActions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the confidential corrective-action queue of accepted activities carrying acknowledgment warnings","tags":["Other"]}},"/bsa-filings/corrective-actions/{packet_id}/{sequence}":{"get":{"operationId":"getBsaFilingsCorrectiveActionsPacket_idSequence","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one queued corrective action and its retained warning classifications","tags":["Other"]},"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"sequence","required":true,"schema":{"type":"string"}}]},"/bsa-filings/information-requests":{"get":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"getBsaFilingsInformationRequests","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_2a54db6c980c"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List complete confidential request custody and reviewed search-plan status","tags":["Other"]},"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain authenticated confidential 314(a) request originals and exact extracted search instructions","tags":["Other"]}},"/bsa-filings/information-requests/source-authorizations/verify":{"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsSourceAuthorizationsVerify","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Information314Proof"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Information314Authorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify only the exact approved source query for the actual compliance service","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}":{"get":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"getBsaFilingsInformationRequestsRequest_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read confidential request custody and independent plan history","tags":["Other"]},"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/information-requests/{request_id}/documents":{"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsRequest_idDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationDocumentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Audit confidential original, plan or reviewed handoff access; a no-match handoff exists only for a complete search and nothing here transmits","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/plans":{"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsRequest_idPlans","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationPlanRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record original-to-manifest review evidence before independent search approval","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/plans/{version}/reviews":{"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsRequest_idPlansVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide the exact authentic original and extracted request plan","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/portal/pull":{"get":{"operationId":"getBsaFilingsInformationRequestsRequest_idPortalPull","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the request's retained 314(a) list download","tags":["Other"]},"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsInformationRequestsRequest_idPortalPull","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download one 314(a) subject list from the portal simulator and retain its provenance bound to the request","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/portal/reports":{"get":{"operationId":"getBsaFilingsInformationRequestsRequest_idPortalReports","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the request's retained 314(a) positive-match reports","tags":["Other"]},"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsInformationRequestsRequest_idPortalReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report a reviewed search's independent positive matches to the 314(a) portal simulator","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/searches":{"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsRequest_idSearches","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationSearch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture request-bound native customer, deposit account, transaction and credit account cuts with durable recovery and explicit coverage holes","tags":["Other"]}},"/bsa-filings/information-requests/{request_id}/searches/{search_id}":{"get":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"getBsaFilingsInformationRequestsRequest_idSearchesSearch_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationSearch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained source cuts and independently reviewed match evidence, one page of evidence items at a time","tags":["Other"]},"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/information-requests/{request_id}/searches/{search_id}/reviews":{"parameters":[{"in":"path","name":"request_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postBsaFilingsInformationRequestsRequest_idSearchesSearch_idReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationMatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InformationSearch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review actual subject candidates (a customer, or an account or transaction reached through the subject's own identifiers) against exact retained native source evidence","tags":["Other"]}},"/bsa-filings/obligations":{"get":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"getBsaFilingsObligations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_36d9366bbf96"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the confidential complete filing candidate queue without inventing legal deadlines","tags":["Other"]}},"/bsa-filings/obligations/{form}/{alert_id}":{"get":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"getBsaFilingsObligationsFormAlert_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable reviewed legal clock history and actual packet status","tags":["Other"]},"parameters":[{"in":"path","name":"form","required":true,"schema":{"type":"string"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"postBsaFilingsObligationsFormAlert_id","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an additional filing candidate for an actual source without declaring a legal obligation","tags":["Other"]}},"/bsa-filings/obligations/{form}/{alert_id}/documents":{"parameters":[{"in":"path","name":"form","required":true,"schema":{"type":"string"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"postBsaFilingsObligationsFormAlert_idDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationDocumentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain confidential review access before returning the exact encrypted legal basis","tags":["Other"]}},"/bsa-filings/obligations/{form}/{alert_id}/links":{"parameters":[{"in":"path","name":"form","required":true,"schema":{"type":"string"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"postBsaFilingsObligationsFormAlert_idLinks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationLinkRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bind an independently reviewed obligation to actual matching prepared filing evidence","tags":["Other"]}},"/bsa-filings/obligations/{form}/{alert_id}/versions":{"parameters":[{"in":"path","name":"form","required":true,"schema":{"type":"string"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"postBsaFilingsObligationsFormAlert_idVersions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an evidenced legal determination or correction against the exact current source","tags":["Other"]}},"/bsa-filings/obligations/{form}/{alert_id}/versions/{version}/reviews":{"parameters":[{"in":"path","name":"form","required":true,"schema":{"type":"string"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential BSA legal-clock workflow, dedicated existing compliance:filings staff authority and recent step-up for controls/export. Candidate alerts and actual packet sources do not establish reportability or a legal trigger. CTR uses actual source date plus 15 calendar days; SAR requires an explicitly reviewed initial-detection date plus 30, with a supported initially-unknown-suspect extension at most 60. A SAR determination may instead reference an actual continuing-activity candidate: its trigger is the prior accepted filing date, the source must fall inside the candidate's 90-day review period and the deadline is the candidate's 120 calendar days (fincen-sar-continuing-activity-clocks-2026-09-14.v1). Independent exact review is required for legal determinations and corrections. Linked packets must have matching actual form/source and report lineage (a continuing clock links only its candidate's continuing report) and production authenticated acceptance; acknowledgment date never supplies the legal trigger. Complete form-filtered cursor queue retains overdue, rejected, unfiled, source-change and late-acceptance evidence. Legal basis remains encrypted and excluded from general discovery; no external transmission.","operationId":"postBsaFilingsObligationsFormAlert_idVersionsVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact legal clock determination","tags":["Other"]}},"/bsa-filings/ops-retention":{"get":{"operationId":"getBsaFilingsOpsRetention","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read every scheduled ops record's confidential five-year retention state, holds and dispositions","tags":["Other"]}},"/bsa-filings/ops-retention/holds":{"get":{"operationId":"getBsaFilingsOpsRetentionHolds","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the complete legal hold history over confidential ops records","tags":["Other"]},"post":{"operationId":"postBsaFilingsOpsRetentionHolds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Place an immediate legal hold on named ops records or every ops record","tags":["Other"]}},"/bsa-filings/ops-retention/holds/{hold}":{"get":{"operationId":"getBsaFilingsOpsRetentionHoldsHold","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one ops legal hold and its release history","tags":["Other"]},"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}}]},"/bsa-filings/ops-retention/holds/{hold}/releases":{"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsOpsRetentionHoldsHoldReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose releasing the exact active ops legal hold","tags":["Other"]}},"/bsa-filings/ops-retention/holds/{hold}/releases/{version}/reviews":{"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsOpsRetentionHoldsHoldReleasesVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide an ops hold release; neither the hold's placer nor the release's proposer may approve","tags":["Other"]}},"/bsa-filings/ops-retention/records/{record_id}":{"get":{"operationId":"getBsaFilingsOpsRetentionRecordsRecord_id","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one ops record's retention schedule, covering holds, dispositions and disposal receipts","tags":["Other"]},"parameters":[{"in":"path","name":"record_id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/ops-retention/records/{record_id}/dispositions":{"parameters":[{"in":"path","name":"record_id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsOpsRetentionRecordsRecord_idDispositions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose destroying an ops record's confidential documents after its five-year period","tags":["Other"]}},"/bsa-filings/ops-retention/records/{record_id}/dispositions/{version}/reviews":{"parameters":[{"in":"path","name":"record_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsOpsRetentionRecordsRecord_idDispositionsVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide an ops disposition; approval destroys only the confidential documents and retains receipts","tags":["Other"]}},"/bsa-filings/retention":{"get":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"getBsaFilingsRetention","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_04a25272ac3a"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read every filing packet's confidential five-year retention schedule, holds and disposition state","tags":["Other"]}},"/bsa-filings/retention/holds":{"get":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"getBsaFilingsRetentionHolds","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List_3070f9f5a4f7"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the complete legal hold history over confidential filing records","tags":["Other"]},"post":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"postBsaFilingsRetentionHolds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionHoldRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Place an immediate legal hold on named filing packets or every filing record","tags":["Other"]}},"/bsa-filings/retention/holds/{hold}":{"get":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"getBsaFilingsRetentionHoldsHold","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one legal hold and its release history","tags":["Other"]},"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}}]},"/bsa-filings/retention/holds/{hold}/releases":{"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"postBsaFilingsRetentionHoldsHoldReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionReleaseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose releasing the exact active legal hold","tags":["Other"]}},"/bsa-filings/retention/holds/{hold}/releases/{version}/reviews":{"parameters":[{"in":"path","name":"hold","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"postBsaFilingsRetentionHoldsHoldReleasesVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a hold release; neither the hold's placer nor the release's proposer may approve","tags":["Other"]}},"/bsa-filings/retention/{packet_id}":{"get":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"getBsaFilingsRetentionPacket_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one filing packet's retention schedule, covering holds, dispositions and disposal receipts","tags":["Other"]},"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/retention/{packet_id}/dispositions":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"postBsaFilingsRetentionPacket_idDispositions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionDispositionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose destroying an accepted filing's encrypted documents after its five-year period","tags":["Other"]}},"/bsa-filings/retention/{packet_id}/dispositions/{version}/reviews":{"parameters":[{"in":"path","name":"packet_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.","operationId":"postBsaFilingsRetentionPacket_idDispositionsVersionReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a disposition; approval destroys only the encrypted documents and retains receipts","tags":["Other"]}},"/bsa-filings/transport/{id}":{"get":{"operationId":"getBsaFilingsTransportId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a packet's retained SDTM file-exchange record","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/transport/{id}/classify":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsTransportIdClassify","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Classify the retained acknowledgment's warnings and enqueue corrective actions","tags":["Other"]}},"/bsa-filings/transport/{id}/submit":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaFilingsTransportIdSubmit","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Put a released packet's exact batch into the SDTM simulator and retain the complete file exchange","tags":["Other"]}},"/bsa-filings/{id}":{"get":{"description":"Confidential filing API: dedicated compliance:filings staff scope, actual verified staff identity and no API keys. Writes, approval and export require step-up within five minutes; independent approval binds exact immutable content and successful full schema/business-rule validation. XML/source and actual response bytes are encrypted and excluded from ordinary bank records/audit exports. Preparing, downloading or reporting transmission does not establish FinCEN acceptance; exact complete authenticated acknowledgment and matching transmission correlation are required. Test-environment acknowledgments remain explicitly test-only. Bounded profile: complete CTR/SAR batch XML for the configured native rules ID (CTR v1/v2/v3, SAR v1/v2); joint SARs remain unsupported. Manifest inspection is not complete XSD validation.","operationId":"getBsaFilingsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a confidential filing and its exact validation, release and response state","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/bsa-filings/{id}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential filing API: dedicated compliance:filings staff scope, actual verified staff identity and no API keys. Writes, approval and export require step-up within five minutes; independent approval binds exact immutable content and successful full schema/business-rule validation. XML/source and actual response bytes are encrypted and excluded from ordinary bank records/audit exports. Preparing, downloading or reporting transmission does not establish FinCEN acceptance; exact complete authenticated acknowledgment and matching transmission correlation are required. Test-environment acknowledgments remain explicitly test-only. Bounded profile: complete CTR/SAR batch XML for the configured native rules ID (CTR v1/v2/v3, SAR v1/v2); joint SARs remain unsupported. Manifest inspection is not complete XSD validation.","operationId":"postBsaFilingsIdCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel an unreleased filing, retaining source lineage for a replacement","tags":["Other"]}},"/bsa-filings/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential filing API: dedicated compliance:filings staff scope, actual verified staff identity and no API keys. Writes, approval and export require step-up within five minutes; independent approval binds exact immutable content and successful full schema/business-rule validation. XML/source and actual response bytes are encrypted and excluded from ordinary bank records/audit exports. Preparing, downloading or reporting transmission does not establish FinCEN acceptance; exact complete authenticated acknowledgment and matching transmission correlation are required. Test-environment acknowledgments remain explicitly test-only. Bounded profile: complete CTR/SAR batch XML for the configured native rules ID (CTR v1/v2/v3, SAR v1/v2); joint SARs remain unsupported. Manifest inspection is not complete XSD validation.","operationId":"postBsaFilingsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide the exact validated filing","tags":["Other"]}},"/bsa-filings/{id}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential filing API: dedicated compliance:filings staff scope, actual verified staff identity and no API keys. Writes, approval and export require step-up within five minutes; independent approval binds exact immutable content and successful full schema/business-rule validation. XML/source and actual response bytes are encrypted and excluded from ordinary bank records/audit exports. Preparing, downloading or reporting transmission does not establish FinCEN acceptance; exact complete authenticated acknowledgment and matching transmission correlation are required. Test-environment acknowledgments remain explicitly test-only. Bounded profile: complete CTR/SAR batch XML for the configured native rules ID (CTR v1/v2/v3, SAR v1/v2); joint SARs remain unsupported. Manifest inspection is not complete XSD validation. A native v2 SAR support document (one CSV of at most one megabyte) is a separate encrypted payload: its review access and the batch's submission release require its exact attachment_sha256, and the release returns the batch with the attachment and its <SeqNum>_<OriginalAttachmentFileName> name for the attachment zip file. Imported XML naming an attachment is refused. Documents destroyed under an approved retention disposition are refused.","operationId":"postBsaFilingsIdDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Audit confidential document access before release; submission handoff requires independent approval","tags":["Other"]}},"/bsa-filings/{id}/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only actual svc_bsa_bridge with compliance:filings:bridge, no API key, and a valid current purpose-specific Ed25519 signature may admit new validator/transmission/response evidence. Signed payload binds environment, exact prepared batch, receipt/document hash, correlation and times. Exact already-admitted retry survives signing-key retirement; changed evidence refuses. Parsing acknowledgment alone establishes neither authenticity nor production acceptance. An external validation receipt cannot substitute for a native packet's retained service-generated schema and business-rule proof.","operationId":"postBsaFilingsIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Packet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain authenticated validator or actual transmission/FinCEN response bytes from the dedicated bridge","tags":["Other"]}},"/bsa-parameters":{"get":{"description":"The CTR exemption and 314(b) parameters in force on a business date (today by default) and their change history","operationId":"getBsaParameters","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdsView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all BSA parameters","tags":["BSA Parameter"]},"put":{"operationId":"putBsaParameters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdProposal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a BSA parameter change from a later business date; in force once a second person approves it","tags":["BSA Parameter"]}},"/bsa-parameters/proposals/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postBsaParametersProposalsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's BSA parameter proposal (operations:approve), or withdraw your own","tags":["BSA Parameter"]}},"/cards":{"get":{"description":"List cards","operationId":"getCards","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Card"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all cards","tags":["Card"]},"post":{"description":"Issue a card","operationId":"postCards","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a card","tags":["Card"]}},"/cards/3ds/areq":{"post":{"operationId":"postCards3dsAreq","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Answer a directory server's 3-D Secure authentication request (AReq) with an ARes or Erro message","tags":["Card"]}},"/cards/3ds/authentications/{id}":{"get":{"operationId":"getCards3dsAuthenticationsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a 3-D Secure authentication with its challenge messages and value uses","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/3ds/creq":{"post":{"operationId":"postCards3dsCreq","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Answer a 3-D Secure challenge message (CReq) with a CRes or Erro message","tags":["Card"]}},"/cards/3ds/enrollment-proposals/{id}":{"get":{"operationId":"getCards3dsEnrollmentProposalsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a 3-D Secure enrollment proposal and its decision","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/3ds/enrollment-proposals/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCards3dsEnrollmentProposalsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve, reject or withdraw a 3-D Secure enrollment proposal","tags":["Card"]}},"/cards/3ds/maintenance-runs":{"post":{"operationId":"postCards3dsMaintenanceRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Index card numbers, end expired challenges and deliver due challenge results now","tags":["Card"]}},"/cards/atm/device/messages":{"post":{"description":"Requires the verified svc_atmdevice service JWT with cards:atm:device. Body is one CADP1 frame (application/vnd.corgi.atm-device.v1), HMAC-SHA256 MACed. Sequence replay of the exact bytes returns the retained answer. Not NCR NDC.","operationId":"postCardsAtmDeviceMessages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.corgi.atm-device.v1":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/vnd.corgi.atm-device.v1":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Answer one Corgi ATM Device Protocol message from a terminal","tags":["ATM"]}},"/cards/atm/exceptions":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmExceptions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"terminal_ref","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Exception"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the ATM exception queue","tags":["ATM"]}},"/cards/atm/exceptions/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmExceptionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exception"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an ATM exception with its resolutions","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/exceptions/{id}/resolutions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmExceptionsIdResolutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResolution"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose how an ATM exception ends","tags":["ATM"]}},"/cards/atm/journal-uploads/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmJournalUploadsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalUpload"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an uploaded electronic journal and its reconciliation","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/network-settlements":{"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmNetworkSettlements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile a business date against the ATM network's settlement report","tags":["ATM"]}},"/cards/atm/network-settlements/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmNetworkSettlementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an ATM network settlement","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/network-settlements/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmNetworkSettlementsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post an approved ATM network settlement","tags":["ATM"]}},"/cards/atm/network-settlements/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmNetworkSettlementsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an ATM network settlement","tags":["ATM"]}},"/cards/atm/network/messages":{"post":{"description":"Requires the verified svc_atmnetwork service JWT with cards:atm:network. Body is one bank-defined ISO 8583:1987 message (application/vnd.corgi.atm-network.v1) for a card the bank issued at another ATM. Not a certified Pulse or STAR interface.","operationId":"postCardsAtmNetworkMessages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.corgi.atm-network.v1":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/vnd.corgi.atm-network.v1":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Answer one shared ATM network message for a card the bank issued","tags":["ATM"]}},"/cards/atm/replenishments":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmReplenishments","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Replenishment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List replenishment orders","tags":["ATM"]}},"/cards/atm/replenishments/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmReplenishmentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Replenishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a replenishment order","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/replenishments/{id}/updates":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The armored-carrier module records scheduled, completed or cancelled progress under cards:atm:replenishment. Completed updates name the accounts custody movement that loaded the unit. The switch does not move vault cash itself.","operationId":"postCardsAtmReplenishmentsIdUpdates","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplenishmentUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Replenishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the carrier's progress on a replenishment order","tags":["ATM"]}},"/cards/atm/resolutions/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmResolutionsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Carry out an approved ATM exception resolution","tags":["ATM"]}},"/cards/atm/resolutions/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmResolutionsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an ATM exception resolution","tags":["ATM"]}},"/cards/atm/terminal-configurations/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTerminalConfigurationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalConfig"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an ATM configuration version and its review","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/terminal-configurations/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmTerminalConfigurationsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalConfig"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an ATM configuration version","tags":["ATM"]}},"/cards/atm/terminals":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTerminals","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Terminal"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List boarded ATMs with their live state","tags":["ATM"]},"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmTerminals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Terminal"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Terminal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Board an ATM on its custody unit for independent review","tags":["ATM"]}},"/cards/atm/terminals/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTerminalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Terminal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one ATM's configuration and state","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/terminals/{id}/cash-reconciliations":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTerminalsIdCashReconciliations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CashReconciliation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List an ATM's counters reconciliations against its custody ledger","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/terminals/{id}/commands":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmTerminalsIdCommands","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtmCommandRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtmCommand"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtmCommand"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Queue a command for an ATM: in or out of service, counters, journal or configuration","tags":["ATM"]}},"/cards/atm/terminals/{id}/configurations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmTerminalsIdConfigurations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalConfig"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalConfig"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a new configuration version for an ATM","tags":["ATM"]}},"/cards/atm/terminals/{id}/replenishments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmTerminalsIdReplenishments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"evidence":{"type":"string"}},"required":["evidence"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Replenishment"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Replenishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask the armored carrier module to replenish an ATM","tags":["ATM"]}},"/cards/atm/transactions":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTransactions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"terminal_ref","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AtmTransaction"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List ATM transactions","tags":["ATM"]}},"/cards/atm/transactions/{id}":{"get":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"getCardsAtmTransactionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtmTransaction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one ATM transaction and its outcome","tags":["ATM"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/atm/work-passes":{"post":{"description":"Verified ATM operations staff with cards:atm:read on reads and cards:atm:write plus authentication within five minutes on writes; an independent reviewer holding cards:atm:approve decides configurations, exception resolutions and network settlements. Device messages require svc_atmdevice with cards:atm:device; network messages require svc_atmnetwork with cards:atm:network; replenishment updates admit the carrier's cards:atm:replenishment identity. The general cards:read and cards:write scopes do not open the switch. CADP1 is a bank-defined NDC-style cycle, not NCR NDC. The network link is a bank-defined ISO 8583:1987 subset, not a certified Pulse or STAR interface. Software PIN work is refused in production. Surcharges on cards other banks issued are disclosed on screen (12 CFR 1005.16). Cash posts to the terminal's ATM custody unit on GL 1020. See services/cards/atm/README.md.","operationId":"postCardsAtmWorkPasses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPass"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run one ATM pass: age unanswered dispenses, finish postings and deliver queued reversals","tags":["ATM"]}},"/cards/cardholders/authorities":{"get":{"description":"List cardholder authority evidence","operationId":"getCardsCardholdersAuthorities","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CardholderAuthority"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all cardholder authorities","tags":["Cardholder Authority"]},"post":{"description":"Propose evidenced cardholder authority or legacy binding","operationId":"postCardsCardholdersAuthorities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthorityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthority"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a cardholder authority","tags":["Cardholder Authority"]}},"/cards/cardholders/authorities/{id}":{"get":{"description":"Read cardholder authority evidence","operationId":"getCardsCardholdersAuthoritiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a cardholder authority by ID","tags":["Cardholder Authority"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/cardholders/authorities/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsCardholdersAuthoritiesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review cardholder authority","tags":["Cardholder Authority"]}},"/cards/cardholders/authorities/{id}/revocations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsCardholdersAuthoritiesIdRevocations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderRevocationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardholderAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke delegated cardholder authority","tags":["Cardholder Authority"]}},"/cards/clearing-exceptions":{"get":{"operationId":"getCardsClearingExceptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Clearings posted against an account or facility that could not carry them","tags":["Card"]}},"/cards/clearing/exceptions":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Lists the clearing file exception queue newest first, optionally for one file (file_id), each with its record, status (open, returned, resolved) and every resolution.","operationId":"getCardsClearingExceptions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"file_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ClearingException"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the clearing file exception queue","tags":["Card"]}},"/cards/clearing/exceptions/{id}":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Reads one exception: kind (unknown_card, card_mismatch, refused, duplicate, duplicate_conflict, unmatched_reversal, over_reversal, unmatched_return), direction, amount, the record and its resolutions.","operationId":"getCardsClearingExceptionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingException"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a clearing file exception and its resolutions","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/clearing/exceptions/{id}/resolutions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Proposes how an open exception ends: post (the record to a named card of the same network, through the clearing or refund path), return (an issuer return instruction to the network; its later return credit or debit in a clearing file clears the suspense) or write_off (a debit item the bank absorbs to 5500, only once the file settlement carried it into suspense). A reason and 1 to 50 retained evidence references with lowercase SHA-256 are required. Nothing moves until a different reviewer approves the exact proposal. One pending proposal per exception; refused while a settlement of the exception's file awaits review or application. The same proposal by the same maker under the same key replays.","operationId":"postCardsClearingExceptionsIdResolutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose posting, returning or writing off a clearing file exception","tags":["Card"]}},"/cards/clearing/fetches":{"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Pulls a nonfuture processing date's files for a network from the configured source (CARD_CLEARING_SOURCE: the card clearing simulator locally, or a directory a transfer agent fills) and retains each as an upload would; a file already retained replays. 409 conflict when no source is configured. The source is not network connectivity.","operationId":"postCardsClearingFetches","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/IngestedFile"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fetch a processing date's clearing files from the configured source","tags":["Card"]}},"/cards/clearing/files":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Lists retained files newest first with each file's record dispositions and applied settlement; network and processing_date (YYYY-MM-DD) filter.","operationId":"getCardsClearingFiles","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"network","schema":{"type":"string"}},{"in":"query","name":"processing_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IngestedFile"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained clearing files","tags":["Card"]},"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Delivers a network file by upload as standard padded base64 (at most 16 MiB decoded). The file is decoded in the network's format and validated whole (header, every record, ARN check digits, conversion arithmetic, trailer control totals) or refused whole. A file dated after the bank business date is refused. The network file reference is the identity: the same content again returns the retained file with 200 and replayed true; other content under the same reference is 409 conflict.","operationId":"postCardsClearingFiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingIngestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestedFile"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestedFile"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver a network clearing and settlement file by upload","tags":["Card"]}},"/cards/clearing/files/{id}":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Reads a retained file's header, content digest, source, dispositions (pending, posted, exceptions, fees, return_matched) and applied settlement.","operationId":"getCardsClearingFilesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestedFile"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained clearing file","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/clearing/files/{id}/processing":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Matches and posts every record without a disposition, in file order, through the existing clearing, refund and force post paths. The matching decision is captured before money moves, so a retry after a lost response repeats it. A refusal of the clearing path records the record as an exception; a failure a retry can finish (the ledger or accounts unavailable) stops the run with the records before it disposed, and the next call resumes. Processing a fully disposed file returns processed 0.","operationId":"postCardsClearingFilesIdProcessing","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Match and post a clearing file's records","tags":["Card"]}},"/cards/clearing/files/{id}/records":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Lists the file's records in file order after after_sequence (default 0), limit 1 to 500 (default 100), each with its identity, content digest and immutable disposition: how it matched (authorization, presentment, late_presentment, force_post, refund, reversal, fee, return, exception), the authorization row it posted on and any hold kept for the rest of a multiple clearing.","operationId":"getCardsClearingFilesIdRecords","parameters":[{"in":"query","name":"after_sequence","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecordView"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a clearing file's records with their dispositions","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/clearing/files/{id}/settlements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Proposes a processed file's settlement reconciliation against the evidenced master account movement (reference, lowercase SHA-256 of the retained advice, nonfuture value date, signed amount, positive when the network paid the bank). Every record is categorised (principal, credit, suspense debit or credit, return credit or debit, fee); posted presentments settle in principal batches of at most 250 with their interchange and scheme fees through network finance, and one direct journal carries credits (2310), suspense (2320), matched returns and unattributable interchange (4120) and fees (5500). The categories must add up to the trailer's net settlement and that net must equal the master account movement, or the proposal is 409 conflict. The file settles after its processing date's settlement date is reached, once, and a return credit settles only after the returned exception's own file settled.","operationId":"postCardsClearingFilesIdSettlements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a clearing file's settlement reconciliation to the master account movement","tags":["Card"]}},"/cards/clearing/resolutions/{id}":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Reads a resolution with its review and result.","operationId":"getCardsClearingResolutionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a clearing exception resolution","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/clearing/resolutions/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Carries out the exact approved resolution once; a retry returns the recorded result. A posting the clearing path refuses ends as refused and the exception stays open for another proposal. A posting after the file settled relieves the suspense: a debit through a claimed settlement batch from 2320, a credit by 2320 to 2310. A return retains its instruction before sending it; the acknowledgement is not the money.","operationId":"postCardsClearingResolutionsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply an approved clearing exception resolution","tags":["Card"]}},"/cards/clearing/resolutions/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Requires cards:clearing:write, cards:clearing:approve and a step-up within five minutes; the reviewer differs from the maker and decides the exact content SHA-256. The same review by the same reviewer under the same key replays; a changed one is 422 idempotency_key_reused. An approval requires the exception still open with this proposal its latest.","operationId":"postCardsClearingResolutionsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review a clearing exception resolution","tags":["Card"]}},"/cards/clearing/settlements/{id}":{"get":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Reads a settlement reconciliation: sources, principal chunks with their network finance lines, figures, the direct journal, review and result.","operationId":"getCardsClearingSettlementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a clearing file settlement reconciliation","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/clearing/settlements/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Posts the exact approved settlement once, step by step, each step replaying on retry: the principal batches, the network finance statements (proposed by the settlement's maker, reviewed by its reviewer) and their cash reconciliations, then the direct journal under a captured attempt the ledger fences when its business date passes. A completion lost after the journals commit finishes on retry without posting again.","operationId":"postCardsClearingSettlementsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post an approved clearing file settlement reconciliation","tags":["Card"]}},"/cards/clearing/settlements/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff on the card clearing desk's narrow scopes only: cards:clearing:read for reads, cards:clearing:write with a step-up within five minutes for writes; cards:write does not reach these routes and no service token or API key does. The file formats are bank-defined approximations of the proprietary Visa BASE II, Mastercard IPM and Discover clearing specifications (services/cards/clearing/README.md); a file from the card clearing simulator is simulated, not network traffic. Requires cards:clearing:write, cards:clearing:approve and a step-up within five minutes; the reviewer differs from the maker and decides the exact content SHA-256. The same review by the same reviewer under the same key replays; a changed one is 422 idempotency_key_reused. An approval recomputes the settlement from the file's current dispositions and resolutions and refuses one that changed.","operationId":"postCardsClearingSettlementsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review a clearing file settlement reconciliation","tags":["Card"]}},"/cards/fleet/authorities":{"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetAuthorities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetAuthority"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose independently reviewed fuel driver and vehicle authority","tags":["Card"]}},"/cards/fleet/authorities/{id}":{"get":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"getCardsFleetAuthoritiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained driver and vehicle fuel authority","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/fleet/authorities/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetAuthoritiesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact fleet driver vehicle and policy evidence","tags":["Card"]}},"/cards/fleet/authorities/{id}/revocations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetAuthoritiesIdRevocations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevocationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetAuthority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Immediately revoke fleet authority for new spending","tags":["Card"]}},"/cards/fleet/close-readiness":{"get":{"description":"svc_operations with cards:read or verified cards staff may observe retained uncompleted presentments through date=YYYY-MM-DD. Current source observation, not reconstructed historical balances or proof of external feed completeness. Pending policy exceptions and incomplete local completion block readiness; truncation fails closed.","operationId":"getCardsFleetCloseReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Observe retained actual fuel obligations awaiting accounting","tags":["Card"]}},"/cards/fleet/history":{"get":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract. card_id is required; after_id is an optional prior authority ID. Returns 200 versions ascending, with more for continuation.","operationId":"getCardsFleetHistory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page immutable fleet authority versions for one card","tags":["Card"]}},"/cards/fleet/presentments":{"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetPresentments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain signed measured fuel presentment and policy exceptions","tags":["Card"]}},"/cards/fleet/presentments/{id}":{"get":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"getCardsFleetPresentmentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained fuel lines and actual clearing result","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/fleet/presentments/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetPresentmentsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetApplyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post or recover actual fuel clearing under retained final details","tags":["Card"]}},"/cards/fleet/presentments/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff and fresh step-up for authority changes; independent operations:approve review. Fleet cards require exact signed svc_issuerproc driver/vehicle prompts, approved monetary ceiling and supported USD US fuel terminals. Final measured fuel quantity, tax-inclusive unit price and line totals are separately signed and retained. Out-of-policy final presentments remain pending until independently evidenced exception review; actual obligations cannot be erased by rejecting them. Normal authorization, clearing, force-presentment and increment entry points enforce these bindings. Transport, prompt verification and licensed scheme mapping belong to the issuer processor. See services/cards/fleet/README.md for exact integer units and signature contract.","operationId":"postCardsFleetPresentmentsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presentment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve an exact evidenced fuel posting exception","tags":["Card"]}},"/cards/network-tokens/authorization-requests":{"post":{"description":"Only the network's own token service connector (svc_vts for visa, svc_mdes for mastercard, svc_ddx for discover) holding cards:tokens:network and no API key; cards:write and staff are refused. CARD_NETWORK_TOKEN_CONFIG must enable tokenization. Locally the connector is a VTS, MDES or DDX style simulator; nothing a simulator sends is evidence that a network acted. The request reference is the idempotency key: an identical retry replays the retained event with 200 and replayed true, a changed body under the same reference is idempotency_key_reused. The bank decides from the funding card (active, unexpired, not replaced, holder authority current), the token count, the requestor deny list, card verification results and the token service risk data: approved, declined with every reason, or require_idv with the verification methods offered. Push provisioning names the holder's wallet consent, which must be for this card, requestor and device, enabled, unused and fresh. An unknown pan_token is not_found; a token reference already held is conflict.","operationId":"postCardsNetworkTokensAuthorizationRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworktokensAuthorizationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide a token service's token authorization request: approve, decline or require identification and verification (token service connector only)","tags":["Card"]}},"/cards/network-tokens/command-deliveries":{"post":{"description":"Staff with cards:tokens:write and a fresh step-up run a delivery pass now (the service also delivers every CARD_NETWORK_TOKEN_DELIVERY_INTERVAL). Commands leave in creation order per token; one waiting behind an undelivered command for its token is counted as waiting. A failed delivery is retried under the same command id.","operationId":"postCardsNetworkTokensCommandDeliveries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkTokenDeliveryRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver pending token service commands now (staff)","tags":["Card"]}},"/cards/network-tokens/notifications":{"post":{"description":"Only the network's own token service connector (svc_vts for visa, svc_mdes for mastercard, svc_ddx for discover) holding cards:tokens:network and no API key; cards:write and staff are refused. CARD_NETWORK_TOKEN_CONFIG must enable tokenization. Locally the connector is a VTS, MDES or DDX style simulator; nothing a simulator sends is evidence that a network acted. The request reference is the idempotency key: an identical retry replays the retained event with 200 and replayed true, a changed body under the same reference is idempotency_key_reused. Every notification is retained with its outcome: applied, no_change, stale (older than the last applied, never for a deletion) or refused. occurred_at more than five minutes ahead of the bank clock is validation_failed.","operationId":"postCardsNetworkTokensNotifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworktokensNotification"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a token lifecycle notification from the token service (token service connector only)","tags":["Card"]}},"/cards/network-tokens/proposals":{"get":{"description":"Staff with cards:tokens:read; newest first, pending=true leaves out reviewed proposals; limit and starting_after page.","operationId":"getCardsNetworkTokensProposals","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Proposal"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List network token proposals, newest first (staff)","tags":["Card"]},"post":{"description":"Staff with cards:tokens:write and a fresh step-up propose resuming a bank suspension, replacing a token's controls (both at the token's current sequence) or moving a card's tokens to a replacement card with the same holder, account, facility, network and kind. The Idempotency-Key replays per maker.","operationId":"postCardsNetworkTokensProposals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a resume, a controls change or a card replacement for independent review (staff)","tags":["Card"]}},"/cards/network-tokens/proposals/{id}":{"get":{"description":"Staff with cards:tokens:read.","operationId":"getCardsNetworkTokensProposalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a network token proposal and its review (staff)","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/network-tokens/proposals/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff with cards:tokens:approve, a fresh step-up and a subject different from the maker (403 otherwise) approve or reject against the proposal's content_sha256. An approval applies the change and queues its commands in the same transaction; a proposal that no longer matches the token is conflict and can only be rejected. A reviewed proposal is conflict.","operationId":"postCardsNetworkTokensProposalsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworktokensReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's network token proposal (staff)","tags":["Card"]}},"/cards/network-tokens/tokens":{"get":{"description":"The card's bound holder (verified customer identity) or staff with cards:tokens:read. card_id is required; lists tokens whose funding card is the card now, so a replaced card lists none.","operationId":"getCardsNetworkTokensTokens","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Token"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a card's network tokens for its holder or network token staff","tags":["Card"]}},"/cards/network-tokens/tokens/{id}":{"get":{"description":"The card's bound holder (verified customer identity) or staff with cards:tokens:read. network_status is what the token service reports, issuer_status the bank's own block, effective_status the most restrictive of both; card controls still apply to every token authorization.","operationId":"getCardsNetworkTokensTokensId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a network token's network, issuer and effective status","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/network-tokens/tokens/{id}/commands":{"get":{"description":"Staff with cards:tokens:read. Commands sent to the token service for the token with every delivery attempt; an acknowledgment marked simulated came from a simulator.","operationId":"getCardsNetworkTokensTokensIdCommands","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CommandView"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the commands sent to the token service for a token and every delivery attempt (staff)","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/network-tokens/tokens/{id}/controls":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The bound holder with authentication within five minutes replaces the token's own controls at the current sequence: per transaction and daily limits in minor units, channels within the token domain, blocked MCCs and a valid-until time. Staff change controls only through a proposal.","operationId":"postCardsNetworkTokensTokensIdControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Replace a token's own controls as its holder","tags":["Card"]}},"/cards/network-tokens/tokens/{id}/history":{"get":{"description":"The card's bound holder (verified customer identity) or staff with cards:tokens:read. after_sequence is a nonnegative integer, default zero; at most 200 immutable events in sequence order, more means continue from the last sequence.","operationId":"getCardsNetworkTokensTokensIdHistory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworktokensHistory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a network token's immutable events by sequence","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/network-tokens/tokens/{id}/holder-verifications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The bound holder with authentication within five minutes approves a pending_idv token offered issuer_app verification, at the current sequence; staff cannot verify for the holder.","operationId":"postCardsNetworkTokensTokensIdHolderVerifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderVerificationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve a pending token in the bank app as its holder (issuer_app verification)","tags":["Card"]}},"/cards/network-tokens/tokens/{id}/lifecycle":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The bound holder with authentication within five minutes may suspend, resume their own suspension or delete; staff with cards:tokens:write and a fresh step-up may suspend (taking over a holder suspension as a bank hold) or delete. A bank hold resumes only through an approved proposal. expected_sequence must be the token's current sequence (conflict otherwise); the Idempotency-Key replays per actor. A command for the token service is queued with the change and delivered in order.","operationId":"postCardsNetworkTokensTokensIdLifecycle","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Suspend, resume or delete a token as its holder, or suspend or delete it as staff","tags":["Card"]}},"/cards/network-tokens/verification-attempts":{"post":{"description":"Only the network's own token service connector (svc_vts for visa, svc_mdes for mastercard, svc_ddx for discover) holding cards:tokens:network and no API key; cards:write and staff are refused. CARD_NETWORK_TOKEN_CONFIG must enable tokenization. Locally the connector is a VTS, MDES or DDX style simulator; nothing a simulator sends is evidence that a network acted. The request reference is the idempotency key: an identical retry replays the retained event with 200 and replayed true, a changed body under the same reference is idempotency_key_reused. Checks the code against the latest code sent: verified approves the token, incorrect, expired and locked leave it pending, and the last attempt on the last code declines it. The code is never retained; the event keeps a domain-separated digest to recognise an exact replay.","operationId":"postCardsNetworkTokensVerificationAttempts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeAttemptRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Check the one-time code the cardholder entered in the wallet (token service connector only)","tags":["Card"]}},"/cards/network-tokens/verification-codes":{"post":{"description":"Only the network's own token service connector (svc_vts for visa, svc_mdes for mastercard, svc_ddx for discover) holding cards:tokens:network and no API key; cards:write and staff are refused. CARD_NETWORK_TOKEN_CONFIG must enable tokenization. Locally the connector is a VTS, MDES or DDX style simulator; nothing a simulator sends is evidence that a network acted. The request reference is the idempotency key: an identical retry replays the retained event with 200 and replayed true, a changed body under the same reference is idempotency_key_reused. The token must be pending_idv with the method offered. A six-digit code is sealed and sent to the cardholder through the notifications service (card_token_code_sms or card_token_code_email); it never appears in a response, event or history. At most three codes per token by default.","operationId":"postCardsNetworkTokensVerificationCodes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the cardholder a one-time code by the method they chose in the wallet (token service connector only)","tags":["Card"]}},"/cards/production/bureau-fetches":{"post":{"operationId":"postCardsProductionBureauFetches","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fetch and record the card bureau's acknowledgment and status files","tags":["Card"]}},"/cards/production/bureau-files":{"post":{"operationId":"postCardsProductionBureauFiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver a card bureau acknowledgment or status file","tags":["Card"]}},"/cards/production/bureau-files/{id}":{"get":{"operationId":"getCardsProductionBureauFilesId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a received bureau file and what each record did","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/production/files":{"post":{"operationId":"postCardsProductionFiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Build a production file from the pending orders","tags":["Card"]}},"/cards/production/files/{id}":{"get":{"operationId":"getCardsProductionFilesId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a production file and its submission attempts","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/production/orders":{"post":{"operationId":"postCardsProductionOrders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Order a new, reissued or replacement physical card from the card bureau","tags":["Card"]}},"/cards/production/orders/{id}":{"get":{"operationId":"getCardsProductionOrdersId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a card production order and its events","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/production/pin-events":{"post":{"operationId":"postCardsProductionPinEvents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the PIN service's outcome for a PIN-set session","tags":["Card"]}},"/cards/production/pin-set-sessions":{"post":{"operationId":"postCardsProductionPinSetSessions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open a session to set a card's PIN with the PIN service","tags":["Card"]}},"/cards/production/pin-set-sessions/{id}":{"get":{"operationId":"getCardsProductionPinSetSessionsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a PIN-set session","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/production/runs":{"post":{"operationId":"postCardsProductionRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a bulk expiry renewal or reissue run for independent approval","tags":["Card"]}},"/cards/production/runs/{id}":{"get":{"operationId":"getCardsProductionRunsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a production run and what it did with each candidate","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/production/runs/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsProductionRunsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve, reject or withdraw a production run","tags":["Card"]}},"/cards/production/runs/{id}/executions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsProductionRunsIdExecutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Order the cards of an approved production run","tags":["Card"]}},"/cards/production/submissions":{"post":{"operationId":"postCardsProductionSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the production files due for submission to the card bureau","tags":["Card"]}},"/cards/schemes/actions/{id}":{"get":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"getCardsSchemesActionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact retained action and posting evidence","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/schemes/actions/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesActionsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesApplyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply or recover reviewed bank-only scheme accounting","tags":["Card"]}},"/cards/schemes/actions/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesActionsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review source-bound scheme action and reserved capacity","tags":["Card"]}},"/cards/schemes/cases":{"get":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"getCardsSchemesCases","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SchemesCase"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the latest 200 retained scheme cases","tags":["Card"]},"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesCases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCase"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a source-bound card scheme dispute with signed eligibility evidence","tags":["Card"]}},"/cards/schemes/cases/{id}":{"get":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"getCardsSchemesCasesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read actual scheme state and bank recovery balances","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/schemes/cases/{id}/actions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesCasesIdActions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesActionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAction"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain an outbound instruction, authenticated network fact, cash fact or exact loss allocation","tags":["Card"]}},"/cards/schemes/cases/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesCasesIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesApplyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pin actual original clearing and queue a deadline-bound issuer instruction","tags":["Card"]}},"/cards/schemes/cases/{id}/history":{"get":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities. after_ordinal is a nonnegative integer, default zero. Up to 200 actions return in ordinal order; more indicates another page.","operationId":"getCardsSchemesCasesIdHistory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesHistory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable case instructions, signed facts and accounting results","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/schemes/cases/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified cards staff, fresh step-up on writes and independent operations:approve review. Network and cash proposals additionally require exact svc_issuerproc service authority and a versioned Ed25519 processor receipt under optional CARD_SCHEME_CONFIG. Actual original USD clearing is pinned without consuming settlement reconciliation ownership. Instructions retain dispatch deadlines; only signed exact sequence acknowledgements establish network facts. Case accounting uses 1310 receivable, 2310 payable and 2390 unallocated recovery; actual cash receipts separately move 1010. Allocation exclusively claims the actual completed final consumer dispute loss journal before recovering expense5500; it does not credit the customer again. One live case per original clearing and one pending command per case reserve capacity. Closed network cases do not admit protocol reopening; partial unused original/loss amounts are explicit. Scheme eligibility, licensed reason-specific rules, external cash sourcing and certified transport remain adapter responsibilities.","operationId":"postCardsSchemesCasesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact original clearing and scheme eligibility","tags":["Card"]}},"/cards/schemes/close-readiness":{"get":{"description":"Required date=YYYY-MM-DD is a nonfuture bank posting date. Verified cards staff read authority or exact svc_operations service with cards:read may observe retained non-rejected signed financial facts and prepared bank journals still missing durable completion. The result is a current observation, not a historical network feed reconstruction. Ready is false on applicable blockers or truncated inventory; at most 200 blockers return. External adapter completeness remains a separate close prerequisite.","operationId":"getCardsSchemesCloseReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemesCloseReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Observe retained signed scheme financial facts and unfinished accounting for bank close","tags":["Card"]}},"/cards/security/ceremonies":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod. Optional status=open|complete|approved|rejected|withdrawn.","operationId":"getCardsSecurityCeremonies","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KeyCeremony"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List key ceremonies (optional status)","tags":["Card Security"]},"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"postCardsSecurityCeremonies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeremonyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open a dual-control key ceremony (Idempotency-Key required)","tags":["Card Security"]}},"/cards/security/ceremonies/{id}":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsSecurityCeremoniesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one key ceremony","tags":["Card Security"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/security/ceremonies/{id}/components":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"postCardsSecurityCeremoniesIdComponents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentEntry"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Enter one custodian's clear key component (Idempotency-Key required)","tags":["Card Security"]}},"/cards/security/ceremonies/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"postCardsSecurityCeremoniesIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeremonyDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCeremony"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve, reject or withdraw a ceremony (Idempotency-Key required)","tags":["Card Security"]}},"/cards/security/ceremonies/{id}/exported-block":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsSecurityCeremoniesIdExportedBlock","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportedKeyBlock"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The key block an approved export produced, under the counterparty's zone master key","tags":["Card Security"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/security/hsm":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod. Both adapters identify themselves as simulators.","operationId":"getCardsSecurityHsm","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Info"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The configured HSM adapter (a simulator until a validated device is wired)","tags":["Card Security"]}},"/cards/security/keys":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsSecurityKeys","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SecurityKey"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the card cryptography key registry","tags":["Card Security"]}},"/cards/security/keys/{id}":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsSecurityKeysId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityKey"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one key registry entry","tags":["Card Security"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/settlements":{"post":{"operationId":"postCardsSettlements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardsSettlementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardsSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Settle a business date's cleared purchases with the network","tags":["Card"]}},"/cards/settlements/network-finance":{"get":{"description":"Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.","operationId":"getCardsSettlementsNetworkFinance","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NetworkfinanceRecord"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the latest 200 retained network finance records","tags":["Card"]},"post":{"description":"Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.","operationId":"postCardsSettlementsNetworkFinance","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture source-bound interchange, network fees or actual external cash reconciliation","tags":["Card"]}},"/cards/settlements/network-finance/{id}":{"get":{"description":"Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.","operationId":"getCardsSettlementsNetworkFinanceId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained network finance sources and posting evidence","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/settlements/network-finance/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.","operationId":"postCardsSettlementsNetworkFinanceIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceApplyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post or recover exact independently reviewed network accounting","tags":["Card"]}},"/cards/settlements/network-finance/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified staff cards authority; fresh step-up for writes and independent operations:approve review. Immutable USD processor statement lines bind actual clearing receipts, unique network references and capped reversals. Interchange posts 1310/4120; scheme fees post 5500/2310. Separately reviewed external cash evidence reconciles signed actual cash and optional completed principal settlement; only the adjustment delta moves master cash. Exact journal recovery survives lost acknowledgment. External network transport, invoice authenticity verification and settlement account statement sourcing remain integration responsibilities.","operationId":"postCardsSettlementsNetworkFinanceIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkfinanceRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact network finance sources","tags":["Card"]}},"/cards/settlements/reconciliations":{"get":{"operationId":"getCardsSettlementsReconciliations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SettlementReconciliation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List historical card settlement reconciliations","tags":["Card"]},"post":{"operationId":"postCardsSettlementsReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose explicit historical card settlement membership","tags":["Card"]}},"/cards/settlements/reconciliations/{id}":{"get":{"operationId":"getCardsSettlementsReconciliationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read historical card settlement evidence","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/settlements/reconciliations/{id}/applications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsSettlementsReconciliationsIdApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliationApplicationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fence unposted legacy cash and apply reviewed membership","tags":["Card"]}},"/cards/settlements/reconciliations/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsSettlementsReconciliationsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliationReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact historical settlement evidence","tags":["Card"]}},"/cards/spend/expenses":{"get":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md. account_id is required; optional after_id pages up to 200 immutable records ascending with more for continuation.","operationId":"getCardsSpendExpenses","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page expense evidence for the current authorized business organization","tags":["Card"]},"post":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md.","operationId":"postCardsSpendExpenses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expense"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expense"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain customer receipt allocations against actual posted card sources","tags":["Card"]}},"/cards/spend/expenses/{id}":{"get":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md.","operationId":"getCardsSpendExpensesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expense"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained receipt coding review and export membership","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/spend/expenses/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md.","operationId":"postCardsSpendExpensesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Expense"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact receipt source and customer accounting classifications","tags":["Card"]}},"/cards/spend/exports":{"post":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md.","operationId":"postCardsSpendExports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare one immutable customer accounting artifact from reviewed actual card expenses","tags":["Card"]}},"/cards/spend/exports/{id}":{"get":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md.","operationId":"getCardsSpendExportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact retained accounting artifact without asserting external import","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/spend/exports/{id}/source-status":{"get":{"description":"Verified bank-bound customer PERSON identity with customer scope, session/device and online account organization membership required. Writes require authentication within five minutes; API keys, staff and service impersonation refused. Existing maker/approver/admin roles and amount limits apply. Expense review requires distinct users AND person customer IDs. Pending/approved allocations reserve exact bank-source and receipt totals; duplicate bytes cannot be relabeled. Actual unreversed committed card journals are revalidated. Pre-export coding corrections preserve source/receipt/amount. Immutable customer-expense-json-1 exports contain balanced customer-book entries, exact review/source proofs and unique expense membership. Preparation/download never claims provider delivery/import, and never posts customer expense codes to bank GLs. See services/cards/spend/README.md. Observes current source state separately from the immutable historical artifact; a later bank journal reversal flags affected expense IDs without rewriting a previous export.","operationId":"getCardsSpendExportsIdSourceStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportSourceStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Observe whether an exported bank source was subsequently reversed or changed","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/statement-details":{"get":{"operationId":"getCardsStatementDetails","parameters":[{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Detail"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read payment descriptions for customer statements","tags":["Card"]}},"/cards/switch/advices":{"get":{"operationId":"getCardsSwitchAdvices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Stand-in decisions and network advices the switch posts after answering (cards:read; status=pending, posted, matched, recorded, reversed, held or refused)","tags":["Card"]}},"/cards/switch/advices/runs":{"post":{"operationId":"postCardsSwitchAdvicesRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post pending switch advices now (cards:switch:write, fresh step-up)","tags":["Card"]}},"/cards/switch/advices/{id}":{"get":{"operationId":"getCardsSwitchAdvicesId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one switch advice and its resolutions (cards:read)","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/switch/advices/{id}/resolutions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsSwitchAdvicesIdResolutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose posting or refusing a held switch advice (cards:switch:write, fresh step-up)","tags":["Card"]}},"/cards/switch/exchanges":{"get":{"operationId":"getCardsSwitchExchanges","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Messages the card networks sent the switch and the answers, redacted (cards:read; network and network_ref filter)","tags":["Card"]}},"/cards/switch/exchanges/{id}":{"get":{"operationId":"getCardsSwitchExchangesId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one switch exchange (cards:read)","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/switch/links":{"get":{"operationId":"getCardsSwitchLinks","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Card network links: adapter (simulator), profile, connection, sign-on and last echo (cards:read)","tags":["Card"]}},"/cards/switch/resolutions/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsSwitchResolutionsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another member of staff's resolution (cards:switch:write and cards:switch:approve, fresh step-up), or withdraw your own; an approved post is attempted at once","tags":["Card"]}},"/cards/switch/stand-in-parameters":{"get":{"operationId":"getCardsSwitchStandInParameters","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every version of the bank's stand-in parameters and its decision (cards:read)","tags":["Card"]},"post":{"operationId":"postCardsSwitchStandInParameters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose the next version of the stand-in parameters (cards:switch:write, fresh step-up); in force only once a different member of staff approves","tags":["Card"]}},"/cards/switch/stand-in-parameters/active":{"get":{"operationId":"getCardsSwitchStandInParametersActive","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The stand-in parameters in force (cards:read, or svc_cardnet with cards:switch:network)","tags":["Card"]}},"/cards/switch/stand-in-parameters/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsSwitchStandInParametersIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another member of staff's stand-in parameters (cards:switch:write and cards:switch:approve, fresh step-up), or withdraw your own","tags":["Card"]}},"/cards/wallets/authorizations":{"post":{"description":"Requires the same verified processor identity and signing key. Receipt action authorize, verification cryptogram_verified, and SHA256 of wallets.Transaction must bind the exact USD contactless/ecommerce terms, enrolled token, requestor, device and current lifecycle sequence. Suspended/deleted tokens cannot create a new hold or facility reservation. Authoritative already-committed debit holds can recover through later revocation under their original reference; existing completed authorization replay remains available. Token increments and force presentment without original authorization are explicitly unsupported. Network token issuance, HSM cryptogram verification and scheme certification remain processor integration responsibilities.","operationId":"postCardsWalletsAuthorizations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsAuthorizationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardsDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Authorize using an active token and exact signed cryptogram verification","tags":["Card"]}},"/cards/wallets/events":{"post":{"description":"Requires svc_issuerproc service JWT with cards:write and an Ed25519 signature from the configured current network/requestor key. Signing bytes are the wallets.SigningBytes v1 domain-separated typed JSON with UTC issued_at. Issued receipt must follow consent and be within five minutes (30-second future skew). Exact retained event-reference replay is idempotent; changed receipt, sequence gaps, conflicting token mappings and resurrection fail closed. Activation requires signed issuer_identity_verified external evidence.","operationId":"postCardsWalletsEvents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsEvent"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsEvent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a signed issuer-processor token lifecycle receipt","tags":["Card"]}},"/cards/wallets/tokens":{"get":{"description":"card_id is required. Bound holder customer identity, cards staff or svc_issuerproc authority only. Network and local status remain distinct; effective token status does not override the underlying card, account or facility controls.","operationId":"getCardsWalletsTokens","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WalletsToken"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List card token lifecycle state for its holder or bank authority","tags":["Card"]},"post":{"description":"Only an explicitly bank-bound customer with customer scope, the card's exact holder ID, verified session/device and authentication within five minutes may consent. The card must be active and holder authority current. Requestor and exact terms version/SHA256 must match CARD_WALLET_CONFIG. An empty configuration disables enrollment. Consent identities, session/device hashes and source terms remain immutable; processor activation is separate.","operationId":"postCardsWalletsTokens","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsToken"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsToken"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record verified cardholder consent for a configured token requestor","tags":["Card"]}},"/cards/wallets/tokens/{id}":{"get":{"description":"card_id is required. Bound holder customer identity, cards staff or svc_issuerproc authority only. Network and local status remain distinct; effective token status does not override the underlying card, account or facility controls.","operationId":"getCardsWalletsTokensId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsToken"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained wallet lifecycle and effective status","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/wallets/tokens/{id}/controls":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified holder may suspend, resume or delete using the exact current local sequence. Fresh cards staff may permanently delete only. Core deletion is terminal and immediate; an outbox instruction requests external lifecycle handling but does not assert network deletion. Network resume cannot lift a local suspension.","operationId":"postCardsWalletsTokensIdControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Suspend, resume or permanently disable a wallet token in core","tags":["Card"]}},"/cards/wallets/tokens/{id}/history":{"get":{"description":"Same holder or bank read authority as token reads. after_network_sequence and after_local_sequence are nonnegative integers, default zero. Each stream returns at most 200 immutable records in sequence order; the respective more flag means continue from the last returned sequence. Historical event results describe the outcome at that event, while token contains current observed state.","operationId":"getCardsWalletsTokensIdHistory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletsHistory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable wallet network receipts and local controls by sequence","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}":{"get":{"description":"Read a card","operationId":"getCardsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a card by ID","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}/3ds/authentications":{"get":{"operationId":"getCardsId3dsAuthentications","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a card's 3-D Secure authentications, newest first","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}/3ds/enrollment":{"get":{"operationId":"getCardsId3dsEnrollment","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a card's 3-D Secure enrollment, its changes and proposals","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}/3ds/enrollment/changes":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsId3dsEnrollmentChanges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Change a card's 3-D Secure enrollment as its cardholder","tags":["Card"]}},"/cards/{id}/3ds/enrollment/proposals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsId3dsEnrollmentProposals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a staff change to a card's 3-D Secure enrollment","tags":["Card"]}},"/cards/{id}/activate":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsIdActivate","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Activate a card","tags":["Card"]}},"/cards/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close a card","tags":["Card"]}},"/cards/{id}/controls":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putCardsIdControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Controls"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Replace the card's controls","tags":["Card"]}},"/cards/{id}/pan":{"get":{"operationId":"getCardsIdPan","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reveal the card number (step-up required)","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}/pause":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsIdPause","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pause a card","tags":["Card"]}},"/cards/{id}/personalization":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod. The CVV, CVV2 and iCVV are returned once and never stored.","operationId":"postCardsIdPersonalization","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalizationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalizationResult"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalizationResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bind a card to its verification and issuer master keys and return its codes once","tags":["Card"]}},"/cards/{id}/pin":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsIdPin","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPIN"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A card's PIN verification record without the value","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod. The PIN never leaves the HSM; only the IBM 3624 offset or Visa PVV is stored.","operationId":"postCardsIdPin","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PINRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPIN"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPIN"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set or change a card's PIN from a PIN-pad block","tags":["Card"]}},"/cards/{id}/pin/unlock":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"postCardsIdPinUnlock","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PINUnlockRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPIN"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPIN"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reset a locked PIN's try counter","tags":["Card"]}},"/cards/{id}/production-orders":{"get":{"operationId":"getCardsIdProductionOrders","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the production orders that produce or replace a card","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cards/{id}/report":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsIdReport","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string"}},"required":["status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report a card lost or stolen (optional Idempotency-Key records the report and replays its outcome; the operations service reports on cards:report under its command key, relaying the request id, maker and checker)","tags":["Card"]}},"/cards/{id}/resume":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCardsIdResume","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resume a paused card","tags":["Card"]}},"/cards/{id}/security-binding":{"get":{"description":"Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.","operationId":"getCardsIdSecurityBinding","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSecurityBinding"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The keys personalisation fixed for a card","tags":["Card"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cases":{"get":{"description":"List cases","operationId":"getCases","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Case"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all cases","tags":["Case"]},"post":{"description":"Open a case","operationId":"postCases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"kind":{"type":"string"},"ref":{"type":"string"},"subject":{"type":"string"},"summary":{"type":"string"}},"required":["kind","ref","subject","summary"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Case"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a case","tags":["Case"]}},"/cases/sync-alerts":{"post":{"operationId":"postCasesSyncAlerts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cases_opened":{"format":"int64","type":"integer"}},"required":["cases_opened"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open cases for open compliance alerts","tags":["Case"]}},"/cases/{id}":{"get":{"description":"Read a case","operationId":"getCasesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Case"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a case by ID","tags":["Case"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/cases/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCasesIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"by":{"type":"string"},"outcome":{"type":"string"}},"required":["by","outcome"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Case"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close a case","tags":["Case"]}},"/cases/{id}/notes":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCasesIdNotes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"by":{"type":"string"},"text":{"type":"string"}},"required":["by","text"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Case"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Add a note","tags":["Case"]}},"/cash-operations/atm-replenishments":{"post":{"description":"The ATM switch's Carrier.RequestReplenishment contract. Staff still confirm denominations and a different supervisor decides before vault cash moves. The armoredcarrier simulator is local-only and is not a licensed carrier.","operationId":"postCashOperationsAtmReplenishments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArmoredcarrierReplenishmentOrder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArmoredcarrierCarrierReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accept an ATM switch replenishment order","tags":["Physical Cash"]}},"/cash-operations/carrier-reconciliations":{"post":{"operationId":"postCashOperationsCarrierReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recon"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile armored shipments to a custody unit and the GL","tags":["Physical Cash"]}},"/cash-operations/carriers":{"get":{"operationId":"getCashOperationsCarriers","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Carrier"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List boarded armored carriers","tags":["Physical Cash"]},"post":{"operationId":"postCashOperationsCarriers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Carrier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Board an armored carrier with legal name, contact and evidence","tags":["Physical Cash"]}},"/cash-operations/carriers/{carrier}":{"get":{"operationId":"getCashOperationsCarriersCarrier","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Carrier"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a boarded armored carrier","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"carrier","required":true,"schema":{"type":"string"}}]},"/cash-operations/claims":{"post":{"operationId":"postCashOperationsClaims","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Claim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open a shortage or surplus claim against a sealed shipment","tags":["Physical Cash"]}},"/cash-operations/claims/{claim}":{"get":{"operationId":"getCashOperationsClaimsClaim","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Claim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a discrepancy claim and its review","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"claim","required":true,"schema":{"type":"string"}}]},"/cash-operations/claims/{claim}/decisions":{"parameters":[{"in":"path","name":"claim","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsClaimsClaimDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Claim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a discrepancy claim","tags":["Physical Cash"]}},"/cash-operations/close-readiness":{"get":{"operationId":"getCashOperationsCloseReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Readiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Block daily close for missing counts, variances, unfinished cash postings, open armored shipments or unfinished FedCash instructions","tags":["Physical Cash"]}},"/cash-operations/contracts":{"get":{"operationId":"getCashOperationsContracts","parameters":[{"in":"query","name":"carrier_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Contract"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List armored carrier contracts","tags":["Physical Cash"]},"post":{"operationId":"postCashOperationsContracts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contract"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose dated carrier terms against a vault custody unit","tags":["Physical Cash"]}},"/cash-operations/contracts/{contract}":{"get":{"operationId":"getCashOperationsContractsContract","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contract"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a carrier contract and its independent review","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"contract","required":true,"schema":{"type":"string"}}]},"/cash-operations/contracts/{contract}/decisions":{"parameters":[{"in":"path","name":"contract","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsContractsContractDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contract"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject carrier contract terms","tags":["Physical Cash"]}},"/cash-operations/counts":{"post":{"operationId":"postCashOperationsCounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture denominations and exact authoritative custody ledger source","tags":["Physical Cash"]}},"/cash-operations/counts/{count}":{"get":{"operationId":"getCashOperationsCountsCount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained physical count and discrepancy","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"count","required":true,"schema":{"type":"string"}}]},"/cash-operations/counts/{count}/decisions":{"parameters":[{"in":"path","name":"count","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsCountsCountDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Count"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently attest or reject a physical count","tags":["Physical Cash"]}},"/cash-operations/device-deposits":{"post":{"operationId":"postCashOperationsDeviceDeposits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Credit cash an ATM counted and kept","tags":["Physical Cash"]}},"/cash-operations/device-dispenses":{"post":{"operationId":"postCashOperationsDeviceDispenses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post cash an ATM paid to a card another bank issued against the ATM network receivable","tags":["Physical Cash"]}},"/cash-operations/device-movements/{movement}":{"get":{"operationId":"getCashOperationsDeviceMovementsMovement","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an ATM device cash movement","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"movement","required":true,"schema":{"type":"string"}}]},"/cash-operations/device-reversals":{"post":{"operationId":"postCashOperationsDeviceReversals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return cash to ATM custody after a posted withdrawal or dispense paid out less","tags":["Physical Cash"]}},"/cash-operations/device-units/{unit}":{"get":{"operationId":"getCashOperationsDeviceUnitsUnit","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the ATM custody unit a terminal is boarded on","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"unit","required":true,"schema":{"type":"string"}}]},"/cash-operations/device-withdrawals":{"post":{"operationId":"postCashOperationsDeviceWithdrawals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hold an ATM withdrawal on the account for the ATM switch","tags":["Physical Cash"]}},"/cash-operations/device-withdrawals/{movement}/completion":{"parameters":[{"in":"path","name":"movement","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsDeviceWithdrawalsMovementCompletion","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post what an ATM dispensed for a held withdrawal, or release the hold","tags":["Physical Cash"]}},"/cash-operations/fedcash-shipments":{"post":{"description":"The FedCash module's shipment contract. Kind order is currency or coin into the contract vault; kind deposit leaves the vault for a Reserve Bank office. Staff confirm and a different supervisor decides before GL 1020 moves.","operationId":"postCashOperationsFedcashShipments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedCashOrder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArmoredcarrierCarrierReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accept a FedCash currency order or deposit for physical shipment","tags":["Physical Cash"]}},"/cash-operations/fedcash/catalog":{"get":{"description":"Cash staff. Public 2026 FedCash offices, standard straps/bundles/bags, noon-local order windows and Uniform Cash Access / recirculation fees.","operationId":"getCashOperationsFedcashCatalog","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Published FedCash offices, packing units, windows and 2026 fees","tags":["Physical Cash"]}},"/cash-operations/fedcash/close-readiness":{"get":{"description":"Blocks while a FedCash instruction due on or before the date is unfinished or a statement match awaits review.","operationId":"getCashOperationsFedcashCloseReadiness","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Block close for unfinished FedCash instructions or unreviewed statement matches","tags":["Physical Cash"]}},"/cash-operations/fedcash/discrepancies/{discrepancy}/decisions":{"parameters":[{"in":"path","name":"discrepancy","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashDiscrepanciesDiscrepancyDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discrepancy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review a counted FedCash difference","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions":{"get":{"operationId":"getCashOperationsFedcashInstructions","parameters":[{"in":"query","name":"unit_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CashInstruction"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List FedCash orders and deposits","tags":["Physical Cash"]},"post":{"description":"Cash writer with a recent step-up. Captures an order or deposit against a vault unit; another supervisor must decide it.","operationId":"postCashOperationsFedcashInstructions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstructionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a currency or coin order or deposit for independent review","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions/{instruction}":{"get":{"operationId":"getCashOperationsFedcashInstructionsInstruction","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a FedCash instruction and its review, shipment, receipt and posting","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}]},"/cash-operations/fedcash/instructions/{instruction}/decisions":{"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashInstructionsInstructionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a FedCash instruction","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions/{instruction}/execution":{"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}],"post":{"description":"Posts GL 1020 custody against master cash 1010 and any UCAP or cross-shipping fees to 5410. A counted difference needs independent review first.","operationId":"postCashOperationsFedcashInstructionsInstructionExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post the master-account and GL 1020 movement after receipt","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions/{instruction}/receipt":{"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashInstructionsInstructionReceipt","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashReceiptRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the counted receipt or a Fed difference advice","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions/{instruction}/shipment":{"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashInstructionsInstructionShipment","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hand the physical movement to the armored-carrier module","tags":["Physical Cash"]}},"/cash-operations/fedcash/instructions/{instruction}/submission":{"parameters":[{"in":"path","name":"instruction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashInstructionsInstructionSubmission","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send an approved instruction to the Reserve Bank office","tags":["Physical Cash"]}},"/cash-operations/fedcash/reconciliations":{"post":{"operationId":"postCashOperationsFedcashReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Match a Fed statement line to GL 1010 journals and the GL 1020 custody movement","tags":["Physical Cash"]}},"/cash-operations/fedcash/reconciliations/{reconciliation}/decisions":{"parameters":[{"in":"path","name":"reconciliation","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsFedcashReconciliationsReconciliationDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review a FedCash statement match","tags":["Physical Cash"]}},"/cash-operations/fedcash/statements":{"post":{"operationId":"postCashOperationsFedcashStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashStatementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain a Reserve Bank office cash statement","tags":["Physical Cash"]}},"/cash-operations/fedcash/statements/pulls":{"post":{"operationId":"postCashOperationsFedcashStatementsPulls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"office_code":{"type":"string"}},"required":["business_date","office_code"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pull the office's daily cash statement from the FedCash simulator","tags":["Physical Cash"]}},"/cash-operations/fedcash/statements/{statement}":{"get":{"operationId":"getCashOperationsFedcashStatementsStatement","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained FedCash statement","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"statement","required":true,"schema":{"type":"string"}}]},"/cash-operations/filing-sources":{"get":{"description":"Confidential complete native cash source for one customer and prior banking date. Both query parameters are required. Only the actual authenticated svc_compliance service with accounts:read and no API key is admitted; staff and other services cannot read this projection. Requires settled native teller cash, completed monitoring delivery, unchanged evidenced sole individual ownership and exact unreversed ledger journals. Optional profile cash-custody-v2 returns the custody cut instead: every owner of individual or joint accounts, the titling form, an identified customer conducting for the owner, and teller or ATM units; other titling, vault custody and non-customer conductors refuse. Optional profile cash-custody-v3 returns the extended cut for CTR v3: vault units, every supported titling form, non-customer and agent conductors, delivery methods and foreign-currency cash. Account numbers and conductor identity are confidential. Response uses Cache-Control: no-store; source is excluded from ordinary record discovery. It is source evidence, not a CTR filing or regulatory acknowledgment.","operationId":"getCashOperationsFilingSources","parameters":[{"in":"query","name":"customer_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"business_date","required":true,"schema":{"format":"date","type":"string"}},{"in":"query","name":"profile","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read complete native teller cash evidence only as the compliance service","tags":["Physical Cash"]}},"/cash-operations/invoices":{"post":{"operationId":"postCashOperationsInvoices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a contracted carrier invoice for independent review","tags":["Physical Cash"]}},"/cash-operations/invoices/{invoice}":{"get":{"operationId":"getCashOperationsInvoicesInvoice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a carrier invoice, review and posting","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"invoice","required":true,"schema":{"type":"string"}}]},"/cash-operations/invoices/{invoice}/decisions":{"parameters":[{"in":"path","name":"invoice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsInvoicesInvoiceDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a carrier invoice","tags":["Physical Cash"]}},"/cash-operations/invoices/{invoice}/posting":{"parameters":[{"in":"path","name":"invoice","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsInvoicesInvoicePosting","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post an approved carrier invoice to expense and payable","tags":["Physical Cash"]}},"/cash-operations/movements":{"get":{"operationId":"getCashOperationsMovements","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Movement"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List captured physical cash movements and recovery evidence","tags":["Physical Cash"]},"post":{"operationId":"postCashOperationsMovements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MovementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Movement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare exact physical cash posting for independent review","tags":["Physical Cash"]}},"/cash-operations/movements/{movement}":{"get":{"operationId":"getCashOperationsMovementsMovement","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Movement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read physical cash posting evidence","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"movement","required":true,"schema":{"type":"string"}}]},"/cash-operations/movements/{movement}/decisions":{"parameters":[{"in":"path","name":"movement","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsMovementsMovementDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Movement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a cash movement","tags":["Physical Cash"]}},"/cash-operations/movements/{movement}/execution":{"parameters":[{"in":"path","name":"movement","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsMovementsMovementExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Movement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Commit or recover an independently approved cash movement","tags":["Physical Cash"]}},"/cash-operations/orders":{"get":{"operationId":"getCashOperationsOrders","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CashOrder"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List armored carrier cash orders","tags":["Physical Cash"]},"post":{"operationId":"postCashOperationsOrders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare a scheduled or ad hoc cash order with denomination breakdown","tags":["Physical Cash"]}},"/cash-operations/orders/{order}":{"get":{"operationId":"getCashOperationsOrdersOrder","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a carrier order, confirmation and review","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"order","required":true,"schema":{"type":"string"}}]},"/cash-operations/orders/{order}/confirmations":{"parameters":[{"in":"path","name":"order","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsOrdersOrderConfirmations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Confirm denominations and route before independent review","tags":["Physical Cash"]}},"/cash-operations/orders/{order}/decisions":{"parameters":[{"in":"path","name":"order","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsOrdersOrderDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a confirmed carrier order","tags":["Physical Cash"]}},"/cash-operations/receipt-counts":{"post":{"operationId":"postCashOperationsReceiptCounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptCountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptCount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an independent receiving count","tags":["Physical Cash"]}},"/cash-operations/shipments":{"get":{"operationId":"getCashOperationsShipments","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List armored shipments and their progress","tags":["Physical Cash"]}},"/cash-operations/shipments/{shipment}":{"get":{"operationId":"getCashOperationsShipmentsShipment","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a shipment, sealed manifest and progress","tags":["Physical Cash"]},"parameters":[{"in":"path","name":"shipment","required":true,"schema":{"type":"string"}}]},"/cash-operations/shipments/{shipment}/manifests":{"parameters":[{"in":"path","name":"shipment","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsShipmentsShipmentManifests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record seal numbers on a scheduled shipment","tags":["Physical Cash"]}},"/cash-operations/shipments/{shipment}/progress":{"parameters":[{"in":"path","name":"shipment","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCashOperationsShipmentsShipmentProgress","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgressRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record pickup, transit, delivery or exception","tags":["Physical Cash"]}},"/cash-operations/units":{"get":{"operationId":"getCashOperationsUnits","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Unit"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List physical custody units","tags":["Physical Cash"]},"post":{"operationId":"postCashOperationsUnits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Register a zero-balance physical custody unit","tags":["Physical Cash"]}},"/clearings":{"post":{"operationId":"postClearings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Force-post a clearing presented without an authorisation","tags":["Other"]}},"/close-plan":{"get":{"description":"Read the independently approved scheduled close plan","operationId":"getClosePlan","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveClosePlan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all bank close plans","tags":["Bank Close Plan"]}},"/close-preparations":{"get":{"description":"Read closing-day loan-source capture checkpoints","operationId":"getClosePreparations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CloseRun"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all close preparations","tags":["Close Preparation"]}},"/close-preparations/advance":{"post":{"operationId":"postClosePreparationsAdvance","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"by":{"type":"string"}},"required":["by"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover one preparation step inside the actual before-cutoff window","tags":["Close Preparation"]}},"/close-runs":{"get":{"description":"Read the latest 100 whole-bank close checkpoints","operationId":"getCloseRuns","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CloseRun"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all bank closes","tags":["Bank Close"]}},"/close-runs/advance":{"post":{"description":"Requires operations:write and a staff identity with operations:approve, no API key, and authentication within five minutes. Advances only one step of the oldest due approved close; accepts no date, step or dependency override. A blocked result retains the exact step, the problem code in last_error and the module's own words in last_reason; each attempt record carries its reason when blocked and the admitted source's source_sha256 when the module's source carries one. Idle or disabled scheduling returns an empty run.","operationId":"postCloseRunsAdvance","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"by":{"type":"string"}},"required":["by"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover one step of the oldest due close; fresh staff step-up required","tags":["Bank Close"]}},"/close-runs/{id}":{"get":{"description":"Read a bank close and its latest 200 immutable attempt records","operationId":"getCloseRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank close by ID","tags":["Bank Close"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/complaint-policies":{"post":{"description":"Capture a bank complaint deadline policy","operationId":"postComplaintPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintPolicyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a complaint policy","tags":["Complaint Policy"]}},"/complaint-policies/{policy}":{"get":{"description":"Read retained complaint policy","operationId":"getComplaintPoliciesPolicy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a complaint policy by ID","tags":["Complaint Policy"]},"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}]},"/complaint-policies/{policy}/decide":{"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintPoliciesPolicyDecide","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a complaint policy","tags":["Complaint Policy"]}},"/complaints":{"get":{"description":"List complaint investigations","operationId":"getComplaints","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Complaint"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all complaints","tags":["Complaint"]},"post":{"description":"Record staff-mediated complaint intake","operationId":"postComplaints","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintIntake"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a complaint","tags":["Complaint"]}},"/complaints/escalations":{"post":{"operationId":"postComplaintsEscalations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintEscalationRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Process a bounded deadline escalation batch","tags":["Complaint"]}},"/complaints/report":{"get":{"operationId":"getComplaintsReport","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read complaint management counts and overdue work","tags":["Complaint"]}},"/complaints/{id}":{"get":{"description":"Read complaint investigation","operationId":"getComplaintsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a complaint by ID","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/complaints/{id}/acknowledge":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdAcknowledge","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint acknowledge","tags":["Complaint"]}},"/complaints/{id}/assessments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdAssessments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAssessmentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAssessment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture staff UDAAP assessment and completed remedy evidence","tags":["Complaint"]}},"/complaints/{id}/assessments/{assessment}":{"get":{"operationId":"getComplaintsIdAssessmentsAssessment","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAssessment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained staff assessment","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"assessment","required":true,"schema":{"type":"string"}}]},"/complaints/{id}/assessments/{assessment}/decide":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"assessment","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdAssessmentsAssessmentDecide","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAssessment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a current complaint assessment","tags":["Complaint"]}},"/complaints/{id}/claim":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdClaim","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint claim","tags":["Complaint"]}},"/complaints/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint close","tags":["Complaint"]}},"/complaints/{id}/deliveries":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdDeliveries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDeliveryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain separate paper dispatch or delivery evidence","tags":["Complaint"]}},"/complaints/{id}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintEvidenceRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain complaint evidence bytes","tags":["Complaint"]}},"/complaints/{id}/documents/{document}":{"get":{"operationId":"getComplaintsIdDocumentsDocument","responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download verified retained complaint evidence","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document","required":true,"schema":{"type":"string"}}]},"/complaints/{id}/entries":{"get":{"operationId":"getComplaintsIdEntries","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ComplaintEntry"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable complaint chronology","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/complaints/{id}/escalate":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdEscalate","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint escalate","tags":["Complaint"]}},"/complaints/{id}/note":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdNote","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint note","tags":["Complaint"]}},"/complaints/{id}/policy":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdPolicy","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint policy","tags":["Complaint"]}},"/complaints/{id}/publish":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdPublish","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintPublication"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Publish an approved response and queue its readiness event","tags":["Complaint"]}},"/complaints/{id}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint release","tags":["Complaint"]}},"/complaints/{id}/reopen":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdReopen","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Complaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record complaint reopen","tags":["Complaint"]}},"/complaints/{id}/responses":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdResponses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintResponseRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture exact proposed customer response","tags":["Complaint"]}},"/complaints/{id}/responses/{response}":{"get":{"operationId":"getComplaintsIdResponsesResponse","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained response review","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"response","required":true,"schema":{"type":"string"}}]},"/complaints/{id}/responses/{response}/decide":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"response","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postComplaintsIdResponsesResponseDecide","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve the exact customer response","tags":["Complaint"]}},"/complaints/{id}/responses/{response}/document":{"get":{"operationId":"getComplaintsIdResponsesResponseDocument","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download exact retained response text","tags":["Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"response","required":true,"schema":{"type":"string"}}]},"/counterparties":{"get":{"description":"List a customer's counterparties","operationId":"getCounterparties","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SavedCounterparty"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all counterparties","tags":["Counterparty"]},"post":{"description":"Save a counterparty to pay: a bank account (ACH, instant or wire), an account at this bank (book transfer), a bank abroad named by BIC with an IBAN or account number (international wire), or an address (a mailed check)","operationId":"postCounterparties","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounterpartyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCounterparty"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a counterparty","tags":["Counterparty"]}},"/counterparties/{id}":{"delete":{"description":"Delete a counterparty; schedules that pay it stop at their next run","operationId":"deleteCounterpartiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCounterparty"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Delete a counterparty","tags":["Counterparty"]},"get":{"description":"Read a counterparty","operationId":"getCounterpartiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedCounterparty"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a counterparty by ID","tags":["Counterparty"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/crs-reports":{"get":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"getCrsReports","responses":{"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"CRS XML generation; disabled by default because the United States is not a CRS participating jurisdiction","tags":["Other"]},"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postCrsReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"CRS XML generation; disabled by default because the United States is not a CRS participating jurisdiction","tags":["Other"]}},"/ctr-exemptions":{"get":{"description":"List CTR exemption designations, optionally for one customer","operationId":"getCtrExemptions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"subject","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CTRExemption"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all CTR exemptions","tags":["CTR Exemption"]},"post":{"description":"Propose a CTR exempt-person designation (31 CFR 1020.315) with its eligibility facts and FinCEN 110 filing","operationId":"postCtrExemptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemption"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a CTR exemption","tags":["CTR Exemption"]}},"/ctr-exemptions/{id}":{"get":{"description":"Read a CTR exemption with its decision, reviews, revocation and status","operationId":"getCtrExemptionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemption"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a CTR exemption by ID","tags":["CTR Exemption"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ctr-exemptions/{id}/applications":{"get":{"operationId":"getCtrExemptionsIdApplications","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CTRExemptionApplication"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The cash events on which the exemption kept ctr_required from firing","tags":["CTR Exemption"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ctr-exemptions/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCtrExemptionsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemption"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's designation (operations:approve), or withdraw your own","tags":["CTR Exemption"]}},"/ctr-exemptions/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCtrExemptionsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemptionReviewRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemptionReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the annual eligibility review of a Phase II exemption","tags":["CTR Exemption"]}},"/ctr-exemptions/{id}/revoke":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCtrExemptionsIdRevoke","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reasonBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CTRExemption"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke a CTR exemption from today's business date","tags":["CTR Exemption"]}},"/customer-groups":{"get":{"description":"List groups","operationId":"getCustomerGroups","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all customer groups","tags":["Customer Group"]},"post":{"description":"Open a multi-entity group: a parent business and the subsidiaries or affiliates under it; money moves between members as inter-entity transfers","operationId":"postCustomerGroups","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewGroup"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a customer group","tags":["Customer Group"]}},"/customer-groups/{id}":{"get":{"description":"Read a group with its members","operationId":"getCustomerGroupsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a customer group by ID","tags":["Customer Group"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customer-groups/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomerGroupsIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close a group and release its members","tags":["Customer Group"]}},"/customer-groups/{id}/members":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomerGroupsIdMembers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMemberRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Add a business to a group","tags":["Customer Group"]}},"/customer-groups/{id}/members/{customer_id}":{"delete":{"operationId":"deleteCustomerGroupsIdMembersCustomer_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Take a business out of a group (the parent stays)","tags":["Customer Group"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}}]},"/customers":{"get":{"description":"Find customers by email or tax id (staff); returns id, name and status only","operationId":"getCustomers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"email","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Customer"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all customers","tags":["Customer"]},"post":{"description":"Create a customer; the tax id is sealed to the record and indexed by a keyed blind index","operationId":"postCustomers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCustomer"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a customer","tags":["Customer"]}},"/customers/information-requests/search":{"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postCustomersInformationRequestsSearch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture confidential candidate IDs for an independently reviewed exact 314(a) request across current and historical names, addresses, phones, dates of birth, keyed tax indexes and corrected-tax hashes","tags":["Customer"]}},"/customers/{id}":{"get":{"description":"Read a customer","operationId":"getCustomersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a customer by ID","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putCustomersId","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Change a customer's name, email, phone or address with evidence; a name or address change reopens verification","tags":["Customer"]}},"/customers/{id}/as-filed-identities":{"get":{"operationId":"getCustomersIdAsFiledIdentities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a customer's as-filed identity snapshots (last four only)","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdAsFiledIdentities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Snapshot the payee identity an information return is filed with (the accounts service, or finance staff holding customers:tax:read with a step-up within five minutes): the legal name, address and TIN are copied from the customer record, the TIN sealed to the snapshot; the same filing again returns the snapshot as filed","tags":["Customer"]}},"/customers/{id}/as-filed-identities/{identity}/tax-identification":{"get":{"operationId":"getCustomersIdAsFiledIdentitiesIdentityTaxIdentification","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a snapshot's as-filed TIN, name and address for a correction: the accounts service for information returns, or staff with customers:tax:read, a step-up within five minutes and a purpose. Every read is recorded, naming the snapshot and the staff member a service names in on_behalf_of, before the value is returned","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","required":true,"schema":{"type":"string"}}]},"/customers/{id}/backup-withholding":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdBackupWithholding","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithholdingNotice"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Turn backup withholding on or off by hand (an IRS B-notice, a corrected TIN): customer servicing staff with a step-up within five minutes, or a service with customers:write; every change is evidenced with its actor","tags":["Customer"]}},"/customers/{id}/business-parties":{"get":{"operationId":"getCustomersIdBusinessParties","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessParties"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the current evidenced ownership and control-person records","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdBusinessParties","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessPartiesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessParties"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a version of a business's natural-person owners and control person; customers:write service credential, idempotency key and expected_version required; reopens KYC review","tags":["Customer"]}},"/customers/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close a customer (a service with customers:write; staff propose a closure for independent approval instead)","tags":["Customer"]}},"/customers/{id}/closures":{"get":{"operationId":"getCustomersIdClosures","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a customer's closure proposals and their decisions","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdClosures","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose closing a customer (customer servicing staff, step-up within five minutes, idempotency key); a different staff member holding operations:approve decides it","tags":["Customer"]}},"/customers/{id}/closures/{closure}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"closure","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdClosuresClosureDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a closure proposal (customer servicing staff holding operations:approve, not the proposer); an approval closes the customer with evidence","tags":["Customer"]}},"/customers/{id}/crs-self-cert":{"get":{"operationId":"getCustomersIdCrsSelfCert","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a CRS tax-residency self-certification, residency TIN last fours only; disabled unless CRS_ENABLED because the United States is not a CRS participating jurisdiction","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdCrsSelfCert","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a CRS tax-residency self-certification (customer servicing staff, idempotency key); each residency TIN is sealed to the customer record and never stored in the clear; disabled unless CRS_ENABLED (not a U.S. obligation)","tags":["Customer"]}},"/customers/{id}/crs-self-cert/tax-identification":{"get":{"operationId":"getCustomersIdCrsSelfCertTaxIdentification","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open the sealed residency TINs of the current CRS self-certification: staff with customers:crs:read or customers:tax:read and a step-up within five minutes, or the compliance service with customers:crs:read, naming a purpose. Every read is recorded before the values are returned; disabled unless CRS_ENABLED","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customers/{id}/death-reports":{"get":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"getCustomersIdDeathReports","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeathReport"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List death reports for staff review","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postCustomersIdDeathReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an unverified death report","tags":["Customer"]}},"/customers/{id}/death-reports/{report}":{"get":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"getCustomersIdDeathReportsReport","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a death report and its decision","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"report","required":true,"schema":{"type":"string"}}]},"/customers/{id}/death-reports/{report}/corrections":{"get":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"getCustomersIdDeathReportsReportCorrections","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeathCorrection"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read correction proposals and decisions","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"report","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postCustomersIdDeathReportsReportCorrections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathCorrectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose correcting a confirmed death report","tags":["Customer"]}},"/customers/{id}/death-reports/{report}/corrections/{correction}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"report","required":true,"schema":{"type":"string"}},{"in":"path","name":"correction","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postCustomersIdDeathReportsReportCorrectionsCorrectionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathCorrectionDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a death correction","tags":["Customer"]}},"/customers/{id}/death-reports/{report}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"report","required":true,"schema":{"type":"string"}}],"post":{"description":"Staff evidence only. Writes require customers:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.","operationId":"postCustomersIdDeathReportsReportDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeathReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently confirm or reject a death report","tags":["Customer"]}},"/customers/{id}/eligibility":{"get":{"operationId":"getCustomersIdEligibility","parameters":[{"in":"query","name":"customer_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Eligibility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"May this customer open a product of a type","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customers/{id}/fatca-owners":{"get":{"operationId":"getCustomersIdFatcaOwners","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read substantial U.S. owners of a passive NFFE; last fours only unless the caller holds customers:fatca:read or customers:tax:read","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdFatcaOwners","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a version of a passive NFFE's substantial U.S. owners (W-8BEN-E chapter 4 status 24); customer servicing staff, step-up within five minutes, idempotency key","tags":["Customer"]}},"/customers/{id}/group":{"get":{"operationId":"getCustomersIdGroup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The group a customer belongs to","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customers/{id}/kyc-decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdKycDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a KYC decision; only the compliance service's result or staff may set verified","tags":["Customer"]}},"/customers/{id}/privacy":{"get":{"description":"Own verified customer identity or privacy staff authority required. Includes retained exact notice copies, current opt-out election, policy and notice obligations; ordinary customer-master creation alone does not establish a consumer product relationship.","operationId":"getCustomersIdPrivacy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Own privacy notice history, current policy, sharing election and notice obligations","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customers/{id}/privacy-elections":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Own customer identity or fresh privacy staff authority for an evidenced assisted request required; services cannot change elections. expected_version prevents lost updates. Opt-out persists until explicitly revoked, independently of E-SIGN or marketing preferences.","operationId":"postCustomersIdPrivacyElections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyElectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyElection"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyElection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record or revoke an own nonaffiliate-sharing opt-out, independently of marketing preferences and E-SIGN","tags":["Customer"]}},"/customers/{id}/privacy-notices":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Privacy delivery service or fresh privacy staff authority required. Record actual delivery of the exact approved content with evidence SHA-256 and delivery time; electronic delivery additionally requires electronic agreement evidence. Merely requesting delivery or publishing content does not qualify.","operationId":"postCustomersIdPrivacyNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyNoticeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyNotice"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual delivery of the exact approved privacy notice and electronic agreement evidence where used","tags":["Customer"]}},"/customers/{id}/privacy-relationships":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Privacy writer service may assert only its own source_service and product_ref. All deposit products closed remains active with relationship_review_required until fresh privacy staff holding operations:approve records source_service bank, product_ref all_products and inventory_complete true with evidence newer than every source event and no active product. This prevents deposit closure from silently ending ongoing loan relationships.","operationId":"postCustomersIdPrivacyRelationships","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRelationshipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRelationshipRequest"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyRelationshipRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an evidenced active/former consumer relationship; a KYC master record alone is not a relationship","tags":["Customer"]}},"/customers/{id}/record-controls":{"get":{"description":"Fresh dedicated customers:records:read staff authority and nonempty specific purpose required. Each successful retrieval is recorded immutably. Lists return at most 200 ordered IDs; pass the last ID as after. Customer and ingest-service identities cannot retrieve these legal records. Content retrieval verifies the retained hash and refuses disposed payloads; custody metadata remains available.","operationId":"getCustomersIdRecordControls","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecordsAction"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List preserved record-control and independent-decision evidence","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh customers:records:write staff authority required. hold immediately preserves the named record, or all current and future archive records for the customer when record_id is empty. release_hold, dispose and retention_event remain pending independent approval. Evidence and matter references required. An event names its original nonfuture occurrence and cannot rewrite an already captured trigger. Holds never release automatically.","operationId":"postCustomersIdRecordControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsActionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsAction"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Immediately preserve a customer's records or propose independent hold release or record disposition","tags":["Customer"]}},"/customers/{id}/record-controls/{action}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh customers:records:approve staff authority, no API key and actor different from maker required. Hold release/disposition/retention event are serialized with capture, other controls and schedule changes. Disposition rechecks every current hold, captured retention and current policy; permanent or unknown-trigger retention blocks it. Only the encrypted live archive payload is deleted atomically with immutable approval evidence. Customer-master, financial histories, external documents and backup/WAL/object-lock copies are outside this deletion boundary. A disposed record cannot be recreated by idempotent replay or key rotation.","operationId":"postCustomersIdRecordControlsActionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a hold release or disposition, rechecking current retention and holds atomically","tags":["Customer"]}},"/customers/{id}/records":{"get":{"description":"Fresh dedicated customers:records:read staff authority and nonempty specific purpose required. Each successful retrieval is recorded immutably. Lists return at most 200 ordered IDs; pass the last ID as after. Customer and ingest-service identities cannot retrieve these legal records. Content retrieval verifies the retained hash and refuses disposed payloads; custody metadata remains available.","operationId":"getCustomersIdRecords","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecordsRecord"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained customer record custody and preservation holds with an audited purpose","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh records writer staff or customers:records:ingest service required. An ingest service may assert only its own source_service and has no record read authority. Capture actual content, base64 in JSON and limited to 256 KiB, matching SHA-256, source custody, original creation time and reviewed category. Each record gets an AES-GCM envelope with a random data key bound to its record ID. Missing retention-event evidence preserves indefinitely until an independently approved retention_event control. Existing customer-wide holds cover new records automatically. Idempotency is exact-content and actor bound; source references are unique per customer/source.","operationId":"postCustomersIdRecords","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture actual encrypted customer evidence with original source custody and reviewed retention policy","tags":["Customer"]}},"/customers/{id}/records/{record}":{"get":{"description":"Fresh dedicated customers:records:read staff authority and nonempty specific purpose required. Each successful retrieval is recorded immutably. Lists return at most 200 ordered IDs; pass the last ID as after. Customer and ingest-service identities cannot retrieve these legal records. Content retrieval verifies the retained hash and refuses disposed payloads; custody metadata remains available.","operationId":"getCustomersIdRecordsRecord","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsContent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retrieve integrity-checked retained evidence for an audited legal or retention purpose","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"record","required":true,"schema":{"type":"string"}}]},"/customers/{id}/sharing-exports":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"A verified service with customers:privacy:share must match the current approved service/recipient/purpose/field grant and supply an actual-use evidence reference/hash. Current policy/election and notice/opportunity/opt-out gates are checked atomically before snapshot capture or idempotent replay. A denied result contains no data. Only approved contact fields may be returned; no tax IDs or account data. Share-only services cannot bypass this gate using operational customer reads.","operationId":"postCustomersIdSharingExports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyExportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyExport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Export only policy-approved customer fields to a named recipient for a permitted purpose; enforce current notices and opt-out atomically","tags":["Customer"]}},"/customers/{id}/tax-certifications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdTaxCertifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCertification"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the W-9 or W-8 on file (customer servicing staff, or a service with customers:write); a certified W-9 lifts backup withholding and records its TIN when none is sealed. A W-8's foreign TIN is sealed to the record; a W-8BEN-E carries the entity's chapter 3 and chapter 4 status codes","tags":["Customer"]}},"/customers/{id}/tax-document-identities":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Prepared-document capture does not assert furnishing or filing. Fresh staff customers:tax:read with explicit information_return purpose, or actual svc_accounts with customers:tax:read and the verified staff subject in on_behalf_of. Source name/address and full TIN are copied under the customer lock; only immutable metadata/last4 leave this call, and the TIN remains separately encrypted. Same customer/year/document_ref replays the original snapshot.","operationId":"postCustomersIdTaxDocumentIdentities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"in":"query","name":"purpose","schema":{"type":"string"}},{"in":"query","name":"on_behalf_of","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDocumentIdentityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDocumentIdentity"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDocumentIdentity"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture immutable prepared-document identity with encrypted TIN; this does not assert filing or furnishing","tags":["Customer"]}},"/customers/{id}/tax-document-identities/{identity}":{"get":{"operationId":"getCustomersIdTaxDocumentIdentitiesIdentity","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}},{"in":"query","name":"on_behalf_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDocumentIdentity"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained prepared-document identity metadata under the restricted tax-reporting purpose","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","required":true,"schema":{"type":"string"}}]},"/customers/{id}/tax-document-identities/{identity}/tax-identification":{"get":{"description":"Same restricted reporting authority. Full retained TIN is opened only for this exact customer's snapshot and an immutable read record is committed before release. Ciphertext is separately scoped to the snapshot and participates in managed key rotation. Generic service, ordinary staff, customer, API-key and third-party authority refuse.","operationId":"getCustomersIdTaxDocumentIdentitiesIdentityTaxIdentification","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}},{"in":"query","name":"on_behalf_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDocumentIdentification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open the exact encrypted prepared-document identity, recording the reporting actor before releasing the TIN","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"identity","required":true,"schema":{"type":"string"}}]},"/customers/{id}/tax-id-corrections":{"get":{"operationId":"getCustomersIdTaxIdCorrections","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a customer's TIN correction proposals and their decisions (last fours only)","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdTaxIdCorrections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose replacing the TIN on file (customer servicing staff, step-up within five minutes, idempotency key); the TIN is sealed on receipt and returned as its last four only","tags":["Customer"]}},"/customers/{id}/tax-id-corrections/{correction}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"correction","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdTaxIdCorrectionsCorrectionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a TIN correction (customer servicing staff holding operations:approve, not the proposer); an approval swaps the sealed TIN while the one the proposal saw is on file, with an encryption_audit row and evidence, and sends a verified customer back to KYC review","tags":["Customer"]}},"/customers/{id}/tax-identification":{"get":{"operationId":"getCustomersIdTaxIdentification","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxIdentification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the full tax id, and the W-8's foreign TIN and a W-8BEN-E's chapter 3 and chapter 4 status codes: staff with customers:tax:read, a step-up within five minutes and a purpose; the accounts service for information returns; the compliance service with customers:tax:read for KYC. Every read is recorded before the values are returned, with the staff member a service names in on_behalf_of","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/customers/{id}/tin-notices":{"get":{"operationId":"getCustomersIdTinNotices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a customer's IRS TIN notices: pending, withholding or cured, with the cure","tags":["Customer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postCustomersIdTinNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an IRS CP2100 or CP2100A listing against a customer (the accounts service forwarding its record, a service with customers:write, or customer servicing staff with a step-up within five minutes; idempotency key). Backup withholding turns on by withholding_due unless the customer cures the mismatch first: a certified W-9 cures a first B notice, a second needs the TIN validated by Form SSA-7028 or IRS Letter 147C","tags":["Customer"]}},"/deposit-abuse-reports":{"post":{"description":"Dedicated accounts:chex:write human staff authority (the chex_officer role) and authentication within five minutes required; accounts:write and API keys are refused 403. Idempotent on the key. reason is nsf_activity, unpaid_balance, suspected_fraud, account_abuse or returned_deposits. Identity is unsealed from the customer's most recent inquiry. Close with a ChexSystems reason also furnishes best-effort after a prior inquiry.","operationId":"postDepositAbuseReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseReport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a deposit abuse report","tags":["Deposit Abuse Report"]}},"/deposit-abuse-reports/{id}":{"get":{"description":"Dedicated accounts:chex:read staff or service authority required; accounts:read is not enough. Reads return last-four, score and recommendation, never the sealed identity. ","operationId":"getDepositAbuseReportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a deposit abuse report by ID","tags":["Deposit Abuse Report"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/deposit-placement-readiness":{"get":{"description":"Placement staff/service read scope required. Unresolved or active agency positions block closure of their original funding/redemption account. Read-only callback does not acquire the accounts service lock.","operationId":"getDepositPlacementReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read unresolved agency positions that block closing the funding/redemption deposit","tags":["Other"]}},"/deposit-placement-snapshot":{"get":{"description":"Placement staff/service read scope required. Current watched snapshot retains source controls/positions, actual outbound accounting journal, signed receiving-bank interest and explicit unknown/exception fields. Off-bank claims remain distinct from original-bank deposits and bank-owned investments. No historical reconstruction is claimed.","operationId":"getDepositPlacementSnapshot","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture current agency claims with actual ledger evidence and unknown interest kept explicit","tags":["Other"]}},"/deposit-placements":{"get":{"description":"Verified owner reads their account's positions; verified placement staff/service readers may read the bank inventory. Cursor query supported.","operationId":"getDepositPlacements","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Placement"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read customer agency positions distinct from originating-bank deposits","tags":["Other"]},"post":{"description":"Fresh bound individual customer consents to exact disclosure, amount, account and program. Independently approved outside exposure plus all pending/active placements share owner/bank/single-capacity headroom. Staff cannot manufacture customer consent. Unsupported ownership, restricted/protected/overdraft accounts, stale evidence and missing capacity refuse.","operationId":"postDepositPlacements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsCreateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Request an agency deposit under authenticated owner consent","tags":["Other"]}},"/deposit-placements/{id}":{"get":{"description":"Verified owner or placement reader sees retained controls, reservations, consent, immutable instruction, signed actual receipt, accounting recovery plans and off-bank position.","operationId":"getDepositPlacementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an agency position and retained settlement evidence","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/deposit-placements/{id}/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only payments:placements:bridge service whose exact subject is in the retained program receives the durable placement instruction. Dispatch state commits before returning; retry returns the same command. This API is the actual provider integration boundary, not a certification claim.","operationId":"postDepositPlacementsIdDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue a durable approved placement instruction to its configured service bridge","tags":["Other"]}},"/deposit-placements/{id}/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the retained program's authorized bridge submits actual signed settlement/cancellation. Ed25519 signature binds the original instruction, allocation, owner/bank/capacity, amount, evidence bytes/hash and actual date. One provider settlement/allocation claim cannot back two commands. Receipt is durable before ledger mutation; exact accounting plans/journal keys recover uncertainty without duplicate money. Valid late external settlement remains actual evidence; open-period correction retains its original date and exception. Customer DDA liability leaves on placement and returns with actual paid interest on redemption; no agency asset is booked as bank-owned.","operationId":"postDepositPlacementsIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify and retain signed actual placement settlement before transferring DDA liability off bank","tags":["Other"]}},"/deposit-placements/{id}/redemption":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh bound owner authorizes full redemption to the original still-open deposit. Exact actor/key replay; demand deposits or mature CDs only. Unsupported early penalties, partial withdrawal or changed terms refuse. No new DDA credit until signed actual redemption.","operationId":"postDepositPlacementsIdRedemption","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedemptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Authorize full redemption of an active agency deposit","tags":["Other"]}},"/deposit-placements/{id}/redemption/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only payments:placements:bridge service whose exact subject is in the retained program receives the durable redemption instruction. Dispatch state commits before returning; retry returns the same command. This API is the actual provider integration boundary, not a certification claim.","operationId":"postDepositPlacementsIdRedemptionDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue the exact customer-authorized redemption instruction","tags":["Other"]}},"/deposit-placements/{id}/redemption/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the retained program's authorized bridge submits actual signed settlement/cancellation. Ed25519 signature binds the original instruction, allocation, owner/bank/capacity, amount, evidence bytes/hash and actual date. One provider settlement/allocation claim cannot back two commands. Receipt is durable before ledger mutation; exact accounting plans/journal keys recover uncertainty without duplicate money. Valid late external settlement remains actual evidence; open-period correction retains its original date and exception. Customer DDA liability leaves on placement and returns with actual paid interest on redemption; no agency asset is booked as bank-owned.","operationId":"postDepositPlacementsIdRedemptionReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify actual signed redemption and restore customer DDA funds exactly once","tags":["Other"]}},"/deposit-placements/{id}/redemption/withdraw":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh owner may withdraw an undispatched redemption; the underlying receiving-bank claim stays active. Dispatched commands require signed cancellation. Prior commands and exact keys remain retained.","operationId":"postDepositPlacementsIdRedemptionWithdraw","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withdraw a redemption that has not been dispatched","tags":["Other"]}},"/deposit-placements/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh placement approver reviews exact customer request; current customer eligibility and all named parties must screen clear. Approval reserves both DDA and actual master cash using atomic conditional holds. No liability leaves before signed actual settlement. Lost hold responses recover exact keys; withdrawals recover both reservations.","operationId":"postDepositPlacementsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Review an exact customer instruction and reserve both customer and bank cash","tags":["Other"]}},"/deposit-placements/{id}/statements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Exact program bridge submits signed principal and accrued-interest observation bound to the original settled allocation and journal. Date/content is immutable and monotonic. Unknown, stale or reserve-exhausting interest blocks new affected placements; no zero or coverage guarantee is inferred.","operationId":"postDepositPlacementsIdStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsStatement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain a signed receiving-bank principal and accrued-interest statement","tags":["Other"]}},"/deposit-placements/{id}/withdraw":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh bound owner may withdraw only before dispatch. Both actual holds are recovered/released before capacity closes; post-dispatch cancellation needs signed bridge evidence.","operationId":"postDepositPlacementsIdWithdraw","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withdraw an undispatched placement and recover its reservations","tags":["Other"]}},"/deposit-screenings":{"get":{"description":"Dedicated accounts:chex:read staff or service authority required; accounts:read is not enough. Reads return last-four, score and recommendation, never the sealed identity. customer_id is required.","operationId":"getDepositScreenings","parameters":[{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DepositScreening"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all deposit screenings","tags":["Deposit Screening"]},"post":{"description":"Dedicated accounts:chex:write human staff authority (the chex_officer role) and authentication within five minutes required; accounts:write and API keys are refused 403. Idempotent on the key. Decline and refer do not themselves refuse this route; the opening path (POST /accounts with screening) refuses both with 422 accounts.deposit_screening_declined. No ChexSystems URL answers 424 dependency_failed.","operationId":"postDepositScreenings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/depositScreenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositScreening"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositScreening"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a deposit screening","tags":["Deposit Screening"]}},"/deposit-screenings/{id}":{"get":{"description":"Dedicated accounts:chex:read staff or service authority required; accounts:read is not enough. Reads return last-four, score and recommendation, never the sealed identity. ","operationId":"getDepositScreeningsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositScreening"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a deposit screening by ID","tags":["Deposit Screening"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/devices":{"get":{"description":"List enrolled devices","operationId":"getDevices","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Device"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all devices","tags":["Device"]}},"/devices/{id}":{"delete":{"description":"Revoke a device and its sessions","operationId":"deleteDevicesId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Delete a device","tags":["Device"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/devices/{id}/trust":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDevicesIdTrust","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Mark a device trusted","tags":["Device"]}},"/disputes":{"get":{"description":"List consumer EFT disputes for verified staff","operationId":"getDisputes","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Dispute"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all disputes","tags":["Dispute"]},"post":{"description":"Record a consumer deposit EFT error notice and captured deadlines","operationId":"postDisputes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a dispute","tags":["Dispute"]}},"/disputes/deadlines":{"get":{"operationId":"getDisputesDeadlines","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DisputeDeadlineView"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List pending error-resolution deadlines by case","tags":["Dispute"]}},"/disputes/{id}":{"get":{"description":"Read a dispute and its accounting state","operationId":"getDisputesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a dispute by ID","tags":["Dispute"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/disputes/{id}/actions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdActions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeActionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a provisional credit, determination or recovery","tags":["Dispute"]}},"/disputes/{id}/actions/{action}":{"get":{"operationId":"getDisputesIdActionsAction","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a financial dispute action","tags":["Dispute"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}]},"/disputes/{id}/actions/{action}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdActionsActionCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeCancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover an approved dispute action without another posting","tags":["Dispute"]}},"/disputes/{id}/actions/{action}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdActionsActionDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a financial dispute action","tags":["Dispute"]}},"/disputes/{id}/actions/{action}/execute":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdActionsActionExecute","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeAction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover an approved dispute action without another posting","tags":["Dispute"]}},"/disputes/{id}/actions/{action}/final-card-loss":{"get":{"description":"Only an actual svc_cards JWT with compliance:disputes:recovery:read can read this source. Requires a completed independently approved error/partial-error determination, actual unreversed original card clearing and exact final expense journal, and no pending financial action or provisional recovery. Principal excludes related fees and interest. SourceSHA256 excludes observation time. This observation posts no customer credit and reserves no loss capacity; the recovery consumer must retain exact evidence and claim the loss journal before allocating bank recoveries.","operationId":"getDisputesIdActionsActionFinalCardLoss","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinalCardDisputeLoss"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the exact completed consumer card loss for the authorized cards recovery service","tags":["Dispute"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"action","required":true,"schema":{"type":"string"}}]},"/disputes/{id}/events":{"get":{"operationId":"getDisputesIdEvents","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DisputeEvent"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable dispute evidence and actions","tags":["Dispute"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/disputes/{id}/evidence":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdEvidence","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeEvidenceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record retained investigation evidence","tags":["Dispute"]}},"/disputes/{id}/notices":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postDisputesIdNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeNoticeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual customer notice transmission evidence","tags":["Dispute"]}},"/escheatments":{"get":{"description":"List escheatments, optionally by state","operationId":"getEscheatments","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"state","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Escheatment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all escheatments","tags":["Escheatment"]}},"/events":{"get":{"description":"List events","operationId":"getEvents","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all events","tags":["Event"]}},"/events/{id}":{"get":{"operationId":"getEventsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an event by ID","tags":["Event"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/facilities":{"get":{"description":"A customer's facilities","operationId":"getFacilities","parameters":[{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LendingFacility"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all facilities","tags":["Facility"]},"post":{"description":"Apply for a credit facility (revolving line, construction, letter of credit, factoring, floor plan, warehouse, merchant cash advance)","operationId":"postFacilities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityApplication"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingFacility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a facility","tags":["Facility"]}},"/facilities/billing-errors/work":{"get":{"operationId":"getFacilitiesBillingErrorsWork","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillingError"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page protected consumer-card billing-error work and deadlines","tags":["Facility"]}},"/facilities/closing/sources/{id}/statements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified lending staff/service authority; fresh staff step-up for writes. Capture occurs only on the actual closing bank date during the final fifteen minutes before cutoff, binds an immutable plan version, verifies accrual/recognition and prepares due facility bills, retains risk/billing evidence, and seals instrument mutations until cutoff. A source cannot be reconstructed on a later day. Next-day billing consumes already-generated minimum/due state without inventing delivery evidence. CECL execution may name close_source_id and compares dated ledger receivables to the exact retained source.","operationId":"postFacilitiesClosingSourcesIdStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingStatementRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Consume actual closing-day facility billing evidence","tags":["Facility"]}},"/facilities/payment-commands/work":{"get":{"operationId":"getFacilitiesPaymentCommandsWork","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FacilityPaymentCommand"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Review captured unfinished facility payments and cancellation state","tags":["Facility"]}},"/facilities/portfolio":{"get":{"operationId":"getFacilitiesPortfolio","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FacilityBook"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Facilities by product: committed, drawn and unused","tags":["Facility"]}},"/facilities/reservation-expiries":{"post":{"operationId":"postFacilitiesReservationExpiries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sweep expired facility reservations: record and publish every reservation whose time ran out","tags":["Facility"]}},"/facilities/statements":{"post":{"operationId":"postFacilitiesStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"period":{"type":"string"}},"required":["period"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingStatementRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bill every open facility for a period: interest, fees, the minimum due and its due date","tags":["Facility"]}},"/facilities/{id}":{"get":{"description":"Read a facility with today's availability","operationId":"getFacilitiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingFacility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a facility by ID","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/activations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdActivations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingFacility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open an approved facility (issue a letter of credit, fund a merchant cash advance)","tags":["Facility"]}},"/facilities/{id}/affiliate-credit":{"get":{"description":"Verified staff/service lending:read authority required. Source terms bind exact credit ID, borrower, full gross commitment, currency and logical destination to a SHA256. A compliance plan must be approved and capacity reserved before credit approval; new funding additionally needs an exact journal usage and authoritative confirmation. Affiliate facility execution is refused. A fee-netted affiliate closing is outside supported gross-cash term-loan scope.","operationId":"getFacilitiesIdAffiliateCredit","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact facility terms for affiliate credit review","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/affiliate-funding-source":{"get":{"description":"Verified lending:read staff/service authority required. Returns expected immutable ledger address, captured product GL code and known activated/prepared receivable ID if present, with exact credit terms. Takes no instrument write lock and is safe for a compliance authorization callback before lending funding commits.","operationId":"getFacilitiesIdAffiliateFundingSource","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingSource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read source ledger identity before affiliate facility use","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/billing-cycles":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingCycles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCycleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCycle"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual statement cycle and transmission evidence","tags":["Facility"]}},"/facilities/{id}/billing-errors":{"get":{"operationId":"getFacilitiesIdBillingErrors","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillingError"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read facility billing-error cases","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrors","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingErrorRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a written Reg Z billing-error notice and protect disputed amounts","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}":{"get":{"operationId":"getFacilitiesIdBillingErrorsCase","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read billing-error state and captured deadlines","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/billing-errors/{case}/events":{"get":{"operationId":"getFacilitiesIdBillingErrorsCaseEvents","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BillingEvent"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable billing-error evidence and decisions","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/billing-errors/{case}/evidence":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseEvidence","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingEvidence"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Add authenticated investigation evidence","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/interest-reconciliations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseInterestReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestReconciliationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose exact reviewed interest-source waiver and payment refund allocation","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/interest-reconciliations/{reconciliation}":{"get":{"operationId":"getFacilitiesIdBillingErrorsCaseInterestReconciliationsReconciliation","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured interest reconciliation and accounting outcome","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"reconciliation","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/billing-errors/{case}/interest-reconciliations/{reconciliation}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"reconciliation","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseInterestReconciliationsReconciliationDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide and execute a captured interest reconciliation","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/interest-reconciliations/{reconciliation}/execute":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"reconciliation","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseInterestReconciliationsReconciliationExecute","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover exact interest correction and original-deposit refunds","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/interest-sources":{"get":{"operationId":"getFacilitiesIdBillingErrorsCaseInterestSources","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInterestSources"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read original overlapping interest sources and balance reconciliation","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/billing-errors/{case}/notices":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingNotice"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual acknowledgment or result notice transmission","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingError"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release protection after actual result notice and full grace period","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/resolutions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseResolutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an evidence-backed financial correction or no-error determination","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/resolutions/{resolution}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"resolution","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseResolutionsResolutionDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide and recover a captured correction","tags":["Facility"]}},"/facilities/{id}/billing-errors/{case}/resolutions/{resolution}/execute":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"resolution","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBillingErrorsCaseResolutionsResolutionExecute","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingResolution"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover an approved correction from committed ledger evidence","tags":["Facility"]}},"/facilities/{id}/borrowing-base":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdBorrowingBase","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BorrowingBase"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingFacility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"File a borrowing base certificate","tags":["Facility"]}},"/facilities/{id}/card-refunds":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdCardRefunds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a merchant's card refund to a card facility","tags":["Facility"]}},"/facilities/{id}/closings":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingPlan"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture immutable closing terms and requirements","tags":["Facility"]}},"/facilities/{id}/closings/{case}":{"get":{"operationId":"getFacilitiesIdClosingsCase","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read closing evidence and funding state","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/closings/{case}/cancellation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel and fence an unposted closing","tags":["Facility"]}},"/facilities/{id}/closings/{case}/consummation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseConsummation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consummation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the signed contractual obligation after disclosure checks","tags":["Facility"]}},"/facilities/{id}/closings/{case}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingUpload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Archive closing evidence for independent review","tags":["Facility"]}},"/facilities/{id}/closings/{case}/documents/{document}/pdf":{"get":{"operationId":"getFacilitiesIdClosingsCaseDocumentsDocumentPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download immutable closing evidence","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"document","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/closings/{case}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release closing after conditions and rescission clearance","tags":["Facility"]}},"/facilities/{id}/closings/{case}/rescission":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseRescission","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record written rescission and fence unposted funding","tags":["Facility"]}},"/facilities/{id}/closings/{case}/reviews/{subject}":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"subject","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdClosingsCaseReviewsSubject","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide closing terms or document evidence","tags":["Facility"]}},"/facilities/{id}/conversions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdConversions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Convert a construction facility into its permanent loan","tags":["Facility"]}},"/facilities/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Decide a facility in review: an independent credit officer approves or declines it. `decision` is `approve` or `decline`; the actor is the verified credit officer, and the decision records them as `decided_by`. `reasons` are the principal reasons that officer states. A decline is an adverse action, which Reg B (12 CFR 1002.9(b)(2)) requires to state its principal specific reasons, so a decline carrying none is refused 400 `validation_failed` on `reasons`; at most 10 reasons, each at most 300 characters, and blank ones are dropped. The automated triggers that sent the file to review stay apart as `review_reasons`.","operationId":"postFacilitiesIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingFacility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide a facility in review: an independent credit officer approves or declines it","tags":["Facility"]}},"/facilities/{id}/draw-authorizations":{"get":{"operationId":"getFacilitiesIdDrawAuthorizations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DrawAuthorization"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A facility's draw authorisations, their decisions and the advances they funded","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdDrawAuthorizations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawAuthorizationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawAuthorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask for the authority to make one advance: dual control over advances at or above the bank's figure","tags":["Facility"]}},"/facilities/{id}/draw-authorizations/{authorization_id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"authorization_id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdDrawAuthorizationsAuthorization_idDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawAuthorizationDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawAuthorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide a draw authorisation: a second officer approves or rejects it, the officer who asked withdraws it","tags":["Facility"]}},"/facilities/{id}/draws":{"get":{"operationId":"getFacilitiesIdDraws","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Draw"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A facility's draws and financed items","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Draw on a facility: an advance, a presentation under a letter of credit, or an item financed. `kind` is `advance` (the default), `presentation`, `receivable`, `unit`, `note` or `card`. A `card` draw is the card network's money already paid to a merchant, posted whatever the facility's availability and consuming the reservation the purchase placed, so only the card authorisation service (`svc_cards`) may post one: bank staff, any other service, a customer and every API key are refused 403 `forbidden`, and a replay of the same idempotency key with different terms is refused 409. Every other kind is drawn by verified bank staff holding `lending:write`, or by the accounts service covering an overdraft on a linked line; every other caller is refused 403.","operationId":"postFacilitiesIdDraws","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DrawResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Draw on a facility: an advance, a presentation under a letter of credit, or an item financed","tags":["Facility"]}},"/facilities/{id}/payment-cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdPaymentCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityPaymentCancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityPaymentCancellation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently cancel an unposted payment or recover its committed journal","tags":["Facility"]}},"/facilities/{id}/payments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdPayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flat"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pay a facility from its settlement account","tags":["Facility"]}},"/facilities/{id}/rate-contract":{"get":{"operationId":"getFacilitiesIdRateContract","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesContract"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the signed variable-rate contract","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRateContract","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesTerms"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_9e2345ba8bd4"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable signed-note variable-rate terms","tags":["Facility"]}},"/facilities/{id}/rate-resets":{"get":{"operationId":"getFacilitiesIdRateResets","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Record_642039d9104b"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable rate-reset history","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRateResets","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_642039d9104b"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Calculate and capture the next contractual rate reset and notice","tags":["Facility"]}},"/facilities/{id}/rate-resets/{reset}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRateResetsResetCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_0f87d82e510e"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose cancellation of an unapplied reset for independent review","tags":["Facility"]}},"/facilities/{id}/rate-resets/{reset}/delivery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRateResetsResetDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delivery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"recorded":{"type":"boolean"}},"required":["recorded"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record verified notice delivery evidence","tags":["Facility"]}},"/facilities/{id}/rate-resets/{reset}/notice":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRateResetsResetNotice","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sha256":{"type":"string"}},"required":["sha256"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Render and archive an approved rate notice","tags":["Facility"]}},"/facilities/{id}/rate-resets/{reset}/notice.pdf":{"get":{"operationId":"getFacilitiesIdRateResetsResetNoticePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the archived rate notice","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}]},"/facilities/{id}/remittances":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdRemittances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flat"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a merchant's card-receipt holdback to a merchant cash advance","tags":["Facility"]}},"/facilities/{id}/reservations":{"get":{"operationId":"getFacilitiesIdReservations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The reservations still holding room on a facility","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdReservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hold room on a facility for money promised elsewhere (a card authorisation in flight) until the draw carrying the same reference lands, it is released, or it expires","tags":["Facility"]}},"/facilities/{id}/reservations/{reservation}":{"delete":{"operationId":"deleteFacilitiesIdReservationsReservation","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release a reservation: the room is free again","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reservation","required":true,"schema":{"type":"string"}}],"patch":{"operationId":"patchFacilitiesIdReservationsReservation","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Raise a live reservation to a new, larger total (a card authorisation incremented); the Idempotency-Key replays the raise","tags":["Facility"]}},"/facilities/{id}/settlements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFacilitiesIdSettlements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"draw_id":{"type":"string"}},"required":["amount","currency_code","draw_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Settle a financed item: an invoice collected, a vehicle sold, a note taken out","tags":["Facility"]}},"/facilities/{id}/statements":{"get":{"operationId":"getFacilitiesIdStatements","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LendingFacilityStatement"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A facility's billing cycles","tags":["Facility"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/fatca-reports":{"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAProposeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a Form 8966 FATCA XML v2.0.1 report for the bank as a U.S. withholding agent that is not an FFI (passive NFFEs with substantial U.S. owners); independent review required (Idempotency-Key)","tags":["Other"]}},"/fatca-reports/{id}":{"get":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"getFatcaReportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a FATCA report's review and IDES packaging state","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/fatca-reports/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCADecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's FATCA report (compliance:fatca:approve)","tags":["Other"]}},"/fatca-reports/{id}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Export the sealed FATCA XML or IDES packet after recording confidential access (compliance:fatca:export)","tags":["Other"]}},"/fatca-reports/{id}/notifications":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdNotifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retrieve ICMM-style NVF notifications from the IDES simulator","tags":["Other"]}},"/fatca-reports/{id}/package":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdPackage","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Build the IDES transmission packet (sign, zip, AES-256-CBC, RSA wrap) after independent approval","tags":["Other"]}},"/fatca-reports/{id}/transmit":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdTransmit","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Submit the packaged IDES ZIP to the local IDES simulator (not the IRS)","tags":["Other"]}},"/fatca-reports/{id}/void":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.","operationId":"postFatcaReportsIdVoid","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FATCAReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a void (FATCA3) of an original Form 8966 document, naming its MessageRefId","tags":["Other"]}},"/fed-position-samples":{"get":{"description":"List a day's Fed position samples","operationId":"getFedPositionSamples","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FedSample"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all fed position samples","tags":["Fed Position Sample"]},"post":{"description":"Record a sample of the Fed position (a scheduler calls this through the day)","operationId":"postFedPositionSamples","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedSample"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a fed position sample","tags":["Fed Position Sample"]}},"/fee-corrections":{"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Propose a reverse or adjustment of the exact retained fee journal on the named account. The refund amount is the posted fee (or the overcharge, for an adjustment), never a caller-asserted amount. Proposal alone does not move money. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postFeeCorrections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrection"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a fee correction","tags":["Fee Correction"]}},"/fee-corrections/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read the retained proposal, independent decision and posted ledger correction. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getFeeCorrectionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a fee correction by ID","tags":["Fee Correction"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/fee-corrections/{id}/apply":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Post the independently approved reverse or adjustment as a balanced ledger journal. Replay recovers the recorded correction without posting a second one. A fee journal is corrected at most once. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postFeeCorrectionsIdApply","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post the balanced ledger correction of an approved fee correction","tags":["Fee Correction"]}},"/fee-corrections/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write and operations:approve authority is required; the reviewer differs from the maker. Review the exact fee-correction digest. The maker cannot review their own proposal. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postFeeCorrectionsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeCorrection"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the exact fee correction digest","tags":["Fee Correction"]}},"/fraud-parameters":{"get":{"description":"The outbound fraud thresholds in force on a business date (today by default) and their change history","operationId":"getFraudParameters","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudParametersView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all fraud parameters","tags":["Fraud Parameter"]},"put":{"operationId":"putFraudParameters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudParameterProposal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudParameterChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a fraud threshold from a later business date as the verified staff member; it is in force only once a second person approves it","tags":["Fraud Parameter"]}},"/fraud-parameters/proposals/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFraudParametersProposalsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudParameterDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudParameterChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's fraud threshold proposal (operations:approve), or withdraw your own; decisions are immutable","tags":["Fraud Parameter"]}},"/fraud-reviews":{"get":{"description":"List outbound payments the fraud rules held, newest first (status open, released or rejected; payment_id)","operationId":"getFraudReviews","parameters":[{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"payment_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReviewList"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all fraud reviews","tags":["Fraud Review"]}},"/fraud-reviews/{id}":{"get":{"description":"Read a fraud review: the rules hit, the parameters and history judged, the call-backs and the decision","operationId":"getFraudReviewsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a fraud review by ID","tags":["Fraud Review"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/fraud-reviews/{id}/callbacks":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFraudReviewsIdCallbacks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudCallbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudCallback"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a call-back to the number on the customer record (outcome verified, not_verified or no_answer); the body cannot name a number","tags":["Fraud Review"]}},"/fraud-reviews/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postFraudReviewsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release (back onto the normal send path) or reject (funds released) a held payment with a reason; not the payment's initiator, and a call-back release needs a second staff member","tags":["Fraud Review"]}},"/fx-quote-expiry-runs":{"post":{"description":"The scheduler lapses a bounded page of quotes whose rate no longer stands, held or booked, and answers the quote ids it expired. A quote is expired by the clock whether or not anyone reads it, so a rate the bank no longer holds is never bookable or convertible.","operationId":"postFxQuoteExpiryRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteExpiryRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Lapse a bounded page of quotes whose rate no longer stands (scheduler)","tags":["Other"]}},"/fx-quotes":{"post":{"description":"The customer's own instruction: a customer token, or a service holding accounts:fx:quote acting on an instruction it is carrying out. pair is BASE/QUOTE (for example EUR/USD) and side says whether the customer buys or sells the base currency, which fixes which of their accounts the money leaves and which it arrives in: buying the base means it arrives in the base-currency account. Exactly one leg carries the amount, in its own currency's minor units (JPY has none, KWD three). source_account_id and target_account_id name the customer's own open deposit accounts, whose currencies must match the pair and side. The quote is struck on the bank's current approved customer sheet and answers the rate, both amounts, their currencies and when it expires; it is held unbooked until it is booked, cancelled or expires. The ledger's per-conversion and daily customer limits apply (ledger.fx_limit_exceeded, 422), an unsupported currency is ledger.currency_unsupported (422) and no valid sheet is ledger.fx_rate_unavailable (409). The Idempotency-Key is scoped to the customer and source account and bound to the request; a replay returns the quote already struck with 200.","operationId":"postFxQuotes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteOrder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteResource"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteResource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an FX quote","tags":["FX Quote"]}},"/fx-quotes/{id}":{"get":{"description":"Read permission on the account the quote was struck from. The quote's state is quoted while it is merely held, booked once the rate is firm, cancelled if it was withdrawn and expired once its time passed.","operationId":"getFxQuotesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteResource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an FX quote by ID","tags":["FX Quote"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/fx-quotes/{id}/book":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Initiate permission on the source account, and an Idempotency-Key. Booking makes the quote a firm rate the bank honours until it expires, so a service carrying out a customer instruction can rely on the price before it moves any money. Booking is idempotent under its key: the same key answers the booking already made with 200, a different key on an already booked quote is 409, a cancelled or expired quote is 409, and a quote whose time has passed is accounts.fx_quote_expired (409).","operationId":"postFxQuotesIdBook","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteResource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Book a held quote as a firm rate the bank honours until it expires (idempotent under its Idempotency-Key)","tags":["FX Quote"]}},"/fx-quotes/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Initiate permission on the source account. A held quote is withdrawn and prices nothing; cancelling an already cancelled quote answers the same again. A booked quote is a firm rate and is not cancellable: it runs to its conversion or its expiry (409).","operationId":"postFxQuotesIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXQuoteResource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel a held quote so it prices nothing","tags":["FX Quote"]}},"/fx-rate-sheet":{"get":{"description":"A customer identity, or a service holding accounts:fx:quote, reads the bank's current customer rates: for every currency pair the bank quotes, the mid rate it prices from, the rate the customer buys the base currency at, the rate they sell it at, the spreads either side of mid in basis points and the largest conversion the pair prices. Rates are quote-currency major units per one base major unit, at ten decimals, for display. Every pair is quoted against USD, which is how the sheet is approved; a conversion between two foreign currencies is priced through USD on the same sheet. The rates come from the treasury's independently approved sheet, so what is published here and what a quote is struck at are one record; the sheet's maker, approver, policy reference and review evidence stay inside that record. accounts.fx_rate_unavailable-equivalent 409 (ledger.fx_rate_unavailable) when no approved sheet is valid now.","operationId":"getFxRateSheet","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FXRateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the bank's current customer exchange rates and spreads per currency pair, as a quote asked for now would be priced","tags":["Other"]}},"/garnishments":{"get":{"description":"List garnishments","operationId":"getGarnishments","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Garnishment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all garnishments","tags":["Garnishment"]}},"/garnishments/{id}":{"get":{"description":"Read a garnishment","operationId":"getGarnishmentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Garnishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a garnishment by ID","tags":["Garnishment"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/garnishments/{id}/notices":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postGarnishmentsIdNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record that the 31 CFR 212.7 notice went to the account holder within three business days of the account review","tags":["Garnishment"]}},"/garnishments/{id}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postGarnishmentsIdRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reasonBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Garnishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Lift the hold without paying","tags":["Garnishment"]}},"/garnishments/{id}/remit":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postGarnishmentsIdRemit","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"operator":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Garnishment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture the frozen funds as a source-bound issuer payable awaiting separately evidenced outward settlement","tags":["Garnishment"]}},"/healthz":{"get":{"operationId":"getHealthz","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Liveness check","tags":["Health"]}},"/hoa/accounts/{account_id}/balances":{"get":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"getHoaAccountsAccount_idBalances","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Observe actual association receivables including collected check returns","tags":["Other"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}]},"/hoa/changes":{"get":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md. account_id is required, after_id is optional; pages contain up to 200 changes with more for continuation. Supported account inventory is bounded at 2000 retained changes and fails explicitly above that capacity.","operationId":"getHoaChanges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaPage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List association accounting changes with independent decisions","tags":["Other"]},"post":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"postHoaChanges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaChange"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose evidenced association roster, dues or receipt allocation","tags":["Other"]}},"/hoa/changes/{id}":{"get":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"getHoaChangesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact association change evidence","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/hoa/changes/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"postHoaChangesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject exact customer association evidence","tags":["Other"]}},"/hoa/statements":{"post":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"postHoaStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaStatementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaStatement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare immutable association statement from exact reviewed source","tags":["Other"]}},"/hoa/statements/{id}":{"get":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"getHoaStatementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoaStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable association statement artifact","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/hoa/statements/{id}/source-status":{"get":{"description":"Bank-bound verified customer person with customer scope, session/device and current association business membership required. Writes require fresh five-minute step-up; staff, services and API keys cannot impersonate the association. Independent review requires distinct user AND person identities. Reviewed unit roster, assessments, adjustments and collected lockbox allocations are customer receivables, never deposit ownership or bank GL postings. Pending source/invoice/dues and partial-release capacities are serialized against actual check returns. Current balances reopen unpaid dues only from exact committed return evidence. Statement preparation binds the expected current source SHA256 and retains an immutable association-receivables-json-1 artifact/outbox without claiming delivery. See services/payments/hoa/README.md.","operationId":"getHoaStatementsIdSourceStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Compare statement with current dues and actual bank returns","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/information-sharing/counterparties":{"get":{"operationId":"getInformationSharingCounterparties","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InfoSharingCounterparty"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the 314(b) counterparty registry (compliance staff only)","tags":["Information Sharing"]},"post":{"operationId":"postInformationSharingCounterparties","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingCounterpartyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingCounterparty"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a counterparty institution's verified 314(b) registration period","tags":["Information Sharing"]}},"/information-sharing/counterparties/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postInformationSharingCounterpartiesIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingCounterparty"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's registry entry (operations:approve), or withdraw your own","tags":["Information Sharing"]}},"/information-sharing/log":{"get":{"operationId":"getInformationSharingLog","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"counterparty_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InfoSharingEntry"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the immutable 314(b) sharing log (compliance staff only)","tags":["Information Sharing"]},"post":{"operationId":"postInformationSharingLog","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingEntry"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Log a 314(b) exchange; refused unless both registrations are in force today (Idempotency-Key required)","tags":["Information Sharing"]}},"/information-sharing/registrations":{"get":{"operationId":"getInformationSharingRegistrations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InfoSharingRegistration"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the bank's 314(b) registrations (compliance staff only)","tags":["Information Sharing"]},"post":{"operationId":"postInformationSharingRegistrations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingRegistrationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingRegistration"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the bank's 314(b) registration or renewal (31 CFR 1010.540); in force once a second person approves it","tags":["Information Sharing"]}},"/information-sharing/registrations/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postInformationSharingRegistrationsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoSharingRegistration"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's registration (operations:approve), or withdraw your own","tags":["Information Sharing"]}},"/investment-closure-readiness":{"get":{"description":"Verified staff/service with payments:investments:read or payments:investments:write supplies required account_id to inspect unfinished orders, custody lots and actual cash events that block original DDA closure. A disposed lot needs a final signed custodian close-out assertion with zero actual units and explicit zero remaining income after disposal. Sale or maturity alone does not establish no future dividend. This callback reads one consistent database inventory and actual ledger evidence without calling accounts or holding the custody writer lock.","operationId":"getInvestmentClosureReadiness","parameters":[{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosureReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read securities and remaining cash entitlements that block closing the original deposit account","tags":["Other"]}},"/investment-controls/{id}":{"get":{"description":"Verified staff/service with payments:investments:read or payments:investments:write reads retained program, instrument or custody evidence and independent decision. Customers cannot read raw controls through this endpoint.","operationId":"getInvestmentControlsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an investment control by ID","tags":["Investment Control"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/investment-controls/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with both payments:investments:write and payments:investments:approve independently approves or rejects the exact content digest. Maker cannot review their own control. Identical actor/decision replay returns the original review; changed decisions conflict.","operationId":"postInvestmentControlsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact investment program, instrument or custody content","tags":["Investment Control"]}},"/investment-custody-accounts":{"post":{"description":"Fresh verified staff with payments:investments:write proposes signed actual custodian onboarding and ownership, bound to the approved program, customer, original DDA and external beneficial account. Independent review is required. An enabled mapping must be current; a signed disabled revision stops new use without rewriting existing instructions.","operationId":"postInvestmentCustodyAccounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsCustodyAccount"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an investment custody account","tags":["Investment Custody Account"]}},"/investment-distributions":{"post":{"description":"Only the exact configured service with payments:investments:bridge supplies actual signed MMF cash income or full Treasury maturity evidence. Exact actor/key/input and unique external event replay protect cash. Gross, withholding, fees, net cash and actual provider tax character are retained separately. Treasury gross is full redeemed face once, never face plus the discount again; reaching maturity or projecting dividends is not receipt of cash. Competing sale/maturity cannot dispose the same lot twice.","operationId":"postInvestmentDistributions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Distribution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an investment distribution","tags":["Investment Distribution"]}},"/investment-distributions/{id}":{"get":{"description":"Verified owner with customer scope and account access, or staff/service with payments:investments:read or payments:investments:write, reads the immutable actual external cash event and recovery state.","operationId":"getInvestmentDistributionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an investment distribution by ID","tags":["Investment Distribution"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/investment-distributions/{id}/reconcile":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh staff with both payments:investments:write and payments:investments:approve independently reviews the exact completed cash-event digest, actual cash evidence and current signed custody and remaining-income observation. Supported delayed-accounting exceptions may resolve with retained review; competing dispositions remain blocked. The review never changes actual gross, withholding, fees, net cash or original receipt dates and cannot pay an event again. Customers cannot reconcile exceptions.","operationId":"postInvestmentDistributionsIdReconcile","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently reconcile an exact completed investment cash-event exception against actual source evidence","tags":["Investment Distribution"]}},"/investment-instruments":{"post":{"description":"Fresh verified staff with payments:investments:write proposes the exact approved program, CUSIP and evidenced instrument classification. Only USD zero-coupon Treasury bills and government no-load MMF shares are supported. Units and prices use fixed integer scales; Treasury prices are per $100 face, MMF prices per share, with half-up cent cash rounding. No $1 NAV, margin, short sale or automatic reinvestment is assumed.","operationId":"postInvestmentInstruments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsInstrument"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an investment instrument","tags":["Investment Instrument"]}},"/investment-lots":{"get":{"description":"Verified bound customer with customer scope must supply an authorized account_id; verified staff/service with payments:investments:read or payments:investments:write may read the custody inventory. Lots retain original complete quantity, acquisition controls and actual cash cost; tax basis and current prices remain unknown until evidenced.","operationId":"getInvestmentLots","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvestmentsLot"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all investment lots","tags":["Investment Lot"]}},"/investment-lots/{id}":{"get":{"description":"Verified owner with customer scope and account access, or staff/service with payments:investments:read or payments:investments:write, reads original custody identity, actual cost, current reservation, signed observations and actual disposal evidence.","operationId":"getInvestmentLotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsLot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an investment lot by ID","tags":["Investment Lot"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/investment-lots/{id}/observations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the exact configured service with payments:investments:bridge supplies signed actual custodian units, optional values/tax basis/income and as-of date bound to the original settlement and beneficial account. Authentic unit mismatches are retained as exceptions; they never silently rewrite lots. Changed same-date evidence needs explicit correction. Unknown or zero actual NAV is not replaced with $1. Source observations do not post money.","operationId":"postInvestmentLotsIdObservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsObservation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsLot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain signed actual custody units, values and explicit unknowns for reconciliation","tags":["Investment Lot"]}},"/investment-orders":{"get":{"description":"Verified bound customer with customer scope must supply an authorized account_id; verified staff/service with payments:investments:read or payments:investments:write may read the bank inventory. Cursor pagination is supported; every returned customer row remains ownership checked.","operationId":"getInvestmentOrders","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvestmentsOrder"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all investment orders","tags":["Investment Order"]},"post":{"description":"Fresh verified bound customer with customer scope consents to exact owner, account, current controls, disclosure, full quantity, price limit, fee limit and maximum BUY debit or minimum SELL proceeds. Staff cannot manufacture customer consent. Only individual single-owner USD custody is supported. Shared payment limits apply to BUY requests; exclusive full-lot reservation prevents short or competing sales. Actor/key/input replay retains the original stable order and lot identities.","operationId":"postInvestmentOrders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsCreateOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an investment order","tags":["Investment Order"]}},"/investment-orders/{id}":{"get":{"description":"Verified owner with customer scope and account access, or staff/service with payments:investments:read or payments:investments:write, reads retained customer consent, controls, reservations, issued instruction, signed execution and settlement and recovery state.","operationId":"getInvestmentOrdersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an investment order by ID","tags":["Investment Order"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/investment-orders/{id}/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only a service with payments:investments:bridge whose exact subject matches the retained program receives the durable approved instruction. Current source/control checks precede first dispatch; dispatch commits before returning and retry retains the exact issued command.","operationId":"postInvestmentOrdersIdDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsInstruction"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue the durable approved securities instruction to its configured broker bridge","tags":["Investment Order"]}},"/investment-orders/{id}/execution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the exact configured service with payments:investments:bridge submits domain-separated signed full execution or actual zero-cash no-fill cancellation/rejection. Evidence binds issued command, owner, external account, security, units, actual price, fees, net cash and broker/custodian. Confirmation bytes and actual customer delivery recipient/time/method are retained. Quotes, ACKs, partial fills or unauthorized price/cash changes cannot become a full settlement.","operationId":"postInvestmentOrdersIdExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsExecution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain signed actual full execution or no-fill cancellation and customer confirmation delivery","tags":["Investment Order"]}},"/investment-orders/{id}/reconcile":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh staff with both payments:investments:write and payments:investments:approve independently reviews the exact digest of the completed order, distinct from the original customer and trade approver. Only supported delayed-accounting exceptions can resolve after actual immutable cash claims and current signed custody units and explicit remaining income are verified. Review is retained; it cannot rewrite broker evidence or authorize another trade. Customers cannot reconcile exceptions.","operationId":"postInvestmentOrdersIdReconcile","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently reconcile an exact completed order accounting exception against actual cash and custody evidence","tags":["Investment Order"]}},"/investment-orders/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh staff with both payments:investments:write and payments:investments:approve reviews exact customer consent independently. Current ownership, KYC/sanctions and active controls are checked again. A BUY reserves both actual customer DDA and bank cash; a SELL binds the exclusive complete custody lot. Execution acknowledgement alone cannot move customer money.","operationId":"postInvestmentOrdersIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Review exact customer trade consent and reserve actual buy cash or full-sale custody units","tags":["Investment Order"]}},"/investment-orders/{id}/settlement":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the exact configured service with payments:investments:bridge submits signed actual cash and customer beneficial custody delivery, bound to the retained full execution. Receipt is retained before accounting, external evidence cannot fund two orders, and saved exact journal plans recover uncertain replies without duplicate cash. Late actual settlement retains its original date and exception. BUY removes DDA liability only after actual paid DVP; SELL restores actual received net cash. Customer securities never become bank-owned investment assets.","operationId":"postInvestmentOrdersIdSettlement","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsSettlement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify actual signed cash and beneficial custody delivery before booking securities settlement","tags":["Investment Order"]}},"/investment-orders/{id}/withdraw":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified bound customer with customer scope may withdraw only before dispatch. Actual cash and lot reservations recover before withdrawal completes. A dispatched order needs signed actual no-fill cancellation, not a local timeout assumption.","operationId":"postInvestmentOrdersIdWithdraw","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withdraw an undispatched securities order and recover its reservations","tags":["Investment Order"]}},"/investment-programs":{"post":{"description":"Fresh verified staff with payments:investments:write proposes exact actor/input content. The reviewed program binds this bank, broker/custodian identity, public evidence keys, actual agency authority and custody, tax and confirmation agreements. Initial tax reporter and confirmation provider are broker_custodian; bank remuneration is none. This is an agency securities program, not a deposit or a bank-owned portfolio, and no provider certification or blanket regulatory approval is inferred.","operationId":"postInvestmentPrograms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsProgram"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an investment program","tags":["Investment Program"]}},"/investment-programs/{id}/disclosure":{"get":{"description":"Required instrument_id query selects the independently approved instrument in this current approved program. A verified bound customer with customer scope, or staff/service with payments:investments:read or payments:investments:write, receives exact disclosure terms and digest. The disclosure states that securities are not FDIC insured, are not deposits or bank guarantees and can lose principal; it binds broker/custodian and actual tax and confirmation responsibility.","operationId":"getInvestmentProgramsIdDisclosure","parameters":[{"in":"query","name":"instrument_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsDisclosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the customer risk disclosure binding the program and required instrument_id","tags":["Investment Program"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/investment-snapshot":{"get":{"description":"Verified staff/service with payments:investments:read or payments:investments:write captures the complete current source inventory and actual ledger evidence with immutable digests and explicit custody or cash exceptions. No customer all-book access. Original customer securities stay separate from deposits and bank-owned assets. A complete source above the bounded response size fails explicitly; evidence is never silently truncated or reconstructed as historical truth.","operationId":"getInvestmentSnapshot","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestmentsSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a bounded complete custody source with actual cash evidence and explicit exceptions","tags":["Other"]}},"/kyc-checks":{"get":{"description":"List KYC checks","operationId":"getKycChecks","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/KYCCheck"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all KYC checks","tags":["KYC Check"]},"post":{"description":"Verify a customer through the provider and record the decision","operationId":"postKycChecks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["customer_id"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a KYC check","tags":["KYC Check"]}},"/kyc-checks/{id}":{"get":{"description":"Read a KYC check","operationId":"getKycChecksId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KYCCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a KYC check by ID","tags":["KYC Check"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts":{"post":{"description":"Open a ledger account (idempotent on address)","operationId":"postLedgerAccounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerOpenAccountRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a ledger account","tags":["Ledger Account"]}},"/ledger/accounts/{id}":{"get":{"description":"Read the actual persisted ledger account address and accounting classification","operationId":"getLedgerAccountsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a ledger account by ID","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/activity":{"get":{"operationId":"getLedgerAccountsIdActivity","parameters":[{"in":"query","name":"from","schema":{"type":"string"}},{"in":"query","name":"through","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerActivity"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Complete activity and opening/closing balances for an inclusive date range","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/balance":{"get":{"operationId":"getLedgerAccountsIdBalance","parameters":[{"in":"query","name":"definition","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A named balance (posted or available)","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/balances":{"get":{"operationId":"getLedgerAccountsIdBalances","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}},{"in":"query","name":"recorded_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBalances"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Posted and available balances with active holds by kind; with as_of, the posted balance as of a date (and as it was known before an instant)","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an empty ledger account","tags":["Ledger Account"]}},"/ledger/accounts/{id}/closure":{"get":{"operationId":"getLedgerAccountsIdClosure","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerClosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable closure evidence","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdClosure","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerClosureRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerClosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically settle final interest, taxes and payout, then close","tags":["Ledger Account"]}},"/ledger/accounts/{id}/entries":{"get":{"operationId":"getLedgerAccountsIdEntries","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"entries":{"items":{"$ref":"#/components/schemas/LedgerEntryLine"},"type":"array"}},"required":["entries"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Entries with running balance","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/interest-plan":{"get":{"operationId":"getLedgerAccountsIdInterestPlan","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerInterestPlan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an interest plan","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putLedgerAccountsIdInterestPlan","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerInterestPlanRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerInterestPlan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set the interest plan on a ledger account","tags":["Ledger Account"]}},"/ledger/accounts/{id}/interest-plan/accruals":{"get":{"operationId":"getLedgerAccountsIdInterestPlanAccruals","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accruals":{"items":{"$ref":"#/components/schemas/LedgerAccrual"},"type":"array"}},"required":["accruals"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Daily accruals for a period","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/interest-plan/adjustments":{"get":{"operationId":"getLedgerAccountsIdInterestPlanAdjustments","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerInterestAdjustment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Interest corrections made by backdated journals","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/interest-plan/close":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdInterestPlanClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Stop accrual on an account","tags":["Ledger Account"]}},"/ledger/accounts/{id}/interest-plan/schedules":{"get":{"operationId":"getLedgerAccountsIdInterestPlanSchedules","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DomainInterestSchedule"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained interest schedules and cancellations","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdInterestPlanSchedules","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestScheduleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainInterestSchedule"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainInterestSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a future calendar-dated interest instruction","tags":["Ledger Account"]}},"/ledger/accounts/{id}/interest-plan/schedules/{schedule}":{"get":{"operationId":"getLedgerAccountsIdInterestPlanSchedulesSchedule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainInterestSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an immutable interest instruction and status","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"schedule","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/interest-plan/schedules/{schedule}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"schedule","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdInterestPlanSchedulesScheduleCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestScheduleCancellation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainInterestSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel interest terms before their effective date and accrual","tags":["Ledger Account"]}},"/ledger/accounts/{id}/protection":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerAccountsIdProtection","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"purpose":{"type":"string"}},"required":["purpose"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Permanently classify an IRA/HSA ledger account under accounts service authority","tags":["Ledger Account"]}},"/ledger/accounts/{id}/snapshots/{date}":{"get":{"operationId":"getLedgerAccountsIdSnapshotsDate","parameters":[{"in":"query","name":"version","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The end-of-day snapshot for a date","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"date","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/statement-snapshot":{"get":{"operationId":"getLedgerAccountsIdStatementSnapshot","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Complete statement financial cut with sealed history or immutable final closure evidence","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/accounts/{id}/usd-equivalent":{"get":{"description":"Ledger reader authority and a closed business_date required. The account's closing posted balance on the date and its USD equivalent at the approved closing rate the close remeasured the currency at, rounded once to the cent; a USD account is its own equivalent. This is the bank's own closing-rate equivalent for reporting. It is not the FDIC's insurance determination: 12 CFR 330.3(c) determines a foreign-currency deposit's insurance in the USD equivalent as of close of business on the date of default at the noon buying rates the Federal Reserve Bank of New York quotes, unless the deposit agreement names other widely recognized rates. not_found before the currency's first close.","operationId":"getLedgerAccountsIdUsdEquivalent","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUSDEquivalent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"An account's closing posted balance on a closed business date and its USD equivalent at that date's closing rate","tags":["Ledger Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/availability-batches":{"post":{"operationId":"postLedgerAvailabilityBatches","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAvailabilityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically replace a deposit's availability holds","tags":["Ledger"]}},"/ledger/borrowing-proposals":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerBorrowingProposals","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerBorrowingProposal"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List proposed draws waiting for a second treasury approver, pending ones first","tags":["Ledger"]}},"/ledger/borrowing-proposals/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerBorrowingProposalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingProposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a proposed draw and its review","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/borrowing-proposals/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. Approval rechecks the lender's capacity on the day and books the advance under the proposal's own key.","operationId":"postLedgerBorrowingProposalsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingProposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (booking the advance after a fresh capacity check) or reject a proposed draw (a treasury checker other than its maker)","tags":["Ledger"]}},"/ledger/borrowings":{"get":{"description":"List the bank's borrowings, open ones first","operationId":"getLedgerBorrowings","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerBorrowing"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all borrowings","tags":["Borrowing"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Draws from a reviewed lender whose kind matches (`fhlb_advance` from `fhlb`, `discount_window` from `federal_reserve_discount_window`), refused 409 `conflict` beyond the lender's capacity. Above the approval threshold the draw is accepted 202 with a borrowing proposal instead of the borrowing, for a second treasury approver.","operationId":"postLedgerBorrowings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowing"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowing"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a borrowing","tags":["Borrowing"]}},"/ledger/borrowings/{id}":{"get":{"description":"Read a borrowing with what is outstanding","operationId":"getLedgerBorrowingsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowing"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a borrowing by ID","tags":["Borrowing"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/borrowings/{id}/lender-repayments":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerBorrowingsIdLenderRepayments","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerLenderRepayment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a borrowing's repayments through its lender, oldest first","tags":["Borrowing"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 `dependency_failed`. Only an advance drawn through a lender connection, else 409 `conflict`; principal beyond what is outstanding is 409. The lender's confirmation books, in one journal, the advance's liability for principal and the interest recognised from its statements, interest on borrowings (GL 5200) for the lender's charge beyond that, and the master account (GL 1010) for what the lender debited; the last dollar marks the borrowing repaid. A refusal is retained with the lender's reason. One repayment in flight per advance; a lost confirmation is 424 `dependency_failed` and the same key resends.","operationId":"postLedgerBorrowingsIdLenderRepayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderRepaymentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderRepayment"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderRepayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Repay principal of an advance drawn through its lender's connection: the lender charges the interest owed and the confirmation books principal, interest and cash in one journal (treasury staff)","tags":["Borrowing"]}},"/ledger/borrowings/{id}/repayments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. No second approver. The last dollar closes the advance once no whole cent of interest has accrued since the last month-end.","operationId":"postLedgerBorrowingsIdRepayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flat"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowing"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Repay a borrowing in part or in full (treasury staff, no second approver); the last dollar closes it","tags":["Borrowing"]}},"/ledger/borrowings/{id}/structure-terms":{"get":{"description":"Every version of the advance's structure terms and its review, oldest first; Schedule RC-M items 5.a.(1) to 5.a.(3) read the approved version in force at the report date. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerBorrowingsIdStructureTerms","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerBorrowingStructureTerms"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List every version of an advance's structure terms and their reviews, oldest first","tags":["Borrowing"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Records the next version of an advance's terms from `effective_date` (on or after the draw, before maturity): `rate_type` `fixed` (a floating rate is refused 422: the ledger accrues each advance at one annual rate with no repricing), one `options` entry per kind the agreement contains (`call`, `conversion` or `put` with its first exercise date; `cap`, `floor` or `other_embedded_derivative`), an empty list attesting none, and the agreement's `source_ref` and SHA-256. A call the lender exercised or a put the bank exercised carries `exercised_date`, the date it repays the advance, in a version effective from the notice (on or after the first exercise date, on or before maturity, at most one per version); a conversion has none, since a converted advance floats. Schedule RC-M item 5.a reports such an advance by its exercise date and a convertible one by its next conversion date. The database refuses the same option records. A version waiting for review, or one not effective after the approved version, is refused 409 `conflict`. The same key and terms replay; other terms under the key are 409.","operationId":"postLedgerBorrowingsIdStructureTerms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingStructureTermsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingStructureTerms"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingStructureTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the next version of an advance's fixed-rate structure terms (call, conversion, put, cap, floor or other embedded derivative) from an effective date, pending independent review (treasury staff)","tags":["Borrowing"]}},"/ledger/borrowings/{id}/structure-terms/{version}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. ","operationId":"postLedgerBorrowingsIdStructureTermsVersionReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerBorrowingStructureTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a version of an advance's structure terms (a treasury checker other than its maker)","tags":["Borrowing"]}},"/ledger/business-date":{"get":{"operationId":"getLedgerBusinessDate","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The current business date, next banking day and cutoff","tags":["Ledger"]}},"/ledger/cash/matches":{"post":{"description":"Dedicated ledger:cash staff/source authority, verified non-API-key identity, and recent step-up for staff mutations. Exact immutable content and a different reviewer are required for actual cash allocation. Every grouped journal must have the actual line direction and their sum must exactly equal that line. A line and each actual master-account journal can be consumed only once across modules. Test source statements cannot pin or allocate production journals. Signed source date remains separate from journal accounting date; this is line-source reliance, not a claim that the whole bank closing balance reconciles.","operationId":"postLedgerCashMatches","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankcashMatch"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankcashMatch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank cash match","tags":["Bank Cash Match"]}},"/ledger/cash/matches/{id}":{"get":{"description":"Dedicated ledger:cash staff/source authority, verified non-API-key identity, and recent step-up for staff mutations. Exact immutable content and a different reviewer are required for actual cash allocation. Every grouped journal must have the actual line direction and their sum must exactly equal that line. A line and each actual master-account journal can be consumed only once across modules. Test source statements cannot pin or allocate production journals. Signed source date remains separate from journal accounting date; this is line-source reliance, not a claim that the whole bank closing balance reconciles.","operationId":"getLedgerCashMatchesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankcashMatch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank cash match by ID","tags":["Bank Cash Match"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/cash/matches/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated ledger:cash staff/source authority, verified non-API-key identity, and recent step-up for staff mutations. Exact immutable content and a different reviewer are required for actual cash allocation. Every grouped journal must have the actual line direction and their sum must exactly equal that line. A line and each actual master-account journal can be consumed only once across modules. Test source statements cannot pin or allocate production journals. Signed source date remains separate from journal accounting date; this is line-source reliance, not a claim that the whole bank closing balance reconciles.","operationId":"postLedgerCashMatchesIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankcashDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankcashMatch"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently match and exclusively allocate actual cash journals against a statement line","tags":["Bank Cash Match"]}},"/ledger/cash/statements":{"post":{"description":"Only actual svc_bank_statement_bridge with ledger:cash:bridge may deliver independently signed complete normalized statement and actual raw document bytes (maximum 8 MiB). Source configuration binds real open bank-owned USD GL1010, external account identity, environment and dated Ed25519 verification keys. Full opening-plus-lines rollforward must equal closing balance, and revisions must extend exact current source digest. Raw source uses authenticated encryption; exact admitted replay survives signing-key retirement. This is a bank bridge contract, not a certified Fed/operator protocol. Missing source configuration disables admission.","operationId":"postLedgerCashStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedStatement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetainedStatement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetainedStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an independent bank statement","tags":["Independent Bank Statement"]}},"/ledger/cash/statements/{id}":{"get":{"description":"Dedicated ledger:cash staff/source authority, verified non-API-key identity, and recent step-up for staff mutations. Exact immutable content and a different reviewer are required for actual cash allocation. Every grouped journal must have the actual line direction and their sum must exactly equal that line. A line and each actual master-account journal can be consumed only once across modules. Test source statements cannot pin or allocate production journals. Signed source date remains separate from journal accounting date; this is line-source reliance, not a claim that the whole bank closing balance reconciles.","operationId":"getLedgerCashStatementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetainedStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an independent bank statement by ID","tags":["Independent Bank Statement"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/cash/statements/{id}/document":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh actual bank cash staff with read and write scopes and bounded recorded purpose required. Source document is decrypted, authenticated and hash-verified, then access is durably recorded before bytes are released. Full response limit supports an 8 MiB document encoded as JSON. Generic statement readers and bridge credentials cannot export raw evidence.","operationId":"postLedgerCashStatementsIdDocument","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"content":{"format":"byte","type":"string"}},"required":["content"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Audit exact confidential statement document export before releasing source bytes","tags":["Independent Bank Statement"]}},"/ledger/chart-of-accounts":{"get":{"operationId":"getLedgerChartOfAccounts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"chart":{"items":{"$ref":"#/components/schemas/LedgerChartLine"},"type":"array"}},"required":["chart"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The chart of accounts","tags":["Ledger"]}},"/ledger/check-source-consumptions":{"post":{"operationId":"postLedgerCheckSourceConsumptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCheckConsumptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically pay or collect complete funded checks and prevent duplicate consumption or reversal","tags":["Ledger"]}},"/ledger/check-source-reservations":{"post":{"operationId":"postLedgerCheckSourceReservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCheckSourceReservationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCheckSourceReservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reserve complete check return funding before operator publication against reversal or reuse","tags":["Ledger"]}},"/ledger/closing-snapshots/{date}":{"get":{"operationId":"getLedgerClosingSnapshotsDate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the original completed closing balances and provenance","tags":["Ledger"]},"parameters":[{"in":"path","name":"date","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/breaks/{id}/resolution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store requires `operations:approve` and a step-up within five minutes. A `pledged_asset_ended` break is refused 409 `conflict` while its pledge is still reserved or pledged. The same resolution by the same checker replays.","operationId":"postLedgerCollateralBreaksIdResolution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralBreakResolution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralBreak"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resolve a break with a reason (a treasury checker); a pledged-asset break resolves only once its pledge is releasing or released","tags":["Ledger"]}},"/ledger/collateral/capacity":{"get":{"description":"Every approved lender's position; reporting reads the Reserve Bank's lendable value from it for the Fed position. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralCapacity","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerLenderCapacity"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every approved lender's lendable value, advances outstanding and borrowing capacity","tags":["Ledger"]}},"/ledger/collateral/close-readiness":{"get":{"description":"Blocks on a break or a lender's latest statement awaiting review or reconciliation beyond `break_block_age_days`, a reserved or acknowledged pledge on a matured or ineligible asset, and advances beyond a lender's lendable value; ledger end of day enforces the same judgement. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralCloseReadiness","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralCloseReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Whether the register lets the bank close a business_date: breaks and lender statements awaiting review or reconciliation beyond the reviewed tolerance, matured or ineligible pledges, and advances beyond capacity","tags":["Ledger"]}},"/ledger/collateral/lender-advances":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLenderAdvances","parameters":[{"in":"query","name":"lender_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerLenderAdvance"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all lender advances","tags":["Lender Advance"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 `dependency_failed`. Refused 409 `conflict` beyond the register's capacity for the lender. At or below the approval threshold the request is sent at once (201); above it the advance is accepted 202 `pending_review` for a second treasury approver. The lender's confirmation books the borrowing on GL 2410 or 2420 at the confirmed rate with no interest plan; a declined request is retained with the lender's reason. A lost confirmation is 424 `dependency_failed` and the same key resends.","operationId":"postLedgerCollateralLenderAdvances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderAdvanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderAdvance"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderAdvance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a lender advance","tags":["Lender Advance"]}},"/ledger/collateral/lender-advances/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLenderAdvancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderAdvance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a lender advance by ID","tags":["Lender Advance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lender-advances/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the maker, refused 422 `ledger.maker_checker_required`. Approval rechecks capacity on the day and sends the request; the same decision by the same checker replays and resends a request whose answer was lost.","operationId":"postLedgerCollateralLenderAdvancesIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderAdvance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (requesting the advance after a fresh capacity check) or reject an advance request (a treasury checker other than its maker)","tags":["Lender Advance"]}},"/ledger/collateral/lender-imports/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLenderImportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an imported lender statement or schedule and the interest it recognised","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lender-submissions/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLenderSubmissionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderCollateralSubmission"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a delivery or release with its transfer and the lender's decision","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lenders":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLenders","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerCollateralLender"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all collateral lenders","tags":["Collateral Lender"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. `kind` is `fhlb` (advances under GL 2410), `federal_reserve_discount_window` (GL 2420) or `repo_counterparty` (GL 2430, no advances); `evidence_keys` holds one to ten base64 ed25519 public keys by key id. The lender holds pledges and advances only once a different treasury checker approves it.","operationId":"postLedgerCollateralLenders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralLenderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralLender"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralLender"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a collateral lender","tags":["Collateral Lender"]}},"/ledger/collateral/lenders/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLendersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralLender"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a collateral lender by ID","tags":["Collateral Lender"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lenders/{id}/capacity":{"get":{"description":"Every live pledge as the schedule in force judges it for an advance to the horizon (the latest open advance's maturity, or `horizon` when later), the lendable value of the acknowledged eligible pledges, the advances outstanding, capacity and shortfall. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLendersIdCapacity","parameters":[{"in":"query","name":"horizon","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderCapacity"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A lender's live pledges as the schedule in force judges them, lendable value, advances outstanding and borrowing capacity; horizon names an advance maturity the collateral must outlast","tags":["Collateral Lender"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lenders/{id}/reconciliation":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralLendersIdReconciliation","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A lender's latest signed statement, the register's position and the breaks still open","tags":["Collateral Lender"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/lenders/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. ","operationId":"postLedgerCollateralLendersIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralLender"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a lender record (a treasury checker other than its maker)","tags":["Collateral Lender"]}},"/ledger/collateral/lenders/{id}/schedule-imports":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 `dependency_failed`. Reads the lender's signed collateral schedule and records it as a register schedule (haircut = 10000 less the lender's margin) that applies only once a treasury checker other than the importer approves it. The same key or the same signed document replays.","operationId":"postLedgerCollateralLendersIdScheduleImports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Import the lender's signed collateral schedule through its connection as a register schedule pending a treasury checker (treasury staff)","tags":["Collateral Lender"]}},"/ledger/collateral/lenders/{id}/statement-imports":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 `dependency_failed`. Reads the lender's signed statement for `as_of` (not after today, else 422), recognises each connected advance's accrued interest as the difference from what was recognised (GL 5200 against the advance), then records the statement in the register's lender-report form and opens a break for every difference. The same key or the same signed document replays.","operationId":"postLedgerCollateralLendersIdStatementImports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderDocumentImport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Import the lender's signed collateral statement for as_of through its connection: recognise the interest its advances accrued, then reconcile the statement against the register (treasury staff)","tags":["Collateral Lender"]}},"/ledger/collateral/loan-facts":{"post":{"description":"Only the lending service's own identity `svc_lending` holding `ledger:post` (never staff or an API key) reports a loan's facts; any other caller is refused 403 `forbidden`. A live pledge is re-evaluated at once; an acknowledged pledge on a loan paid off, charged off or matured opens a `pledged_asset_ended` break.","operationId":"postLedgerCollateralLoanFacts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLoanCollateralFacts"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report a loan's current facts (the lending service): a pledged loan that went past due, to nonaccrual, charged off or paid off stops lending at once","tags":["Ledger"]}},"/ledger/collateral/parameters":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralParameters","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerCollateralParameters"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the register's parameter instructions and their reviews","tags":["Ledger"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. `draw_approval_threshold_amount` is the draw above which a second approver books the advance; `break_block_age_days` (0 to 365) how old a break or an unreviewed lender statement may be before it blocks the close. With none approved every draw needs a second approver and every open break or unreviewed statement blocks.","operationId":"postLedgerCollateralParameters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralParameterRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralParameters"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralParameters"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the register's effective-dated parameters: the draw approval threshold and the break age that blocks the close, pending independent review (treasury staff)","tags":["Ledger"]}},"/ledger/collateral/parameters/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. ","operationId":"postLedgerCollateralParametersIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralParameters"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a parameter instruction (a treasury checker other than its maker)","tags":["Ledger"]}},"/ledger/collateral/pledge-positions":{"get":{"description":"Replays every retained pledge event to the close of `as_of`, a business date that has ended (409 `conflict` otherwise): each pledge reserved, pledged or releasing at that close, with the business date its state began. A pledge released on or before the date is absent. Events retained before ledger migration 0059 carry no business date; a pledge whose undated events could fall on either side of the date is listed in `undated_pledges` instead of placed. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralPledgePositions","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledgePositions"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every pledge live at the close of a business date that has ended (as_of), replayed from the retained pledge events, with pledges whose undated history cannot be placed","tags":["Ledger"]}},"/ledger/collateral/pledged-totals":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralPledgedTotals","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPledgedTotals"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Acknowledged pledges by lender, asset kind and class, for the Call Report's pledged securities and pledged loans","tags":["Ledger"]}},"/ledger/collateral/pledges":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralPledges","parameters":[{"in":"query","name":"lender_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerCollateralPledge"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all collateral pledges","tags":["Collateral Pledge"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. One live pledge per asset across every program, refused 409 `conflict`. A loan's facts are read from lending and the reservation is mirrored onto the loan after it commits; if lending does not answer the reservation stands and the call answers 424 `dependency_failed`, and replaying the key repeats the mirror.","operationId":"postLedgerCollateralPledges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledgeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledge"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a collateral pledge","tags":["Collateral Pledge"]}},"/ledger/collateral/pledges/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralPledgesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a collateral pledge by ID","tags":["Collateral Pledge"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/pledges/{id}/lender-submissions":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralPledgesIdLenderSubmissions","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerLenderCollateralSubmission"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a pledge's deliveries to and releases through its lender, oldest first","tags":["Collateral Pledge"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The lender is a simulator reached through the lender kind's configured connection; a kind with none answers 424 `dependency_failed`. `purpose` `pledge` takes a `reserved` pledge (a loan is listed on the lender's schedule; a Treasury lot is first moved free of payment through the Fedwire Securities simulator to the lender's securities account); `release` takes a `pledged` one and is refused 409 `conflict` when it would leave the lender's advances uncovered. The lender's signed acceptance moves the pledge to `pledged`, its release to `released`; a refusal is retained with its reason. One submission in flight per pledge, else 409. When the operator or lender does not answer the call is 424 `dependency_failed` and the same key resends.","operationId":"postLedgerCollateralPledgesIdLenderSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderSubmissionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderCollateralSubmission"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerLenderCollateralSubmission"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver a reserved pledge to its lender (a loan listed on the lender's schedule; a securities lot moved by a Fedwire Securities transfer to the lender's account first) or ask the lender to release an acknowledged one; the lender's signed decision moves the pledge (treasury staff)","tags":["Collateral Pledge"]}},"/ledger/collateral/pledges/{id}/transitions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. `reserved` to `pledged` (the lender's `reference` is required), `releasing` or `released`; `pledged` to `releasing`; `releasing` to `released`. A release that would leave more of the lender's advances uncovered is refused 409 `conflict`. The same transition replays and repeats lending's mirror.","operationId":"postLedgerCollateralPledgesIdTransitions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledgeTransition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralPledge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Move a pledge to pledged (with the lender's reference), releasing or released; a release that would leave advances uncovered is refused (treasury staff)","tags":["Collateral Pledge"]}},"/ledger/collateral/schedules":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralSchedules","parameters":[{"in":"query","name":"lender_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerCollateralSchedule"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List collateral schedules, optionally for one lender_id","tags":["Ledger"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Names an approved lender, an effective date, one entry per asset class it rules on (haircut 0 to 9999 bps; securities valued at market value, loans at unpaid principal) and the lender's source. Nonaccrual, charge-off, payoff and maturity always make an asset ineligible. Applies only once a different treasury checker approves it.","operationId":"postLedgerCollateralSchedules","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralScheduleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralSchedule"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a lender's effective-dated collateral schedule: eligible classes, haircuts, valuation bases and ineligibility conditions, pending independent review (treasury staff)","tags":["Ledger"]}},"/ledger/collateral/schedules/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. ","operationId":"postLedgerCollateralSchedulesIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a collateral schedule (a treasury checker other than its maker)","tags":["Ledger"]}},"/ledger/collateral/statements":{"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. The statement is signed with ed25519 over `ledger.collateral.statement.v1`, a NUL byte and the statement without its signature, by one of the lender's retained keys; `as_of` cannot be after the business date. A break opens for every difference from the register; the same key or signed content replays.","operationId":"postLedgerCollateralStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralStatement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralStatementRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralStatementRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a lender's signed collateral statement and open a break for every difference from the register (treasury staff)","tags":["Ledger"]}},"/ledger/collateral/statements/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerCollateralStatementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralStatementRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained lender statement, its breaks and its review","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/collateral/statements/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write`; the store also requires `operations:approve`, a step-up within five minutes and a checker other than the record's maker, refused 422 `ledger.maker_checker_required`. The same decision by the same checker replays; a different one is 409 `conflict`. The checker must not be the statement's recorder, and approval is refused 409 `conflict` while any break the statement opened is unresolved.","operationId":"postLedgerCollateralStatementsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerCollateralStatementRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve a statement's reconciliation once every break it opened is resolved, or reject it (a treasury checker other than its recorder)","tags":["Ledger"]}},"/ledger/correspondent/break-proposals/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentBreakProposalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakProposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a break proposal and its review","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/break-proposals/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Approval executes the resolution in the same transaction: a manual match, an adjustment journal against the reviewed GL and its match, an accepted timing difference, or the dismissal of a chain or evidence break. The checker must differ from the maker, hold ledger:correspondent:approve and have stepped up; the break must still be the version proposed on. A break about money on the account cannot be dismissed.","operationId":"postLedgerCorrespondentBreakProposalsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakProposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (executing the resolution) or reject a break proposal","tags":["Ledger"]}},"/ledger/correspondent/breaks":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentBreaks","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Break"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all nostro breaks","tags":["Nostro Break"]}},"/ledger/correspondent/breaks/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentBreaksId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Break"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a nostro break by ID","tags":["Nostro Break"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/breaks/{id}/proposals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentBreaksIdProposals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakProposal"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakProposal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a break's resolution: a match, an adjustment against a reviewed GL, a timing difference or a dismissal","tags":["Nostro Break"]}},"/ledger/correspondent/control-changes":{"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentControlChanges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlChangeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentControlChange"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentControlChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose suspending, reactivating, closing or terminating a correspondent or nostro account","tags":["Ledger"]}},"/ledger/correspondent/control-changes/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentControlChangesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentControlChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a control change","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/control-changes/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentControlChangesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentControlChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (applied only at the revision it was proposed against) or reject a control change","tags":["Ledger"]}},"/ledger/correspondent/correspondents":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentCorrespondents","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Correspondent"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all correspondent banks","tags":["Correspondent Bank"]},"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentCorrespondents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Correspondent"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Correspondent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a correspondent bank","tags":["Correspondent Bank"]}},"/ledger/correspondent/correspondents/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentCorrespondentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Correspondent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a correspondent bank by ID","tags":["Correspondent Bank"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/correspondents/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentCorrespondentsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Correspondent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a proposed correspondent (a different person from its maker)","tags":["Correspondent Bank"]}},"/ledger/correspondent/interest-periods/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentInterestPeriodsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestPeriod"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an interest period with its settlement","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/invoices":{"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentInvoices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentInvoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentInvoice"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a correspondent invoice","tags":["Correspondent Invoice"]}},"/ledger/correspondent/invoices/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentInvoicesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a correspondent invoice by ID","tags":["Correspondent Invoice"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/invoices/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentInvoicesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentInvoice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (billing the matched accrued charges) or reject an invoice","tags":["Correspondent Invoice"]}},"/ledger/correspondent/liquidity-alerts":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentLiquidityAlerts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LiquidityAlert"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all nostro liquidity alerts","tags":["Nostro Liquidity Alert"]}},"/ledger/correspondent/liquidity-alerts/{id}/acknowledgements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentLiquidityAlertsIdAcknowledgements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidityAlert"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Acknowledge an open liquidity alert with what treasury is doing about it","tags":["Nostro Liquidity Alert"]}},"/ledger/correspondent/message-receipts":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentMessageReceipts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MessageReceipt"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List delivery receipts (accepted, replayed or refused with the reason)","tags":["Ledger"]}},"/ledger/correspondent/messages":{"post":{"description":"The SWIFT gateway service (svc_payments) reaches this route with one scope and nothing else of the ledger's: ledger:correspondent:route reads settlement routes, ledger:correspondent:post posts movements, ledger:correspondent:statement delivers cash management messages. A camt.052.001.08, camt.053.001.08 or camt.054.001.08 Document of at most 8 MiB, as received. Every delivery is receipted: a message or page already retained replays, and a page retained with other content, a claimed electronic sequence number, a statement that does not roll forward or precedes the account's boarding statement, and an account or servicer the registry does not hold are refused with the reason. An accepted delivery reconciles the account and evaluates its liquidity.","operationId":"postLedgerCorrespondentMessages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageDelivery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deliver a correspondent's camt.052 intraday report, camt.053 statement or camt.054 notification received over SWIFT (or by staff), reconciled on arrival","tags":["Ledger"]}},"/ledger/correspondent/movements":{"post":{"description":"The SWIFT gateway service (svc_payments) reaches this route with one scope and nothing else of the ledger's: ledger:correspondent:route reads settlement routes, ledger:correspondent:post posts movements, ledger:correspondent:statement delivers cash management messages. The ledger writes the nostro entry from the movement itself and posts the counter entries beside it (none puts the other side on payments in transit and suspense in the movement's currency), retains the references the correspondent's statement will carry and records the charge the terms expect. The Idempotency-Key replays the same movement and journal; another request under the same key is refused. A debit needs an open account at an active correspondent.","operationId":"postLedgerCorrespondentMovements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentMovementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentMovement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentMovement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post a payment the SWIFT gateway settles through a nostro account: the journal and the references the statement will carry, in one idempotent transaction","tags":["Ledger"]}},"/ledger/correspondent/movements/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentMovementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentMovement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a movement and the charge expected on it","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccounts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NostroAccount"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all nostro accounts","tags":["Nostro Account"]},"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NostroAccountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NostroAccount"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NostroAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a nostro account","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NostroAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a nostro account by ID","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/charges":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdCharges","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ExpectedCharge"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's expected, accrued, posted, invoiced and settled correspondent charges","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/interest-accruals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdInterestAccruals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestPeriod"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accrue a closed month's interest on the account's daily balances (idempotent per month)","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}/interest-periods":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdInterestPeriods","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InterestPeriod"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's interest periods","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/invoices":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdInvoices","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrespondentInvoice"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's invoices","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/liquidity-evaluations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdLiquidityEvaluations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidityEvaluation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Judge the account's balance readings against its liquidity limits, raising and resolving alerts","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}/monthly-fees":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdMonthlyFees","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthlyFeeRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a closed month's account fees under the terms in force (idempotent per fee)","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}/movements":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdMovements","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrespondentMovement"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the SWIFT gateway's movements through a nostro account","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/reconciliations":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdReconciliations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrespondentReconciliationRun"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's reconciliation runs, newest first","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReconciliationRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run a reconciliation of the nostro account's statements against the ledger","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NostroAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (opening its due-from ledger account in the account's currency) or reject a proposed nostro account","tags":["Nostro Account"]}},"/ledger/correspondent/nostro-accounts/{id}/statements":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdStatements","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StatementSummary"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's retained report, statement and notification pages","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/nostro-accounts/{id}/terms":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentNostroAccountsIdTerms","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrespondentTerms"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a nostro account's terms versions, latest effective first","tags":["Nostro Account"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentNostroAccountsIdTerms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentTerms"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a nostro account's cutoffs, charges, interest, liquidity limits and reconciliation tolerances from an effective date","tags":["Nostro Account"]}},"/ledger/correspondent/positions":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentPositions","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrespondentPosition"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every nostro account's position at a date: due-from or overdrawn ledger balance, latest statement closing, open breaks and alerts","tags":["Ledger"]}},"/ledger/correspondent/pulls":{"post":{"description":"Reads the configured correspondent message source (the correspondent bank simulator on the local stack) and receives each message in order, advancing the source cursor. A deployed bank configures no source: its correspondents' messages arrive over SWIFT through the gateway.","operationId":"postLedgerCorrespondentPulls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PullResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pull the next messages from the configured message source (the correspondent bank simulator on the local stack)","tags":["Ledger"]}},"/ledger/correspondent/reconciliations/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentReconciliationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReconciliationRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a reconciliation run's evidence and balance proof","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/routes/{currency}":{"get":{"description":"The SWIFT gateway service (svc_payments) reaches this route with one scope and nothing else of the ledger's: ledger:correspondent:route reads settlement routes, ledger:correspondent:post posts movements, ledger:correspondent:statement delivers cash management messages. destination_bic names the beneficiary bank: the account whose terms name the longest prefix of it settles the payment, and otherwise the currency's primary account does. A currency with no open nostro account at an active correspondent, or no approved terms in force, is ledger.correspondent_route_unavailable.","operationId":"getLedgerCorrespondentRoutesCurrency","parameters":[{"in":"query","name":"destination_bic","schema":{"type":"string"}},{"in":"query","name":"at","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The settlement route the SWIFT gateway sends a currency through, chosen for the destination bank when destination_bic names one: the nostro account, the correspondent's same-day window and value date, outbound charges and liquidity","tags":["Ledger"]},"parameters":[{"in":"path","name":"currency","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/statements/{id}":{"get":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"getLedgerCorrespondentStatementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained page with its entries","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/correspondent/terms/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.","operationId":"postLedgerCorrespondentTermsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrespondentTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a terms version","tags":["Ledger"]}},"/ledger/currencies":{"get":{"description":"Ledger reader authority required. Every ISO 4217 currency the core knows, with its minor units from ISO 4217 List One as published by the SIX Group maintenance agency on 2026-01-01 (JPY 0, KWD 3). enabled is true for USD and the currencies the ledger's LEDGER_CURRENCIES configuration admits for new accounts; fx_position appears once a movement has crossed the currency's position.","operationId":"getLedgerCurrencies","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Currency"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the ISO 4217 currencies the ledger knows with their minor units, whether new accounts may open in each, and each currency's FX position pair","tags":["Ledger"]}},"/ledger/deposit-postings":{"post":{"operationId":"postLedgerDepositPostings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"availability":{"$ref":"#/components/schemas/LedgerAvailabilityRequest"},"journal":{"$ref":"#/components/schemas/LedgerJournal"}},"required":["availability","journal"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerDepositPosting"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerDepositPosting"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically post a deposit receipt and its captured availability holds","tags":["Ledger"]}},"/ledger/end-of-day-runs":{"post":{"operationId":"postLedgerEndOfDayRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"},"operator":{"type":"string"}},"required":["business_date","operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerEODReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run end of day for a business date","tags":["Ledger"]}},"/ledger/fedwire-securities/advice-syncs":{"post":{"description":"The ledger's guard admits verified bank securities staff holding `ledger:securities:write`; the store requires a step-up within five minutes (never a service or an API key). The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Reads every advice the operator sent the bank on `business_date` (not after today, else 422) and takes each exactly as a delivery, so a lost delivery is recovered and a delivered one replays.","operationId":"postLedgerFedwireSecuritiesAdviceSyncs","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesAdviceSync"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerFedSecuritiesAdvice"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a business day's advices from the Fedwire Securities Service (simulator) again and take each one as a delivery, recovering an advice whose delivery was lost (bank securities staff)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/advices":{"get":{"description":"A read needs `ledger:securities:read`; `ledger:read` alone is refused 403 `forbidden`.","operationId":"getLedgerFedwireSecuritiesAdvices","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerFedSecuritiesAdvice"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained advices, optionally for one business_date, exceptions first","tags":["Fedwire Securities Connection"]},"post":{"description":"The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Only the configured connector's service identity (`svc_fedsecurities` locally) holding `ledger:fedwire-securities:advice` delivers; staff, another service and API keys are refused 403 `forbidden`. The advice must verify against the operator's configured keys and be a settled advice to one of the bank's accounts, else 422 `validation_failed`. A delivery against payment quoting a bank securities order books that order's settlement from the message (outcome `settled`); a free return from a lender's account or the bank's own move into its restricted account is `recorded`; anything else is an `exception` with its reason. The same operator reference replays; with other content it is 409 `conflict`.","operationId":"postLedgerFedwireSecuritiesAdvices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesAdvice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Take a signed advice from the Fedwire Securities Service (simulator) for one of the bank's securities accounts: a delivery against payment quoting a bank securities order books that order's settlement, a free return from a lender's account is recorded, anything else is retained as an exception (the configured connector only)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/advices/{id}":{"get":{"description":"A read needs `ledger:securities:read`; `ledger:read` alone is refused 403 `forbidden`.","operationId":"getLedgerFedwireSecuritiesAdvicesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesAdvice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained advice, its match and outcome","tags":["Fedwire Securities Connection"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fedwire-securities/deliveries":{"get":{"description":"A read needs `ledger:securities:read`; `ledger:read` alone is refused 403 `forbidden`.","operationId":"getLedgerFedwireSecuritiesDeliveries","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerFedSecuritiesDelivery"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List proposed and sent transfers, those waiting for review or the operator first","tags":["Fedwire Securities Connection"]},"post":{"description":"The ledger's guard admits verified bank securities staff holding `ledger:securities:write`; the store requires a step-up within five minutes (never a service or an API key). `order_id` names a sale of a Fedwire Securities program whose trade is recognised and whose delivery is not settled, delivered against its net cash to `receiver_aba`/`receiver_account`; `advice_id` names an exception advice reversed (type code 2002) the same business day. One live delivery per order or advice, else 409 `conflict`. Pending until a securities checker approves.","operationId":"postLedgerFedwireSecuritiesDeliveries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesDeliveryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesDelivery"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a transfer the bank sends: a sold lot delivered against payment to the buyer's securities account, or an exception advice reversed to its sender, pending a securities checker (bank securities staff)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/deliveries/{id}":{"get":{"description":"A read needs `ledger:securities:read`; `ledger:read` alone is refused 403 `forbidden`.","operationId":"getLedgerFedwireSecuritiesDeliveriesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a transfer the bank sends, its review and the operator's answer","tags":["Fedwire Securities Connection"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fedwire-securities/deliveries/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The guard admits staff holding `ledger:securities:write` and `ledger:securities:approve`; the store requires a step-up within five minutes and a checker other than the maker, refused 422 `ledger.maker_checker_required` (the database refuses it too). The same decision by the same checker replays; a different one is 409 `conflict`. The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Approval sends the proposed transfer: the acknowledgment settles it (a sale's settlement is booked from it, a reversal marks its advice reversed) and a rejection refuses it with the operator's reason. When the operator does not answer the call is 424 `dependency_failed`, the delivery stays `sending`, and the same review resends the same message.","operationId":"postLedgerFedwireSecuritiesDeliveriesIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerFedSecuritiesDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (sending the transfer to the operator and booking a sale's settlement from its acknowledgment) or reject a proposed transfer (a securities checker other than its maker)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/holdings-breaks/{id}/resolution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The guard admits staff holding `ledger:securities:write` and `ledger:securities:approve`; the store requires a step-up within five minutes. The same resolution by the same checker replays; another is 409 `conflict`.","operationId":"postLedgerFedwireSecuritiesHoldingsBreaksIdResolution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsBreakResolution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsBreak"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resolve a holdings break with a reason (a securities checker)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/holdings-reconciliations":{"post":{"description":"The ledger's guard admits verified bank securities staff holding `ledger:securities:write`; the store requires a step-up within five minutes (never a service or an API key). The operator is the Fedwire Securities Service simulator: nothing it answers is a Reserve Bank message. Reads the signed holdings statement of every approved Fedwire Securities program account and approved discount window restricted account at the close of `as_of` (not after today, else 422) and compares it with the lots the book places there, opening a break per line that differs. With no such account it is 409 `conflict`.","operationId":"postLedgerFedwireSecuritiesHoldingsReconciliations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsReconciliationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsReconciliation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile the operator's signed holdings statements for the bank's securities accounts at the close of as_of against the book, opening a break for every line that differs (bank securities staff)","tags":["Fedwire Securities Connection"]}},"/ledger/fedwire-securities/holdings-reconciliations/{id}":{"get":{"description":"A read needs `ledger:securities:read`; `ledger:read` alone is refused 403 `forbidden`.","operationId":"getLedgerFedwireSecuritiesHoldingsReconciliationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a holdings reconciliation, its statements, lines, breaks and review","tags":["Fedwire Securities Connection"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fedwire-securities/holdings-reconciliations/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The guard admits staff holding `ledger:securities:write` and `ledger:securities:approve`; the store requires a step-up within five minutes and a checker other than the maker, refused 422 `ledger.maker_checker_required` (the database refuses it too). The same decision by the same checker replays; a different one is 409 `conflict`. The checker must not be the recorder, and approval is refused 409 `conflict` while any break is unresolved.","operationId":"postLedgerFedwireSecuritiesHoldingsReconciliationsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldingsReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve a holdings reconciliation once every break is resolved, or reject it (a securities checker other than its recorder)","tags":["Fedwire Securities Connection"]}},"/ledger/fx/authorities/{id}":{"get":{"operationId":"getLedgerFxAuthoritiesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an immutable FX authority proposal and independent decision","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/authorities/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh treasury checker and operations:approve must independently approve exact replacement terms against the current authority digest. Actual correspondent identity, account and currency remain immutable. Limits, short-dated operating authority and public receipt keys can renew; the pause remains in force. Unsent orders bound to earlier authority require cancellation and a new proposal. Already dispatched money still requires an exact final receipt signed by a currently approved key; a rotated-out key cannot authorize new evidence. Previously accepted receipts retain the exact verified key/digest and remain recoverable without re-signing or moving money twice.","operationId":"postLedgerFxAuthoritiesIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently replace current FX authority without changing bank account identity or clearing a pause","tags":["Foreign Currency Inventory"]}},"/ledger/fx/books":{"get":{"operationId":"getLedgerFxBooks","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Book"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed bank-owned foreign correspondent currency books","tags":["Foreign Currency Inventory"]},"post":{"description":"Fresh treasury staff with ledger:treasury:write required. The independently reviewed book pins a real noninterest-bearing bank-owned correspondent account, legal entity, USD master cash account, native currency scale, positive limits, short-dated authority and named public bridge keys. No account is funded or external authority inferred. General customer deposits remain USD.","operationId":"postLedgerFxBooks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Book"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a zero-boarded foreign currency book with actual correspondent and authority evidence","tags":["Foreign Currency Inventory"]}},"/ledger/fx/books/{id}":{"get":{"operationId":"getLedgerFxBooksId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Book"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained correspondent authority and current status","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/books/{id}/authorities":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxBooksIdAuthorities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxAuthorityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authority"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose replacement correspondent limits, dated authority and public signing keys","tags":["Foreign Currency Inventory"]}},"/ledger/fx/books/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxBooksIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Book"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review correspondent authority and create its protected USD carrying-value account","tags":["Foreign Currency Inventory"]}},"/ledger/fx/books/{id}/position":{"get":{"operationId":"getLedgerFxBooksIdPosition","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxPosition"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read actual native units, reservations and reconciled USD carrying value","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/books/{id}/status-changes":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxBooksIdStatusChanges","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pause new FX orders immediately or propose independently reviewed reactivation","tags":["Foreign Currency Inventory"]}},"/ledger/fx/close-evidence":{"get":{"description":"Ledger reader authority and business_date required. For every foreign currency the books held, the close that runs inside end of day before the date closes retains the approved closing sheet and rate, the foreign income and expense sweeps into USD, the position's native balance and its USD equivalent before and after remeasurement, and the adjustment posted to GL 4230 (net nontrading foreign exchange gains or losses). lines are every GL code held in the currency translated at the closing rate in the GL's normal balance direction; a currency's translated lines, its position and the position's equivalent net to zero in USD.","operationId":"getLedgerFxCloseEvidence","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseEvidence"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read what the close retained for a business date's foreign currencies: each currency's sweep and remeasurement and every GL line's USD equivalent","tags":["Foreign Currency Inventory"]}},"/ledger/fx/close-readiness":{"get":{"description":"Ledger reader authority and business_date required. Checks only dated retained native/USD movements, unresolved reserved/receipt-pending orders, source-bound actual closing-window rates and a signed correspondent inventory at the exact bank cutoff. Current-day balances or prices cannot impersonate prior-day sources. A point-in-time readiness observation does not lock all later external cash activity.","operationId":"getLedgerFxCloseReadiness","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify actual dated currency inventory, closing rates, settlement completion and signed cutoff statements","tags":["Foreign Currency Inventory"]}},"/ledger/fx/conversions":{"post":{"description":"Only the conversion service that quoted may convert its quote, under an Idempotency-Key. The quote must be unexpired and its sheet still approved and valid (ledger.fx_quote_expired, 409), the daily limit is rechecked under a per-customer lock, and the source account's available balance after the conversion must cover its holds (ledger.insufficient_available). One journal moves the customer's source account, each foreign currency's FX position and USD equivalent at the sheet's mid rate with a retained leg, the spread to GL 4240 and the target account; each currency balances on its own. A quote converts once; the same key replays the same conversion after expiry, and GET /ledger/fx/conversions/by-key recovers a lost response. Conversion journals are not generically reversible. Publishes ledger.fx_conversion.posted.","operationId":"postLedgerFxConversions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxConvertRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post an unexpired quote once as a conversion through the FX position (conversion service)","tags":["Foreign Currency Inventory"]}},"/ledger/fx/conversions/by-key":{"get":{"operationId":"getLedgerFxConversionsByKey","parameters":[{"in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover the calling conversion service's conversion by its idempotency key after a lost response","tags":["Foreign Currency Inventory"]}},"/ledger/fx/conversions/{id}":{"get":{"operationId":"getLedgerFxConversionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a posted customer conversion","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/customer-rate-sheet":{"get":{"description":"The conversion service (a service token with ledger:fx:convert, no API key) reads the approved, valid, unwithdrawn customer sheet a quote asked for now would be priced on; every other identity is 403. ledger.fx_rate_unavailable (409) when no sheet is valid. It is the same sheet POST /ledger/fx/quotes prices from, so the rate a customer is shown and the rate their quote is struck at come from one record.","operationId":"getLedgerFxCustomerRateSheet","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the approved customer rate sheet pricing conversions now (conversion service)","tags":["Foreign Currency Inventory"]}},"/ledger/fx/orders":{"post":{"operationId":"postLedgerFxOrders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an exactly priced same-day bank FX purchase or sale","tags":["Foreign Currency Inventory"]}},"/ledger/fx/orders/{id}":{"get":{"operationId":"getLedgerFxOrdersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an FX order and its immutable signed settlement evidence","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/orders/{id}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxOrdersIdCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"evidence":{"type":"string"}},"required":["evidence"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel an undispatched order and release reservations; dispatched orders need signed bridge evidence","tags":["Foreign Currency Inventory"]}},"/ledger/fx/orders/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxOrdersIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve and atomically reserve actual USD cash or native correspondent units","tags":["Foreign Currency Inventory"]}},"/ledger/fx/orders/{id}/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxOrdersIdDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Durably release an approved reserved order for the configured correspondent bridge","tags":["Foreign Currency Inventory"]}},"/ledger/fx/orders/{id}/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Exact configured bridge service JWT with ledger:fx:bridge and a valid Ed25519 signature over fx.Receipt.SigningBytes required. The Corgi bridge contract attests both actual cash legs or final zero-movement cancellation; a transport acknowledgement is insufficient. Exact external references cannot be reused. The verified receipt commits before application so posting failure preserves visible receipt_pending work. Successful money application atomically changes balanced native entries, USD journal, carrying value and reservations. Generic reversal refuses externally settled currency; return cash requires a separate actual trade.","operationId":"postLedgerFxOrdersIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxOrder"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify exact signed final bridge evidence and atomically post native units and USD cash accounting","tags":["Foreign Currency Inventory"]}},"/ledger/fx/quotes":{"post":{"description":"Only the conversion service (a service token with ledger:fx:convert, no API key) quotes; every other identity is 403. The source and target must be two open, unprotected deposit accounts of the same customer in different currencies the ledger holds (ledger.currency_unsupported, 422, otherwise). Exactly one of source_amount or target_amount is fixed, in the account currency's minor units. The price comes from the most recently approved, valid, unwithdrawn customer sheet (ledger.fx_rate_unavailable, 409, when there is none): the customer sells at mid less the sell spread and buys at mid plus the buy spread, arbitrary precision, rounding once in the bank's favour; USD equivalents are at mid and their difference is the spread. A quote over a line's per-conversion limit or the customer's remaining daily limit is ledger.fx_limit_exceeded (422). The quote holds for FX_QUOTE_TTL (60 seconds by default), never past the sheet's validity. The Idempotency-Key is bound to the request body.","operationId":"postLedgerFxQuotes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Quote a conversion between two of one customer's deposit accounts on the current approved customer sheet (conversion service)","tags":["Foreign Currency Inventory"]}},"/ledger/fx/quotes/{id}":{"get":{"operationId":"getLedgerFxQuotesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained customer FX quote","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/rate-sheets":{"get":{"operationId":"getLedgerFxRateSheets","parameters":[{"in":"query","name":"purpose","schema":{"type":"string"}},{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RateSheet"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a business date's rate sheets of one purpose, newest first","tags":["Foreign Currency Inventory"]},"post":{"description":"Fresh treasury staff with ledger:treasury:write and an Idempotency-Key bound to the exact sheet. Every line's usd_per_foreign_major must equal the named snapshot's derived rate (no typed rates), lines are sorted and unique, and the snapshot must be the latest retained from its source on or before business_date and at most five days old. A customer_conversion sheet is for the current business date, valid for at most 24 hours, with spreads of 0 to 1000 basis points, a per-conversion limit per line and a daily per-customer limit, and only in currencies the ledger holds; a closing_revaluation sheet carries mid rates for a current or past business date. Proposals publish ledger.fx_rate_sheet.proposed.","operationId":"postLedgerFxRateSheets","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a customer conversion or closing rate sheet bound to a retained publication","tags":["Foreign Currency Inventory"]}},"/ledger/fx/rate-sheets/{id}":{"get":{"operationId":"getLedgerFxRateSheetsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a rate sheet, its independent decision and whether it was withdrawn","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/rate-sheets/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"A treasury approver with ledger:treasury:write and operations:approve, authenticated within five minutes and different from the maker, decides the exact retained content_sha256 (403 for the maker, 409 for a changed digest). The schema refuses a maker's decision independently. A business date has at most one approved, unwithdrawn closing sheet; a customer sheet cannot be approved after its validity ends. Publishes ledger.fx_rate_sheet.approved or rejected.","operationId":"postLedgerFxRateSheetsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject the exact retained rate sheet as a different treasury approver","tags":["Foreign Currency Inventory"]}},"/ledger/fx/rate-sheets/{id}/withdrawals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Treasury staff with ledger:treasury:write and fresh authentication withdraw an approved sheet with evidence; a withdrawal only stops money moving, so it needs no second person. A withdrawn customer sheet stops quoting and converting at once, including quotes already issued on it; a closing sheet cannot be withdrawn once the close remeasured at it. Publishes ledger.fx_rate_sheet.withdrawn.","operationId":"postLedgerFxRateSheetsIdWithdrawals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetWithdrawal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSheet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Stop an approved rate sheet pricing at once","tags":["Foreign Currency Inventory"]}},"/ledger/fx/rate-snapshots":{"post":{"description":"Fresh treasury staff with ledger:treasury:write required (authentication within five minutes). The configured FX_RATE_SOURCE is fetched for a current or past publication_date and retained byte for byte with its SHA-256 and the USD-per-major rates derived from its euro crosses, rounded once to twelve decimals. The local source is the reference-rate simulator, whose rates are generated; the retained source says simulator or provider. A source failure or a date the source has not published answers dependency_failed (502); no source configured answers unavailable. Refetching the same publication returns the snapshot already retained.","operationId":"postLedgerFxRateSnapshots","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSnapshotRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fetch a reference-rate publication from the configured source and retain it with the USD rates derived from it","tags":["Foreign Currency Inventory"]}},"/ledger/fx/rate-snapshots/{id}":{"get":{"operationId":"getLedgerFxRateSnapshotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained reference-rate publication and its derived USD rates","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/statements":{"post":{"description":"Configured bridge identity and pinned Ed25519 signature required. Supply the actual correspondent ending position and complete cash-reference inventory from zero boarding. Every retained cash reference, direction and quantity must match; equal totals cannot hide unknown, omitted or unapplied cash. Evidence and identified breaks are retained immutably. This bank bridge JSON is not a certified SWIFT/CHIPS adapter.","operationId":"postLedgerFxStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxStatementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify a signed complete correspondent cash inventory and retain exact reconciliation breaks","tags":["Foreign Currency Inventory"]}},"/ledger/fx/statements/{id}":{"get":{"operationId":"getLedgerFxStatementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable external correspondent reconciliation evidence","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/status-changes/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerFxStatusChangesIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide an enabling proposal against its current status revision","tags":["Foreign Currency Inventory"]}},"/ledger/fx/valuations":{"post":{"operationId":"postLedgerFxValuations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxValuationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Valuation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a current source-bound foreign currency remeasurement","tags":["Foreign Currency Inventory"]}},"/ledger/fx/valuations/{id}":{"get":{"operationId":"getLedgerFxValuationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Valuation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the actual native source, reviewed FX rate and USD posting","tags":["Foreign Currency Inventory"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/fx/valuations/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh treasury checker with operations:approve, different from maker, approves the exact retained digest. The current native source, reservations, USD carrying value and quote recency must still agree. Remeasurement changes USD carrying value and profit/loss without creating native units or cash receipts. Failed or stale source leaves the proposal unposted.","operationId":"postLedgerFxValuationsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Valuation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve a still-current FX valuation and post the exact gain or loss","tags":["Foreign Currency Inventory"]}},"/ledger/gl-accounts/{gl_code}":{"get":{"operationId":"getLedgerGlAccountsGl_code","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The system ledger account for a GL code and currency","tags":["Ledger"]},"parameters":[{"in":"path","name":"gl_code","required":true,"schema":{"type":"string"}}]},"/ledger/gl-exports/{period}":{"get":{"operationId":"getLedgerGlExportsPeriod","parameters":[{"in":"query","name":"format","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/LedgerGLLine"},"type":"array"},"period":{"type":"string"}},"required":["lines","period"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"GL summary for a period (JSON or CSV)","tags":["Ledger"]},"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/ledger/gl-journal-entries":{"get":{"operationId":"getLedgerGlJournalEntries","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every GL entry of a period","tags":["Ledger"]}},"/ledger/holds":{"post":{"description":"Place a hold","operationId":"postLedgerHolds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHoldRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a hold","tags":["Hold"]}},"/ledger/holds/by-key":{"get":{"operationId":"getLedgerHoldsByKey","parameters":[{"description":"Original operation key; at most 2000 UTF-8 bytes.","in":"query","name":"key","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a committed hold and its current status by idempotency key","tags":["Hold"]}},"/ledger/holds/{id}":{"get":{"description":"Read a hold and its current status","operationId":"getLedgerHoldsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a hold by ID","tags":["Hold"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/holds/{id}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Release a hold. A hold records the service that placed it, and only that service may release it. A hold no service owns — a legacy or legal hold — is released by a verified staff person (never an API key, never a service) holding `ledger:holds:release` who stepped up within five minutes; the release records them as `released_by`. The ledger's guard admits that scope on this route and nowhere else, so it reaches no journal, and it does not reach a hold a service owns. Every other caller is refused 403 `forbidden`; a missing or stale step-up answers `step_up_required`.","operationId":"postLedgerHoldsIdRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release a hold","tags":["Hold"]}},"/ledger/interest-expense":{"get":{"operationId":"getLedgerInterestExpense","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerInterestExpense"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Year-to-date recognized deposit-interest expense by account and effective date through period YYYY-MM; excludes settlement of the accrued liability","tags":["Ledger"]}},"/ledger/journal-cancellations":{"post":{"operationId":"postLedgerJournalCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"key":{"type":"string"},"reason":{"type":"string"}},"required":["key","reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cancelled":{"type":"boolean"},"journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]}},"required":["cancelled"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fence a supported unposted fee, dispute, lending or card settlement instruction, or return its committed journal","tags":["Ledger"]}},"/ledger/journal-evidence":{"get":{"operationId":"getLedgerJournalEvidence","parameters":[{"in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournalEvidence"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read actual journal and current reversal or reliance evidence","tags":["Ledger"]}},"/ledger/journal-evidence-claims":{"post":{"operationId":"postLedgerJournalEvidenceClaims","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEvidenceClaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEvidenceClaim"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEvidenceClaim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Claim independently reviewed card or complaint remedy journals against generic reversal","tags":["Ledger"]}},"/ledger/journal-source-pins":{"post":{"description":"An actual svc_cards service JWT with ledger:post pins the exact original card clearing for the independently reviewed card_scheme_clearing purpose. The full retained posting command digest includes hold release. Immutable same-purpose/reference replay requires identical evidence. Pin and reversal serialize on a separate exclusion record; the pin does not consume the existing settlement reconciliation's exclusive journal claim.","operationId":"postLedgerJournalSourcePins","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalSourcePinRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalSourcePin"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalSourcePin"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pin original card clearing against reversal without consuming reconciliation ownership","tags":["Ledger"]}},"/ledger/journals":{"post":{"description":"Post a balanced journal","operationId":"postLedgerJournals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a journal","tags":["Journal"]}},"/ledger/journals/by-key":{"get":{"operationId":"getLedgerJournalsByKey","parameters":[{"description":"Original operation key; at most 2000 UTF-8 bytes.","in":"query","name":"key","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read committed journal evidence by idempotency key","tags":["Journal"]}},"/ledger/journals/{id}":{"get":{"description":"Read a journal","operationId":"getLedgerJournalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a journal by ID","tags":["Journal"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/journals/{id}/reverse":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerJournalsIdReverse","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"effective_date":{"type":"string"},"reason":{"type":"string"}},"required":["effective_date","reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerJournal"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reverse a journal","tags":["Journal"]}},"/ledger/payable-obligations":{"get":{"description":"Verified svc_payments with existing ledger:post is required even locally. Bounded current operational work queue: optional starting_after typed obligation cursor, limit1–100(default25), kind, issuer, account_id, loan_id and status unpaid(default) or all. Returns immutable source/owner/tax context and current reserved/paid/returned/refunded/unallocated/unpaid amounts with opaque remittance identities. A page is not an immutable closing snapshot; current amounts are rechecked before issue. Unknown/duplicate query fields refuse; source issuers cannot enumerate the bank queue.","operationId":"getLedgerPayableObligations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuePage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read bounded current payable work queue under exact payments service authority","tags":["Ledger"]},"post":{"description":"Verified owning svc_accounts or svc_lending with existing ledger:post is required even locally; staff, customers, API keys and other services cannot register sources. Allocate exact positive credits of an actual unreversed original journal; cumulative allocations cannot exceed the credited line. Independently identifies the account owner and optional tax recipient. SourceDateBasis is calendar_date when omitted; a calendar source date cannot be in the future. Explicit journal_posting_date requires exact equality with the verified original journal PostingDate, including a legitimate next-bank date after cutoff or during a weekend. The basis is retained in the source hash and does not infer a statutory deadline. Immutable native account-closure lineage is required to adopt a ledger-owned closure component. Exact issuer/kind/source-ID replay recovers one obligation and one funded native hold; changed replay conflicts. Existing spent legacy credits require reconciliation.","operationId":"postLedgerPayableObligations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Obligation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Obligation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Allocate actual unreversed payable credits to the verified source service and reserve them against generic spending","tags":["Ledger"]}},"/ledger/payable-obligations/{id}":{"get":{"description":"Verified owning source service or svc_payments with ledger:post reads only its authorized immutable obligation. No bank statement or external recipient credentials are exposed.","operationId":"getLedgerPayableObligationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Obligation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable payable source evidence as its actual owning service or payments service","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/payable-obligations/{id}/refunds":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only verified svc_lending with existing ledger:post may refund an exact loan_forwarding obligation. The caller supplies retained lender request/notice evidence and actual requesting identity. Native accounting resolves only the original two-entry loan receipt's borrower-owned open USD DDA, bounds the amount by still-held unallocated funds, atomically debits2365 and credits that original DDA, and pins the refund against generic reversal. Exact key and source identity replay returns the original journal; no caller-selected destination exists.","operationId":"postLedgerPayableObligationsIdRefunds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return only unallocated loan-forwarding funds to the actual original borrower debit DDA","tags":["Ledger"]}},"/ledger/payable-obligations/{id}/status":{"get":{"description":"Verified owning source service or svc_payments reads exact reserved, gross paid, returned, refunded, unallocated and net unpaid amounts plus opaque remittance identities and current independent cash readiness. These values do not claim a receiving servicer applied a payment to a loan.","operationId":"getLedgerPayableObligationsIdStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read actual obligation allocations and opaque cash-reconciliation status","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/payable-remittances":{"post":{"description":"Verified svc_payments with existing ledger:post is required even locally. Retain the payments service's actual independently reviewed recipient and exact source allocations, decode and verify the original beneficiary wire message, then reserve actual source allocations and master funds atomically. Intrinsic instruction ID is the replay identity. Current recipient terms must admit new reservations; exact committed replay preserves original terms after expiry. This creates no external settlement.","operationId":"postLedgerPayableRemittances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reserve actual payable allocations and master funds for the verified payments service's reviewed instruction","tags":["Ledger"]}},"/ledger/payable-remittances/{id}":{"get":{"description":"Verified svc_payments with existing ledger:post is required even locally. Recover immutable original wire instruction, independent review, source allocations and native master reservation after a lost response.","operationId":"getLedgerPayableRemittancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover exact native instruction and original reservation","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/payable-remittances/{id}/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified svc_payments with existing ledger:post is required even locally. Authenticate the exact retained environment/provider/key and signed event, retain it before accounting, then apply supported partial settlement or actual partial return against its booked original. Cumulative allocation bounds and globally claimed native cash identities exclude reuse; prior independent line allocations also block duplicate booking. Unsupported fees or conflicting actual evidence remain retained with explicit refusal. The route accepts one strict8MiB JSON envelope, including at most4MiB raw evidence; complete responses are bounded16MiB. Exact event identity replay recovers one original journal. Production bank-statement date/amount/source proof remains required for cash readiness.","operationId":"postLedgerPayableRemittancesIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesCashReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain authentic external cash before exact native settlement or return accounting","tags":["Ledger"]}},"/ledger/payable-remittances/{id}/receipts/{event}":{"get":{"description":"Verified svc_payments with existing ledger:post is required even locally. Read the exact retained signed cash event, original booking or explicit accounting blocker, and current independent master statement proof identity. Source issuers use their narrow obligation status instead of this private cash evidence endpoint.","operationId":"getLedgerPayableRemittancesIdReceiptsEvent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained actual cash receipt and independent master statement readiness","tags":["Ledger"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"event","required":true,"schema":{"type":"string"}}]},"/ledger/periods/{period}":{"get":{"description":"A closed period's record","operationId":"getLedgerPeriodsPeriod","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPeriodReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a period by ID","tags":["Period"]},"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/ledger/periods/{period}/close":{"parameters":[{"in":"path","name":"period","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLedgerPeriodsPeriodClose","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"operator":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPeriodReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Month-end close for a period","tags":["Period"]}},"/ledger/reserve-interest/accruals":{"get":{"description":"The daily interest accrued on the Federal Reserve master account for a period: the balance, the rate that applied, the actual/360 day count and the journal on GL 1470 and 4020. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerReserveInterestAccruals","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveAccrualPage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Daily interest on the Federal Reserve master account for a period","tags":["Reserve Interest"]}},"/ledger/reserve-interest/rates":{"get":{"description":"List the IORB rate instructions and their reviews, newest first. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerReserveInterestRates","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReserveRate"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List IORB rate instructions and their reviews","tags":["Reserve Interest"]},"post":{"description":"Record the interest on reserve balances (IORB) rate from a date, pending independent review. The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only a verified staff person (never an API key) holding that scope who stepped up within five minutes, and records them as the maker. The rate applies only once a different treasury staff member approves it. An idempotency key is required, and the table rejects update, delete and truncate.","operationId":"postLedgerReserveInterestRates","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveRateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveRate"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveRate"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the interest on reserve balances rate from a date, pending independent review (treasury staff)","tags":["Reserve Interest"]}},"/ledger/reserve-interest/rates/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Approve or reject a recorded IORB rate. The ledger's guard admits `ledger:treasury:write`; the store additionally requires `operations:approve`, a step-up within five minutes and a checker who is not the maker (compared without regard to case or surrounding space). A rate cannot be approved for a date already accrued, and two approved rates cannot share a date.","operationId":"postLedgerReserveInterestRatesIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveRate"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject an IORB rate (a treasury checker other than its maker)","tags":["Reserve Interest"]}},"/ledger/reserve-interest/settlements":{"get":{"operationId":"getLedgerReserveInterestSettlements","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List Federal Reserve interest credits, optionally by status (pending_review is the treasury checker's queue)","tags":["Reserve Interest"]},"post":{"description":"Record the Federal Reserve's credit of the accrued interest, entered by treasury staff. The ledger's guard admits `ledger:treasury:write`; the store admits only a verified staff person with that scope and a step-up within five minutes. A credit that matches the accrued whole cents settles the period; one that differs is held for independent review. An idempotency key is required.","operationId":"postLedgerReserveInterestSettlements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hand-enter the Federal Reserve's interest credit for an accrued period (treasury staff; the contingency when no Statement of Account arrives, settled only on review)","tags":["Reserve Interest"]}},"/ledger/reserve-interest/settlements/{id}":{"get":{"description":"Read one recorded credit, its accrued period and its review. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerReserveInterestSettlementsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained Federal Reserve interest credit","tags":["Reserve Interest"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/reserve-interest/settlements/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Approve or reject a credit that differs from the accrual. The ledger's guard admits `ledger:treasury:write`; the store additionally requires `operations:approve`, a step-up within five minutes and a checker who is not the maker. An approval journals the difference to GL 4020.","operationId":"postLedgerReserveInterestSettlementsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Settle or reject a proposed interest credit (a treasury checker other than its maker)","tags":["Reserve Interest"]}},"/ledger/reserve-interest/statement-credits":{"post":{"description":"Feed the interest credit read off the Federal Reserve's master account report. This is the one route the statement feed's scope reaches: the ledger's guard admits `ledger:reserve-interest:statement` and nothing else here, and the store admits only the reporting service's own subject (`svc_reporting`) on that scope — staff, an API key and every other service are refused 403 `forbidden`. The credit is a proposal: nothing posts until a treasury checker other than the feed reviews it. A redelivered report posts nothing again.","operationId":"postLedgerReserveInterestStatementCredits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveStatementCredit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSettlement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose the Federal Reserve's interest credit read off its Statement of Account (the reporting service's statement feed), matched to the accrual; nothing posts until a treasury checker reviews it","tags":["Reserve Interest"]}},"/ledger/reverse-repos":{"get":{"description":"Open reverse repos first. A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerReverseRepos","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LedgerReverseRepo"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all reverse repos","tags":["Reverse Repo"]},"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. `kind` is `reverse_repo` (bilateral), `tri_party_reverse_repo` (names `tri_party_agent`) or `buy_sell_back` (two distinct trades, economically a reverse repo). The bank is the cash lender: cash out of the master account into a resale asset on GL 1150, interest income on GL 4030, haircut collateral covering the full repurchase amount priced on the bankrepo engine, refused 409 `conflict` when coverage fails. A `repo_counterparty` is required; other lender kinds are refused. Liability-side classic repo remains the bank-owned repo program on GL 2430.","operationId":"postLedgerReverseRepos","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepoRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepo"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepo"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a reverse repo","tags":["Reverse Repo"]}},"/ledger/reverse-repos/{id}":{"get":{"description":"A read needs `ledger:read` or `ledger:post`.","operationId":"getLedgerReverseReposId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepo"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a reverse repo by ID","tags":["Reverse Repo"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/reverse-repos/{id}/accruals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Recognises interest earned through `through` (today by default, never past maturity) into the resale asset and interest income. The same boundary posts nothing.","operationId":"postLedgerReverseReposIdAccruals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepoAccrualRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepo"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recognise the interest a reverse repo has earned through a boundary date (today by default) into the resale asset and interest income (treasury staff)","tags":["Reverse Repo"]}},"/ledger/reverse-repos/{id}/resales":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"The ledger's guard admits `ledger:treasury:write` on this route and refuses `ledger:post`; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Accrues through the unwind then takes the counterparty's cash — principal plus interest earned — back into the master account and clears the resale asset. No second approver. The body is empty.","operationId":"postLedgerReverseReposIdResales","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerReverseRepo"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resell a reverse repo at maturity or unwind it early: the counterparty's cash — principal plus interest earned — comes back and the resale asset clears (treasury staff)","tags":["Reverse Repo"]}},"/ledger/securities/classifications":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Proposes the next version of an approved instrument's classification: `designation` (`available_for_sale`; `held_to_maturity` is refused 422 because the program's accounting policy admits AFS only), `rcb_line` (a retained FFIEC 051 Schedule RC-B body item: 1, 2, 3, 4a1, 4a2, 4b1, 4b2, 4b3, 4c1a, 4c1b, 4c2a, 4c2b, 5a, 5b, 6a or 6b), `rate_type` (`fixed` or `floating`), `structured_note` (items 2, 3, 5 and 6 only), `effective_date`, evidence and rationale. A Treasury bill, the only instrument kind, is refused 422 unless it is item 1, fixed rate and not structured. The version binds the instrument's exact content digest; a new version must take effect after the approved one and is refused 409 while another awaits review. The database refuses the same.","operationId":"postLedgerSecuritiesClassifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Classification"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities classification","tags":["Bank Securities Classification"]}},"/ledger/securities/classifications/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read required. Reads a retained classification version and its independent decision.","operationId":"getLedgerSecuritiesClassificationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities classification by ID","tags":["Bank Securities Classification"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/classifications/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with both ledger:securities:write and ledger:securities:approve required. The reviewer differs from the maker (403) and binds the exact content digest (409); approval rechecks the instrument's unchanged content. The same decision by the same reviewer replays.","operationId":"postLedgerSecuritiesClassificationsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the exact classification digest","tags":["Bank Securities Classification"]}},"/ledger/securities/controls/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read required. Read retained bank securities authority and exact independent decision. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"getLedgerSecuritiesControlsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities control by ID","tags":["Bank Securities Control"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/controls/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with both ledger:securities:write and ledger:securities:approve required. Independently review the exact bank securities control digest. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesControlsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the exact bank securities control digest","tags":["Bank Securities Control"]}},"/ledger/securities/custody-accounts":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Requires a signed exact program/bank/master/custodian relationship, actual bank beneficial ownership, original empty inventory, exclusive core instructions and no third-party lien. Disabled evidence can be retained, but cannot authorize new trading. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesCustodyAccounts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustodyAccount"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank custody account","tags":["Bank Custody Account"]}},"/ledger/securities/instruments":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Requires exact checked CUSIP, whole $100-face units, fixed integer scales, issue/maturity dates and actual terms. No coupons, foreign currencies or assumed par price. Immutable independently reviewed instrument revisions preserve original acquisition terms. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesInstruments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instrument"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities instrument","tags":["Bank Securities Instrument"]}},"/ledger/securities/lots/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read required. Read a bank-owned lot with separate original trade and actual cash provenance. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"getLedgerSecuritiesLotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities lot by ID","tags":["Bank Securities Lot"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/lots/{id}/accruals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. to_date is an exclusive start-of-day boundary. Closing through day D requires D+1. Exact integer cumulative effective-interest rounding determines each dated increment; contractual settlement remains the start after late delivery. No cash, maturity payment or current tax is inferred by accrual. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesLotsIdAccruals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["to_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accrete exact daily effective-interest amounts to an exclusive start-of-day boundary","tags":["Bank Securities Lot"]}},"/ledger/securities/lots/{id}/observations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified non-API-key exact configured service with ledger:securities:bridge required. Only the original exact custodian bridge supplies signed actual physical units, liens and optional actual values/income. Unknown is not zero or par. Authentic mismatches remain exceptions. Same-date refresh requires a strictly later observation timestamp; completed-day basis cannot downgrade. Final close-out requires explicitly zero units, liens and remaining income. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesLotsIdObservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Observation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain monotonic signed actual custody quantity and explicitly known or unknown valuation","tags":["Bank Securities Lot"]}},"/ledger/securities/orders":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Exact actor/key/input replay retains the original stable order and lot. BUY binds a cash ceiling and actual master source; SELL reserves the entire original owned lot exclusively. Full fills only. Request and independent review do not invent execution or settlement. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities order","tags":["Bank Securities Order"]}},"/ledger/securities/orders/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read required. A service with only ledger:securities:bridge may read the exact order owned by its retained program subject; no general inventory access. Read exact bank securities order, issued command and actual evidence. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"getLedgerSecuritiesOrdersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities order by ID","tags":["Bank Securities Order"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/orders/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Requires a bounded note. Only undispatched work can cancel locally; exact actor/note replay remains retained. Dispatched work requires signed zero-fill rejection/cancellation, with no cash or units, rather than a timeout assumption. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrdersIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"note":{"type":"string"}},"required":["note"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel an undispatched bank trade and release exact reservations","tags":["Bank Securities Order"]}},"/ledger/securities/orders/{id}/dispatch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Fresh staff rechecks current authority, exact governed dealer nonaffiliate classification and intact reservations before retaining the exact issued instruction. The configured service reads only its own order; transport acknowledgement never means actual trade or paid cash. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrdersIdDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Durably issue the reviewed reserved bank trade instruction","tags":["Bank Securities Order"]}},"/ledger/securities/orders/{id}/execution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified non-API-key exact configured service with ledger:securities:bridge required. Only the retained exact program bridge can submit signed actual full execution or zero-fill cancellation/rejection. Actual execution binds bank/master/custody, full quantity, price/fee/cash limits and confirmation bytes. BUY recognizes security cost and purchase payable; SELL derecognizes book assets and creates receivable while physical units remain reserved until DVP. The actual receipt is retained before recoverable native ledger accounting. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrdersIdExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain actual signed full execution and separately recognize trade-date accounting","tags":["Bank Securities Order"]}},"/ledger/securities/orders/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with both ledger:securities:write and ledger:securities:approve required. Reviewer differs from maker and binds the exact retained request digest. Current controls, bank source, exact governed dealer identity and independently reviewed nonaffiliate classification, and limits are rechecked before actual bank cash or the full custody lot is reserved. Missing, expired or affiliate dealer source refuses approval. Shared writer serialization prevents short or competing full-lot dispositions. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrdersIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve a full bank trade and atomically reserve cash or custody lot","tags":["Bank Securities Order"]}},"/ledger/securities/orders/{id}/settlement":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified non-API-key exact configured service with ledger:securities:bridge required. Signed DVP binds the exact actual execution, full physical units, cash amount, reviewed external master account and actual bank statement identifier/line, plus actual cash/delivery documents and dates. Native ledger accounting and state commit atomically; permanent exact-source protection refuses generic reversal or receipt reuse. Late evidence retains actual dates and contractual original yield. Provider signature alone does not establish independent bank-statement reconciliation. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesOrdersIdSettlement","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain actual signed bank master statement cash and physical custody DVP","tags":["Bank Securities Order"]}},"/ledger/securities/positions":{"get":{"description":"Verified non-API-key staff or services holding ledger:read or ledger:securities:read (the reporting service reads it for Schedule RC-B); customers and API keys are refused 403 even locally. `as_of` names a business date whose original ledger closing completed, else 409 `ledger.period_not_ready`. Every lot held on the date (traded on or before it and not disposed of by it) or carried by that closing is placed with its version-one closing cost, fair-value adjustment and allowance; amortized cost is checked against the contractual schedule through the close; fair value comes only from an independently approved day_close valuation as of the date whose balances the closing carries, otherwise the position names it missing, never zero; the classification in force is the approved version effective on or before the date. A position whose lot record and closing disagree (booked or disposed of after the close, a valuation restated after it) names the exception. No signed receipt, dealer or bank statement evidence is included; responses are bounded at 16 MiB.","operationId":"getLedgerSecuritiesPositions","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionSet"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all bank securities positions","tags":["Bank Securities Position"]}},"/ledger/securities/programs":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Only bank-owned USD zero-coupon Treasury bills classified AFS, trade-date recognition and the explicit exact daily effective-yield convention are supported. The program binds bank legal entity, actual GL1010 and external master account identity, actual authority, broker/custodian agreements and signing keys. The reviewed dealer allowlist binds actual customer identity, external dealer reference, legal name and source evidence; it never substitutes for current independently reviewed nonaffiliate classification. No customer securities, deposits, HTM, funds, repos or certification are implied. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesPrograms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Program"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Control"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities program","tags":["Bank Securities Program"]}},"/ledger/securities/redemptions":{"post":{"description":"Verified non-API-key exact original custodian service with ledger:securities:bridge supplies signed actual full Treasury repayment, original lot/reservation identity, actual external master statement and line, custody extinguishment and tax documents. The receipt ID and external references bind immutable replay; they cannot fund another source. Native accounting finishes contractual accretion, removes original AFS and allocated tax balances, reverses remaining ACL through credit provision and retains actual gross face, net cash, withholding and fees separately. Calendar maturity or projected discount is not cash; full face is paid once. The actual receipt is retained before accounting so posting failure remains recoverable. Complete evidence is strictly bounded at 5 MiB; responses at 16 MiB never silently truncate.","operationId":"postLedgerSecuritiesRedemptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redemption"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedemptionRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank treasury redemption","tags":["Bank Treasury Redemption"]}},"/ledger/securities/redemptions/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read reads retained actual full Treasury repayment and original gross, withholding, fee and net cash evidence, native journal and accounting exceptions. A bridge scope alone grants no general redemption inventory access. Customers are refused even in local mode.","operationId":"getLedgerSecuritiesRedemptionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedemptionRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank treasury redemption by ID","tags":["Bank Treasury Redemption"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/snapshots":{"post":{"description":"Verified non-API-key staff/service with ledger:securities:read captures immutable source evidence under exact actor/key/input replay. This read authority cannot issue trades. ObservationDate is the actual current source date; requested BusinessDate describes close coverage, not reconstructed historical inventory. Snapshot retains original control/receipt evidence, assigned journal IDs, keys, actors, posting dates and commit times plus exact fingerprints including hold release; actual managed balances and dealer registry checks remain explicit. Day-close coverage needs the requested day's evidenced value and accrual through exclusive boundary D+1. Independent actual master-statement reconciliation remains a blocker until separately proven; provider signatures alone cannot make the book ready. Complete response is bounded at 16 MiB and never silently truncated. Customers and API keys are refused even locally.","operationId":"postLedgerSecuritiesSnapshots","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"legal_entity":{"type":"string"}},"required":["business_date","legal_entity"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities snapshot","tags":["Bank Securities Snapshot"]}},"/ledger/securities/snapshots/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read reads the retained immutable snapshot, source digest, observed inventory and exact readiness blockers. This is the original capture, not a newly inferred historical position. A bridge scope alone does not grant bank-wide source access. Complete responses exceed the supported limit only by explicit refusal; no partial inventory is presented as complete.","operationId":"getLedgerSecuritiesSnapshotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities snapshot by ID","tags":["Bank Securities Snapshot"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/valuations":{"post":{"description":"Fresh verified non-API-key staff with ledger:securities:write required. Requires the current lot revision, actual signed price with intraday or day_close basis and explicit independently evidenced tax basis, separate OCI/earnings deferred taxes, credit allowance and sale assessments. Unknown tax/credit is not zero. Ordinary marks refuse required write-down/new-basis branches that need a separate supported accounting resolution. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesValuations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a bank securities valuation","tags":["Bank Securities Valuation"]}},"/ledger/securities/valuations/{id}":{"get":{"description":"Verified non-API-key staff/service with ledger:securities:read required. Read an immutable bank security valuation and accounting decision. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"getLedgerSecuritiesValuationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a bank securities valuation by ID","tags":["Bank Securities Valuation"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/ledger/securities/valuations/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified non-API-key staff with both ledger:securities:write and ledger:securities:approve required. Independent exact-content review rechecks current custody and lot revision and applies exact amortized cost, AFS adjustment, ACL, AOCI and allocated deferred-tax deltas. Effective-interest cost derives from the retained contractual schedule, not an imported scalar or unreviewed straight-line approximation. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.","operationId":"postLedgerSecuritiesValuationsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksecuritiesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve current AFS valuation and post exact balance changes","tags":["Bank Securities Valuation"]}},"/ledger/trial-balance":{"get":{"operationId":"getLedgerTrialBalance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerTrialBalance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Trial balance by GL code and currency","tags":["Ledger"]}},"/lending-collateral/fact-reports":{"post":{"description":"Verified staff or services holding `lending:write` (never an API key) re-send the facts of every pledged loan the register has not acknowledged; loans it could not take stay pending and block lending's close readiness.","operationId":"postLendingCollateralFactReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollateralReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report to the collateral register every pledged loan whose facts changed since it last acknowledged them; loans it could not take stay pending and hold lending's close (a lending writer)","tags":["Other"]}},"/lending-collateral/loans/{id}":{"get":{"description":"The collateral register (`svc_ledger` with `lending:collateral:encumber`) or verified staff or services holding `lending:read` or `lending:write` read it; customers and API keys are refused 403 `forbidden`. The register class follows the product's Schedule RC-C item; maturity is the last scheduled instalment's due date, unresolved without a schedule.","operationId":"getLendingCollateralLoansId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollateralLoan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a collateral loan by ID","tags":["Collateral Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-collateral/loans/{id}/encumbrance":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the ledger's own service identity `svc_ledger` holding `lending:collateral:encumber` (never staff, another service or an API key) may call it; any other caller is refused 403 `forbidden`. A new pledge is refused 409 `conflict` while another holds the loan; the same pledge only moves forward; a clear names its released pledge. While encumbered the loan cannot be participated out or have its servicing transferred.","operationId":"postLendingCollateralLoansIdEncumbrance","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncumbranceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollateralLoan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set the register's pledge on a loan, or clear the named released pledge; while set the loan cannot be sold, participated out or have its servicing transferred (the ledger's service identity with lending:collateral:encumber only)","tags":["Collateral Loan"]}},"/lending-furnishing/disputes":{"post":{"description":"Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. Opens an FCRA dispute against a furnished loan tradeline. The claim detail is sealed; the next furnishing cycle marks the tradeline disputed (XB).","operationId":"postLendingFurnishingDisputes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingDisputeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingDispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Open an FCRA dispute against a furnished loan tradeline","tags":["Credit Bureau Furnishing"]}},"/lending-furnishing/disputes/{id}/resolution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. status is corrected or verified. An already-closed dispute answers 409 conflict.","operationId":"postLendingFurnishingDisputesIdResolution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeResolution"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingDispute"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close an FCRA dispute as corrected or verified","tags":["Credit Bureau Furnishing"]}},"/lending-furnishing/loans/{id}/disputes":{"get":{"description":"Dedicated lending:furnishing:read staff or service authority required; lending:read is not enough. Packet reads return lifecycle metadata only (no file bytes, no SSN). ","operationId":"getLendingFurnishingLoansIdDisputes","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LendingDispute"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a loan's FCRA furnishing disputes","tags":["Credit Bureau Furnishing"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-furnishing/packets":{"get":{"description":"Dedicated lending:furnishing:read staff or service authority required; lending:read is not enough. Packet reads return lifecycle metadata only (no file bytes, no SSN). Optional cycle and limit query; newest first, at most 200.","operationId":"getLendingFurnishingPackets","parameters":[{"in":"query","name":"cycle","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FurnishingPacket"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List furnishing packets (metadata only)","tags":["Credit Bureau Furnishing"]},"post":{"description":"Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. Idempotent on the key. Each subject names exactly one of loan_id or facility_id. While an FCRA dispute is open the tradeline carries Metro 2 compliance condition code XB; a correction sets the Correction indicator.","operationId":"postLendingFurnishingPackets","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FurnishingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FurnishingPacket"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FurnishingPacket"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Build a Metro 2 furnishing file for a reporting cycle","tags":["Credit Bureau Furnishing"]}},"/lending-furnishing/packets/{id}":{"get":{"description":"Dedicated lending:furnishing:read staff or service authority required; lending:read is not enough. Packet reads return lifecycle metadata only (no file bytes, no SSN). ","operationId":"getLendingFurnishingPacketsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FurnishingPacket"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a furnishing packet's lifecycle metadata","tags":["Credit Bureau Furnishing"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-furnishing/packets/{id}/submissions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. Submits a built (or failed) packet to the configured bureau and records the acknowledgment. An already-acknowledged packet is returned unchanged. No bureau URL answers 424 dependency_failed.","operationId":"postLendingFurnishingPacketsIdSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FurnishingPacket"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Submit a built furnishing file to the consumer reporting agency","tags":["Credit Bureau Furnishing"]}},"/lending-furnishing/purge":{"post":{"description":"Dedicated lending:furnishing:write human staff authority (the furnishing_officer role) and authentication within five minutes required; lending:read/write and API keys are refused 403. Consumer identity is accepted on build, sealed at rest, and never returned on a packet read. Deletes packets whose retain_until is before the business date, scrubbing the sealed consumer data.","operationId":"postLendingFurnishingPurge","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/furnishingPurge"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Purge furnishing packets whose retention window has passed","tags":["Credit Bureau Furnishing"]}},"/lending-insiders/credits/{kind}/{target}/terms":{"get":{"description":"Dedicated lending:insiders:read authority required. Capture the returned terms digest in an authorization; current terms are rechecked on credit approval, funding, activation and new draws. A credit application for an insider enters review before any approved commitment.","operationId":"getLendingInsidersCreditsKindTargetTerms","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditTerms"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the exact terms used to bind board authorization to a credit","tags":["Other"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}},{"in":"path","name":"target","required":true,"schema":{"type":"string"}}]},"/lending-insiders/current/{kind}/{subject}":{"get":{"description":"Dedicated lending:insiders:read staff/service authority and nonempty purpose query required; access is retained. Exposure includes pending applications, gross loans, unrecovered charge-offs, full facility commitments and reviewed external inventory. Missing/stale classifications remain visible and block new extensions of credit.","operationId":"getLendingInsidersCurrentKindSubject","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the currently approved insider control revision","tags":["Other"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}},{"in":"path","name":"subject","required":true,"schema":{"type":"string"}}]},"/lending-insiders/exposure":{"get":{"description":"Dedicated lending:insiders:read staff/service authority and nonempty purpose query required; access is retained. Exposure includes pending applications, gross loans, unrecovered charge-offs, full facility commitments and reviewed external inventory. Missing/stale classifications remain visible and block new extensions of credit.","operationId":"getLendingInsidersExposure","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersExposure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Measure gross loans, undrawn commitments and external insider exposure against reviewed classifications","tags":["Other"]}},"/lending-insiders/exposure/{as_of}":{"get":{"description":"Dedicated lending:insiders:read staff/service authority and nonempty purpose query required; access is retained. as_of is a YYYY-MM-DD date not after the lending business date. Loan and facility records come only from the closing-day source retained for that date, after its seal, whose dated ledger receivables must still agree (lending.reconciliation_required otherwise); membership comes only from approved classification revisions effective on that date; credit outside lending only from the external exposure inventory of the approved policy revision effective on that date (policy). 409 when no source is retained for the date, no policy revision is effective on it, or a borrower with credit, an inventoried customer or a linked insider has no classification effective then. Follows FFIEC 051 Schedule RC-M item 1: funded loans at principal outstanding, lines of credit at the total line (or the drawn balance when greater), activated construction commitments and standby letters of credit at their amount, each credit once in aggregate_minor and in full for each insider it is attributed to. Applications are excluded. Each inventory entry recorded for an insider or related interest is an external credit with undetermined_reason, not counted, because the policy does not date its balance. Credits the records cannot place (undisbursed approvals, charge-offs, participations sold, factoring and merchant cash advances, revolving balances within the 12 CFR 215.3(b)(5) open-end plan exclusion without a board authorization recorded before the close, overdraft lines within (b)(6), lapsed lines, credit attributed only to insiders of an affiliate) carry undetermined_reason and are not counted; a revolving line whose catalogue terms rest availability on a borrowing base is not a standardized open-end plan and counts at its line whatever is drawn.","operationId":"getLendingInsidersExposureAs_of","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatedExposure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the insider credit Call Report Schedule RC-M item 1 counts at a past date from its closing-day source and the classifications effective then","tags":["Other"]},"parameters":[{"in":"path","name":"as_of","required":true,"schema":{"type":"string"}}]},"/lending-insiders/records":{"post":{"description":"Dedicated lending:insiders:write human staff authority and authentication within five minutes required. Exactly one annual classification, capital/board/inventory policy, or exact-credit board authorization; corrections name current approved previous_id. Captured evidence is immutable. Capital policy supports USD gross exposure, individual limits at most 15% and aggregate limits at most 100% of evidenced unimpaired capital/surplus; no statutory secured or small-bank exception deductions.","operationId":"postLendingInsidersRecords","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersProposal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable insider classification, capital policy, or exact-credit board evidence","tags":["Other"]}},"/lending-insiders/records/{id}":{"get":{"description":"Dedicated lending:insiders:read staff/service authority and nonempty purpose query required; access is retained. Exposure includes pending applications, gross loans, unrecovered charge-offs, full facility commitments and reviewed external inventory. Missing/stale classifications remain visible and block new extensions of credit.","operationId":"getLendingInsidersRecordsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained insider evidence with purpose-bound access logging","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-insiders/records/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:insiders:approve, fresh human staff authentication and a subject different from the recorder required. Stale corrections cannot overwrite approved evidence. Board authorization requires majority approval of the entire reviewed roster, recorded abstention/nonparticipation by interested directors, current policy/classification and exact credit terms. Records evidence of actual board proceedings, not an electronic substitute for a board vote.","operationId":"postLendingInsidersRecordsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsidersRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an insider control record with recent staff authentication","tags":["Other"]}},"/lending-monitoring/exports":{"post":{"description":"Dedicated export authority required. Capture is idempotent by actor and exact request with stable content hashes. Monitoring produces draft 110-field pipe-delimited LAR data from complete approved captures, identifying credits still unassessed; no transmittal sheet or full FFIEC edit certification. Risk inputs are a repeatable-read current snapshot with actual payment, accrual, loss and reviewed risk-grade histories and source IDs. Historical reporting_year is refused for current risk balances. Unfinished money commands block new risk exports. submission_ready is always false.","operationId":"postLendingMonitoringExports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a replayable draft LAR or CECL input snapshot with source IDs, hashes and explicit validation limitations","tags":["Other"]}},"/lending-monitoring/exports/{export}":{"get":{"description":"Dedicated export authority and nonempty purpose query required, including when retrieving previously captured bytes. Access is recorded.","operationId":"getLendingMonitoringExportsExport","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retrieve the immutable export with purpose-bound sensitive-access evidence","tags":["Other"]},"parameters":[{"in":"path","name":"export","required":true,"schema":{"type":"string"}}]},"/lending-monitoring/revisions/{revision}":{"get":{"description":"Dedicated read authority and a nonempty purpose query required; access is recorded.","operationId":"getLendingMonitoringRevisionsRevision","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a segregated revision with sensitive-access evidence","tags":["Other"]},"parameters":[{"in":"path","name":"revision","required":true,"schema":{"type":"string"}}]},"/lending-monitoring/revisions/{revision}/decisions":{"parameters":[{"in":"path","name":"revision","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated approve authority, fresh staff authentication and an actor different from the maker required. Stale approved predecessors cannot be overwritten; decisions and retained evidence are immutable.","operationId":"postLendingMonitoringRevisionsRevisionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a captured correction; stale corrections never overwrite the current record","tags":["Other"]}},"/lending-monitoring/schema":{"get":{"description":"Dedicated segregated monitoring read authority required. Registry records the official 2026 FIG source/version/hash and supported structural validation boundary.","operationId":"getLendingMonitoringSchema","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the supported HMDA FIG field registry and validation boundary (segregated monitoring scope)","tags":["Other"]}},"/lending-monitoring/targets/{kind}/{target}/revisions":{"get":{"description":"Dedicated read authority and a nonempty purpose query required. At most 200 revisions ordered by ID; pass the last ID as after to continue. Monitoring requires reporting_year=2026, risk grades use zero. Access is retained in the sensitive-read log.","operationId":"getLendingMonitoringTargetsKindTargetRevisions","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Revision"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read at most 200 segregated revisions after an ID, recording the purpose of access","tags":["Other"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}},{"in":"path","name":"target","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires dedicated lending:monitoring:write or lending:risk:write staff authority and authentication within five minutes. Monitoring identities cannot also hold lending:write or operations:approve. kind is loan or facility. Corrections name the current approved previous_id; evidence remains immutable. Monitoring uses the 2026 FIG registry; fields use official 1-based field-number keys. No demographics enter underwriting. Risk grades name an evidenced scale/version and nonfuture effective date.","operationId":"postLendingMonitoringTargetsKindTargetRevisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringProposal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture an immutable regulatory correction against its approved predecessor; dedicated staff scope and recent authentication","tags":["Other"]}},"/lending-risk/cecl/executions":{"post":{"description":"Dedicated lending:risk:export. Current business-date snapshot only, currently approved model and explicit approved risk grade for every exposure. Retains source export ID/hash, deterministic per-credit output and split funded/unfunded loss. Current accrual, complete money commands and principal/ledger tie required.","operationId":"postLendingRiskCeclExecutions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execute"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeclRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture current source data and execute the approved CECL model","tags":["Other"]}},"/lending-risk/cecl/models":{"post":{"description":"Dedicated lending:risk:write human staff with fresh authentication. Named/versioned monthly-pd-lgd-v1 assumptions, explicitly approved forecast/historical loss/linear-reversion/prepayment/LGD, contractual-term/cancellability groups and annual board/independent-validation evidence. No bank coefficients supplied by code. Accrued-interest exclusion requires an evidenced timely-reversal accounting election. Corrections name current approved predecessor.","operationId":"postLendingRiskCeclModels","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeclRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose versioned evidenced CECL model assumptions","tags":["Other"]}},"/lending-risk/cecl/records/{id}":{"get":{"description":"Dedicated lending:risk:read with nonempty purpose; access retained. Immutable model/execution records with actual source IDs and independent decisions.","operationId":"getLendingRiskCeclRecordsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeclRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable CECL model or execution evidence","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-risk/cecl/records/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:risk:approve, recent human authentication, different maker and no credit-decision scopes. Output reviewer cannot be model maker. Stale model/source revisions refuse; approved executions are revalidated before actual Allowance(date) posts funded ACL1490 and separate unfunded liability2490 against provision5400. Lost posting acknowledgment recovers its retained journal before governance changes.","operationId":"postLendingRiskCeclRecordsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CeclRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve source-bound CECL model or output","tags":["Other"]}},"/lending-risk/exports":{"post":{"description":"Dedicated export authority required. Capture is idempotent by actor and exact request with stable content hashes. Monitoring produces draft 110-field pipe-delimited LAR data from complete approved captures, identifying credits still unassessed; no transmittal sheet or full FFIEC edit certification. Risk inputs are a repeatable-read current snapshot with actual payment, accrual, loss and reviewed risk-grade histories and source IDs. Historical reporting_year is refused for current risk balances. Unfinished money commands block new risk exports. submission_ready is always false.","operationId":"postLendingRiskExports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a replayable draft LAR or CECL input snapshot with source IDs, hashes and explicit validation limitations","tags":["Other"]}},"/lending-risk/exports/{export}":{"get":{"description":"Dedicated export authority and nonempty purpose query required, including when retrieving previously captured bytes. Access is recorded.","operationId":"getLendingRiskExportsExport","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringExport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retrieve the immutable export with purpose-bound sensitive-access evidence","tags":["Other"]},"parameters":[{"in":"path","name":"export","required":true,"schema":{"type":"string"}}]},"/lending-risk/revisions/{revision}":{"get":{"description":"Dedicated read authority and a nonempty purpose query required; access is recorded.","operationId":"getLendingRiskRevisionsRevision","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a segregated revision with sensitive-access evidence","tags":["Other"]},"parameters":[{"in":"path","name":"revision","required":true,"schema":{"type":"string"}}]},"/lending-risk/revisions/{revision}/decisions":{"parameters":[{"in":"path","name":"revision","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated approve authority, fresh staff authentication and an actor different from the maker required. Stale approved predecessors cannot be overwritten; decisions and retained evidence are immutable.","operationId":"postLendingRiskRevisionsRevisionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a captured correction; stale corrections never overwrite the current record","tags":["Other"]}},"/lending-risk/targets/{kind}/{target}/revisions":{"get":{"description":"Dedicated read authority and a nonempty purpose query required. At most 200 revisions ordered by ID; pass the last ID as after to continue. Monitoring requires reporting_year=2026, risk grades use zero. Access is retained in the sensitive-read log.","operationId":"getLendingRiskTargetsKindTargetRevisions","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Revision"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read at most 200 segregated revisions after an ID, recording the purpose of access","tags":["Other"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}},{"in":"path","name":"target","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires dedicated lending:monitoring:write or lending:risk:write staff authority and authentication within five minutes. Monitoring identities cannot also hold lending:write or operations:approve. kind is loan or facility. Corrections name the current approved previous_id; evidence remains immutable. Monitoring uses the 2026 FIG registry; fields use official 1-based field-number keys. No demographics enter underwriting. Risk grades name an evidenced scale/version and nonfuture effective date.","operationId":"postLendingRiskTargetsKindTargetRevisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringProposal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture an immutable regulatory correction against its approved predecessor; dedicated staff scope and recent authentication","tags":["Other"]}},"/lending-servicing/actions/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:servicing:approve, fresh human staff authentication and an actor different from the maker required. Replay binds actor and exact review; stale predecessors conflict. A transfer is restricted to funded, unsold, bank-owned loans before charge-off: current accrual, tied principal/ledger receivable, no pending money commands, 15-day advance notice and receiver acknowledgment of unchanged source package. Approval retains the package and changes collection/escrow servicing authority.","operationId":"postLendingServicingActionsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve a servicing action and enforce its financial/borrower-protection effects","tags":["Other"]}},"/lending-servicing/cases":{"get":{"description":"Dedicated lending:servicing:read authority and nonempty purpose query required. Optional loan_id and after cursor; plain array limited to 100 cases ordered by ID. Work identifies pending/overdue acknowledgment and evaluation based on retained action evidence.","operationId":"getLendingServicingCases","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ServicingCase"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List up to 100 assigned servicing cases with overdue borrower-response work","tags":["Other"]},"post":{"description":"Dedicated lending:servicing:write human staff authority and authentication within five minutes required. Records assigned collections/loss-mitigation work, actual receipt and source evidence. A captured loss-mitigation request immediately prevents foreclosure referral; acknowledgment/evaluation work remains visible. No claim that recording a notice delivers it.","operationId":"postLendingServicingCases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenCase"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture an assigned collections or loss-mitigation case with retained borrower evidence","tags":["Other"]}},"/lending-servicing/cases/{id}":{"get":{"description":"Dedicated lending:servicing:read authority and nonempty purpose query required; immutable action/review history and current work deadlines.","operationId":"getLendingServicingCasesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the servicing case and immutable action/review history","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-servicing/cases/{id}/actions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Dedicated lending:servicing:write staff authority with fresh authentication required. Reviewed forbearance suspends staff/service collection debits and late fees on protected installment dates; contractual delinquency, interest, nonaccrual and charge-off accounting remain accurate. Denial requires complete-application evidence, actual notice and at least 14 days to appeal. Supported mortgage foreclosure referral requires more than 120 days past due and no borrower protection. Recording a referral does not perform an external legal filing.","operationId":"postLendingServicingCasesIdActions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose evidenced forbearance, loss-mitigation resolution, foreclosure referral or servicing transfer","tags":["Other"]}},"/lending-servicing/loans/{id}/controls":{"get":{"description":"Dedicated lending:servicing:read authority required. Returns active collection/foreclosure protection and external-servicer authority with source IDs.","operationId":"getLendingServicingLoansIdControls","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingControls"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read active collection, foreclosure and servicing-authority protections","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-servicing/loans/{id}/received-payments":{"get":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"getLendingServicingLoansIdReceivedPayments","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReceivedPayment"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained received-payment instructions and their actual results","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingLoansIdReceivedPayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivePayment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a fresh voluntary borrower DDA payment for the exact approved servicing receiver","tags":["Other"]}},"/lending-servicing/loans/{id}/transfer-snapshot":{"get":{"description":"Dedicated lending:servicing:read authority required. Reconciles principal to posted receivable and captures loan/schedule/payment/escrow/case evidence with a stable digest. Does not sell the loan, transmit the package, forward borrower payments, or represent an external servicer's execution.","operationId":"getLendingServicingLoansIdTransferSnapshot","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture reconciled loan and schedule/escrow history for receiving-servicer acknowledgment","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-servicing/payment-returns/{id}/execution":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingPaymentReturnsIdExecution","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentReturn"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute or recover the reviewed native refund to the original debit DDA","tags":["Other"]}},"/lending-servicing/payment-returns/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingPaymentReturnsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentReturn"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a return of actual unallocated forwarding money","tags":["Other"]}},"/lending-servicing/received-payments/{id}":{"get":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"getLendingServicingReceivedPaymentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardingStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the received payment and authoritative forwarding/refund capacity without claiming receiver application","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lending-servicing/received-payments/{id}/cancellation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingReceivedPaymentsIdCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReceivedPayment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically fence an unposted instruction or recover money that already committed","tags":["Other"]}},"/lending-servicing/received-payments/{id}/recovery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingReceivedPaymentsIdRecovery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivedPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover only already committed borrower receipts and register their actual payable source","tags":["Other"]}},"/lending-servicing/received-payments/{id}/returns":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.","operationId":"postLendingServicingReceivedPaymentsIdReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPayment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentReturn"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a return with actual proper-recipient notice to the borrower","tags":["Other"]}},"/loan-products":{"get":{"description":"Live loan products","operationId":"getLoanProducts","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all loan products","tags":["Loan Product"]}},"/loans":{"get":{"description":"List loans","operationId":"getLoans","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Loan"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all loans","tags":["Loan"]},"post":{"description":"Apply for a loan (underwritten at once)","operationId":"postLoans","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a loan","tags":["Loan"]}},"/loans/accrual-runs":{"post":{"operationId":"postLoansAccrualRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"}},"required":["business_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run the daily interest accrual for a business date","tags":["Loan"]}},"/loans/adverse-actions":{"get":{"operationId":"getLoansAdverseActions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reg B adverse action records and their 30-day notice clocks","tags":["Loan"]}},"/loans/adverse-actions/{id}/notice":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansAdverseActionsIdNotice","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record delivery of the adverse action notice","tags":["Loan"]}},"/loans/allowance-runs":{"get":{"operationId":"getLoansAllowanceRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AllowanceRun"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List allowance runs","tags":["Loan"]},"post":{"operationId":"postLoansAllowanceRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"}},"required":["business_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowanceRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run the allowance for credit losses for a business date and provision the difference","tags":["Loan"]}},"/loans/call-report/balances":{"get":{"description":"Staff or service identity with lending:read or lending:write; customers and API keys are refused. as_of (required) is a non-future business date; from defaults to as_of and is at most 185 days earlier. Pages credits by id with limit (at most 100) and starting_after; ending_before is refused. Each loan or facility with a receivable account lists its principal net of participations sold at the close of the day before from, each dated change through as_of with its journals, and the Schedule RC-C category its product version names as the catalogue writes it. Balances are the ledger history of the credit's own receivable account, listed only after the account's name, owner, currency, namespace and GL code prove it is the one lending opened; a construction facility's receivable passes to its permanent loan on the conversion business date. A receivable recorded on two credits other than that pair refuses the listing with conflict; an unproven account answers lending.reconciliation_required.","operationId":"getLoansCallReportBalances","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}},{"in":"query","name":"from","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}},{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallReportBalances"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page every loan and facility's retained principal at the close of each business date, by Schedule RC-C category","tags":["Loan"]}},"/loans/call-report/closing-credits":{"get":{"description":"Staff or service identity with lending:read or lending:write; customers and API keys are refused. as_of (required) is a date not after the lending business date. Pages credits by id with limit (at most 100) and starting_after; ending_before is refused. Answers only from the closing-day lending source retained for as_of, after its seal expires and while its credit records match the source digests: each loan's and facility's recorded status, days past due and bucket, nonaccrual and charge-off instants, the principal a loan was made for, a facility's limit and undrawn amount, the receivable carried (loan outstanding less participations sold, facility drawn), the last scheduled due date, expiry and draw period, and the Schedule RC-C category its product version names. Every credit on a page must still equal its dated ledger receivable (lending.reconciliation_required otherwise). A date with no source, or a sealed one, answers conflict.","operationId":"getLoansCallReportClosingCredits","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}},{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallReportClosingCredits"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page the loan and facility records the closing-day source retained for a business date: status, delinquency, original amounts and commitments by Schedule RC-C category","tags":["Loan"]}},"/loans/call-report/credit-losses":{"get":{"description":"Staff or service identity with lending:read or lending:write; customers and API keys are refused. from and through (both required) are at most 366 days apart and through is not in the future. Pages records by record_id with limit (at most 100) and starting_after; ending_before is refused. Lists every completed charge-off (from its captured instruction, which must debit the loan allowance GL 1490 account and credit the credit's own receivable, with the committed journal read back under the command key) and every recovery on a loan, with gross, participants' and net (allowance) amounts and the credit's Schedule RC-C category. A charge-off or recovery still pending, a charged-off credit with no completed charge-off record, a charge-off instruction on any other account, or a recovered total not itemized refuses the listing (conflict or lending.reconciliation_required). Facilities have no recovery flow.","operationId":"getLoansCallReportCreditLosses","parameters":[{"in":"query","name":"from","schema":{"type":"string"}},{"in":"query","name":"through","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}},{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallReportCreditLosses"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page the charge-offs and recoveries of a period, by Schedule RC-C category, with the participants' and the bank's shares","tags":["Loan"]}},"/loans/close-readiness":{"get":{"description":"Operator lending authority required. business_date is a nonfuture YYYY-MM-DD date. ready is false when accruals have not reached the date, a due contractual reset remains unapplied, whole-cent interest remains unrecognized, or recoverable lending money commands are incomplete. Accrue may successfully process unaffected credits while this readiness check remains blocked.","operationId":"getLoansCloseReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingCloseReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Check for dated accrual gaps, unapplied contractual rate resets and unresolved lending money commands","tags":["Loan"]}},"/loans/closing/calendar-sources":{"post":{"description":"Verified lending close authority. Only for an actual nonbank calendar-month-end date during 23:45–24:00 Eastern; use calendar_period=true on source readiness for this window. Requires completed accrual through that exact date, refuses later accrual and current balances that do not reconcile to dated receivables, generates due actual calendar-day facility statements, and seals lending only until midnight. A Friday source cannot stand in for a Saturday/Sunday/holiday month end. Source consumption waits until its seal expires.","operationId":"postLoansClosingCalendarSources","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdayRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdaySource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture actual nonbank calendar-month-end loan accrual and billing sources","tags":["Loan"]}},"/loans/closing/source-readiness":{"get":{"description":"Verified lending staff/service authority; fresh staff step-up for writes. Capture occurs only on the actual closing bank date during the final fifteen minutes before cutoff, binds an immutable plan version, verifies accrual/recognition and prepares due facility bills, retains risk/billing evidence, and seals instrument mutations until cutoff. A source cannot be reconstructed on a later day. Next-day billing consumes already-generated minimum/due state without inventing delivery evidence. CECL execution may name close_source_id and compares dated ledger receivables to the exact retained source.","operationId":"getLoansClosingSourceReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdayReadiness"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read bounded capture window and retained source availability","tags":["Loan"]}},"/loans/closing/sources":{"post":{"description":"Verified lending staff/service authority; fresh staff step-up for writes. Capture occurs only on the actual closing bank date during the final fifteen minutes before cutoff, binds an immutable plan version, verifies accrual/recognition and prepares due facility bills, retains risk/billing evidence, and seals instrument mutations until cutoff. A source cannot be reconstructed on a later day. Next-day billing consumes already-generated minimum/due state without inventing delivery evidence. CECL execution may name close_source_id and compares dated ledger receivables to the exact retained source.","operationId":"postLoansClosingSources","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdayRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdaySource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture actual closing-day lending inputs and seal remaining cutoff window","tags":["Loan"]}},"/loans/closing/sources/{business_date}":{"get":{"description":"Verified lending staff/service authority; fresh staff step-up for writes. Capture occurs only on the actual closing bank date during the final fifteen minutes before cutoff, binds an immutable plan version, verifies accrual/recognition and prepares due facility bills, retains risk/billing evidence, and seals instrument mutations until cutoff. A source cannot be reconstructed on a later day. Next-day billing consumes already-generated minimum/due state without inventing delivery evidence. CECL execution may name close_source_id and compares dated ledger receivables to the exact retained source.","operationId":"getLoansClosingSourcesBusiness_date","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosingdaySource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable closing-day source metadata","tags":["Loan"]},"parameters":[{"in":"path","name":"business_date","required":true,"schema":{"type":"string"}}]},"/loans/delinquency-runs":{"post":{"operationId":"postLoansDelinquencyRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"type":"string"}},"required":["business_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelinquencyRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run the past-due sweep for a business date: late fees, nonaccrual and charge-offs","tags":["Loan"]}},"/loans/escrow/work":{"get":{"operationId":"getLoansEscrowWork","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Work"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page escrow obligations and unfinished recovery commands","tags":["Loan"]}},"/loans/information-requests/search":{"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postLoansInformationRequestsSearch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture exact confidential loan and facility evidence for an approved request, its candidate set and the subject's own account numbers inside the original account window","tags":["Loan"]}},"/loans/participation-purchases":{"post":{"operationId":"postLoansParticipationPurchases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Buy a share of another bank's loan or a syndicated credit's allocation","tags":["Loan"]}},"/loans/portfolio":{"get":{"operationId":"getLoansPortfolio","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The lending book: by status, delinquency bucket and product","tags":["Loan"]}},"/loans/rates/indexes/{index}/candidates":{"get":{"operationId":"getLoansRatesIndexesIndexCandidates","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LendingratesObservation"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Fetch unapproved New York Fed index candidates","tags":["Loan"]},"parameters":[{"in":"path","name":"index","required":true,"schema":{"type":"string"}}]},"/loans/rates/indexes/{index}/observations":{"get":{"operationId":"getLoansRatesIndexesIndexObservations","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Record_046f45c32cb3"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read index publication and review history","tags":["Loan"]},"parameters":[{"in":"path","name":"index","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansRatesIndexesIndexObservations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesObservation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_046f45c32cb3"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an index observation with immutable source evidence","tags":["Loan"]}},"/loans/rates/records/{record}/review":{"parameters":[{"in":"path","name":"record","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansRatesRecordsRecordReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_de2ff211e763"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a rate record","tags":["Loan"]}},"/loans/rates/runs":{"post":{"operationId":"postLoansRatesRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["business_date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LendingratesWork"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Activate due approved and delivered contractual rate resets","tags":["Loan"]}},"/loans/rates/work":{"get":{"operationId":"getLoansRatesWork","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LendingratesWork"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List next contractual resets and unmet notice requirements","tags":["Loan"]}},"/loans/{id}":{"get":{"description":"Read a loan","operationId":"getLoansId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a loan by ID","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/affiliate-credit":{"get":{"description":"Verified staff/service lending:read authority required. Source terms bind exact credit ID, borrower, full gross commitment, currency and logical destination to a SHA256. A compliance plan must be approved and capacity reserved before credit approval; new funding additionally needs an exact journal usage and authoritative confirmation. Affiliate facility execution is refused. A fee-netted affiliate closing is outside supported gross-cash term-loan scope.","operationId":"getLoansIdAffiliateCredit","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact loan terms for affiliate credit review","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/affiliate-exposure":{"get":{"description":"Verified staff/service lending:read required. Current observation date (optional current as_of). Optional accrued_through instead requires accrual through a nonfuture close cutoff, returning actual accrued_through and current AsOf; it does not reconstruct historical balances. No pending commands; sold, purchased and charged-off legal obligations refuse. Includes approved undrawn commitment, gross principal, uncollected interest including not-yet-due amounts and due fees. Positive fractions of an interest cent round up for collateral protection; exact rational interest is in minor units. Hash binds full source loan revision.","operationId":"getLoansIdAffiliateExposure","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatesExposure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Current obligation including principal, accrued interest and fees for affiliate coverage","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/affiliate-funding-source":{"get":{"description":"Verified lending:read staff/service authority required. Returns expected immutable ledger address, captured product GL code and known activated/prepared receivable ID if present, with exact credit terms. Takes no instrument write lock and is safe for a compliance authorization callback before lending funding commits.","operationId":"getLoansIdAffiliateFundingSource","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundingSource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read source ledger identity before affiliate funding authorization","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/affiliate-version":{"get":{"description":"Verified lending:read staff/service authority. One source statement returns current business date, exact full loan revision digest (same hash as affiliate-exposure) and pending financial-command status. Takes no instrument write lock; permits a compliance caller holding its own control lock to recheck that captured principal/interest/fees remain unchanged.","operationId":"getLoansIdAffiliateVersion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanVersion"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact source revision and pending financial state without a lending write lock","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/closings":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingPlan"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingCase"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture immutable closing terms and requirements","tags":["Loan"]}},"/loans/{id}/closings/{case}":{"get":{"operationId":"getLoansIdClosingsCase","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read closing evidence and funding state","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}]},"/loans/{id}/closings/{case}/cancellation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Cancel and fence an unposted closing","tags":["Loan"]}},"/loans/{id}/closings/{case}/consummation":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseConsummation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consummation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the signed contractual obligation after disclosure checks","tags":["Loan"]}},"/loans/{id}/closings/{case}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingUpload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Archive closing evidence for independent review","tags":["Loan"]}},"/loans/{id}/closings/{case}/documents/{document}/pdf":{"get":{"operationId":"getLoansIdClosingsCaseDocumentsDocumentPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download immutable closing evidence","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"document","required":true,"schema":{"type":"string"}}]},"/loans/{id}/closings/{case}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Release closing after conditions and rescission clearance","tags":["Loan"]}},"/loans/{id}/closings/{case}/rescission":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseRescission","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record written rescission and fence unposted funding","tags":["Loan"]}},"/loans/{id}/closings/{case}/reviews/{subject}":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"case","required":true,"schema":{"type":"string"}},{"in":"path","name":"subject","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdClosingsCaseReviewsSubject","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingclosingView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide closing terms or document evidence","tags":["Loan"]}},"/loans/{id}/decide":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Decide a loan in review: an independent credit officer approves or declines it. `decision` is `approve` or `decline`; the actor is the verified credit officer, and the decision records them as `decided_by`. `reasons` are the principal reasons that officer states. A decline is an adverse action, which Reg B (12 CFR 1002.9(b)(2)) requires to state its principal specific reasons, so a decline carrying none is refused 400 `validation_failed` on `reasons`; at most 10 reasons, each at most 300 characters, and blank ones are dropped. The automated triggers that sent the file to review stay apart as `review_reasons`.","operationId":"postLoansIdDecide","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide a loan in review","tags":["Loan"]}},"/loans/{id}/disbursements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdDisbursements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Disburse an approved loan","tags":["Loan"]}},"/loans/{id}/escrow-disbursements":{"get":{"operationId":"getLoansIdEscrowDisbursements","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EscrowDisbursement"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A mortgage's escrow payments","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowDisbursements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowDisbursementRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowDisbursement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pay a tax or insurance bill from a mortgage's escrow","tags":["Loan"]}},"/loans/{id}/escrow/analyses":{"get":{"operationId":"getLoansIdEscrowAnalyses","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EscrowStatement"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the loan's immutable escrow analyses","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowAnalyses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture an initial or annual aggregate escrow analysis","tags":["Loan"]}},"/loans/{id}/escrow/analyses/{analysis}":{"get":{"operationId":"getLoansIdEscrowAnalysesAnalysis","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an escrow analysis and statement content","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}]},"/loans/{id}/escrow/analyses/{analysis}/adjustments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowAnalysesAnalysisAdjustments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowAdjustment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Transfer the analysis's opening deposit, lump sum or refund","tags":["Loan"]}},"/loans/{id}/escrow/analyses/{analysis}/delivery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowAnalysesAnalysisDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscrowDelivery"}}},"required":true},"responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual escrow statement delivery evidence","tags":["Loan"]}},"/loans/{id}/escrow/analyses/{analysis}/payment-change":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowAnalysesAnalysisPaymentChange","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentChange"}}},"required":true},"responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply the delivered escrow payment schedule to future installments","tags":["Loan"]}},"/loans/{id}/escrow/analyses/{analysis}/statement":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdEscrowAnalysesAnalysisStatement","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sha256":{"type":"string"}},"required":["sha256"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Render and archive an immutable escrow statement","tags":["Loan"]}},"/loans/{id}/escrow/analyses/{analysis}/statement.pdf":{"get":{"operationId":"getLoansIdEscrowAnalysesAnalysisStatementPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the archived escrow statement","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"analysis","required":true,"schema":{"type":"string"}}]},"/loans/{id}/participations":{"get":{"operationId":"getLoansIdParticipations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Participation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The shares sold on a loan","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdParticipations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"loan":{"$ref":"#/components/schemas/Loan"},"participation":{"$ref":"#/components/schemas/Participation"}},"required":["loan","participation"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sell a share of a loan to another bank","tags":["Loan"]}},"/loans/{id}/payments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdPayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flat"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"loan":{"$ref":"#/components/schemas/Loan"},"payment":{"$ref":"#/components/schemas/LendingPayment"}},"required":["loan","payment"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a payment","tags":["Loan"]}},"/loans/{id}/payoff-quote":{"get":{"operationId":"getLoansIdPayoffQuote","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoffQuote"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Payoff quote for a date","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/loans/{id}/payoffs":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdPayoffs","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Execute a payoff good through the business date","tags":["Loan"]}},"/loans/{id}/rate-contract":{"get":{"operationId":"getLoansIdRateContract","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesContract"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the signed variable-rate contract","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRateContract","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingratesTerms"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_9e2345ba8bd4"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose immutable signed-note variable-rate terms","tags":["Loan"]}},"/loans/{id}/rate-resets":{"get":{"operationId":"getLoansIdRateResets","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Record_642039d9104b"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable rate-reset history","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRateResets","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_642039d9104b"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Calculate and capture the next contractual rate reset and notice","tags":["Loan"]}},"/loans/{id}/rate-resets/{reset}/cancellations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRateResetsResetCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record_0f87d82e510e"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose cancellation of an unapplied reset for independent review","tags":["Loan"]}},"/loans/{id}/rate-resets/{reset}/delivery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRateResetsResetDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delivery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"recorded":{"type":"boolean"}},"required":["recorded"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record verified notice delivery evidence","tags":["Loan"]}},"/loans/{id}/rate-resets/{reset}/notice":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRateResetsResetNotice","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sha256":{"type":"string"}},"required":["sha256"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Render and archive an approved rate notice","tags":["Loan"]}},"/loans/{id}/rate-resets/{reset}/notice.pdf":{"get":{"operationId":"getLoansIdRateResetsResetNoticePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the archived rate notice","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reset","required":true,"schema":{"type":"string"}}]},"/loans/{id}/recoveries":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRecoveries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply a recovery on a charged-off loan to the allowance","tags":["Loan"]}},"/loans/{id}/restore-accrual":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLoansIdRestoreAccrual","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreAccrualRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Loan"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return a nonaccrual loan to accrual once it is current","tags":["Loan"]}},"/loans/{id}/schedule":{"get":{"operationId":"getLoansIdSchedule","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"schedule":{"items":{"$ref":"#/components/schemas/Installment"},"type":"array"}},"required":["schedule"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Amortisation schedule","tags":["Loan"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lockbox-remittances/{id}":{"get":{"description":"Read a remittance with its items and invoices","operationId":"getLockboxRemittancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockboxRemittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a lockbox remittance by ID","tags":["Lockbox Remittance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lockbox-remittances/{id}/content":{"get":{"operationId":"getLockboxRemittancesIdContent","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The remittance file for the customer's receivables (the bank's BAI lockbox layout)","tags":["Lockbox Remittance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lockboxes":{"get":{"description":"List lockboxes","operationId":"getLockboxes","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Lockbox"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all lockboxes","tags":["Lockbox"]},"post":{"description":"Open a lockbox for an account","operationId":"postLockboxes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockboxRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lockbox"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a lockbox","tags":["Lockbox"]}},"/lockboxes/{id}":{"get":{"description":"Read a lockbox","operationId":"getLockboxesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lockbox"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a lockbox by ID","tags":["Lockbox"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/lockboxes/{id}/remittances":{"get":{"operationId":"getLockboxesIdRemittances","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LockboxRemittance"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a lockbox's remittances","tags":["Lockbox"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postLockboxesIdRemittances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"batches":{"items":{"$ref":"#/components/schemas/RemittanceBatch"},"type":"array"}},"required":["batches"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockboxRemittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a day's lockbox mail: JSON batches, or a transmission in the bank's remittance layout as text; every check is deposited to the lockbox's account","tags":["Lockbox"]}},"/merchant-blocks":{"get":{"description":"Merchant identities blocked after a screening at clearing was not clear (status=active or cleared)","operationId":"getMerchantBlocks","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MerchantBlock"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all merchant blocks","tags":["Merchant Block"]}},"/merchant-blocks/{id}/clear":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMerchantBlocksIdClear","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockClearanceBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBlock"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Request that a merchant block be cleared, with the reason (cards:write, fresh step-up); the block stands until a second staff member approves","tags":["Merchant Block"]}},"/merchant-blocks/{id}/clear/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMerchantBlocksIdClearDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBlock"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (clearing the block) or reject another staff member's clearance request (operations:approve, fresh step-up), or withdraw your own","tags":["Merchant Block"]}},"/merchant-screenings/retries":{"post":{"operationId":"postMerchantScreeningsRetries","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantScreenRetry"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Screen again every clearing flagged unscreened and raise every merchant-block alert not yet raised","tags":["Merchant Screening"]}},"/monitoring-events":{"post":{"description":"Report a movement to transaction monitoring","operationId":"postMonitoringEvents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringEvent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a monitoring event","tags":["Monitoring Event"]}},"/monitoring-events/cash":{"post":{"operationId":"postMonitoringEventsCash","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Report cash a teller channel handled for a customer (staff or service identity)","tags":["Monitoring Event"]}},"/monitoring-parameters":{"get":{"description":"The monitoring thresholds in force on a business date (today by default) and their change history","operationId":"getMonitoringParameters","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdsView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all monitoring parameters","tags":["Monitoring Parameter"]},"put":{"operationId":"putMonitoringParameters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdProposal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a threshold change from a later business date as the verified staff member; it is in force only once a second person approves it","tags":["Monitoring Parameter"]}},"/monitoring-parameters/proposals/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMonitoringParametersProposalsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThresholdChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's threshold proposal (operations:approve), or withdraw your own; decisions are immutable","tags":["Monitoring Parameter"]}},"/my/complaints":{"get":{"description":"List only the customer's public complaint records","operationId":"getMyComplaints","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicComplaint"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all customer complaints","tags":["Customer Complaint"]},"post":{"description":"Submit a complaint as the verified bound customer","operationId":"postMyComplaints","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintIntake"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicComplaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a customer complaint","tags":["Customer Complaint"]}},"/my/complaints/{id}":{"get":{"description":"Read public complaint status and response references","operationId":"getMyComplaintsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicComplaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a customer complaint by ID","tags":["Customer Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/my/complaints/{id}/acknowledgements":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMyComplaintsIdAcknowledgements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAcknowledgement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicComplaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Explicitly acknowledge the exact published response hash","tags":["Customer Complaint"]}},"/my/complaints/{id}/documents":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMyComplaintsIdDocuments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintEvidenceRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintDocument"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Submit retained customer evidence","tags":["Customer Complaint"]}},"/my/complaints/{id}/documents/{document}":{"get":{"operationId":"getMyComplaintsIdDocumentsDocument","responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download only customer-provided complaint evidence","tags":["Customer Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document","required":true,"schema":{"type":"string"}}]},"/my/complaints/{id}/reopen":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postMyComplaintsIdReopen","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComplaintAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicComplaint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reopen while preserving the prior investigation and response","tags":["Customer Complaint"]}},"/my/complaints/{id}/responses/{response}/document":{"get":{"operationId":"getMyComplaintsIdResponsesResponseDocument","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retrieve exact published response; does not infer receipt","tags":["Customer Complaint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"response","required":true,"schema":{"type":"string"}}]},"/notification-preferences":{"get":{"description":"List a customer's channel preferences","operationId":"getNotificationPreferences","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Preference"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all notification preferences","tags":["Notification Preference"]}},"/notification-preferences/{customer_id}/{channel}":{"parameters":[{"in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"channel","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putNotificationPreferencesCustomer_idChannel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"address":{"type":"string"},"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Preference"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set a customer's channel preference","tags":["Notification Preference"]}},"/notification-suppressions":{"post":{"description":"Record a delivery block or consent-backed release","operationId":"postNotificationSuppressions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuppressionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a notification suppression","tags":["Notification Suppression"]}},"/notifications":{"get":{"description":"List a customer's notifications","operationId":"getNotifications","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Notification"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all notifications","tags":["Notification"]},"post":{"description":"Send a notification directly","operationId":"postNotifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"data":{"additionalProperties":true,"type":"object"},"template":{"type":"string"}},"required":["customer_id","data","template"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a notification","tags":["Notification"]}},"/notifications/events":{"post":{"operationId":"postNotificationsEvents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"event_id":{"type":"string"},"event_type":{"type":"string"},"payload":{"additionalProperties":true,"type":"object"},"source":{"type":"string"}},"required":["event_id","event_type","payload","source"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ingest an event over HTTP","tags":["Notification"]}},"/notifications/paper-queue":{"get":{"operationId":"getNotificationsPaperQueue","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List regulatory notices waiting for paper delivery","tags":["Notification"]}},"/notifications/paper-queue/dispatch":{"post":{"operationId":"postNotificationsPaperQueueDispatch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Submit the regulatory paper queue to the batched print-and-mail vendor","tags":["Notification"]}},"/notifications/{id}":{"get":{"description":"Read a notification and its delivery status","operationId":"getNotificationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a notification by ID","tags":["Notification"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/notifications/{id}/evidence":{"get":{"operationId":"getNotificationsIdEvidence","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotificationEvidence"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List notification recipient and delivery evidence","tags":["Notification"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/notifications/{id}/paper-delivery":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Record that a queued regulatory notice was posted, with the dispatch reference. Staff reach this route on `notifications:delivery:write` only — `notifications:write` admits a service, never a staff person — and an API key never does; every other caller is refused 403 `forbidden`. `reference` is required and at most 255 characters.","operationId":"postNotificationsIdPaperDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record that a queued regulatory notice was posted","tags":["Notification"]}},"/notifications/{id}/receipts":{"get":{"operationId":"getNotificationsIdReceipts","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotificationsReceipt"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List provider delivery receipts","tags":["Notification"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postNotificationsIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsReceiptRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record a verified provider receipt","tags":["Notification"]}},"/notifications/{id}/retry":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Retry a failed or skipped message with current delivery preferences. Staff reach this route on `notifications:delivery:write` only — `notifications:write` admits a service, never a staff person — and an API key never does; every other caller is refused 403 `forbidden`.","operationId":"postNotificationsIdRetry","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retry a failed or skipped message with current delivery preferences","tags":["Notification"]}},"/open-banking/access-checks":{"post":{"description":"Original third_party token required. Verifies exact retained issuance, active bank binding, current enabled provider revision and credential generation, consent expiry/revocation, purpose/fields/account and transaction date bounds, and appends an immutable allow/refusal. allowed false carries no consent data. Identity permission alone does not satisfy current customer privacy permission.","operationId":"postOpenBankingAccessChecks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingAccessRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingAccessDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Online verify an issued consent token and record each purpose/field/account access decision","tags":["Other"]}},"/open-banking/accounts/{id}/data":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Original narrow third_party token required. Path/body account must agree and be consented, consumer-owned now, and permitted by current privacy policy. Returns selected summary, real ledger balances or transactions with a captured-data SHA-256 and immutable access receipt. No routing/account numbers, tax IDs, ledger account IDs or source references are returned. Transaction from/through are inclusive calendar dates encoded at UTC midnight; at most 1000 entries within approved history, otherwise narrow the range. Authorization/privacy/ownership are rechecked after gathering data; every token reuse repeats checks.","operationId":"postOpenBankingAccountsIdData","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingAccessRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read only current consumer-owned account data authorized by revocable provider consent and current privacy permission","tags":["Other"]}},"/open-banking/customer-data":{"post":{"description":"Original narrow third_party token required. Online identity checks bracket a current customer privacy policy/election check and actual permitted-field snapshot. Only selected legal name/address/email/phone fields can be returned; no tax IDs. consumer_direction rules must match provider, service subject, purpose and fields. A later privacy opt-out revokes prior directions even if general opt-out is subsequently lifted. Allowed snapshots and privacy refusals retain immutable evidence. Responses are no-store and every reuse repeats authorization.","operationId":"postOpenBankingCustomerData","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingAccessRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read only the customer fields authorized by an online-verified revocable consumer direction and current privacy policy","tags":["Other"]}},"/open-banking/ownership-checks":{"post":{"description":"Only verified service svc_identity with exactly accounts:consent:verify may obtain proof for 1..20 specified consumer accounts; every customer must be a current owner. No balance or account number is returned.","operationId":"postOpenBankingOwnershipChecks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnershipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnershipProof"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify exact consumer account ownership for identity's explicit customer direction workflow","tags":["Other"]}},"/open-banking/privacy-checks":{"post":{"description":"Original narrow third_party token required; account fields only. Performs online identity checks and current consumer_direction policy/election/data-kind checks, and returns immutable privacy evidence ID without customer data. Used by the actual account data read before disclosure and again after gathering ledger data.","operationId":"postOpenBankingPrivacyChecks","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingAccessRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Check the current provider, purpose, account-field and privacy election permission for a consent data read","tags":["Other"]}},"/open-banking/providers":{"get":{"description":"Current approved revisions, up to 200 ordered by provider ID. Fresh dedicated provider staff authority sees review metadata; an active consumer session sees enabled providers and exact disclosure copy without staff review evidence. No provider credential is exposed.","operationId":"getOpenBankingProviders","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Provider"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed third-party providers and exact consent disclosures","tags":["Other"]},"post":{"description":"Fresh staff identity:providers:write required. Every purpose fixes permitted fields, 1..365 consent days, 1..730 history days, exact disclosure/hash and reviewed privacy policy/rule IDs. An enabled registry entry must name a configured service client whose only scope is openbanking:exchange. expected_version is the latest proposed revision. No provider secret or approved legal text is supplied by this workflow.","operationId":"postOpenBankingProviders","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a third-party provider's purpose, field, time and privacy-policy bounds","tags":["Other"]}},"/open-banking/providers/{provider}/revisions":{"get":{"description":"Fresh dedicated provider staff read authority required; at most 200 revisions ordered by revision ID.","operationId":"getOpenBankingProvidersProviderRevisions","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Provider"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List provider policy and independent review evidence","tags":["Other"]},"parameters":[{"in":"path","name":"provider","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh staff identity:providers:write required. Every purpose fixes permitted fields, 1..365 consent days, 1..730 history days, exact disclosure/hash and reviewed privacy policy/rule IDs. An enabled registry entry must name a configured service client whose only scope is openbanking:exchange. expected_version is the latest proposed revision. No provider secret or approved legal text is supplied by this workflow.","operationId":"postOpenBankingProvidersProviderRevisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose updated or disabled provider permissions","tags":["Other"]}},"/open-banking/providers/{provider}/revisions/{revision}/decisions":{"parameters":[{"in":"path","name":"provider","required":true,"schema":{"type":"string"}},{"in":"path","name":"revision","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh identity:providers:approve staff authority and an actor different from the maker required. Provider revisions and decisions are immutable. Every newly approved revision invalidates consent for earlier revisions; reenabling never resurrects old consumer directions.","operationId":"postOpenBankingProvidersProviderRevisionsRevisionDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject provider permissions","tags":["Other"]}},"/open-banking/tokens":{"post":{"description":"Authenticate using an existing dedicated provider client_credentials token with exactly openbanking:exchange. The returned third_party bearer lasts at most 60 seconds, has only openbanking:data:read and fixes provider/customer/consent version/purpose/fields/accounts. No owner session, refresh token, API key or operational authority is issued. The credential generation is rechecked on each read; raw bearer secrets are never stored.","operationId":"postOpenBankingTokens","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Exchange registered provider client authentication and existing consumer direction for a data-only token","tags":["Other"]}},"/originations":{"post":{"description":"Capture a mortgage origination before underwriting","operationId":"postOriginations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresApplication"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Origin"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a mortgage origination","tags":["Mortgage Origination"]}},"/originations/{origin}":{"get":{"description":"Read mortgage intake, disclosures and delivery history","operationId":"getOriginationsOrigin","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a mortgage origination by ID","tags":["Mortgage Origination"]},"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}}]},"/originations/{origin}/binding":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginBinding","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Binding"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bind an approved loan to reviewed mortgage terms","tags":["Mortgage Origination"]}},"/originations/{origin}/disclosures":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginDisclosures","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresProposal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresRevision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Calculate an immutable Loan Estimate or Closing Disclosure revision","tags":["Mortgage Origination"]}},"/originations/{origin}/disclosures/{disclosure}/delivery":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}},{"in":"path","name":"disclosure","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginDisclosuresDisclosureDelivery","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresDelivery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disclosed"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record actual or deemed disclosure receipt evidence","tags":["Mortgage Origination"]}},"/originations/{origin}/disclosures/{disclosure}/issue":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}},{"in":"path","name":"disclosure","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginDisclosuresDisclosureIssue","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Issue"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Render and retain the approved mortgage disclosure PDF","tags":["Mortgage Origination"]}},"/originations/{origin}/disclosures/{disclosure}/pdf":{"get":{"operationId":"getOriginationsOriginDisclosuresDisclosurePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the immutable mortgage disclosure PDF","tags":["Mortgage Origination"]},"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}},{"in":"path","name":"disclosure","required":true,"schema":{"type":"string"}}]},"/originations/{origin}/disclosures/{disclosure}/provider-list/pdf":{"get":{"operationId":"getOriginationsOriginDisclosuresDisclosureProviderListPdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the exact retained written service-provider list","tags":["Mortgage Origination"]},"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}},{"in":"path","name":"disclosure","required":true,"schema":{"type":"string"}}]},"/originations/{origin}/disclosures/{disclosure}/review":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}},{"in":"path","name":"disclosure","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginDisclosuresDisclosureReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresReview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disclosed"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review calculated mortgage terms and cost evidence","tags":["Mortgage Origination"]}},"/originations/{origin}/intent":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginIntent","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Intent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record consumer intent after Loan Estimate receipt","tags":["Mortgage Origination"]}},"/originations/{origin}/items":{"parameters":[{"in":"path","name":"origin","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postOriginationsOriginItems","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresItem"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LendingdisclosuresView"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record one of the six application items and actual receipt","tags":["Mortgage Origination"]}},"/passkeys":{"get":{"description":"List passkeys","operationId":"getPasskeys","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Passkey"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all passkeys","tags":["Passkey"]},"post":{"description":"Complete a passkey registration","operationId":"postPasskeys","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyResponse"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Passkey"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a passkey","tags":["Passkey"]}},"/passkeys/options":{"post":{"operationId":"postPasskeysOptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Start a passkey registration","tags":["Passkey"]}},"/payable-obligations":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read a forward-only queue with starting_after as a typed payable obligation ID, limit default 25 and maximum 100, status default unpaid or explicit all, and exact optional kind, issuer, account_id and loan_id filters. Returns complete items with has_more and next_cursor. Unknown or repeated query parameters, malformed encoding and invalid explicit limits are refused; the query is bounded to 8 KiB. This read does not reserve or remit money. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPayableObligations","parameters":[{"in":"query","name":"starting_after","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}},{"in":"query","name":"kind","schema":{"type":"string"}},{"in":"query","name":"issuer","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"loan_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuePage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all payable obligations","tags":["Payable Obligation"]}},"/payable-obligations/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read exact registered source and current reserved, paid, returned, unallocated and unpaid amounts, associated remittance IDs and explicit readiness blockers. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPayableObligationsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObligationStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payable obligation by ID","tags":["Payable Obligation"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payable-recipients":{"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Retain exact legal entity, obligation kind, jurisdiction/payee context, reviewed domestic beneficiary, receiving bank, authority evidence, validity dates and cash-evidence key. Source context does not invent tax enrollment, deposit periods or recipient authority. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRecipients","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientTerms"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recipient"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recipient"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a payable recipient","tags":["Payable Recipient"]}},"/payable-recipients/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read original recipient terms, content digest, independent review and any revocation. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPayableRecipientsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recipient"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payable recipient by ID","tags":["Payable Recipient"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payable-recipients/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write and operations:approve authority is required; the reviewer differs from the maker. Review the exact recipient digest and retained destination authority. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRecipientsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recipient"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the exact payable recipient digest","tags":["Payable Recipient"]}},"/payable-recipients/{id}/revoke":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Revoke future recipient authority while retaining historical issued instructions and actual cash evidence. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRecipientsIdRevoke","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recipient"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke future payable recipient authority while retaining issued cash instructions","tags":["Payable Recipient"]}},"/payable-remittances":{"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Capture exact registered source obligations and requested principal allocations, reviewed recipient, settlement date and reference. Proposal alone neither pays the recipient nor extinguishes the liability. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRemittances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemittanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remittance"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a payable remittance","tags":["Payable Remittance"]}},"/payable-remittances/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read retained original source obligations, recipient, allocations, review, issued instruction, outbound message and cash reservation. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPayableRemittancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payable remittance by ID","tags":["Payable Remittance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payable-remittances/{id}/issue":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Retain the exact independently reviewed and screened command before requesting native payable-source and bank-cash reservations. Expose the outbound instruction only after confirming its exact native reservation; recover the original command on replay. Issuance does not establish actual external settlement. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRemittancesIdIssue","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain the exact command before native reservation and expose it only after confirmed payable-source and bank-cash reservations","tags":["Payable Remittance"]}},"/payable-remittances/{id}/receipts":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Retain signed actual outgoing or returned cash under its intrinsic event identity, original instruction, exact allocations, destination, master account and statement line. Exact replay returns the original evidence; authenticated unsupported cash remains available with explicit accounting blockers. Cash readiness requires actual accounting and reconciliation evidence, not merely a provider signature. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRemittancesIdReceipts","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesCashReceipt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain signed actual outgoing or returned cash and recover supported payable accounting","tags":["Payable Remittance"]}},"/payable-remittances/{id}/receipts/{event_id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read the complete original signed event, actual accounting journal and cash-statement readiness without truncating source evidence. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPayableRemittancesIdReceiptsEvent_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the complete original payable cash receipt and accounting readiness","tags":["Payable Remittance"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"event_id","required":true,"schema":{"type":"string"}}]},"/payable-remittances/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write and operations:approve authority is required; the reviewer differs from the maker. Review the exact remittance digest including its source allocations and recipient. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPayableRemittancesIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remittance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact payable source allocations and destination","tags":["Payable Remittance"]}},"/payment-approvals":{"get":{"description":"List approval requests","operationId":"getPaymentApprovals","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentApproval"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all payment approvals","tags":["Payment Approval"]}},"/payment-approvals/policies/{account_id}":{"get":{"operationId":"getPaymentApprovalsPoliciesAccount_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an account's approval policy","tags":["Payment Approval"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putPaymentApprovalsPoliciesAccount_id","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set what an account requires before a payment leaves: the threshold, how many approvers, whether the requester may approve, how long a request waits","tags":["Payment Approval"]}},"/payment-approvals/{id}":{"get":{"description":"Read an approval request","operationId":"getPaymentApprovalsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentApproval"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payment approval by ID","tags":["Payment Approval"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payment-approvals/{id}/approve":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentApprovalsIdApprove","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentApproval"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve a payment; enough approvals send it","tags":["Payment Approval"]}},"/payment-approvals/{id}/reject":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentApprovalsIdReject","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentApproval"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reject a payment","tags":["Payment Approval"]}},"/payment-control-changes":{"get":{"description":"List proposed loosenings of payment controls, newest first (status pending, approved, rejected or withdrawn; control payment_limit or ach_originator; subject_id an account or Originator)","operationId":"getPaymentControlChanges","parameters":[{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"control","schema":{"type":"string"}},{"in":"query","name":"subject_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ControlChange"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all payment control changes","tags":["Payment Control Change"]}},"/payment-control-changes/{id}":{"get":{"description":"Read a proposed loosening: what it loosens, the control state it was raised against, the state it asks for and its decision","operationId":"getPaymentControlChangesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payment control change by ID","tags":["Payment Control Change"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payment-control-changes/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentControlChangesIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentControlDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another operator's proposed loosening (payments:operations:write and operations:approve), or withdraw your own; an approval applies the change and decisions are immutable","tags":["Payment Control Change"]}},"/payment-history/{account_id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Rebuild the account's payment-and-fee sequence from retained ledger journals and fee corrections. Optional from and through (YYYY-MM-DD) bound the window. The running balance of the last event equals the ledger closing balance when ties_to_ledger is true. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPaymentHistoryAccount_id","parameters":[{"in":"query","name":"from","schema":{"type":"string"}},{"in":"query","name":"through","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentHistory"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payment history by ID","tags":["Payment History"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}]},"/payment-limits/{account_id}":{"get":{"description":"Read account payment limits","operationId":"getPaymentLimitsAccount_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payment limit by ID","tags":["Payment Limit"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"put":{"description":"Requires payments:operations:write and staff authentication within five minutes. Tightening applies immediately; loosening records a pending payment-control-change and returns 409 payments.control_approval_required. A different operator with operations:approve must approve it. The service rechecks the scope, step-up and unchanged control state.","operationId":"putPaymentLimitsAccount_id","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimitRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set bank-controlled payment initiation limits","tags":["Payment Limit"]}},"/payment-limits/{account_id}/usage":{"get":{"operationId":"getPaymentLimitsAccount_idUsage","parameters":[{"in":"query","name":"user_id","schema":{"type":"string"}},{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentUsage"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read gross payment initiation usage for a business date","tags":["Payment Limit"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}]},"/payment-requests":{"get":{"description":"List requests for payment sent and received","operationId":"getPaymentRequests","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"direction","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"rail","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentRequest"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all payment requests","tags":["Payment Request"]}},"/payment-requests/expirations":{"post":{"operationId":"postPaymentRequestsExpirations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"operator":{"type":"string"}},"required":["operator"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expired":{"format":"int64","type":"integer"}},"required":["expired"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Close the open requests whose expiry has passed (a scheduler calls this)","tags":["Payment Request"]}},"/payment-requests/{id}":{"get":{"description":"Read a request for payment","operationId":"getPaymentRequestsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a payment request by ID","tags":["Payment Request"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/payment-requests/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentRequestsIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask for a request the bank sent to be cancelled (camt.055)","tags":["Payment Request"]}},"/payment-requests/{id}/decline":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentRequestsIdDecline","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeclineRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decline a request the bank's customer received (pain.014 RJCT)","tags":["Payment Request"]}},"/payment-requests/{id}/pay":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentRequestsIdPay","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accept a request the bank's customer received and pay it (pain.014 ACTC, then the credit transfer)","tags":["Payment Request"]}},"/payment-requests/{id}/present":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPaymentRequestsIdPresent","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Tell the requester the bank's customer has seen the request (pain.014 PRES)","tags":["Payment Request"]}},"/placement-controls/capacities":{"post":{"description":"Fresh verified payments:placements:write staff proposes immutable exact actor/input controls. Programs retain receiving-bank FDIC identity, agency title, identical customer/recipient simple-interest terms, public bridge keys, tax responsibility and evidenced eligibility. External single-owner capacity states principal and accrued interest excluding this module, with explicit zero and maximum 24-hour evidence validity. No vendor certification or guaranteed FDIC coverage is inferred.","operationId":"postPlacementControlsCapacities","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Capacity"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose evidenced external owner/bank deposit exposure","tags":["Other"]}},"/placement-controls/programs":{"post":{"description":"Fresh verified payments:placements:write staff proposes immutable exact actor/input controls. Programs retain receiving-bank FDIC identity, agency title, identical customer/recipient simple-interest terms, public bridge keys, tax responsibility and evidenced eligibility. External single-owner capacity states principal and accrued interest excluding this module, with explicit zero and maximum 24-hour evidence validity. No vendor certification or guaranteed FDIC coverage is inferred.","operationId":"postPlacementControlsPrograms","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsProgram"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an agency deposit program with receiving-bank identity and signed bridge keys","tags":["Other"]}},"/placement-controls/{id}":{"get":{"description":"Verified placement staff/service reader only; original program/capacity and independent decision.","operationId":"getPlacementControlsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read retained placement controls and independent review","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/placement-controls/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh staff with payments:placements:write and :approve; maker cannot decide their own exact content hash. Identical actor/decision replays; changed review conflicts. New execution uses the latest effective approved program/capacity; disabled program revisions stop new dispatch.","operationId":"postPlacementControlsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsControl"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact placement control content","tags":["Other"]}},"/placement-programs/{id}/disclosure":{"get":{"description":"Verified customer or placement reader receives exact agency terms and disclosure digest. The disclosed claim is at the identified receiving bank, aggregated by owner/capacity; it is not another insured deposit at the originating bank.","operationId":"getPlacementProgramsIdDisclosure","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsDisclosure"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the exact agency deposit disclosure for customer consent","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/placement-sweep-runs/run-due":{"post":{"description":"Verified payments:placements:bridge service executes only mandates bound to its actual subject. A pass requires the current banking business_date, supports starting_after and a limit of 1–25 (default 10), and returns each run or explicit error plus has_more/next_cursor. Each mandate/business day retains one immutable run across retries; no actor or customer consent is synthesized. Customer, API-key and staff credentials cannot run this bridge scheduler. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweepRunsRunDue","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepDueRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepDueResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run a bounded page of due mandates for the actual authenticated program bridge","tags":["Other"]}},"/placement-sweep-runs/{id}":{"get":{"description":"Authorized bound owner, payments:placements:read/write reader or exact retained program bridge reads the immutable original source/selection and actual resulting placement state. Later pause or reacceptance does not rewrite original authorization; actual money still depends on ordinary signed settlement and exact ledger recovery. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPlacementSweepRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRunResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable original sweep source, deterministic selection and resulting placement recovery","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/placement-sweeps":{"get":{"description":"Bound owner for account_id or verified payments:placements:read/write reader; complete bounded mandate inventory with lifecycle state. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPlacementSweeps","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SweepRecord"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read standing sweep mandates for an authorized account","tags":["Other"]},"post":{"description":"Fresh verified payments:placements:write staff proposes immutable standing terms for one demand program and actual single-owner DDA title. Low, target and high watermarks, bounded daily outward principal, dates and full-position redemption/possible target overshoot are exact reviewed terms. This creates no customer acceptance. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweeps","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepTerms"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose exact standing demand-placement terms against the actual single-owner DDA title","tags":["Other"]}},"/placement-sweeps/{id}":{"get":{"description":"Bound owner, verified payments:placements:read/write reader or exact retained program bridge sees retained reviewed terms, exact current customer acceptance and current state. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getPlacementSweepsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read reviewed standing terms, actual customer acceptance and lifecycle state","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/placement-sweeps/{id}/accept":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Only the fresh authenticated bound customer accepts exact reviewed mandate and program disclosure, unchanged individual account title, automatic placement and full-position redemption including target overshoot. Reacceptance retains a new immutable consent; issued commands keep their original acceptance. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweepsIdAccept","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepConsentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain the authenticated owner's explicit acceptance of the exact reviewed standing mandate","tags":["Other"]}},"/placement-sweeps/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:placements:write and payments:placements:approve; maker cannot review their own exact mandate. Review does not manufacture consent or per-run human approval. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweepsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review exact standing program, title, thresholds and full-redemption terms","tags":["Other"]}},"/placement-sweeps/{id}/run":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Verified payments:placements:bridge service for the exact retained program executes one durable selection per mandate/business day. Fresh live title, authority, available balance, complete bank/owner capacity and signed current positions govern admission. Above high, selected principal is capped by target, daily/program limits and aggregate headroom including interest; below low, select the oldest eligible original mandate position for full redemption. No-op/refusal are explicit. The fixed prospective command ID and compact standing authorization bind the full immutable source run; no per-run human decision is fabricated and no future funds availability is guaranteed. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweepsIdRun","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRunResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record one source-backed selection per mandate and business day under its actual standing authority","tags":["Other"]}},"/placement-sweeps/{id}/state":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Authorized bound customer or fresh payments:placements:write staff may pause/cancel future execution. Restart requires separate customer acceptance; existing external commands, holds and signed actual receipts retain their recovery authority. Requests are strict single JSON objects bounded to 1 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postPlacementSweepsIdState","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepStateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SweepRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pause or cancel future standing execution while retaining issued commands","tags":["Other"]}},"/positive-pay/accounts/{id}":{"get":{"operationId":"getPositivePayAccountsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositivePayAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an account's positive pay terms","tags":["Positive Pay"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"operationId":"putPositivePayAccountsId","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositivePayRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositivePayAccount"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Enrol an account in positive pay or replace its terms","tags":["Positive Pay"]}},"/positive-pay/accounts/{id}/issues":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPositivePayAccountsIdIssues","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"issues":{"items":{"$ref":"#/components/schemas/IssueInput"},"type":"array"}},"required":["issues"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PositivePayIssue"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the checks the customer issued (its issue file)","tags":["Positive Pay"]}},"/positive-pay/accounts/{id}/reconciliation/{period}":{"get":{"operationId":"getPositivePayAccountsIdReconciliationPeriod","parameters":[{"in":"query","name":"format","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountReconciliation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The account reconciliation file for a period (YYYY-MM): checks paid, returned or held, issues outstanding and voided, stop payments in force, with totals; format=csv for the customer's accounts payable","tags":["Positive Pay"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"period","required":true,"schema":{"type":"string"}}]},"/positive-pay/exceptions":{"get":{"operationId":"getPositivePayExceptions","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InclearingItem"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List presented checks that did not match an issue, awaiting a decision","tags":["Positive Pay"]}},"/positive-pay/issues":{"get":{"operationId":"getPositivePayIssues","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PositivePayIssue"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List issued checks","tags":["Positive Pay"]}},"/positive-pay/issues/{id}/void":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postPositivePayIssuesIdVoid","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositivePayIssue"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Void an issued check","tags":["Positive Pay"]}},"/privacy/obligations":{"get":{"description":"Privacy staff read/write scope. Returns up to 200 evidenced customer relationships, ordered by customer ID; pass the last customer_id as after. Obligations use a rolling twelve-month schedule and the applicable 100-day transition when the annual exception is lost without a revised-notice requirement. No delivery is implied by a due obligation.","operationId":"getPrivacyObligations","parameters":[{"in":"query","name":"after","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PrivacyStatus"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Page evidenced consumer relationships and initial, revised and annual privacy-notice obligations","tags":["Other"]}},"/privacy/policies":{"get":{"operationId":"getPrivacyPolicies","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PrivacyPolicy"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed privacy policy versions and approval evidence (privacy staff)","tags":["Other"]},"post":{"description":"Privacy staff write scope and authentication within five minutes required. Exact reviewed document SHA-256, disclosure-practices fingerprint, evidence references, future/effective date, configured opt-out period/methods and recipient/service/purpose/field grants are mandatory. No production legal copy is supplied. The next policy version is independently approved. Ordinary nonaffiliate grants require a revised-notice transition when changed; service_provider grants additionally require a reviewed use-restricting contract. Practices unchanged from a delivered notice plus exception-only disclosures are the only annual exception. No universal opt-out requirement is imposed on servicing, fraud prevention or legal-process exceptions.","operationId":"postPrivacyPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicy"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an effective privacy policy, exact reviewed notice content and purpose/recipient sharing rules","tags":["Other"]}},"/privacy/policies/{policy}":{"get":{"operationId":"getPrivacyPoliciesPolicy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a privacy policy and its independent decision","tags":["Other"]},"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}]},"/privacy/policies/{policy}/decisions":{"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh privacy staff write authority plus operations:approve and an actor different from the maker required. Decisions and exact policy content are immutable. Pending proposals are revalidated against previously approved policy at decision time.","operationId":"postPrivacyPoliciesPolicyDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicyDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a privacy policy","tags":["Other"]}},"/products":{"get":{"description":"List deposit products","operationId":"getProducts","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all products","tags":["Product"]}},"/products/directory":{"get":{"operationId":"getProductsDirectory","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BianRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all product versions in the Corgi BIAN 14 directory profile","tags":["Product"]}},"/products/{code}/disclosure-policies":{"get":{"description":"List retained opening agreement, E-SIGN and APY policies","operationId":"getProductsCodeDisclosurePolicies","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DisclosuresPolicy"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all opening disclosure policies","tags":["Opening Disclosure Policy"]},"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}}],"post":{"description":"Prepare exact bank-approved text and computed APY for independent review","operationId":"postProductsCodeDisclosurePolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an opening disclosure policy","tags":["Opening Disclosure Policy"]}},"/products/{code}/disclosure-policies/{policy}":{"get":{"description":"Read retained opening terms and their review","operationId":"getProductsCodeDisclosurePoliciesPolicy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an opening disclosure policy by ID","tags":["Opening Disclosure Policy"]},"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}},{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}]},"/products/{code}/disclosure-policies/{policy}/decisions":{"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}},{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postProductsCodeDisclosurePoliciesPolicyDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject captured opening terms","tags":["Opening Disclosure Policy"]}},"/products/{code}/now-eligibility":{"get":{"description":"List retained NOW beneficial-interest eligibility reviews","operationId":"getProductsCodeNowEligibility","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NowReview"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all NOW eligibility reviews","tags":["NOW Eligibility"]},"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}}],"post":{"description":"Prepare exact NOW title and beneficial-interest evidence for independent review","operationId":"postProductsCodeNowEligibility","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NowRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NowReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a NOW eligibility","tags":["NOW Eligibility"]}},"/products/{code}/now-eligibility/{review}/decisions":{"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}},{"in":"path","name":"review","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postProductsCodeNowEligibilityReviewDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NowDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NowReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject NOW eligibility evidence","tags":["NOW Eligibility"]}},"/products/{code}/opening-documents":{"get":{"operationId":"getProductsCodeOpeningDocuments","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningDocuments"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The live product version's deposit agreement and E-SIGN consumer disclosure, each with its version and SHA-256; a consumer account opening echoes them back as its acknowledgement","tags":["Product"]},"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}}]},"/products/{code}/versions/{version}/directory":{"get":{"operationId":"getProductsCodeVersionsVersionDirectory","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BianRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one product version in the Corgi BIAN 14 directory profile","tags":["Product"]},"parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}},{"in":"path","name":"version","required":true,"schema":{"type":"string"}}]},"/provider-receipts/ses":{"post":{"operationId":"postProviderReceiptsSes","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Amazon SNS subscriber for SES bounce, complaint and delivery events (authenticated by the SNS signature)","tags":["Other"]}},"/rails":{"get":{"operationId":"getRails","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RailList"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The rails' published schedules and whether each is open now","tags":["Rail"]}},"/rails/ach/files":{"post":{"operationId":"postRailsAchFiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"effective_date":{"type":"string"},"same_day":{"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsFile"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Batch pending transfers into a NACHA file and send it","tags":["Rail"]}},"/rails/ach/files/{id}":{"get":{"operationId":"getRailsAchFilesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsFile"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a file","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/ach/files/{id}/content":{"get":{"operationId":"getRailsAchFilesIdContent","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The NACHA text of a file","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/ach/files/{id}/settle":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRailsAchFilesIdSettle","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"settled":{"format":"int64","type":"integer"}},"required":["file_id","settled"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post the settlement of a sent file","tags":["Rail"]}},"/rails/ach/files/{id}/settlement-evidence":{"get":{"description":"Connectivity-zone ACH operator/rail access applies. Returns the original file digest, rail reference, immutable posting date and confirmation. verified_bridge_settlement retains signed bank-bridge evidence and original operator bytes; adapter_acknowledgment identifies the weaker legacy/simulator adapter contract. A file has no financial settlement until confirmation is captured. An already completed legacy file may have no retained confirmation and returns not_found.","operationId":"getRailsAchFilesIdSettlementEvidence","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACHSettlementEvidence"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured ACH posting date and retained settlement confirmation","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/ach/inbound":{"post":{"operationId":"postRailsAchInbound","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a NACHA file as the RDFI","tags":["Rail"]}},"/rails/ach/prenote-verifications":{"post":{"operationId":"postRailsAchPrenoteVerifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"verified":{"format":"int64","type":"integer"}},"required":["verified"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify the prenotifications the RDFIs did not answer within three banking days (a scheduler calls this daily)","tags":["Rail"]}},"/rails/ach/returns":{"post":{"operationId":"postRailsAchReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateACHReturn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an RDFI return of an originated entry","tags":["Rail"]}},"/rails/check/cash-letters":{"get":{"operationId":"getRailsCheckCashLetters","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"direction","schema":{"type":"string"}},{"in":"query","name":"kind","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CashLetter"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List cash letters sent and received","tags":["Rail"]},"post":{"operationId":"postRailsCheckCashLetters","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildCashLetterBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashLetter"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"File the deposited checks (forward) or the returned checks (return) in an image cash letter and send it to the operator","tags":["Rail"]}},"/rails/check/cash-letters/{id}":{"get":{"operationId":"getRailsCheckCashLettersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashLetter"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a cash letter","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/check/cash-letters/{id}/content":{"get":{"operationId":"getRailsCheckCashLettersIdContent","responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The image cash letter file (X9.100-187, EBCDIC)","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/check/cash-letters/{id}/settle":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRailsCheckCashLettersIdSettle","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashLetter"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post the operator's settlement of a cash letter the bank sent","tags":["Rail"]}},"/rails/check/exception-deadlines":{"post":{"operationId":"postRailsCheckExceptionDeadlines","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"decided":{"format":"int64","type":"integer"}},"required":["decided"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply the default decision to positive pay exceptions past their deadline and file the returns (a scheduler calls this)","tags":["Rail"]}},"/rails/check/inbound":{"post":{"operationId":"postRailsCheckInbound","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundCashLetterResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a cash letter from the operator: a presentment of checks drawn on the bank, or a return of the bank's deposits","tags":["Rail"]}},"/rails/realtime/inbound":{"post":{"operationId":"postRailsRealtimeInbound","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"in":"query","name":"rail","schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/xml":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive any message the rail's operator delivers (pacs.008, pacs.004, pacs.009, pacs.002, pacs.028, pain.013, pain.014, camt.055, camt.056, camt.029, camt.054, admi.004, admi.002) and answer it (a pacs.002, an admi.007 or an admi.002)","tags":["Rail"]}},"/rails/realtime/liquidity-transfers":{"post":{"operationId":"postRailsRealtimeLiquidityTransfers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiquidityTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send a liquidity management transfer (pacs.009) to another participant or into the RTP joint account","tags":["Rail"]}},"/rails/realtime/notifications":{"get":{"operationId":"getRailsRealtimeNotifications","parameters":[{"in":"query","name":"rail","schema":{"type":"string"}},{"in":"query","name":"date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RailNotification"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a cycle day's account debit/credit notifications (camt.054) on a rail","tags":["Rail"]}},"/rails/swift/bank-transfers":{"post":{"operationId":"postRailsSwiftBankTransfers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftBankTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the bank's own funds to another institution over SWIFT (CBPR+ pacs.009); a second operator approves it","tags":["Rail"]}},"/rails/swift/inbound":{"post":{"operationId":"postRailsSwiftInbound","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a message the SWIFT network (the simulator) delivers: pacs.008, pacs.009 (core or cover), pacs.004, pacs.002, camt.056 or camt.029 under head.001.001.02","tags":["Rail"]}},"/rails/swift/notifications":{"post":{"operationId":"postRailsSwiftNotifications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftNotification"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"applied":{"type":"boolean"},"duplicate":{"type":"boolean"},"id":{"type":"string"}},"required":["applied","id"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a notification from the SWIFT network (the simulator): a message delivered, a delivery abandoned, or a tracker status","tags":["Rail"]}},"/rails/swift/releases":{"post":{"operationId":"postRailsSwiftReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRelease"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the SWIFT payments queued for their currency's window (a scheduler calls this)","tags":["Rail"]}},"/rails/swift/repairs":{"get":{"operationId":"getRailsSwiftRepairs","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SwiftRepair"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The SWIFT repair queue","tags":["Rail"]}},"/rails/swift/repairs/{id}":{"get":{"operationId":"getRailsSwiftRepairsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepairDetail"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A SWIFT repair with its maker-checker record","tags":["Rail"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/rails/swift/repairs/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRailsSwiftRepairsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepairDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepair"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject the proposed decision on a SWIFT repair (a second operator holding operations:approve); approval carries it out","tags":["Rail"]}},"/rails/swift/repairs/{id}/proposals":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRailsSwiftRepairsIdProposals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepairProposalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepair"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a decision on a SWIFT repair (the maker)","tags":["Rail"]}},"/rails/swift/routes":{"get":{"operationId":"getRailsSwiftRoutes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRoutes"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The bank's BIC, SWIFT currency routes with their correspondents, windows and charges, and whether each currency is open now","tags":["Rail"]}},"/rails/wire/bank-transfers":{"post":{"operationId":"postRailsWireBankTransfers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the bank's own funds to another institution (a Fedwire bank transfer, pacs.009); a second operator approves it","tags":["Rail"]}},"/rails/wire/inbound":{"post":{"operationId":"postRailsWireInbound","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive a Fedwire message from the service: a customer credit transfer (pacs.008), a bank transfer (pacs.009), a payment return (pacs.004), a return request (camt.056) or a return request response (camt.029), each under its head.001; nonvalue messages are answered with an admi.007 or admi.002","tags":["Rail"]}},"/rails/wire/releases":{"post":{"operationId":"postRailsWireReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireRelease"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Send the wires queued for the next Fedwire opening (a scheduler calls this at each opening)","tags":["Rail"]}},"/rails/wire/status":{"post":{"operationId":"postRailsWireStatus","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Receive the service's answer on a message the bank sent: a payment status report (pacs.002), a receipt acknowledgement (admi.007), a message reject (admi.002) or a negative return request response (camt.029)","tags":["Rail"]}},"/rdc-limits":{"get":{"description":"Read the remote-deposit limit in force for a customer and product (the product default when no override has been written)","operationId":"getRdcLimits","parameters":[{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"product_code","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDepositLimit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all remote deposit limits","tags":["Remote Deposit Limit"]},"put":{"operationId":"putRdcLimits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"product_code","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDepositLimit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDepositLimit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set a per-customer, per-product remote-deposit limit override. Tightening takes effect on the operator's word; raising any bound waits for a second operator holding operations:approve","tags":["Remote Deposit Limit"]}},"/realtime-return-requests/{id}":{"get":{"description":"Read a return request on an instant payment","operationId":"getRealtimeReturnRequestsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a realtime return request by ID","tags":["Realtime Return Request"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/realtime-return-requests/{id}/respond":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRealtimeReturnRequestsIdRespond","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RespondBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Honour or refuse a return request another participant sent (camt.029, then the return)","tags":["Realtime Return Request"]}},"/reconciliation-breaks":{"get":{"description":"List breaks with their age","operationId":"getReconciliationBreaks","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"source","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReconciliationBreak"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all reconciliation breaks","tags":["Reconciliation Break"]}},"/reconciliation-breaks/{id}":{"get":{"description":"Read a break","operationId":"getReconciliationBreaksId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationBreak"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a reconciliation break by ID","tags":["Reconciliation Break"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reconciliation-breaks/{id}/explain":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReconciliationBreaksIdExplain","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationBreak"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Explain a break without closing it","tags":["Reconciliation Break"]}},"/reconciliation-breaks/{id}/resolve":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReconciliationBreaksIdResolve","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationBreak"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resolve a break","tags":["Reconciliation Break"]}},"/reconciliations/runs":{"get":{"operationId":"getReconciliationsRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"source","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReconciliationRun"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reconciliation runs","tags":["Reconciliation"]},"post":{"operationId":"postReconciliationsRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile a source's statement against the bank's records","tags":["Reconciliation"]}},"/reconciliations/runs/{id}":{"get":{"operationId":"getReconciliationsRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationRun"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a reconciliation run","tags":["Reconciliation"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reconciliations/runs/{id}/source":{"get":{"description":"Reporting read authority and verified staff/service operator required; customer impersonation refused. Retains reporting-reconciliation-input-1: exact statement version, internal settlement items and event IDs, optional USD GL position/sync ID, and SHA256. Record is raw JSON to preserve all integer amounts. Hash compact JSON with sorted object keys, exact numbers and original array order; the Go client's Digest verifies it. Run, inputs and break updates commit atomically. Inputs are the reporting projections/imports actually used, not independent authentication of a bank statement. Historical runs before source capture return not_found rather than reconstructing evidence.","operationId":"getReconciliationsRunsIdSource","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationEvidence"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact retained versioned reconciliation inputs and their source hash","tags":["Reconciliation"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reconciliations/statements":{"get":{"operationId":"getReconciliationsStatements","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every version of a source's statement for a date, oldest first","tags":["Reconciliation"]},"post":{"operationId":"postReconciliationsStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingStatement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an external statement for a source and date; the version it supersedes is retained","tags":["Reconciliation"]}},"/reconciliations/statements/fedaccount":{"post":{"operationId":"postReconciliationsStatementsFedaccount","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the Federal Reserve's Statement of Account (camt.053) as the master account statement and propose its IORB credits","tags":["Reconciliation"]}},"/reconciliations/statements/fedaccount/position":{"post":{"operationId":"postReconciliationsStatementsFedaccountPosition","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedSample"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the Account Balance System's camt.052 position as the actual Federal Reserve daylight overdraft","tags":["Reconciliation"]}},"/reconciliations/statements/fednow":{"post":{"operationId":"postReconciliationsStatementsFednow","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the FedNow Service's account activity details report (camt.052) as the instant lines of the master account statement","tags":["Reconciliation"]}},"/reconciliations/statements/fedwire":{"post":{"operationId":"postReconciliationsStatementsFedwire","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingStatement"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the Fedwire Funds Service's Activity Report (camt.052) as the wire lines of the master account statement","tags":["Reconciliation"]}},"/record-schedules":{"get":{"description":"Fresh customers:records:read staff authority. Returns at most 200 schedules ordered by ID; pass last id as after.","operationId":"getRecordSchedules","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Schedule"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed retention schedules (records staff)","tags":["Other"]},"post":{"description":"Dedicated customers:records:write staff authority and authentication within five minutes required. No production retention period is assumed. Provide bank-reviewed authority and evidence, category version, creation or evidenced_event trigger, future/effective date and days or permanent retention. Another staff member with customers:records:approve decides the schedule; stale versions cannot override an approved successor or change an existing category's trigger.","operationId":"postRecordSchedules","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose a versioned bank-reviewed customer record retention schedule","tags":["Other"]}},"/record-schedules/{schedule}/decisions":{"parameters":[{"in":"path","name":"schedule","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh customers:records:approve staff authority and actor different from maker required. All proposal and decision evidence is immutable.","operationId":"postRecordSchedulesScheduleDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject a retention schedule","tags":["Other"]}},"/refunds":{"post":{"operationId":"postRefunds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Post a merchant refund to a card","tags":["Other"]}},"/reporting/agency-position-snapshots":{"get":{"description":"Verified reporting staff/service reader; cursor pagination of original observations.","operationId":"getReportingAgencyPositionSnapshots","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PlacementsSnapshotRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List retained dated agency observations including explicit unknown interest and reconciliation blockers","tags":["Reporting Run"]},"post":{"description":"Fresh reporting staff captures and verifies the actual current payments source digest and retains it immutably. Actor-bound key replays original observation, even if later statements change. Missing source refuses; unknown interest and incomplete reconciliation remain explicit. Reporting performs no money posting.","operationId":"postReportingAgencyPositionSnapshots","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsSnapshotRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsSnapshotRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retain current customer-owned off-bank positions and actual ledger/receiving-bank evidence separately from bank deposits and assets","tags":["Reporting Run"]}},"/reporting/agency-position-snapshots/{id}":{"get":{"description":"Verified reporting staff/service reader; immutable current-observation evidence, not a historical reconstruction or insurance certification.","operationId":"getReportingAgencyPositionSnapshotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacementsSnapshotRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read original agency position observation and source digest","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report-filings":{"get":{"operationId":"getReportingCallReportFilings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read paged filing summaries for a quarter","tags":["Reporting Run"]},"post":{"operationId":"postReportingCallReportFilings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prepare the exact CDR submission package of an approved instance: its facts, the vendor code and an explanation for every failed quality edit, evaluated against accepted filed history","tags":["Reporting Run"]}},"/reporting/call-report-filings/explanation-codes":{"get":{"operationId":"getReportingCallReportFilingsExplanationCodes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read every quality edit's retained predefined explanation codes for a quarter's taxonomy","tags":["Reporting Run"]}},"/reporting/call-report-filings/history":{"get":{"operationId":"getReportingCallReportFilingsHistory","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Resolve a quarter's current accepted filing, the accepted filings of the seven quarters before it and their continuity","tags":["Reporting Run"]}},"/reporting/call-report-filings/{id}":{"get":{"operationId":"getReportingCallReportFilingsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a filing with its signatures, review, transmission, every acknowledgment and retained facsimiles","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report-filings/{id}/acknowledgments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportFilingsIdAcknowledgments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Observe the CDR's current acknowledgment of a transmitted filing and, once accepted, its public facsimile","tags":["Reporting Run"]}},"/reporting/call-report-filings/{id}/attestations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportFilingsIdAttestations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sign the filing as the CFO (declaration) or as a director (attestation); the authenticated principal is the signer","tags":["Reporting Run"]}},"/reporting/call-report-filings/{id}/document":{"get":{"operationId":"getReportingCallReportFilingsIdDocument","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the exact XBRL the filing transmits","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report-filings/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportFilingsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact package, its explanations and signatures","tags":["Reporting Run"]}},"/reporting/call-report-filings/{id}/transmissions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportFilingsIdTransmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Transmit an approved filing through the configured CDR submission adapter (the CDR simulator locally); a repeat recovers a lost response","tags":["Reporting Run"]}},"/reporting/call-report/edit-catalog":{"get":{"description":"Exact retained FFIEC051 September 30, 2026 v300 taxonomy and bounded edit engine; 39 required Schedule RC body fields and two March-only memoranda. Other schedule applicability, unexecuted functions and prior accepted CDR history remain explicit blockers. Candidate historical comparisons require independently reviewed exact-quarter workpapers and same assigned RSSD; no operator waiver or successful subset makes a filing submission-ready. Staff reporting write plus recent step-up for execution; operator reporting read for evidence.","operationId":"getReportingCallReportEditCatalog","parameters":[{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditCatalog"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact retained FFIEC expressions and declared engine coverage","tags":["Reporting Run"]}},"/reporting/call-report/instances":{"get":{"operationId":"getReportingCallReportInstances","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Instance"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read paged generated-instance history for a quarter","tags":["Reporting Run"]},"post":{"operationId":"postReportingCallReportInstances","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Generate immutable XBRL bytes from independently approved figures","tags":["Reporting Run"]}},"/reporting/call-report/instances/{id}":{"get":{"operationId":"getReportingCallReportInstancesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured facts, taxonomy, conversion and independent review","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/instances/{id}/controls":{"get":{"description":"Exact retained FFIEC051 September 30, 2026 v300 taxonomy and bounded edit engine; 39 required Schedule RC body fields and two March-only memoranda. Other schedule applicability, unexecuted functions and prior accepted CDR history remain explicit blockers. Candidate historical comparisons require independently reviewed exact-quarter workpapers and same assigned RSSD; no operator waiver or successful subset makes a filing submission-ready. Staff reporting write plus recent step-up for execution; operator reporting read for evidence.","operationId":"getReportingCallReportInstancesIdControls","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InstanceControlsSummary"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read immutable bounded control executions","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Exact retained FFIEC051 September 30, 2026 v300 taxonomy and bounded edit engine; 39 required Schedule RC body fields and two March-only memoranda. Other schedule applicability, unexecuted functions and prior accepted CDR history remain explicit blockers. Candidate historical comparisons require independently reviewed exact-quarter workpapers and same assigned RSSD; no operator waiver or successful subset makes a filing submission-ready. Staff reporting write plus recent step-up for execution; operator reporting read for evidence.","operationId":"postReportingCallReportInstancesIdControls","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceControlsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceControls"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceControls"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Preserve bounded edits and RC completeness; unresolved filing blockers remain","tags":["Reporting Run"]}},"/reporting/call-report/instances/{id}/controls/{control_id}":{"get":{"description":"Exact retained FFIEC051 September 30, 2026 v300 taxonomy and bounded edit engine; 39 required Schedule RC body fields and two March-only memoranda. Other schedule applicability, unexecuted functions and prior accepted CDR history remain explicit blockers. Candidate historical comparisons require independently reviewed exact-quarter workpapers and same assigned RSSD; no operator waiver or successful subset makes a filing submission-ready. Staff reporting write plus recent step-up for execution; operator reporting read for evidence.","operationId":"getReportingCallReportInstancesIdControlsControl_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceControls"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact source hashes, edit outcomes and remaining blockers","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"control_id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/instances/{id}/document":{"get":{"operationId":"getReportingCallReportInstancesIdDocument","responses":{"200":{"content":{"application/xml":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Download the exact captured XBRL document","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/instances/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportInstancesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review supplied instance bytes and generic validation","tags":["Reporting Run"]}},"/reporting/call-report/instances/{id}/validations":{"get":{"operationId":"getReportingCallReportInstancesIdValidations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InstanceValidationSummary"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read paged immutable validator evidence","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportInstancesIdValidations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceValidation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceValidation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run and preserve explicit offline generic XBRL validation","tags":["Reporting Run"]}},"/reporting/call-report/instances/{id}/validations/{validation_id}":{"get":{"operationId":"getReportingCallReportInstancesIdValidationsValidation_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceValidation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the full immutable validation log and execution evidence","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"validation_id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/profiles":{"get":{"operationId":"getReportingCallReportProfiles","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CallreportRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read profile and review history for a reporting quarter","tags":["Reporting Run"]},"post":{"operationId":"postReportingCallReportProfiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallreportProfile"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallreportRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an immutable bank profile and Call Report work plan","tags":["Reporting Run"]}},"/reporting/call-report/profiles/{id}":{"get":{"operationId":"getReportingCallReportProfilesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallreportRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a bank profile and its captured reporting work plan","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/profiles/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportProfilesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallreportReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallreportRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review a form selection and conditional schedule evidence","tags":["Reporting Run"]}},"/reporting/call-report/schedule-matrices/{schedule}":{"get":{"description":"Local source kinds declare exact retained FFIEC051 September 30, 2026 v300 form positions; nine kinds account for every position of RC-R Part I, RC-B, RC-K, RC-M, RC-O, RI-A, RI-B Parts I and II and SU. A preview captures a completed quarter from retained core data without retaining it: every declared position is a value or a missing item categorised not_retained, reviewed_input, activity_condition or source_unavailable, never a zero. The matrix reports bindings, captions, instruction digests and declared coverage; it asserts no requirement or completeness. Operator reporting read.","operationId":"getReportingCallReportScheduleMatricesSchedule","parameters":[{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletenessResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List one schedule's retained positions with captions, instruction digests and declared source coverage","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"schedule","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/source-kinds":{"get":{"description":"Local source kinds declare exact retained FFIEC051 September 30, 2026 v300 form positions; nine kinds account for every position of RC-R Part I, RC-B, RC-K, RC-M, RC-O, RI-A, RI-B Parts I and II and SU. A preview captures a completed quarter from retained core data without retaining it: every declared position is a value or a missing item categorised not_retained, reviewed_input, activity_condition or source_unavailable, never a zero. The matrix reports bindings, captions, instruction digests and declared coverage; it asserts no requirement or completeness. Operator reporting read.","operationId":"getReportingCallReportSourceKinds","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LocalSourceKind"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the local source kinds and the exact retained form positions each supplies or explains","tags":["Reporting Run"]}},"/reporting/call-report/source-kinds/{kind}/preview":{"get":{"description":"Local source kinds declare exact retained FFIEC051 September 30, 2026 v300 form positions; nine kinds account for every position of RC-R Part I, RC-B, RC-K, RC-M, RC-O, RI-A, RI-B Parts I and II and SU. A preview captures a completed quarter from retained core data without retaining it: every declared position is a value or a missing item categorised not_retained, reviewed_input, activity_condition or source_unavailable, never a zero. The matrix reports bindings, captions, instruction digests and declared coverage; it asserts no requirement or completeness. Operator reporting read.","operationId":"getReportingCallReportSourceKindsKindPreview","parameters":[{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture a local source for a completed quarter without retaining it: values and categorised missing items","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/workpapers":{"get":{"operationId":"getReportingCallReportWorkpapers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Workpaper"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read paged workpaper and figure-review history for a quarter","tags":["Reporting Run"]},"post":{"operationId":"postReportingCallReportWorkpapers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkpaperRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture immutable quarterly sources, mappings, adjustments and figures","tags":["Reporting Run"]}},"/reporting/call-report/workpapers/{id}":{"get":{"operationId":"getReportingCallReportWorkpapersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read captured quarter sources, figures and independent review","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/call-report/workpapers/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingCallReportWorkpapersIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkpaperReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the supplied figures and their exact content digest","tags":["Reporting Run"]}},"/reporting/capital/policies":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingCapitalPolicies","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all capital policies","tags":["Capital Policy"]},"post":{"description":"Requires verified staff reporting:write with fresh step-up. Exact-input and actor-bound idempotency. Runs require an independently approved effective policy and the exact tied closing of a calendar quarter end or, with measurement month_end, of a quarter's first or second calendar month-end (a month-end that is not a Federal Reserve banking day is measured on the closing of the last banking day before it, recorded in the result as closing_date with carried true, as 12 CFR 327.5(a)(1) uses the previous business day's amounts for a closed day); a month-end run carries no quarter average, leverage deduction, consolidation or trading input and reports tier 1 capital and risk-based ratios without a leverage ratio or CBLR screen, for Schedule RC-O item 5. Every core asset/contra-asset and equity/income/expense balance must reconcile to explicitly classified or excluded allocations. Risk weights, conversion factors, capital eligibility adjustments, off-balance inclusion, whole-quarter average assets and consolidation are evidenced, never inferred from product labels. Undefined denominators are not reported as zero or a passing ratio. Outputs are a reviewed standardized capital workpaper and current CBLR criteria screen, not a filing or regulatory/PCA compliance decision; CBLR election and grace history remain in the governed Call Report workflow.","operationId":"postReportingCapitalPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalPolicy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a capital policy","tags":["Capital Policy"]}},"/reporting/capital/policies/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingCapitalPoliciesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a capital policy by ID","tags":["Capital Policy"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/capital/policies/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingCapitalPoliciesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact capital record digest","tags":["Capital Policy"]}},"/reporting/capital/runs":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingCapitalRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all capital runs","tags":["Capital Run"]},"post":{"description":"Requires verified staff reporting:write with fresh step-up. Exact-input and actor-bound idempotency. Runs require an independently approved effective policy and the exact tied closing of a calendar quarter end or, with measurement month_end, of a quarter's first or second calendar month-end (a month-end that is not a Federal Reserve banking day is measured on the closing of the last banking day before it, recorded in the result as closing_date with carried true, as 12 CFR 327.5(a)(1) uses the previous business day's amounts for a closed day); a month-end run carries no quarter average, leverage deduction, consolidation or trading input and reports tier 1 capital and risk-based ratios without a leverage ratio or CBLR screen, for Schedule RC-O item 5. Every core asset/contra-asset and equity/income/expense balance must reconcile to explicitly classified or excluded allocations. Risk weights, conversion factors, capital eligibility adjustments, off-balance inclusion, whole-quarter average assets and consolidation are evidenced, never inferred from product labels. Undefined denominators are not reported as zero or a passing ratio. Outputs are a reviewed standardized capital workpaper and current CBLR criteria screen, not a filing or regulatory/PCA compliance decision; CBLR election and grace history remain in the governed Call Report workflow.","operationId":"postReportingCapitalRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a capital run","tags":["Capital Run"]}},"/reporting/capital/runs/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingCapitalRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a capital run by ID","tags":["Capital Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/capital/runs/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingCapitalRunsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact capital record digest","tags":["Capital Run"]}},"/reporting/contingency-funding/runs":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingContingencyFundingRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all contingency funding runs","tags":["Contingency Funding Run"]},"post":{"description":"Requires verified staff reporting:write with fresh step-up. Runs require an independently approved scenario version that no approved version supersedes, the exact tied historical closing of a completed business date with every nonzero asset, contra-asset and liability GL classified (chart deposit GLs only as deposits), register advances at their original closing balances reconciled to the advance GLs, and the collateral register read on the next banking day; without the register the run is refused (dependency_failed), never assumed. Securities encumbrance is explicit per marketable security GL and no smaller than the register's live securities pledges; contingent flows are explicit, including an empty list. Results are cumulative sources and uses and net position by bucket per severity, stressed capacity per lender, survival days and indicator statuses. No liquidity coverage ratio or net stable funding ratio is calculated.","operationId":"postReportingContingencyFundingRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContingencyRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a contingency funding run","tags":["Contingency Funding Run"]}},"/reporting/contingency-funding/runs/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingContingencyFundingRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a contingency funding run by ID","tags":["Contingency Funding Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/contingency-funding/runs/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingContingencyFundingRunsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact contingency funding record digest","tags":["Contingency Funding Run"]}},"/reporting/contingency-funding/scenarios":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingContingencyFundingScenarios","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all contingency funding scenarios","tags":["Contingency Funding Scenario"]},"post":{"description":"Requires verified staff reporting:write with fresh step-up; exact-input and actor-bound idempotency. A scenario version fixes the stress event, 1–30 daily and 1–10 intramonth buckets ending no later than day 31, 1–5 severities, a role for each GL (cash, marketable_security, deposit, advance, other_liability or excluded) with an explicit haircut and available day or a nondecreasing cumulative runoff per bucket and severity, a lendable-value haircut and available day per register lender kind and severity, and 1–50 early-warning indicators with reviewed thresholds, owners and actions. A version that supersedes another names an independently approved version of the same name that no approved version already supersedes, so the versions of a scenario form one chain (conflict otherwise). No regulatory threshold is supplied by the service.","operationId":"postReportingContingencyFundingScenarios","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContingencyScenario"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a contingency funding scenario","tags":["Contingency Funding Scenario"]}},"/reporting/contingency-funding/scenarios/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingContingencyFundingScenariosId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a contingency funding scenario by ID","tags":["Contingency Funding Scenario"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/contingency-funding/scenarios/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance. Approving a scenario version that supersedes another is refused (conflict) once another approved version supersedes the same version, under the transaction lock the database guard takes for that version.","operationId":"postReportingContingencyFundingScenariosIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact contingency funding record digest","tags":["Contingency Funding Scenario"]}},"/reporting/contingency-funding/sources/{date}":{"get":{"description":"Verified reporting staff or service reader required. Captures without retaining the exact tied historical closing of the date with each GL's chart deposit class, register advances at their original closing balances and the collateral register's position with each approved lender, each with its digest. The register is read live; a run pairs it only with the closing of the previous banking day. Without the register the read is refused (dependency_failed).","operationId":"getReportingContingencyFundingSourcesDate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContingencySource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read the exact retained closing, dated register advances and collateral register position a contingency funding run for the date would capture","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"date","required":true,"schema":{"type":"string"}}]},"/reporting/custody-position-snapshots":{"get":{"description":"Verified reporting:read returns one complete immutable custody source per page; follow the returned cursor. Actual unknown prices and entitlements remain null with explicit blockers. Source records are never silently truncated.","operationId":"getReportingCustodyPositionSnapshots","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SnapshotRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all custody position snapshots","tags":["Custody Position Snapshot"]},"post":{"description":"Verified reporting:write staff or authorized service retains a current custody source with all signed orders, broker executions, actual settlements, lots, distributions and exact committed bank journal fingerprints. Actor/key replay returns the original observation, including unknown market value, tax basis or accrued income. Claims remain customer securities outside both bank-owned assets and insured DDA. No historical reconstruction or tax certification is inferred.","operationId":"postReportingCustodyPositionSnapshots","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a custody position snapshot","tags":["Custody Position Snapshot"]}},"/reporting/custody-position-snapshots/{id}":{"get":{"description":"Verified reporting:read returns the original dated source and verifies retained document signatures, consent/approval, actual cash fingerprints and content digest.","operationId":"getReportingCustodyPositionSnapshotsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a custody position snapshot by ID","tags":["Custody Position Snapshot"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/events":{"post":{"operationId":"postReportingEvents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ingest an event over HTTP (service identities only; the sandbox relays them for staff)","tags":["Reporting Run"]}},"/reporting/fr-y9sp/coverage":{"get":{"operationId":"getReportingFrY9spCoverage","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ScheduleCoverage"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The declared FR Y-9SP completeness matrix: every position of Schedules SI, SC and SC-M","tags":["Reporting Run"]}},"/reporting/fr-y9sp/profiles":{"get":{"operationId":"getReportingFrY9spProfiles","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Fry9spRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read FR Y-9SP profile and review history for a report date","tags":["Reporting Run"]},"post":{"operationId":"postReportingFrY9spProfiles","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spProfile"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose an immutable FR Y-9SP holding-company profile and its work plan","tags":["Reporting Run"]}},"/reporting/fr-y9sp/profiles/{id}":{"get":{"operationId":"getReportingFrY9spProfilesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one FR Y-9SP holding-company profile, its plan and its independent review","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/fr-y9sp/profiles/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingFrY9spProfilesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review an FR Y-9SP profile and its exact content digest","tags":["Reporting Run"]}},"/reporting/fr-y9sp/source-kinds":{"get":{"operationId":"getReportingFrY9spSourceKinds","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Kind"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the FR Y-9SP local source kinds and the exact form positions each accounts for","tags":["Reporting Run"]}},"/reporting/fr-y9sp/source-kinds/{kind}/preview":{"get":{"operationId":"getReportingFrY9spSourceKindsKindPreview","parameters":[{"in":"query","name":"profile_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spSourceSnapshot"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture one FR Y-9SP source under an approved profile without retaining it","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"kind","required":true,"schema":{"type":"string"}}]},"/reporting/fr-y9sp/workpapers":{"get":{"operationId":"getReportingFrY9spWorkpapers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"report_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Fry9spWorkpaper"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read paged FR Y-9SP workpaper and figure-review history for a report date","tags":["Reporting Run"]},"post":{"operationId":"postReportingFrY9spWorkpapers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaperRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaper"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture the FR Y-9SP sources, figures and completeness matrix for a report date","tags":["Reporting Run"]}},"/reporting/fr-y9sp/workpapers/{id}":{"get":{"operationId":"getReportingFrY9spWorkpapersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one FR Y-9SP workpaper: captured sources, figures, coverage and review","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/fr-y9sp/workpapers/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postReportingFrY9spWorkpapersIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaperReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fry9spWorkpaper"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the supplied FR Y-9SP figures and their exact content digest","tags":["Reporting Run"]}},"/reporting/insurance/policies":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingInsurancePolicies","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all insurance policies","tags":["Insurance Policy"]},"post":{"description":"Requires verified reporting staff and fresh step-up. Proposals bind idempotency to exact actor/input. Runs require an independently approved dated bank/rule policy and original retained closing/account balance versions. GET sources/{date} supplies captured title hashes for preparing evidence. Classification binds to those title hashes, uses evidenced beneficial-owner shares and qualification, and aggregates all accounts at one bank by owner/capacity. Trust beneficiary identities count once per grantor across accounts, capped at five. Missing or unsupported titles, special circumstances, or unreconciled principal/accrued interest remain explicit exceptions and make all estimates preliminary. This is not an FDIC determination, Part370 certification or network placement instruction.","operationId":"postReportingInsurancePolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsurancePolicy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a insurance policy","tags":["Insurance Policy"]}},"/reporting/insurance/policies/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingInsurancePoliciesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a insurance policy by ID","tags":["Insurance Policy"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/insurance/policies/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingInsurancePoliciesIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact insurance record digest","tags":["Insurance Policy"]}},"/reporting/insurance/runs":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingInsuranceRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all insurance runs","tags":["Insurance Run"]},"post":{"description":"Requires verified reporting staff and fresh step-up. Proposals bind idempotency to exact actor/input. Runs require an independently approved dated bank/rule policy and original retained closing/account balance versions. GET sources/{date} supplies captured title hashes for preparing evidence. Classification binds to those title hashes, uses evidenced beneficial-owner shares and qualification, and aggregates all accounts at one bank by owner/capacity. Trust beneficiary identities count once per grantor across accounts, capped at five. Missing or unsupported titles, special circumstances, or unreconciled principal/accrued interest remain explicit exceptions and make all estimates preliminary. This is not an FDIC determination, Part370 certification or network placement instruction.","operationId":"postReportingInsuranceRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuranceRunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a insurance run","tags":["Insurance Run"]}},"/reporting/insurance/runs/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingInsuranceRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a insurance run by ID","tags":["Insurance Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/insurance/runs/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingInsuranceRunsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact insurance record digest","tags":["Insurance Run"]}},"/reporting/insurance/sources/{date}":{"get":{"description":"Verified reporting staff/service reader required. Captures the exact retained historical closing, original account balance versions, core owners/beneficiaries and title revision timestamps. Inventory is read twice to detect retitling while captured. Missing balance feeds refuse; unknown historical title chronology remains explicit for the run. Source preview is not an insurance determination.","operationId":"getReportingInsuranceSourcesDate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuranceSource"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read exact dated original account balances and current title chronology to prepare reviewed insurance classification evidence","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"date","required":true,"schema":{"type":"string"}}]},"/reporting/rebuilds":{"get":{"operationId":"getReportingRebuilds","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RebuildRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every read-model rebuild, newest first","tags":["Reporting Run"]},"post":{"operationId":"postReportingRebuilds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Empty the event-derived facts and re-consume the topics from their start under a fresh consumer group (operators)","tags":["Reporting Run"]}},"/reporting/syncs":{"get":{"operationId":"getReportingSyncs","parameters":[{"in":"query","name":"business_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SyncRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every sync of a business date, oldest first; reports read the last","tags":["Reporting Run"]},"post":{"operationId":"postReportingSyncs","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"period":{"type":"string"}},"required":["period"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pull the ledger into the read models as a new version of a business date's positions: the live trial balance, or a past date's retained closing snapshot","tags":["Reporting Run"]}},"/reporting/syncs/{id}":{"get":{"operationId":"getReportingSyncsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncPositions"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"One sync and the positions it wrote, whether or not a later sync superseded them","tags":["Reporting Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/treasury/runs":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingTreasuryRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all treasury runs","tags":["Treasury Run"]},"post":{"description":"Requires verified staff with reporting:write and authentication within five minutes; service/customer/API-key callers are refused. Idempotency is bound to exact input and actor. Scenarios fix every discount/index curve month and explicit runoff/prepayment/beta/haircut assumptions. Runs require an independently approved scenario, exact tied historical ledger closing, matching modeled or explicitly excluded GL balances, and evidenced complete cash/unsupported-instrument projections. Results are immutable monthly static-runoff analytics, not a regulatory ratio, live funding action or an intramonth liquidity guarantee.","operationId":"postReportingTreasuryRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a treasury run","tags":["Treasury Run"]}},"/reporting/treasury/runs/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingTreasuryRunsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a treasury run by ID","tags":["Treasury Run"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/treasury/runs/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingTreasuryRunsIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact treasury record digest","tags":["Treasury Run"]}},"/reporting/treasury/scenarios":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingTreasuryScenarios","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AlmRecord"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all treasury scenarios","tags":["Treasury Scenario"]},"post":{"description":"Requires verified staff with reporting:write and authentication within five minutes; service/customer/API-key callers are refused. Idempotency is bound to exact input and actor. Scenarios fix every discount/index curve month and explicit runoff/prepayment/beta/haircut assumptions. Runs require an independently approved scenario, exact tied historical ledger closing, matching modeled or explicitly excluded GL balances, and evidenced complete cash/unsupported-instrument projections. Results are immutable monthly static-runoff analytics, not a regulatory ratio, live funding action or an intramonth liquidity guarantee.","operationId":"postReportingTreasuryScenarios","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a treasury scenario","tags":["Treasury Scenario"]}},"/reporting/treasury/scenarios/{id}":{"get":{"description":"Verified reporting:read or reporting:write staff/service identity required; customer tokens and API keys are refused. Cursor pagination returns immutable records with review evidence.","operationId":"getReportingTreasuryScenariosId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a treasury scenario by ID","tags":["Treasury Scenario"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reporting/treasury/scenarios/{id}/reviews":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Requires reporting:write, operations:approve, fresh staff authentication and a different actor from the proposer. Review names the exact content_sha256 and retained evidence. An existing identical review replays; changing actor, decision or evidence conflicts. Approval attests the supplied scope, inputs and result; it does not establish regulatory compliance.","operationId":"postReportingTreasuryScenariosIdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlmRecord"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject the exact treasury record digest","tags":["Treasury Scenario"]}},"/reports":{"get":{"description":"List settlement reports newest first, filtered by type, status and window","operationId":"getReports","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"from_date","schema":{"type":"string"}},{"in":"query","name":"to_date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SettlementReport"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all reports","tags":["Report"]},"post":{"description":"Schedule a settlement report over a window of business dates for the caller's own accounts, or bank-wide with the reporting scope; the scheduler builds it and stores its documents","operationId":"postReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a report","tags":["Report"]}},"/reports/activity":{"get":{"operationId":"getReportsActivity","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Journal activity by kind for a period","tags":["Activity Report"]}},"/reports/balance-sheet":{"get":{"operationId":"getReportsBalanceSheet","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Balance sheet as of a date","tags":["Balance Sheet"]}},"/reports/call-report/mapping":{"get":{"operationId":"getReportsCallReportMapping","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mapping"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Every product and GL code with the schedule items it reports on","tags":["Call Report Schedule"]}},"/reports/call-report/rc":{"get":{"operationId":"getReportsCallReportRc","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Call report Schedule RC lines","tags":["Call Report Schedule"]}},"/reports/call-report/rc-c":{"get":{"operationId":"getReportsCallReportRcC","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Schedule RC-C: loans by category, from the products' mapping","tags":["Call Report Schedule"]}},"/reports/call-report/rc-e":{"get":{"operationId":"getReportsCallReportRcE","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Schedule RC-E: deposits by column, from the products' mapping","tags":["Call Report Schedule"]}},"/reports/call-report/rc-l":{"get":{"operationId":"getReportsCallReportRcL","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Schedule RC-L: unused commitments and standby letters of credit from the facilities","tags":["Call Report Schedule"]}},"/reports/call-report/rc-n":{"get":{"operationId":"getReportsCallReportRcN","parameters":[{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Schedule RC-N: past due and nonaccrual loans by category","tags":["Call Report Schedule"]}},"/reports/call-report/ri":{"get":{"operationId":"getReportsCallReportRi","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Schedule RI: income and expense by item for a period","tags":["Call Report Schedule"]}},"/reports/daily-flash":{"get":{"operationId":"getReportsDailyFlash","parameters":[{"in":"query","name":"as_of","required":true,"schema":{"type":"string"}},{"in":"query","name":"compare_to","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyFlash"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Daily management balances from retained original ledger closings","tags":["Daily Flash"]}},"/reports/deposits":{"get":{"operationId":"getReportsDeposits","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Accounts by product","tags":["Deposit Report"]}},"/reports/fed-position":{"get":{"operationId":"getReportsFedPosition","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FedPosition"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Intraday position at the Federal Reserve against the net debit cap","tags":["Fed Position"]}},"/reports/fr2900":{"get":{"operationId":"getReportsFr2900","parameters":[{"in":"query","name":"week_ending","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FR2900"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"FR 2900 report of deposits: weekly averages by deposit class","tags":["FR 2900 Report"]}},"/reports/fr2915":{"get":{"description":"reporting:read. The Report of Foreign (Non-U.S.) Currency Deposits (FR 2915, OMB 7100-0087, form 01/2024, instructions June 2021) for the seven days ending on the Monday named by week_ending, or the week containing as_of. FR 2900 respondents that offer foreign-currency deposits at U.S. offices file it one week each quarter, the week beginning the third Tuesday of March, June, September and December (quarterly_reporting_week). Each day reads the same positions the FR 2900 averages, the latest closed-date sync on or before the day, so a weekend or holiday carries the previous close, and the foreign-currency deposit lines that sync translated at that day's approved closing rate: the daily valuation method, at the bank's consistent series of rate quotations. A demand deposit class is item 1 (MDRM 2340) and every other transaction or savings class item 2 (other liquid deposits, MB60); cash items in process of collection (0020) are zero because the core takes no foreign-currency items, and a foreign-currency time deposit line is refused (409) because item 4 (2697) needs each deposit's balance against $100,000. Amounts are the seven-day averages in cents and rounded to the nearest thousand U.S. dollars as filed; nothing_to_report is the form's box for a week without foreign-currency deposits on every day.","operationId":"getReportsFr2915","parameters":[{"in":"query","name":"week_ending","schema":{"type":"string"}},{"in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FR2915"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"FR 2915 report of foreign (non-U.S.) currency deposits: the weekly averages, converted to USD at each day's closing rate, of the foreign-currency deposits the FR 2900 includes","tags":["Report"]}},"/reports/income-statement":{"get":{"operationId":"getReportsIncomeStatement","parameters":[{"in":"query","name":"period","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Income statement for a period","tags":["Income Statement"]}},"/reports/reporting-central/submissions":{"post":{"operationId":"postReportsReportingCentralSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCentralRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCentralReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"File an FR 2900 or FR Y-9SP with the Reporting Central simulator and retain its receipt (simulator only)","tags":["Report"]}},"/reports/reporting-central/submissions/{id}":{"get":{"operationId":"getReportsReportingCentralSubmissionsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingCentralReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one retained Reporting Central simulator receipt","tags":["Report"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reports/{id}":{"get":{"description":"Read a settlement report and the documents it produced","operationId":"getReportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a report by ID","tags":["Report"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/reports/{id}/documents/{format}":{"get":{"operationId":"getReportsIdDocumentsFormat","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettlementReportContent"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a completed report's document as json or csv","tags":["Report"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"format","required":true,"schema":{"type":"string"}}]},"/request-kinds":{"get":{"description":"Request kinds the console supports","operationId":"getRequestKinds","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RequestKind"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all request kinds","tags":["Request Kind"]}},"/requests":{"get":{"description":"List requests","operationId":"getRequests","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Request"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all requests","tags":["Request"]},"post":{"description":"Submit a maker-checker request","operationId":"postRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"kind":{"type":"string"},"payload":{"additionalProperties":true,"type":"object"},"requested_by":{"type":"string"}},"required":["kind","payload","requested_by"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a request","tags":["Request"]}},"/requests/{id}":{"get":{"description":"Read a request","operationId":"getRequestsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a request by ID","tags":["Request"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/requests/{id}/decide":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRequestsIdDecide","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approver":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["approver","decision","note"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve (and apply) or reject a request","tags":["Request"]}},"/requests/{id}/recover":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRequestsIdRecover","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecoveryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Recover an approved request using its captured terms","tags":["Request"]}},"/retirement/customers/{id}/eligibility":{"get":{"operationId":"getRetirementCustomersIdEligibility","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RetirementEligibility"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed customer/year contribution eligibility and declared outside-custodian amounts","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh dedicated retirement writer and independent approval. Verified living consumer DOB, own compensation, modified AGI, twelve month-start HSA eligibility determinations, evidenced spouse family-base allocation, all declared outside-bank IRA/Roth/HSA amounts and Roth first tax year are retained. Inherited accounts, spousal-compensation inference and the HSA last-month testing exception are unsupported.","operationId":"postRetirementCustomersIdEligibility","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EligibilityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementEligibility"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementEligibility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose bank-evidenced IRA/HSA owner eligibility and contribution declarations","tags":["Other"]}},"/retirement/customers/{id}/eligibility/{eligibility}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"eligibility","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementCustomersIdEligibilityEligibilityDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementEligibility"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide customer/year IRA/HSA eligibility","tags":["Other"]}},"/retirement/customers/{id}/rmd-reviews":{"get":{"operationId":"getRetirementCustomersIdRmdReviews","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RMDReview"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List owner RMD calculations and external custodian declarations","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Every bank traditional IRA from the prior year must have a current approved year-end position. Verified living owner DOB selects the reviewed rule. Per-account requirements round up to a cent and aggregate with evidenced outside requirements. First-year deferral is explicit. No automatic external-custodian data or RMD notice delivery is claimed.","operationId":"postRetirementCustomersIdRmdReviews","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDReview"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Calculate RMD across all bank traditional IRAs and reviewed outside requirements","tags":["Other"]}},"/retirement/customers/{id}/rmd-reviews/{review}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"review","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementCustomersIdRmdReviewsReviewDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide an owner RMD calculation","tags":["Other"]}},"/retirement/customers/{id}/rmd-reviews/{review}/status":{"get":{"operationId":"getRetirementCustomersIdRmdReviewsReviewStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDStatus"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reconcile RMD requirements to actual paid allocations including lateness","tags":["Other"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"review","required":true,"schema":{"type":"string"}}]},"/retirement/rmd-allocations":{"post":{"description":"Independently reviewed gross allocation from an actually executed traditional IRA distribution, bound to its ledger receipt and paid date. All approved obligation years share the distribution gross cap, preventing first-year deferral double counting. Late payments can remedy a shortfall while status retains missed-deadline evidence.","operationId":"postRetirementRmdAllocations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDAllocationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDAllocation"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDAllocation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Allocate an executed IRA distribution to an RMD obligation without cross-year double counting","tags":["Other"]}},"/retirement/rmd-allocations/{allocation}/decisions":{"parameters":[{"in":"path","name":"allocation","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementRmdAllocationsAllocationDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDAllocation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject actual RMD fulfillment evidence","tags":["Other"]}},"/retirement/rmd-policies":{"get":{"operationId":"getRetirementRmdPolicies","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RMDPolicy"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed annual RMD policies","tags":["Other"]},"post":{"description":"Fresh retirement writer then independent retirement approver. Explicit reviewed annual birth cohorts, commencement ages and uniform-lifetime divisors; no production legally approved table is seeded. Inherited/joint-life and statutory relief cases require separate workflows.","operationId":"postRetirementRmdPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDPolicy"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose annual RMD age cohorts and uniform-lifetime divisors for independent review","tags":["Other"]}},"/retirement/rmd-policies/{policy}/decisions":{"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementRmdPoliciesPolicyDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RMDPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide an evidenced annual RMD policy","tags":["Other"]}},"/retirement/rules":{"get":{"operationId":"getRetirementRules","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Rule"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed annual IRA/HSA cash servicing rules","tags":["Other"]},"post":{"description":"Fresh dedicated accounts:retirement:write staff authority. Reviewed authority/evidence hashes, annual limits, phaseout brackets and deadlines are explicit bank configuration; no legally approved values are seeded. expected_version orders proposals. Independent accounts:retirement:approve reviewer activates the immutable version at its effective date.","operationId":"postRetirementRules","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose evidenced annual IRA/HSA limits and tax treatment for independent review","tags":["Other"]}},"/retirement/rules/{rule}/decisions":{"parameters":[{"in":"path","name":"rule","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementRulesRuleDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently approve or reject an annual retirement servicing rule","tags":["Other"]}},"/retirement/tax-policies":{"get":{"operationId":"getRetirementTaxPolicies","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaxPolicy"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List reviewed annual retirement tax-document policies","tags":["Other"]},"post":{"description":"Fresh dedicated retirement writer, then independent retirement approver. Only the implemented 2026 irs-2026-cash-retirement-v1 schema is accepted. The bank supplies reviewed issuer identity, complete recipient instructions, applicable deadlines and electronic-delivery disclosures with exact evidence/version. No production legal copy or future IRS schema is inferred.","operationId":"postRetirementTaxPolicies","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPolicy"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose reviewed annual issuer, recipient instructions and tax-delivery requirements","tags":["Other"]}},"/retirement/tax-policies/{policy}/decisions":{"parameters":[{"in":"path","name":"policy","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postRetirementTaxPoliciesPolicyDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordsDecision"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxPolicy"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently decide a retirement tax-document policy","tags":["Other"]}},"/sanctioned-jurisdictions":{"get":{"description":"The comprehensively sanctioned jurisdictions and areas (ISO 3166-2 regions, postal prefixes) in force on a business date (today by default; date=YYYY-MM-DD) and every recorded change","operationId":"getSanctionedJurisdictions","parameters":[{"in":"query","name":"date","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JurisdictionList"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all sanctioned jurisdictions","tags":["Sanctioned Jurisdiction"]}},"/sanctioned-jurisdictions/proposals":{"post":{"operationId":"postSanctionedJurisdictionsProposals","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JurisdictionProposal"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JurisdictionChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose adding or removing a jurisdiction, or a region or postal prefix of one, from a date as the verified staff member (fresh step-up); it is in force only once a second person approves it","tags":["Sanctioned Jurisdiction"]}},"/sanctioned-jurisdictions/proposals/{id}/decision":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postSanctionedJurisdictionsProposalsIdDecision","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDecisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JurisdictionChange"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject another staff member's jurisdiction proposal (operations:approve), or withdraw your own; decisions are immutable","tags":["Sanctioned Jurisdiction"]}},"/sanctions-lists":{"get":{"description":"Loaded sanctions lists with their version and content hash","operationId":"getSanctionsLists","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SanctionsList"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all sanctions lists","tags":["Sanctions List"]}},"/sanctions-lists/refresh":{"post":{"operationId":"postSanctionsListsRefresh","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reload the sanctions lists from their configured files and re-screen every known subject on change","tags":["Sanctions List"]}},"/scheduled-transfers":{"get":{"description":"List schedules","operationId":"getScheduledTransfers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ScheduledTransfer"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all scheduled transfers","tags":["Scheduled Transfer"]},"post":{"description":"Schedule a payment to a counterparty or a transfer between the customer's accounts: today, on a date, or on a recurrence; under the account's approval policy it waits for its approvers","operationId":"postScheduledTransfers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a scheduled transfer","tags":["Scheduled Transfer"]}},"/scheduled-transfers/runs":{"post":{"operationId":"postScheduledTransfersRuns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run every schedule whose date has come and lapse overdue approvals (the scheduler calls this; so may operations)","tags":["Scheduled Transfer"]}},"/scheduled-transfers/{id}":{"get":{"description":"Read a schedule","operationId":"getScheduledTransfersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a scheduled transfer by ID","tags":["Scheduled Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/scheduled-transfers/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postScheduledTransfersIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleActionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"End a schedule","tags":["Scheduled Transfer"]}},"/scheduled-transfers/{id}/pause":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postScheduledTransfersIdPause","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleActionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hold an active schedule","tags":["Scheduled Transfer"]}},"/scheduled-transfers/{id}/resume":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postScheduledTransfersIdResume","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleActionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Restart a paused schedule from its next date","tags":["Scheduled Transfer"]}},"/scheduled-transfers/{id}/runs":{"get":{"operationId":"getScheduledTransfersIdRuns","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ScheduledRun"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The schedule's runs: the transfer each created, or why it failed","tags":["Scheduled Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/scheduler/passes":{"post":{"operationId":"postSchedulerPasses","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Run one pass of the day's routines (due schedules, wire releases and resends, ACH file resends, instant reconciliations, expiries) as the in-process scheduler does","tags":["Other"]}},"/scim/v2/ResourceTypes":{"get":{"operationId":"getScimV2ResourceTypes","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Supported SCIM resource types","tags":["Staff Provisioning"]}},"/scim/v2/ResourceTypes/{id}":{"get":{"operationId":"getScimV2ResourceTypesId","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Read a supported SCIM resource type","tags":["Staff Provisioning"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/scim/v2/Schemas":{"get":{"operationId":"getScimV2Schemas","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Supported SCIM schemas","tags":["Staff Provisioning"]}},"/scim/v2/Schemas/{id}":{"get":{"operationId":"getScimV2SchemasId","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Read a supported SCIM schema","tags":["Staff Provisioning"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/scim/v2/ServiceProviderConfig":{"get":{"operationId":"getScimV2ServiceProviderConfig","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"SCIM capabilities","tags":["Staff Provisioning"]}},"/scim/v2/Users":{"get":{"operationId":"getScimV2Users","parameters":[{"description":"userName eq or externalId eq with a quoted string","in":"query","name":"filter","schema":{"type":"string"}},{"in":"query","name":"startIndex","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"count","schema":{"default":100,"maximum":200,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffList"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"List or filter provisioned staff","tags":["Staff Provisioning"]},"post":{"operationId":"postScimV2Users","requestBody":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"required":true},"responses":{"201":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Provision a staff identity","tags":["Staff Provisioning"]}},"/scim/v2/Users/{id}":{"delete":{"operationId":"deleteScimV2UsersId","parameters":[{"description":"current SCIM version; stale versions return 412","in":"header","name":"If-Match","schema":{"type":"string"}}],"responses":{"204":{"description":"No content"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Deactivate staff and revoke sessions","tags":["Staff Provisioning"]},"get":{"operationId":"getScimV2UsersId","responses":{"200":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Read a provisioned staff identity","tags":["Staff Provisioning"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"patch":{"operationId":"patchScimV2UsersId","parameters":[{"description":"current SCIM version; stale versions return 412","in":"header","name":"If-Match","schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffPatch"}}},"required":true},"responses":{"200":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Update staff attributes atomically","tags":["Staff Provisioning"]},"put":{"operationId":"putScimV2UsersId","parameters":[{"description":"current SCIM version; stale versions return 412","in":"header","name":"If-Match","schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"required":true},"responses":{"200":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/StaffUser"}}},"description":"OK"},"400":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"409":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"412":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"413":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"422":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"424":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"429":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"500":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"},"503":{"content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/SCIMError"}}},"description":"SCIM error"}},"summary":"Replace staff attributes and revoke changed permissions","tags":["Staff Provisioning"]}},"/screenings":{"get":{"description":"List screenings","operationId":"getScreenings","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"subject_type","schema":{"type":"string"}},{"in":"query","name":"result","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Screening"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all screenings","tags":["Screening"]},"post":{"description":"Screen a name against the sanctions lists","operationId":"postScreenings","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Screening"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a screening","tags":["Screening"]}},"/screenings/{id}":{"get":{"description":"Read a screening","operationId":"getScreeningsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Screening"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a screening by ID","tags":["Screening"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/sessions":{"post":{"description":"Log in with email, password and device signals","operationId":"postSessions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a session","tags":["Session"]}},"/sessions/passkey":{"post":{"operationId":"postSessionsPasskey","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyLoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Complete a passkey login","tags":["Session"]}},"/sessions/passkey/options":{"post":{"operationId":"postSessionsPasskeyOptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasskeyLoginOptionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Start a passkey login (challenge and allowed credentials)","tags":["Session"]}},"/sessions/refresh":{"post":{"operationId":"postSessionsRefresh","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Rotate the refresh token and mint a new access token","tags":["Session"]}},"/sessions/revoke":{"post":{"operationId":"postSessionsRevoke","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke the current session","tags":["Session"]}},"/simulate/cards/clearing":{"post":{"operationId":"postSimulateCardsClearing","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateClearing"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the network clearing an authorization","tags":["Simulation"]}},"/simulate/cards/purchase":{"post":{"operationId":"postSimulateCardsPurchase","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulatePurchase"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardsDecision"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate a merchant purchase on a card","tags":["Simulation"]}},"/simulate/cards/switch/messages":{"post":{"operationId":"postSimulateCardsSwitchMessages","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Sandbox entry to the switch, registered only in the sandbox: one packed ISO 8583 message on a network's simulated profile, decided as a simulator link would decide it (svc_cardnet with cards:switch:network)","tags":["Simulation"]}},"/simulate/reconciliations/statements":{"post":{"operationId":"postSimulateReconciliationsStatements","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateStatements"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReportingStatement"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the operators' statements for a date and record them","tags":["Simulation"]}},"/simulate/transfers/ach/change":{"post":{"operationId":"postSimulateTransfersAchChange","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateACHChange"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Change"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an RDFI sending a notification of change about an entry the bank originated","tags":["Simulation"]}},"/simulate/transfers/ach/receive":{"post":{"operationId":"postSimulateTransfersAchReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateACHReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an incoming ACH credit or debit","tags":["Simulation"]}},"/simulate/transfers/ach/return":{"post":{"operationId":"postSimulateTransfersAchReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateACHReturn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an RDFI returning an originated entry","tags":["Simulation"]}},"/simulate/transfers/ach/settle":{"post":{"operationId":"postSimulateTransfersAchSettle","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateACHSettle"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the operator settling a sent ACH file","tags":["Simulation"]}},"/simulate/transfers/checks/presentment":{"post":{"operationId":"postSimulateTransfersChecksPresentment","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PresentmentItem"},"type":"array"}},"required":["items"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundCashLetterResult"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the operator presenting checks drawn on the bank","tags":["Simulation"]}},"/simulate/transfers/checks/return":{"post":{"operationId":"postSimulateTransfersChecksReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateCheckReturn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the payor bank returning a check the bank's customer deposited","tags":["Simulation"]}},"/simulate/transfers/international-wire/bank-receive":{"post":{"operationId":"postSimulateTransfersInternationalWireBankReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateSwiftBankReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate a correspondent sending the bank a SWIFT bank transfer or cover (pacs.009) through the network simulator","tags":["Simulation"]}},"/simulate/transfers/international-wire/cancellation-request":{"post":{"operationId":"postSimulateTransfersInternationalWireCancellationRequest","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateSwiftCancellation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftCancellation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the institution that sent the bank a SWIFT payment asking for it back (camt.056)","tags":["Simulation"]}},"/simulate/transfers/international-wire/receive":{"post":{"operationId":"postSimulateTransfersInternationalWireReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateSwiftReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate a correspondent sending the bank an international wire (pacs.008) through the network simulator","tags":["Simulation"]}},"/simulate/transfers/realtime/liquidity-receive":{"post":{"operationId":"postSimulateTransfersRealtimeLiquidityReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateLiquidityReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate a liquidity management transfer arriving (pacs.009)","tags":["Simulation"]}},"/simulate/transfers/realtime/notification":{"post":{"operationId":"postSimulateTransfersRealtimeNotification","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateNotification"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RailNotification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the service notifying the bank, as a correspondent, of a respondent's settled message (camt.054)","tags":["Simulation"]}},"/simulate/transfers/realtime/receive":{"post":{"operationId":"postSimulateTransfersRealtimeReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateRealtimeReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an incoming realtime transfer","tags":["Simulation"]}},"/simulate/transfers/realtime/request":{"post":{"operationId":"postSimulateTransfersRealtimeRequest","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulatePaymentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate another institution's customer asking the bank's customer to pay (pain.013)","tags":["Simulation"]}},"/simulate/transfers/realtime/request-cancellation":{"post":{"operationId":"postSimulateTransfersRealtimeRequestCancellation","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateRequestCancellation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the requester cancelling a request the bank's customer received (camt.055)","tags":["Simulation"]}},"/simulate/transfers/realtime/return":{"post":{"operationId":"postSimulateTransfersRealtimeReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateInstantReturn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the receiver returning a payment the bank sent","tags":["Simulation"]}},"/simulate/transfers/realtime/return-request":{"post":{"operationId":"postSimulateTransfersRealtimeReturnRequest","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateInstantReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the sender asking for a payment the bank received back (camt.056)","tags":["Simulation"]}},"/simulate/transfers/wire/bank-receive":{"post":{"operationId":"postSimulateTransfersWireBankReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateBankTransferReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an incoming bank transfer (pacs.009) onto the transit account","tags":["Simulation"]}},"/simulate/transfers/wire/receive":{"post":{"operationId":"postSimulateTransfersWireReceive","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateWireReceive"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate an incoming wire","tags":["Simulation"]}},"/simulate/transfers/wire/return":{"post":{"operationId":"postSimulateTransfersWireReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateWireReturn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the receiver returning a wire the bank sent (pacs.004)","tags":["Simulation"]}},"/simulate/transfers/wire/return-request":{"post":{"operationId":"postSimulateTransfersWireReturnRequest","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateWireReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Simulate the sender asking for a wire the bank received back (camt.056)","tags":["Simulation"]}},"/staff/audit-log/verify":{"get":{"operationId":"getStaffAuditLogVerify","parameters":[{"in":"query","name":"anchor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffAuditVerification"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Walk the security and staff audit hash chains and report the first break","tags":["Staff Audit Log"]}},"/staff/authorizations":{"post":{"description":"Start staff OIDC sign-in with PKCE and browser binding","operationId":"postStaffAuthorizations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffAuthorization"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Create a staff authorization","tags":["Staff Authorization"]}},"/staff/sessions":{"post":{"description":"Exchange an OIDC code for a provisioned staff session","operationId":"postStaffSessions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffLoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffTokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Create a staff session","tags":["Staff Session"]}},"/staff/sessions/refresh":{"post":{"operationId":"postStaffSessionsRefresh","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaffTokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Rotate a staff refresh token without extending MFA freshness","tags":["Staff Session"]}},"/staff/sessions/revoke":{"post":{"operationId":"postStaffSessionsRevoke","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke the current staff session","tags":["Staff Session"]}},"/step-ups":{"post":{"operationId":"postStepUps","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepUpRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Prove presence by PIN or passkey; returns a token carrying the step-up time","tags":["Step-up"]}},"/step-ups/options":{"post":{"operationId":"postStepUpsOptions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":{},"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Start a passkey step-up","tags":["Step-up"]}},"/stop-payments":{"get":{"description":"List stop payment orders","operationId":"getStopPayments","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StopPayment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all stop payments","tags":["Stop Payment"]},"post":{"description":"Order the bank not to pay a check or a range of checks","operationId":"postStopPayments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPaymentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a stop payment","tags":["Stop Payment"]}},"/stop-payments/expirations":{"post":{"operationId":"postStopPaymentsExpirations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expired":{"format":"int64","type":"integer"}},"required":["expired"],"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Lapse the orders whose time has passed (a scheduler calls this daily)","tags":["Stop Payment"]}},"/stop-payments/{id}":{"get":{"description":"Read a stop payment order","operationId":"getStopPaymentsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a stop payment by ID","tags":["Stop Payment"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/stop-payments/{id}/confirm":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postStopPaymentsIdConfirm","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Confirm an oral stop order in writing","tags":["Stop Payment"]}},"/stop-payments/{id}/release":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postStopPaymentsIdRelease","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Lift a stop payment order","tags":["Stop Payment"]}},"/tax-forms/1099-int":{"get":{"operationId":"getTaxForms1099Int","parameters":[{"in":"query","name":"year","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxYear"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The year's 1099-INT and 1042-S figures: interest paid and tax withheld by customer, with each recipient's TIN status; format=irs1220 returns the Forms 1099-INT as a Publication 1220 file for the IRS FIRE system (missing_tin=blank files recipients whose TIN is still to be collected with a blank TIN); format=irs1187 returns the Forms 1042-S as a Publication 1187 file for the IRS FIRE system","tags":["Tax Form"]}},"/tax-forms/1099-int/corrections":{"post":{"operationId":"postTaxForms1099IntCorrections","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCorrectionRequest"}}},"required":true},"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Corrected Forms 1099-INT as a Publication 1220 file: a G record with the current figures for an amount error, a zeroed G record for a return that should not have been filed, and for a TIN or name error a G record repeating the return as filed (from the payer's filed copy) with zero amounts followed by a C record with the current identity and figures; recorded as an export","tags":["Tax Form"]}},"/tax-forms/1099-int/transmissions":{"get":{"operationId":"getTaxForms1099IntTransmissions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List a tax year's IRS FIRE transmissions and their lifecycle (year=YYYY)","tags":["Tax Form"]},"post":{"operationId":"postTaxForms1099IntTransmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Build the year's Forms 1099-INT as a Publication 1220 file and retain it as a proposed IRS FIRE transmission awaiting a second reviewer (Idempotency-Key); body {year, blank_missing_tin}","tags":["Tax Form"]}},"/tax-forms/1099-int/transmissions/{id}":{"get":{"operationId":"getTaxForms1099IntTransmissionsId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read one IRS FIRE transmission: its status, receipt and acknowledgment","tags":["Tax Form"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/tax-forms/1099-int/transmissions/{id}/decisions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTaxForms1099IntTransmissionsIdDecisions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A reviewer other than the proposer approves (submits to FIRE and ingests the acknowledgment) or rejects a proposed transmission (Idempotency-Key); body {decision}","tags":["Tax Form"]}},"/tax-forms/b-notices":{"get":{"operationId":"getTaxFormsBNotices","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"year","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TINNotice"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the IRS TIN notices dated in a year (year=YYYY) with the B notice each calls for","tags":["Tax Form"]},"post":{"operationId":"postTaxFormsBNotices","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TINNoticeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TINNotice"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record an account an IRS CP2100 or CP2100A listed with a mismatched name and TIN (Idempotency-Key): the first or second B notice it calls for, the B notice mailing date and the backup-withholding start date","tags":["Tax Form"]}},"/tax-forms/tin-matching":{"post":{"operationId":"postTaxFormsTinMatching","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Check a bulk set of name/TIN pairs against the IRS TIN Matching program and retain the backup-withholding candidates (Idempotency-Key)","tags":["Tax Form"]}},"/tax-forms/tin-matching/{id}":{"get":{"operationId":"getTaxFormsTinMatchingId","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a retained bulk TIN Matching run: the code and backup-withholding disposition per line (never the submitted TINs)","tags":["Tax Form"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/tokens":{"post":{"description":"Issue a service token by client credentials. A wrong client id or secret answers `identity.credential_invalid`. A replica whose configuration for the client is older than the live one — the generation it holds has been retired — mints nothing and answers 503 `unavailable`: retry, and a replica with the live configuration issues the token.","operationId":"postTokens","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityTokenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Create a token","tags":["Token"]}},"/tokens/api-key":{"post":{"operationId":"postTokensApiKey","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyTokenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Exchange a customer API key for an account-scoped token valid for at most 60 seconds","tags":["Token"]}},"/transfers":{"get":{"description":"List transfers on every rail","operationId":"getTransfers","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TransferSummary"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all transfers","tags":["Transfer"]}},"/transfers/ach":{"post":{"description":"Originate an ACH credit or debit","operationId":"postTransfersAch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an ACH transfer","tags":["ACH Transfer"]}},"/transfers/ach/{id}":{"get":{"description":"Read an ACH transfer","operationId":"getTransfersAchId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an ACH transfer by ID","tags":["ACH Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/ach/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersAchIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject an ACH transfer held for review (optional Idempotency-Key replays the recorded decision)","tags":["ACH Transfer"]}},"/transfers/book":{"post":{"description":"Book transfer between two accounts at the bank","operationId":"postTransfersBook","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a book transfer","tags":["Book Transfer"]}},"/transfers/book/{id}":{"get":{"description":"Read a book transfer","operationId":"getTransfersBookId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a book transfer by ID","tags":["Book Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/checks":{"get":{"description":"List check transfers: deposits (default), issued official checks (kind=issue) or checks drawn on the bank that the operator presented (kind=inclearing)","operationId":"getTransfersChecks","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"kind","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"cash_letter_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CheckDeposit"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all check transfers","tags":["Check Transfer"]}},"/transfers/checks/closure":{"post":{"operationId":"postTransfersChecksClosure","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClosureCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficialCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue only the exact official-check payout from a captured, funded account closure","tags":["Check Transfer"]}},"/transfers/checks/closure-authority":{"get":{"operationId":"getTransfersChecksClosureAuthority","responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Verify service authority before reserving an official-check closure payout","tags":["Check Transfer"]}},"/transfers/checks/deposit":{"post":{"description":"channel is branch, mobile, atm (a proprietary ATM only), or lockbox. nonproprietary_atm is explicitly refused with payments.unsupported_deposit_channel. An integrator unable to establish that the bank operates the ATM must use nonproprietary_atm. The opening minimum of an unfunded certificate also applies.","operationId":"postTransfersChecksDeposit","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Deposit a check: MICR line, amount and images; on the account at once under its Reg CC hold, collected through the next cash letter","tags":["Check Transfer"]}},"/transfers/checks/deposits/{id}/atm-reverse":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksDepositsIdAtmReverse","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Reverse a proprietary ATM check deposit the terminal did not keep; the account credit comes off before the item is presented","tags":["Check Transfer"]}},"/transfers/checks/deposits/{id}/exception-holds":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksDepositsIdExceptionHolds","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExceptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExceptionHold"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Place the Reg CC redeposited-check exception hold (12 CFR 229.13(c)) on a check deposit, grounded in the committed return of the earlier deposit of the same item","tags":["Check Transfer"]}},"/transfers/checks/deposits/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksDepositsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckScreeningReviewBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckScreeningReview"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide a check deposit sanctions screening parked on the transit account: approve (the funds go to the customer under the deposit's Reg CC availability) or block (they stay on the transit account as blocked property)","tags":["Check Transfer"]}},"/transfers/checks/issue":{"post":{"operationId":"postTransfersChecksIssue","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueOfficialCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficialCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Issue a cashier's check from an account or the bank's own GL account","tags":["Check Transfer"]}},"/transfers/checks/{id}":{"get":{"description":"Read a check transfer: a deposit, an official check or a presented check, by id","operationId":"getTransfersChecksId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a check transfer by ID","tags":["Check Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/checks/{id}/collection":{"get":{"operationId":"getTransfersChecksIdCollection","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The collection item a returned deposit opened when the account could not absorb the charge-back","tags":["Check Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/checks/{id}/images/{side}":{"get":{"operationId":"getTransfersChecksIdImagesSide","responses":{"200":{"content":{"image/tiff":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A deposited check's image (front or back), TIFF","tags":["Check Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"side","required":true,"schema":{"type":"string"}}]},"/transfers/checks/{id}/pay":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksIdPay","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InclearingItem"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Pay a presented check held as a positive pay exception","tags":["Check Transfer"]}},"/transfers/checks/{id}/return":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksIdReturn","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InclearingItem"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return a presented check held as a positive pay exception","tags":["Check Transfer"]}},"/transfers/checks/{id}/stop":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksIdStop","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficialCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Stop a lost or stolen official check: its presentment is returned","tags":["Check Transfer"]}},"/transfers/checks/{id}/void":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersChecksIdVoid","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficialCheck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Void an official check never negotiated and refund the remitter","tags":["Check Transfer"]}},"/transfers/iat":{"get":{"description":"List international transfers, newest first (account_id, status and an effective-date range narrow the list)","operationId":"getTransfersIat","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IATTransfer"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all international transfers","tags":["International Transfer"]},"post":{"description":"Originate an international ACH credit or debit (IAT): the seven mandatory addenda are derived from the parties and their banks, every party is screened, and Same Day settlement is refused","operationId":"postTransfersIat","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IATTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IATTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an international transfer","tags":["International Transfer"]}},"/transfers/iat/{id}":{"get":{"description":"Read an international transfer, its addenda and what became of it","operationId":"getTransfersIatId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IATTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an international transfer by ID","tags":["International Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/iat/{id}/cancel":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersIatIdCancel","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IATTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Withdraw an international transfer before it joins a file; the hold is released","tags":["International Transfer"]}},"/transfers/information-requests/search":{"post":{"description":"Confidential bounded 314(a) request custody. Actual svc_bsa_bridge and separately configured environment-bound information_request signature authority admit exact original portal bytes plus extracted manifest (names, US tax identifiers, date of birth, addresses, phones, typed identification numbers, account and routing numbers); no FinCEN signature or live portal adapter is claimed. Two staff members review the original and exact plan before request-bound source queries. Four planned native sources cut the core under one explicit normalization: customers (current, evidenced historical, as-filed and tax-document identities, keyed tax blind index or the salted hash on records without one, corrected-tax hashes, tokenized names as lower-confidence candidates, date of birth as confirmation), accounts (every deposit account in the window, current and former owners from database-maintained ownership history, every account number, the subject's own account numbers), payments (wires, instant payments, ACH transfers and receipts, official checks, check deposits, lockbox and inclearing items, saved counterparties inside the transaction window) and lending (loans and facilities, the credit accounts 31 CFR 1010.505(a) counts as accounts, by candidate borrower or the subject's own account numbers). Each verifies exact planned query authority with compliance using the actual incoming svc_compliance token and existing scopes only. Cuts, decisions and handoffs are immutable, purpose-audited and excluded from general bank/customer discovery; the review view pages evidence items. A search is complete only when every source scanned its whole cut with no declared hole. A complete search with independent decisions on every candidate yields a response_ready handoff of positive evidence, or a no_match_recorded handoff with the exact identifiers, windows, row counts and hashes searched and no reply, because FinCEN instructs no reply without a match. Positives under a declared hole or an unresolved decision are partial_coverage. Passport, licence and other document numbers, which no native customer record retains, are an explicit hole. Nothing transmits: the handoff stays not_transmitted and never submission_ready; the BSA officer reports positives through the FinCEN portal by hand.","operationId":"postTransfersInformationRequestsSearch","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Capture exact confidential transaction and counterparty evidence for an approved request, its candidate set and the subject's own identifiers inside the original transaction window","tags":["Transfer"]}},"/transfers/inter-entity":{"get":{"operationId":"getTransfersInterEntity","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"group_id","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"from","schema":{"type":"string"}},{"in":"query","name":"to","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InterEntityTransfer"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List inter-entity transfers for a group's books: by group, entity, account and date range","tags":["Transfer"]},"post":{"operationId":"postTransfersInterEntity","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterEntityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterEntityTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Move money between two legal entities of one multi-entity group: a book transfer between their accounts recorded with its purpose; both must be members of an active group whose policy lets the initiator act, and the paying account's approval policy applies","tags":["Transfer"]}},"/transfers/inter-entity/{id}":{"get":{"operationId":"getTransfersInterEntityId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterEntityTransfer"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an inter-entity transfer","tags":["Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/international-wire":{"get":{"description":"List international wires, sent and received","operationId":"getTransfersInternationalWire","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SwiftPayment"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all international wires","tags":["International Wire"]},"post":{"description":"Send an international wire from an account: a CBPR+ customer credit transfer (pacs.008) to the creditor's agent, through the simulated international messaging network","operationId":"postTransfersInternationalWire","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an international wire","tags":["International Wire"]}},"/transfers/international-wire/{id}":{"get":{"description":"Read an international wire","operationId":"getTransfersInternationalWireId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an international wire by ID","tags":["International Wire"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/international-wire/{id}/cancellations":{"get":{"operationId":"getTransfersInternationalWireIdCancellations","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SwiftCancellation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The cancellation cases on an international wire, sent and received","tags":["International Wire"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersInternationalWireIdCancellations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftCancellationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftCancellation"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask the next agent to cancel or return an international wire the bank sent (camt.056)","tags":["International Wire"]}},"/transfers/international-wire/{id}/detail":{"get":{"operationId":"getTransfersInternationalWireIdDetail","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPaymentDetail"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read an international wire with every message exchanged about it, its tracking events, cancellation cases and returns","tags":["International Wire"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/international-wire/{id}/returns":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersInternationalWireIdReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftRepair"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose returning a credited international wire the bank received (pacs.004); a second operator approves it in the repair queue","tags":["International Wire"]}},"/transfers/international-wire/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersInternationalWireIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Decide an international wire held for review: sanctions screening, or a bank transfer's second operator","tags":["International Wire"]}},"/transfers/international-wire/{id}/stop":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersInternationalWireIdStop","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/operatorBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Stop an outbound international wire that has not left the bank and release its funds","tags":["International Wire"]}},"/transfers/international-wire/{id}/tracking":{"get":{"operationId":"getTransfersInternationalWireIdTracking","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiftTracker"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Track an international wire: what the bank recorded against its UETR and what the simulated tracker holds, agent by agent","tags":["International Wire"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/realtime":{"post":{"description":"Send a FedNow or RTP credit transfer","operationId":"postTransfersRealtime","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a realtime transfer","tags":["Realtime Transfer"]}},"/transfers/realtime/requests":{"post":{"operationId":"postTransfersRealtimeRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask a payer at another institution to pay the bank's customer (pain.013)","tags":["Realtime Transfer"]}},"/transfers/realtime/{id}":{"get":{"description":"Read an instant payment","operationId":"getTransfersRealtimeId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a realtime transfer by ID","tags":["Realtime Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/realtime/{id}/return-requests":{"get":{"operationId":"getTransfersRealtimeIdReturnRequests","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InstantReturnRequest"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List the return requests on a payment","tags":["Realtime Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRealtimeIdReturnRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestReturnBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask the receiver of a payment the bank sent to return it (camt.056)","tags":["Realtime Transfer"]}},"/transfers/realtime/{id}/returns":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRealtimeIdReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return a payment the bank received (pacs.004 on FedNow, a returning credit transfer on RTP)","tags":["Realtime Transfer"]}},"/transfers/realtime/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRealtimeIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject an instant payment held for review; on one accepted without posting: approve (post, ACCC), reject (RJCT, then the return) or block (BLCK); an optional Idempotency-Key replays the recorded decision","tags":["Realtime Transfer"]}},"/transfers/realtime/{id}/status-request":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRealtimeIdStatusRequest","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantPayment"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask the service what became of a payment the bank sent (pacs.028) and apply the answer","tags":["Realtime Transfer"]}},"/transfers/remote-deposits":{"get":{"description":"List remotely captured items","operationId":"getTransfersRemoteDeposits","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"account_id","schema":{"type":"string"}},{"in":"query","name":"customer_id","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RemoteDeposit"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all remote deposits","tags":["Remote Deposit"]},"post":{"description":"Capture a remotely deposited check: front and back TIFF images, optional amount and payee; the bank reads the MICR line and amounts, refuses a duplicate already in collection, applies the product's remote-deposit limits, and either credits the account as a mobile check under Reg CC or holds the item for maker-checker risk review","operationId":"postTransfersRemoteDeposits","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureRemoteDepositRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDeposit"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a remote deposit","tags":["Remote Deposit"]}},"/transfers/remote-deposits/{id}":{"get":{"description":"Read a remotely captured item","operationId":"getTransfersRemoteDepositsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a remote deposit by ID","tags":["Remote Deposit"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/remote-deposits/{id}/adjustments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRemoteDepositsIdAdjustments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustRemoteDepositRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose or confirm an encoding adjustment of a deposited remote-deposit item. The maker proposes the corrected amount; a second operator holding operations:approve confirms","tags":["Remote Deposit"]}},"/transfers/remote-deposits/{id}/images/{side}":{"get":{"operationId":"getTransfersRemoteDepositsIdImagesSide","responses":{"200":{"content":{"image/tiff":{"schema":{"type":"string"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"A remotely captured item's image (front or back), TIFF","tags":["Remote Deposit"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"side","required":true,"schema":{"type":"string"}}]},"/transfers/remote-deposits/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersRemoteDepositsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewRemoteDepositRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteDeposit"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Propose or confirm a risk-review decision on a remotely captured item: accept (deposit it as a mobile check) or reject. The maker proposes; a second operator holding operations:approve confirms","tags":["Remote Deposit"]}},"/transfers/retirement-receipts/{rail}/{receipt}":{"get":{"description":"Internal: only the accounts service identity with payments:retirement-receipts and no API key. Reads a wire or ACH credit addressed to a protected IRA or HSA, which payments parks on transit GL 2320 instead of posting. claimable is true only while the cash waits there for that reason alone (or for that reason after the sanctions reviewer released a screened credit to it), with no return, operator review or apply under way and no live claim.","operationId":"getTransfersRetirementReceiptsRailReceipt","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementReceipt"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read a wire or ACH credit parked on transit for a protected IRA or HSA, as the accounts service matches it to an inbound custodian transfer","tags":["Transfer"]},"parameters":[{"in":"path","name":"rail","required":true,"schema":{"type":"string"}},{"in":"path","name":"receipt","required":true,"schema":{"type":"string"}}]},"/transfers/retirement-receipts/{rail}/{receipt}/claims":{"parameters":[{"in":"path","name":"rail","required":true,"schema":{"type":"string"}},{"in":"path","name":"receipt","required":true,"schema":{"type":"string"}}],"post":{"description":"Internal accounts service handoff. Takes a claimable receipt for one approved custodian_transfer_in command before its protected journal posts, for the receipt's exact account and amount; replaying the same command's terms returns the live claim. While claimed or applied, operators cannot apply, review or return the receipt.","operationId":"postTransfersRetirementReceiptsRailReceiptClaims","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementClaimRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementReceiptClaim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Take a parked receipt for one approved protected accounts command before it posts","tags":["Transfer"]}},"/transfers/retirement-receipts/{rail}/{receipt}/claims/{claim}/applications":{"parameters":[{"in":"path","name":"rail","required":true,"schema":{"type":"string"}},{"in":"path","name":"receipt","required":true,"schema":{"type":"string"}},{"in":"path","name":"claim","required":true,"schema":{"type":"string"}}],"post":{"description":"Internal accounts service handoff. Records that the committed journal under the claimed command's key debited transit GL 2320 and credited the claimed protected account by exactly the receipt's amount, and marks the wire received or the ACH entry posted with that journal. A missing or different journal refuses.","operationId":"postTransfersRetirementReceiptsRailReceiptClaimsClaimApplications","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementReceiptClaim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Record the committed protected journal that applied a claimed receipt's parked cash","tags":["Transfer"]}},"/transfers/retirement-receipts/{rail}/{receipt}/claims/{claim}/releases":{"parameters":[{"in":"path","name":"rail","required":true,"schema":{"type":"string"}},{"in":"path","name":"receipt","required":true,"schema":{"type":"string"}},{"in":"path","name":"claim","required":true,"schema":{"type":"string"}}],"post":{"description":"Internal accounts service handoff. Hands a claimed receipt back to operations after the accounts service fenced the command's ledger key; refuses when a journal committed under that key. The receipt then returns to its sender through the rail's own return.","operationId":"postTransfersRetirementReceiptsRailReceiptClaimsClaimReleases","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirementReceiptClaim"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hand a claimed receipt back to operations once its command's journal key is fenced with nothing committed","tags":["Transfer"]}},"/transfers/statement-details":{"get":{"operationId":"getTransfersStatementDetails","parameters":[{"in":"query","name":"account_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Detail"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read payment descriptions for customer statements","tags":["Transfer"]}},"/transfers/wire":{"post":{"description":"Send a Fedwire","operationId":"postTransfersWire","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a wire transfer","tags":["Wire Transfer"]}},"/transfers/wire/{id}":{"get":{"description":"Read a wire","operationId":"getTransfersWireId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a wire transfer by ID","tags":["Wire Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/transfers/wire/{id}/apply":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersWireIdApply","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applyWireBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Apply an unapplied inbound wire to an account","tags":["Wire Transfer"]}},"/transfers/wire/{id}/return-requests":{"get":{"operationId":"getTransfersWireIdReturnRequests","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WireReturnRequest"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The return requests on a wire, sent and received","tags":["Wire Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersWireIdReturnRequests","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestReturnBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Ask the receiver of a wire the bank sent to return it (camt.056)","tags":["Wire Transfer"]}},"/transfers/wire/{id}/returns":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersWireIdReturns","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Return an inbound wire to its sender (pacs.004)","tags":["Wire Transfer"]}},"/transfers/wire/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postTransfersWireIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decisionBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wire"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Approve or reject a wire held for review (optional Idempotency-Key replays the recorded decision)","tags":["Wire Transfer"]}},"/transfers/{id}":{"get":{"description":"Read a transfer of any type","operationId":"getTransfersId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferSummary"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a transfer by ID","tags":["Transfer"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/unclaimed-property-reports":{"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Propose a NAUPA standard electronic holder report from registered escheat obligations for an approved unclaimed property recipient. Owner tax identifiers are named by sealed identifier records, never carried in the request. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postUnclaimedPropertyReports","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create an unclaimed property report","tags":["Unclaimed Property Report"]}},"/unclaimed-property-reports/{id}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read a holder report, its independent review, submission, acknowledgments and the state's remittance reference. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getUnclaimedPropertyReportsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an unclaimed property report by ID","tags":["Unclaimed Property Report"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/unclaimed-property-reports/{id}/acknowledgments":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Read, verify and retain the portal's signed acknowledgments of the holder report, including the remittance reference the later payment must carry. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postUnclaimedPropertyReportsIdAcknowledgments","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Read, verify and retain the portal's signed acknowledgments of the holder report","tags":["Unclaimed Property Report"]}},"/unclaimed-property-reports/{id}/review":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write and operations:approve authority is required; the reviewer differs from the maker. Independently review the exact holder report digest. The reviewer differs from the maker. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postUnclaimedPropertyReportsIdReview","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayablesDecisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Independently review the exact holder report digest","tags":["Unclaimed Property Report"]}},"/unclaimed-property-reports/{id}/submissions":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"description":"Fresh verified staff with payments:operations:write authority is required. Hand the approved holder report's exact NAUPA file to the state's portal through the configured adapter. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"postUnclaimedPropertyReportsIdSubmissions","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedPropertyReport"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Hand the approved holder report's exact NAUPA file to the state's portal through the configured adapter","tags":["Unclaimed Property Report"]}},"/unclaimed-property-schedules/{state}":{"get":{"description":"Verified staff/service with payments:read or staff with payments:operations:write authority is required. Read the cited holder report and remittance schedule of a state for a report year. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.","operationId":"getUnclaimedPropertySchedulesState","parameters":[{"in":"query","name":"report_year","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderReportSchedule"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get an unclaimed property schedule by ID","tags":["Unclaimed Property Schedule"]},"parameters":[{"in":"path","name":"state","required":true,"schema":{"type":"string"}}]},"/users":{"post":{"description":"Create a customer login","operationId":"postUsers","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a user","tags":["User"]}},"/users/me":{"get":{"operationId":"getUsersMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"The current user","tags":["User"]}},"/users/me/api-keys":{"get":{"operationId":"getUsersMeApiKeys","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/APIKey"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List API key metadata; secrets are never returned","tags":["User"]},"post":{"operationId":"postUsersMeApiKeys","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedAPIKey"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a scoped API key and return its secret once","tags":["User"]}},"/users/me/api-keys/{id}":{"delete":{"operationId":"deleteUsersMeApiKeysId","responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke an API key; existing access tokens expire within 60 seconds","tags":["User"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/users/me/api-keys/{id}/rotations":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postUsersMeApiKeysIdRotations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedAPIKey"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Atomically revoke an API key and issue its replacement","tags":["User"]}},"/users/me/data-consents":{"get":{"description":"Own active customer session only. Up to 200 retained directions ordered by consent ID, including revocations. Provider and service tokens cannot manage consumer consents.","operationId":"getUsersMeDataConsents","parameters":[{"in":"query","name":"after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Consent"},"type":"array"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List own third-party directions and revocations","tags":["User"]},"post":{"description":"Own active customer session, bank-verified customer binding, customer scope and authentication within five minutes required. Exact current disclosure hash, explicit confirmation, selected fields/purpose/accounts and expiry are retained immutably. Identity proves ownership of every consumer account using a 30-second signer-bound svc_identity token with only accounts:consent:verify. Business permissions or arbitrary account lists are insufficient. A replay may return revoked evidence but never restores authority.","operationId":"postUsersMeDataConsents","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingConsentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consent"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Grant explicit revocable field, purpose, account and time-bounded third-party direction after fresh authentication and ownership proof","tags":["User"]}},"/users/me/data-consents/{consent}/revocations":{"parameters":[{"in":"path","name":"consent","required":true,"schema":{"type":"string"}}],"post":{"description":"Own active customer session and reason required; repeat revocation is harmless. Subsequent token exchange and online checks refuse revoked direction, including already issued tokens. Fresh step-up is not required to stop disclosure.","operationId":"postUsersMeDataConsentsConsentRevocations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenbankingRevocation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consent"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Revoke own consumer direction; outstanding tokens must fail subsequent online data checks","tags":["User"]}},"/users/me/password":{"put":{"operationId":"putUsersMePassword","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Change the password (revokes other sessions)","tags":["User"]}},"/users/me/pin":{"put":{"operationId":"putUsersMePin","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPINRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Set the transaction PIN","tags":["User"]}},"/users/{id}/customer-binding":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postUsersIdCustomerBinding","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerBindingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Bind a login to a verified customer using bank enrolment evidence","tags":["User"]}},"/webhook-deliveries":{"get":{"description":"List webhook deliveries","operationId":"getWebhookDeliveries","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}},{"in":"query","name":"endpoint_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookDelivery"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all webhook deliveries","tags":["Webhook Delivery"]}},"/webhook-deliveries/{id}":{"get":{"operationId":"getWebhookDeliveriesId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a webhook delivery by ID","tags":["Webhook Delivery"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/webhook-deliveries/{id}/evidence":{"get":{"operationId":"getWebhookDeliveriesIdEvidence","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotificationsDeliveryEvidence"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List immutable webhook attempt evidence","tags":["Webhook Delivery"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/webhook-deliveries/{id}/retry":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postWebhookDeliveriesIdRetry","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Retry a webhook delivery now","tags":["Webhook Delivery"]}},"/webhook-endpoints":{"get":{"description":"List webhook endpoints","operationId":"getWebhookEndpoints","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEndpoint"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List all webhook endpoints","tags":["Webhook Endpoint"]},"post":{"description":"Create a webhook endpoint (the secret is returned once)","operationId":"postWebhookEndpoints","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"event_types":{"items":{"type":"string"},"type":"array"},"url":{"type":"string"}},"required":["description","event_types","url"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Create a webhook endpoint","tags":["Webhook Endpoint"]}},"/webhook-endpoints/{id}":{"delete":{"operationId":"deleteWebhookEndpointsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Delete a webhook endpoint","tags":["Webhook Endpoint"]},"get":{"operationId":"getWebhookEndpointsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a webhook endpoint by ID","tags":["Webhook Endpoint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/webhook-endpoints/{id}/rotations":{"get":{"operationId":"getWebhookEndpointsIdRotations","parameters":[{"description":"page size","in":"query","name":"limit","schema":{"default":10,"maximum":100,"type":"integer"}},{"description":"the id of the last item seen; returns the page after it","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"the id of the first item seen; returns the page before it","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookRotation"},"type":"array"},"has_more":{"description":"whether another page follows","type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"A page, newest first"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"List signing-secret rotation evidence","tags":["Webhook Endpoint"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postWebhookEndpointsIdRotations","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotationBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Rotate the signing secret with an overlap during which both secrets sign (the new secret is returned once)","tags":["Webhook Endpoint"]}},"/webhooks/alloy":{"post":{"description":"Alloy's journey decision webhook. The body is signed with base64(HMAC-SHA256(webhook secret, raw body)) in the Authorization header, with no bank token, and its envelope timestamp must be fresh. A verified event only names the journey application: compliance reads the decision back from Alloy and applies it through the KYC path, so nothing in the body sets a status. Each request_token is handled once across replicas (a replay answers duplicate with the recorded outcome and kyc_check_id); an event that cannot change the decision is ignored. The gateway routes the path to compliance.","operationId":"postWebhooksAlloy","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlloyWebhookEvent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlloyWebhookAck"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"security":[],"summary":"Receive an Alloy journey decision","tags":["KYC Provider Webhook"]}},"/wire-return-requests/{id}":{"get":{"description":"Read a wire return request","operationId":"getWireReturnRequestsId","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Get a wire return request by ID","tags":["Wire Return Request"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/wire-return-requests/{id}/respond":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"post":{"operationId":"postWireReturnRequestsIdRespond","parameters":[{"description":"Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RespondBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireReturnRequest"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"409":{"$ref":"#/components/responses/Problem"},"412":{"$ref":"#/components/responses/Problem"},"413":{"$ref":"#/components/responses/Problem"},"422":{"$ref":"#/components/responses/Problem"},"424":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"500":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"summary":"Honour or refuse a return request another participant sent (camt.029, and the return itself when honoured)","tags":["Wire Return Request"]}}},"components":{"responses":{"Problem":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"RFC 9457 problem details with a stable, namespaced code"}},"schemas":{"ACHSettlementEvidence":{"description":"ACHSettlementEvidence binds the immutable financial posting date to the original file and the acknowledgment actually used. Adapter acknowledgment is explicitly weaker than a signed connectivity-bridge settlement assertion.","properties":{"confirmed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"confirmed_by":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence":{"additionalProperties":true,"type":"object"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rail_reference":{"type":"string"},"sha256":{"type":"string"}},"required":["confirmed_by","content_sha256","created_at","evidence","file_id","kind","posting_date","rail_reference","sha256"],"type":"object"},"ACHStop":{"properties":{"company_id":{"type":"string"},"company_name":{"type":"string"},"individual_id":{"type":"string"},"received_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"revoked":{"type":"boolean"},"scheduled_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"timely":{"type":"boolean"}},"required":["received_on","revoked","scheduled_on","timely"],"type":"object"},"APIKey":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"last_used_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"name":{"type":"string"},"revoked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"scopes":{"items":{"type":"string"},"type":"array"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_ids","created_at","expires_at","id","name","scopes","user_id"],"type":"object"},"APIKeyRequest":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"expires_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"}},"required":["account_ids","expires_at","name","scopes"],"type":"object"},"APIKeyTokenRequest":{"properties":{"key_id":{"type":"string"},"secret":{"type":"string"}},"required":["key_id","secret"],"type":"object"},"AbuseReport":{"description":"AbuseReport is a closed-for-cause deposit-account report.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"item_id":{"type":"string"},"reason":{"type":"string"},"unpaid_amount":{"format":"int64","type":"integer"}},"required":["account_id","created_at","customer_id","id","idempotency_key","item_id","reason"],"type":"object"},"AbuseReportRequest":{"description":"AbuseReportRequest furnishes a closed-for-cause deposit account.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"unpaid_amount":{"format":"int64","type":"integer"}},"required":["account_id","customer_id","reason"],"type":"object"},"AccessDecision":{"properties":{"allowed":{"type":"boolean"}},"required":["allowed"],"type":"object"},"AccessRequest":{"properties":{"attachment_sha256":{"description":"AttachmentSHA256 names the exact support document digest, required exactly\nwhen the response carries it: its review access, and the submission release\nof a batch that names it.","type":"string"},"content_sha256":{"type":"string"},"document":{"description":"batch, sources, validation, transmission, response, attachment","type":"string"},"purpose":{"description":"review or submission; submission only for the batch","type":"string"},"reason":{"type":"string"}},"required":["content_sha256","document","purpose","reason"],"type":"object"},"Account":{"description":"Account is one securities account on a Reserve Bank's books: the participant's primary routing number and the account's name. A restricted account names the secured party whose interest the Reserve Bank marks (4.5.2).","properties":{"aba":{"type":"string"},"name":{"type":"string"},"restricted":{"type":"boolean"},"secured_party":{"description":"discount_window, fhlb, public_funds, ...","type":"string"}},"required":["aba","name","restricted"],"type":"object"},"AccountBalance":{"description":"AccountBalance is one account with its balances.","properties":{"balances":{"$ref":"#/components/schemas/Balances"},"certificate":{"oneOf":[{"$ref":"#/components/schemas/CertificateTerms"},{"type":"null"}]},"closed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"default_account_number":{"type":"string"},"default_account_number_id":{"example":"acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"interest_plan":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"now_eligibility_id":{"type":"string"},"opened_at":{"format":"date-time","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"$ref":"#/components/schemas/Ownership"},"ownership_recorded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"ownership_revision":{"description":"zero means unknown legacy chronology","format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"routing_number":{"type":"string"},"statement_cycle":{"type":"string"},"status":{"type":"string"},"status_reason":{"type":"string"},"type":{"type":"string"}},"required":["balances","currency_code","customer_id","default_account_number","default_account_number_id","description","id","interest_plan","ledger_account_id","opened_at","owners","ownership","product_code","product_version","routing_number","statement_cycle","status","type"],"type":"object"},"AccountClosure":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"closing_fee_amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"interest_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"official_check_id":{"type":"string"},"payout_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_amount":{"format":"int64","type":"integer"},"payout_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_method":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"remittance_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"remitted_amount":{"format":"int64","type":"integer"},"rounding_adjustment":{"type":"string"},"withheld_amount":{"format":"int64","type":"integer"},"withholding_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","actor","closing_fee_amount","date","interest_amount","payout_account_id","payout_amount","payout_method","principal_amount","reason","remitted_amount","rounding_adjustment","withheld_amount"],"type":"object"},"AccountNumber":{"description":"AccountNumber routes payments to an account.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_number":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"example":"acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"is_default":{"type":"boolean"},"routing_number":{"type":"string"},"status":{"type":"string"}},"required":["account_id","account_number","created_at","description","id","is_default","routing_number","status"],"type":"object"},"AccountOwner":{"properties":{"backfilled":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"from":{"format":"date-time","type":"string"},"role":{"type":"string"},"to":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["customer_id","from","role"],"type":"object"},"AccountReadiness":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"blockers":{"items":{"type":"string"},"type":"array"},"placement_ids":{"items":{"type":"string"},"type":"array"},"ready":{"type":"boolean"},"sweep_mandate_ids":{"items":{"type":"string"},"type":"array"}},"required":["account_id","blockers","placement_ids","ready"],"type":"object"},"AccountReconciliation":{"description":"AccountReconciliation is a business customer's account reconciliation file for a period.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"exceptions":{"items":{"$ref":"#/components/schemas/InclearingItem"},"type":"array"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"generated_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"outstanding":{"items":{"$ref":"#/components/schemas/PositivePayIssue"},"type":"array"},"paid":{"items":{"$ref":"#/components/schemas/InclearingItem"},"type":"array"},"period":{"type":"string"},"returned":{"items":{"$ref":"#/components/schemas/InclearingItem"},"type":"array"},"stop_payments":{"items":{"$ref":"#/components/schemas/StopPayment"},"type":"array"},"to":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"totals":{"$ref":"#/components/schemas/ReconciliationTotals"},"voided":{"items":{"$ref":"#/components/schemas/PositivePayIssue"},"type":"array"}},"required":["account_id","exceptions","from","generated_on","outstanding","paid","period","returned","stop_payments","to","totals","voided"],"type":"object"},"AccountUSDEquivalent":{"description":"AccountUSDEquivalent is one account's closing posted balance on a date and its USD equivalent at that date's approved closing rate, rounded once: the bank's own figure for reporting. It is not the FDIC's insurance determination, which 12 CFR 330.3(c) makes in USD as of close of business on the date of default at the Federal Reserve Bank of New York's noon buying rates unless the deposit agreement names other widely recognized rates.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_rate_sheet_id":{"type":"string"},"currency_code":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posted_amount":{"format":"int64","type":"integer"},"usd_equivalent_amount":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["business_date","currency_code","ledger_account_id","posted_amount","usd_equivalent_amount","usd_per_foreign_major"],"type":"object"},"AccountingInputs":{"description":"AccountingInputs are explicit controller-supplied assessments, not inferred tax rates or a tax engine. Deferred tax effects are allocated separately to this lot's AFS OCI and earnings; current income tax is a separate tax source.","properties":{"credit_allowance_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"credit_evidence":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"earnings_deferred_tax_asset_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"earnings_deferred_tax_liability_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"earnings_tax_valuation_allowance_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"intent_to_sell":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"oci_deferred_tax_asset_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"oci_deferred_tax_liability_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"oci_tax_valuation_allowance_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"required_to_sell_before_recovery":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"tax_basis_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"tax_evidence":{"$ref":"#/components/schemas/BanksecuritiesEvidence"}},"required":["credit_evidence","tax_evidence"],"type":"object"},"AccountingPlan":{"properties":{"correction_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence_sha256":{"type":"string"},"journal":{"$ref":"#/components/schemas/Journal"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"supersedes_sha256":{"type":"string"}},"required":["created_at","evidence_sha256","journal","journal_key","journal_sha256"],"type":"object"},"AccountingPolicy":{"properties":{"accounting_evidence":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"accrual_convention":{"type":"string"},"acquisition_fees":{"description":"capitalize_direct_acquisition_fees","type":"string"},"cash_rounding":{"description":"half_up_cent","type":"string"},"classification":{"description":"AFS","type":"string"},"credit_evidence":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"credit_method":{"description":"reviewed_afs_credit_assessment","type":"string"},"recognition":{"description":"trade_date","type":"string"},"tax_evidence":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"tax_method":{"description":"reviewed_external_tax_amounts","type":"string"}},"required":["accounting_evidence","accrual_convention","acquisition_fees","cash_rounding","classification","credit_evidence","credit_method","recognition","tax_evidence","tax_method"],"type":"object"},"AccountsAccount":{"description":"Account as the service returns it: one balance, one product, one or more owners and numbers.","properties":{"certificate":{"oneOf":[{"$ref":"#/components/schemas/CertificateTerms"},{"type":"null"}]},"closed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"default_account_number":{"type":"string"},"default_account_number_id":{"example":"acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"interest_plan":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"now_eligibility_id":{"type":"string"},"opened_at":{"format":"date-time","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"$ref":"#/components/schemas/Ownership"},"ownership_recorded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"ownership_revision":{"description":"zero means unknown legacy chronology","format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"routing_number":{"type":"string"},"statement_cycle":{"type":"string"},"status":{"type":"string"},"status_reason":{"type":"string"},"type":{"type":"string"}},"required":["currency_code","customer_id","default_account_number","default_account_number_id","description","id","interest_plan","ledger_account_id","opened_at","owners","ownership","product_code","product_version","routing_number","statement_cycle","status","type"],"type":"object"},"AccountsCreditRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"availability":{"type":"string"},"channel":{"description":"branch (in person), mobile, atm (proprietary) or lockbox; required for special next-day check classes","type":"string"},"currency_code":{"type":"string"},"description":{"type":"string"},"source_ref":{"type":"string"}},"required":["amount","currency_code","description","source_ref"],"type":"object"},"AccrualSchedule":{"properties":{"convention":{"type":"string"},"cost_amount":{"format":"int64","type":"integer"},"face_amount":{"format":"int64","type":"integer"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["convention","cost_amount","face_amount","maturity_date","start_date"],"type":"object"},"AcknowledgeRequest":{"description":"AcknowledgeRequest records that treasury has seen an alert and what it is doing about it.","properties":{"note":{"type":"string"}},"required":["note"],"type":"object"},"Acknowledgment":{"description":"Acknowledgment is one signed agency outcome for a submission.","properties":{"agency":{"type":"string"},"agency_reference":{"type":"string"},"amount_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"environment":{"type":"string"},"event_id":{"type":"string"},"fields":{"additionalProperties":{"type":"string"},"type":"object"},"key_id":{"type":"string"},"kind":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"reasons":{"items":{"type":"string"},"type":"array"},"signature":{"type":"string"},"submission_reference":{"type":"string"},"version":{"type":"string"}},"required":["agency","amount_minor","content_sha256","environment","event_id","key_id","kind","occurred_at","signature","submission_reference","version"],"type":"object"},"AcknowledgmentError":{"properties":{"code":{"type":"string"},"context":{"type":"string"},"element":{"type":"string"},"level":{"type":"string"},"sequence":{"format":"int64","type":"integer"},"text":{"type":"string"}},"required":["sequence"],"type":"object"},"Action":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"preservation":{"items":{"$ref":"#/components/schemas/Propagation"},"type":"array"},"request":{"$ref":"#/components/schemas/ActionRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"},"version_disposition":{"description":"VersionDisposition is the source's receipt for an approved dispose_versions control; until\nit is recorded the approved control is still to be propagated.","oneOf":[{"$ref":"#/components/schemas/VersionDisposition"},{"type":"null"}]}},"required":["actor","created_at","id","preservation","request","status","version"],"type":"object"},"ActionPage":{"properties":{"complete":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/Action"},"type":"array"},"next_cursor":{"type":"string"}},"required":["complete","items","next_cursor"],"type":"object"},"ActionRequest":{"properties":{"bank_wide":{"type":"boolean"},"category":{"type":"string"},"event_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"matter_ref":{"type":"string"},"reason":{"type":"string"},"record_id":{"type":"string"},"target":{"$ref":"#/components/schemas/Target"},"through":{"description":"Through bounds a dispose_versions control: the source removes its retained row versions\nsuperseded on or before this time, once the control is independently approved and no\narchive hold covers the source.","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["bank_wide","evidence_ref","evidence_sha256","kind","matter_ref","reason","target"],"type":"object"},"Activation":{"properties":{"activated_at":{"format":"date-time","type":"string"},"instruction_sha256":{"type":"string"},"pin":{"oneOf":[{"$ref":"#/components/schemas/JournalSourcePin"},{"type":"null"}]},"state":{"$ref":"#/components/schemas/State"}},"required":["activated_at","instruction_sha256","state"],"type":"object"},"ActiveClosePlan":{"properties":{"checker":{"type":"string"},"maker":{"type":"string"},"plan":{"$ref":"#/components/schemas/ClosePlan"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["checker","maker","plan","request_id"],"type":"object"},"Activity":{"properties":{"amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"payee":{"type":"string"},"purpose":{"type":"string"},"reference":{"type":"string"}},"required":["amount","date","payee","purpose","reference"],"type":"object"},"ActivityAcknowledgment":{"properties":{"bsa_id":{"type":"string"},"sequence":{"format":"int64","type":"integer"},"warnings":{"items":{"$ref":"#/components/schemas/AcknowledgmentError"},"type":"array"}},"required":["bsa_id","sequence","warnings"],"type":"object"},"ActivityLine":{"description":"ActivityLine is one debit or credit of securities to the account on the statement's day, with the funds leg when it was against payment.","properties":{"counterparty":{"type":"string"},"cusip":{"type":"string"},"direction":{"description":"credit (securities in) or debit (securities out)","type":"string"},"operator_reference":{"type":"string"},"par_amount":{"format":"int64","type":"integer"},"payment_amount":{"format":"int64","type":"integer"},"type_code":{"type":"string"}},"required":["counterparty","cusip","direction","operator_reference","par_amount","payment_amount","type_code"],"type":"object"},"ActivityManifest":{"properties":{"attachment":{"description":"SARX only: the named single CSV support document","type":"string"},"filing_date":{"type":"string"},"prior_bsa_id":{"type":"string"},"report_kind":{"type":"string"},"sequence":{"format":"int64","type":"integer"}},"required":["filing_date","report_kind","sequence"],"type":"object"},"Address":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"AdjustRemoteDepositRequest":{"description":"AdjustRemoteDepositRequest records an encoding adjustment after the item was deposited.","properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"reason":{"type":"string"}},"required":["amount","reason"],"type":"object"},"Adjustment":{"properties":{"amount":{"format":"int64","type":"integer"},"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"direction":{"type":"string"}},"required":["amount","assessment_id","direction"],"type":"object"},"AdjustmentRequest":{"properties":{"kind":{"type":"string"}},"required":["kind"],"type":"object"},"Admission":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"observation":{"$ref":"#/components/schemas/RegistryObservation"}},"required":["customer_id","observation"],"type":"object"},"AdvanceConfirmation":{"description":"AdvanceConfirmation is the lender's answer to an advance request: made, with the terms it was made on, or declined with the reason.","properties":{"advance_number":{"type":"string"},"available_amount":{"description":"the collateral value available before the advance","format":"int64","type":"integer"},"day_count_basis":{"description":"actual/365 or actual/360","type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"program":{"type":"string"},"rate_bps":{"format":"int64","type":"integer"},"reason":{"type":"string"},"reference":{"type":"string"},"status":{"description":"made or declined","type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["available_amount","day_count_basis","maturity_date","principal_amount","program","rate_bps","reference","status","value_date"],"type":"object"},"AdvanceRequest":{"description":"AdvanceRequest asks the lender for an advance.","properties":{"borrower":{"type":"string"},"lender":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"program":{"description":"primary_credit, secondary_credit; fixed_rate, overnight","type":"string"},"reference":{"description":"the bank's reference; a resend returns the original answer","type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"type":"string"}},"required":["borrower","lender","maturity_date","principal_amount","program","reference","value_date","version"],"type":"object"},"AffiliatesExposure":{"description":"Exposure is a current source-system obligation view. AccruedInterestMinor rounds a positive fraction of a cent up for conservative collateral coverage.","properties":{"accrued_interest_exact":{"type":"string"},"accrued_interest_minor":{"format":"int64","type":"integer"},"accrued_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"credit":{"$ref":"#/components/schemas/CreditRequest"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"destination_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"fees_due_minor":{"format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"principal_outstanding_minor":{"format":"int64","type":"integer"},"source_sha256":{"type":"string"},"source_updated_at":{"format":"date-time","type":"string"},"status":{"type":"string"},"undrawn_obligated_minor":{"format":"int64","type":"integer"}},"required":["accrued_interest_exact","accrued_interest_minor","accrued_through","as_of","credit","customer_id","destination_account_id","fees_due_minor","ledger_account_id","loan_id","principal_outstanding_minor","source_sha256","source_updated_at","status","undrawn_obligated_minor"],"type":"object"},"AgencyAcknowledgment":{"description":"AgencyAcknowledgment is a verified, retained agency acknowledgment.","properties":{"document":{"$ref":"#/components/schemas/Acknowledgment"},"id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"submission_id":{"type":"string"}},"required":["document","id","recorded_at","recorded_by","submission_id"],"type":"object"},"AgencyAddress":{"description":"Address is a mailing address.","properties":{"city":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"name":{"type":"string"},"postal":{"type":"string"},"state":{"type":"string"}},"required":["city","line1","name","postal","state"],"type":"object"},"AgencyReconciliation":{"description":"AgencyReconciliation ties one remittance's payable sources, its issued instruction and transmitted message, the native ledger's cash receipts and the agency's acknowledgments. It is matched only when every source allocation is settled in cash, the message carries exactly that amount, the agency confirmed exactly that amount and nothing was returned or refused.","properties":{"acknowledgments":{"items":{"type":"string"},"type":"array"},"actor":{"type":"string"},"agency_references":{"items":{"type":"string"},"type":"array"},"cash_ready":{"type":"boolean"},"confirmed_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"differences":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"instruction_minor":{"format":"int64","type":"integer"},"message_minor":{"format":"int64","type":"integer"},"protocol":{"type":"string"},"receipt_event_ids":{"items":{"type":"string"},"type":"array"},"remittance_id":{"type":"string"},"returned_minor":{"format":"int64","type":"integer"},"settled_minor":{"format":"int64","type":"integer"},"sources":{"items":{"$ref":"#/components/schemas/ReconciledSource"},"type":"array"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["acknowledgments","actor","agency_references","cash_ready","confirmed_minor","content_sha256","created_at","differences","id","instruction_minor","message_minor","protocol","receipt_event_ids","remittance_id","returned_minor","settled_minor","sources","status","version"],"type":"object"},"AgencyRemittance":{"description":"AgencyRemittance is the agency view of a payable remittance.","properties":{"acknowledgments":{"items":{"$ref":"#/components/schemas/AgencyAcknowledgment"},"type":"array"},"agency":{"type":"string"},"ledger_view_sha256":{"type":"string"},"protocol":{"type":"string"},"reconciliation":{"oneOf":[{"$ref":"#/components/schemas/AgencyReconciliation"},{"type":"null"}]},"remittance":{"$ref":"#/components/schemas/Remittance"},"submissions":{"items":{"$ref":"#/components/schemas/AgencySubmission"},"type":"array"},"transmitted_sha256":{"type":"string"}},"required":["acknowledgments","agency","protocol","remittance","submissions"],"type":"object"},"AgencySubmission":{"description":"AgencySubmission is one hand-off to the agency adapter and, once the carrier answered, its receipt. A receipt is not an agency decision.","properties":{"actor":{"type":"string"},"adapter":{"type":"string"},"agency":{"type":"string"},"attributes":{"additionalProperties":{"type":"string"},"type":"object"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/SubmissionReceipt"},{"type":"null"}]},"subject_id":{"type":"string"},"subject_kind":{"type":"string"}},"required":["actor","adapter","agency","attributes","content_sha256","created_at","id","kind","subject_id","subject_kind"],"type":"object"},"AgencyTerms":{"description":"AgencyTerms are the reviewed agency-specific terms of a recipient; exactly the one matching the recipient's protocol is set. Sensitive identifiers (an obligor's SSN, a levied taxpayer's TIN) are never part of the terms: the terms name a sealed identifier record held by the payments service and its last four digits.","properties":{"child_support":{"oneOf":[{"$ref":"#/components/schemas/ChildSupportTerms"},{"type":"null"}]},"levy":{"oneOf":[{"$ref":"#/components/schemas/LevyTerms"},{"type":"null"}]},"tax_deposit":{"oneOf":[{"$ref":"#/components/schemas/TaxDepositTerms"},{"type":"null"}]},"unclaimed_property":{"oneOf":[{"$ref":"#/components/schemas/UnclaimedPropertyTerms"},{"type":"null"}]}},"type":"object"},"Alert":{"properties":{"detail":{"type":"string"},"id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"pending_by":{"type":"string"},"pending_status":{"description":"a cleared or sar_filed decision awaiting a second person","type":"string"},"rule":{"type":"string"},"severity":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string"}},"required":["detail","id","rule","severity","status","subject"],"type":"object"},"Allocation":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"obligation_id":{"type":"string"},"source_sha256":{"type":"string"}},"required":["amount_minor","obligation_id","source_sha256"],"type":"object"},"AllocationRequest":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"obligation_id":{"type":"string"}},"required":["amount_minor","obligation_id"],"type":"object"},"Allowance":{"description":"Allowance is the expected-loss rate table of a loan product (the CECL loss-rate method): a rate for current loans and one per delinquency bucket, in basis points of the outstanding principal. The rates are the model; changing them is a reviewed product version.","properties":{"30_59_bps":{"format":"int64","type":"integer"},"60_89_bps":{"format":"int64","type":"integer"},"90_plus_bps":{"format":"int64","type":"integer"},"current_bps":{"format":"int64","type":"integer"},"nonaccrual_bps":{"format":"int64","type":"integer"}},"required":["30_59_bps","60_89_bps","90_plus_bps","current_bps","nonaccrual_bps"],"type":"object"},"AllowanceRun":{"description":"AllowanceRun is one computation of the allowance for credit losses (a loss-rate method by product and delinquency status) and the provision that brought the ledger to it.","properties":{"business_date":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"funded_previous_amount":{"format":"int64","type":"integer"},"funded_provision_amount":{"format":"int64","type":"integer"},"funded_required_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"model_execution_id":{"type":"string"},"previous_amount":{"format":"int64","type":"integer"},"provision_amount":{"description":"negative releases allowance","format":"int64","type":"integer"},"required_amount":{"format":"int64","type":"integer"},"segments":{"items":{"$ref":"#/components/schemas/AllowanceSegment"},"type":"array"},"unfunded_previous_amount":{"format":"int64","type":"integer"},"unfunded_provision_amount":{"format":"int64","type":"integer"},"unfunded_required_amount":{"format":"int64","type":"integer"}},"required":["business_date","created_at","id","previous_amount","provision_amount","required_amount","segments"],"type":"object"},"AllowanceSegment":{"description":"AllowanceSegment is one product's share of the allowance for one status and bucket.","properties":{"bucket":{"type":"string"},"loans":{"format":"int64","type":"integer"},"model_group_id":{"type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"rate_bps":{"format":"int64","type":"integer"},"required_amount":{"format":"int64","type":"integer"},"status":{"description":"accruing or nonaccrual","type":"string"}},"required":["bucket","loans","outstanding_amount","product_code","rate_bps","required_amount","status"],"type":"object"},"AlloyWebhookAck":{"description":"AlloyWebhookAck is the answer to Alloy: applied, pending, already_decided, duplicate or ignored.","properties":{"kyc_check":{"oneOf":[{"$ref":"#/components/schemas/KYCCheck"},{"type":"null"}]},"kyc_check_id":{"description":"a duplicate's recorded check","example":"kycc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"outcome":{"description":"a duplicate's recorded outcome","type":"string"},"status":{"type":"string"}},"required":["status"],"type":"object"},"AlloyWebhookData":{"description":"AlloyWebhookData is the journey event Alloy's envelope carries.","properties":{"entity_token":{"type":"string"},"external_entity_id":{"description":"the customer id the bank sent","type":"string"},"journey_application_token":{"type":"string"},"journey_token":{"type":"string"},"timestamp":{"format":"int64","type":"integer"},"type":{"type":"string"}},"required":["entity_token","external_entity_id","journey_application_token","journey_token","timestamp","type"],"type":"object"},"AlloyWebhookEvent":{"description":"AlloyWebhookEvent is Alloy's signed webhook envelope; nothing in it is trusted before the signature holds, and it only points at the journey application.","properties":{"data":{"$ref":"#/components/schemas/AlloyWebhookData"},"request_token":{"description":"handled once across replicas","type":"string"},"timestamp":{"description":"covered by the signature; judges freshness","format":"int64","type":"integer"},"type":{"type":"string"}},"required":["data","request_token","timestamp","type"],"type":"object"},"AlmEvidence":{"description":"Evidence binds externally prepared inputs and assumptions to retained documentation.","properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"AlmPosition":{"description":"Position represents an evidenced part of one GL carrying balance. Simple fixed/floating/nonmaturity instruments are generated from contractual principal schedules. Unsupported instruments use fully evidenced imported monthly flows. Cash has zero principal flows (already in opening liquidity/EVE); its future interest must be explicitly imported, including an explicit all-zero path.","properties":{"annual_coupon_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"assumption_key":{"type":"string"},"base_flows":{"items":{"$ref":"#/components/schemas/CashFlow"},"type":"array"},"cap_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"contractual_principal":{"items":{"format":"int64","type":"integer"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"floor_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"gl_code":{"type":"string"},"id":{"type":"string"},"kind":{"description":"fixed, floating, nonmaturity, imported, cash","type":"string"},"maturity_month":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"side":{"type":"string"},"spread_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"stress_flows":{"items":{"$ref":"#/components/schemas/CashFlow"},"type":"array"}},"required":["assumption_key","evidence","gl_code","id","kind","maturity_month","principal_amount","side"],"type":"object"},"AlmRecord":{"properties":{"capital_policy":{"oneOf":[{"$ref":"#/components/schemas/CapitalPolicy"},{"type":"null"}]},"capital_run":{"oneOf":[{"$ref":"#/components/schemas/CapitalRun"},{"type":"null"}]},"content_sha256":{"type":"string"},"contingency_run":{"oneOf":[{"$ref":"#/components/schemas/ContingencyRun"},{"type":"null"}]},"contingency_scenario":{"description":"Contingency funding records are omitted from every other kind, so earlier digests hold.","oneOf":[{"$ref":"#/components/schemas/ContingencyScenario"},{"type":"null"}]},"id":{"type":"string"},"insurance_policy":{"oneOf":[{"$ref":"#/components/schemas/InsurancePolicy"},{"type":"null"}]},"insurance_run":{"oneOf":[{"$ref":"#/components/schemas/InsuranceRun"},{"type":"null"}]},"kind":{"description":"exactly one corresponding payload exists","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/Review"},{"type":"null"}]},"run":{"oneOf":[{"$ref":"#/components/schemas/Run"},{"type":"null"}]},"scenario":{"oneOf":[{"$ref":"#/components/schemas/Scenario"},{"type":"null"}]}},"required":["content_sha256","id","kind","proposed_at","proposed_by"],"type":"object"},"AlmReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"rationale":{"type":"string"}},"required":["content_sha256","decision","evidence","rationale"],"type":"object"},"AlmSource":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ledger_sha256":{"type":"string"},"positions":{"items":{"$ref":"#/components/schemas/GLSource"},"type":"array"},"sha256":{"type":"string"},"sync_id":{"format":"int64","type":"integer"}},"required":["as_of","ledger_sha256","positions","sha256","sync_id"],"type":"object"},"Analysis":{"description":"Analysis is account analysis for business checking: an earnings credit on the average collected balance offsets the cycle's maintenance and per-item fees.","properties":{"earnings_credit_bps":{"format":"int64","type":"integer"},"per_item_fee_minor":{"format":"int64","type":"integer"}},"required":["earnings_credit_bps","per_item_fee_minor"],"type":"object"},"AnalysisRequest":{"properties":{"input":{"$ref":"#/components/schemas/Input"},"kind":{"type":"string"},"payment_effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"resolution":{"$ref":"#/components/schemas/EscrowResolution"},"variance_explanation":{"type":"string"}},"required":["input","kind","payment_effective_date","resolution"],"type":"object"},"AnalysisStatement":{"description":"AnalysisStatement is a business checking account's cycle analysis.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"average_collected_amount":{"format":"int64","type":"integer"},"days":{"format":"int64","type":"integer"},"earnings_credit_amount":{"format":"int64","type":"integer"},"earnings_credit_bps":{"format":"int64","type":"integer"},"item_count":{"format":"int64","type":"integer"},"item_fees_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maintenance_fee_amount":{"format":"int64","type":"integer"},"net_fee_amount":{"format":"int64","type":"integer"},"per_item_fee_amount":{"format":"int64","type":"integer"},"period":{"type":"string"},"status":{"type":"string"},"total_fees_amount":{"format":"int64","type":"integer"}},"required":["account_id","average_collected_amount","days","earnings_credit_amount","earnings_credit_bps","item_count","item_fees_amount","maintenance_fee_amount","net_fee_amount","per_item_fee_amount","period","status","total_fees_amount"],"type":"object"},"AnnualPosition":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"as_of_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cut_id":{"type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"fmv_minor":{"format":"int64","type":"integer"},"id":{"type":"string"},"ira_type":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/AnnualPositionRequest"},"source_period":{"type":"string"},"source_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"},"wrapper":{"type":"string"}},"required":["account_id","as_of_date","customer_id","cut_id","fmv_minor","id","ledger_account_id","ownership_revision","proposed_at","proposed_by","request","source_period","source_through","status","version","wrapper"],"type":"object"},"AnnualPositionRequest":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"reason":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["evidence_ref","evidence_sha256","expected_version","reason","tax_year"],"type":"object"},"Application":{"properties":{"credit_score":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disbursement_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"escrow_monthly_amount":{"format":"int64","type":"integer"},"guarantee":{"oneOf":[{"$ref":"#/components/schemas/LendingGuarantee"},{"type":"null"}]},"monthly_debt_amount":{"format":"int64","type":"integer"},"monthly_income_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"purpose":{"type":"string"},"syndicate":{"oneOf":[{"$ref":"#/components/schemas/Syndicate"},{"type":"null"}]},"term_months":{"format":"int64","type":"integer"}},"required":["credit_score","customer_id","disbursement_account_id","monthly_debt_amount","monthly_income_amount","principal_amount","product_code","term_months"],"type":"object"},"ApplyRequest":{"description":"ApplyRequest applies an exact approved proposal.","properties":{"content_sha256":{"type":"string"}},"required":["content_sha256"],"type":"object"},"ApprovalDecision":{"description":"ApprovalDecision is one approver's answer.","properties":{"at":{"format":"date-time","type":"string"},"by":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["at","by","decision"],"type":"object"},"ApprovalDecisionBody":{"description":"ApprovalDecisionBody approves or rejects a payment.","properties":{"by":{"type":"string"},"note":{"type":"string"}},"required":["by"],"type":"object"},"ApprovalPolicy":{"description":"ApprovalPolicy is an account's approval policy.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"approvers_required":{"format":"int64","type":"integer"},"enabled":{"type":"boolean"},"expires_hours":{"format":"int64","type":"integer"},"self_approval":{"type":"boolean"},"threshold_amount":{"format":"int64","type":"integer"},"tiers":{"items":{"$ref":"#/components/schemas/ApprovalTier"},"type":"array"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"type":"string"}},"required":["account_id","approvers_required","enabled","expires_hours","self_approval","threshold_amount","updated_at","updated_by"],"type":"object"},"ApprovalPolicyRequest":{"description":"ApprovalPolicyRequest sets what an account requires before a payment leaves.","properties":{"approvers_required":{"description":"1 (default) to 3","format":"int64","type":"integer"},"enabled":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"expires_hours":{"description":"72 by default","format":"int64","type":"integer"},"self_approval":{"description":"whether the requester may approve","type":"boolean"},"threshold_amount":{"description":"payments at or above wait for approval; 0 is every payment","format":"int64","type":"integer"},"tiers":{"items":{"$ref":"#/components/schemas/ApprovalTier"},"type":"array"}},"required":["self_approval","threshold_amount"],"type":"object"},"ApprovalTier":{"properties":{"approvers_required":{"format":"int64","type":"integer"},"threshold_amount":{"format":"int64","type":"integer"}},"required":["approvers_required","threshold_amount"],"type":"object"},"ArmoredcarrierCarrierReceipt":{"description":"CarrierReceipt is the carrier module's acknowledgement of an order.","properties":{"accepted_at":{"format":"date-time","type":"string"},"reference":{"type":"string"}},"required":["accepted_at","reference"],"type":"object"},"ArmoredcarrierReplenishmentOrder":{"description":"ReplenishmentOrder is what the ATM switch hands the armored carrier module.","properties":{"amount":{"format":"int64","type":"integer"},"cash_unit_id":{"type":"string"},"id":{"type":"string"},"location":{"type":"string"},"needed_by":{"format":"date-time","type":"string"},"notes":{"additionalProperties":{"format":"int64","type":"integer"},"description":"requested notes by denomination in cents","type":"object"},"reason":{"description":"low_cash, out_of_cash, manual","type":"string"},"terminal_id":{"type":"string"},"terminal_ref":{"type":"string"}},"required":["amount","cash_unit_id","id","location","needed_by","notes","reason","terminal_id","terminal_ref"],"type":"object"},"Artifact":{"properties":{"receipt":{"$ref":"#/components/schemas/FilingsReceipt"},"recorded_at":{"format":"date-time","type":"string"},"verified_public_key":{"type":"string"}},"required":["receipt","recorded_at","verified_public_key"],"type":"object"},"AssessedFee":{"description":"AssessedFee is the retained fee the correction acts on.","properties":{"amount_minor":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_ref":{"type":"string"}},"required":["amount_minor","currency_code","effective_date","journal_id","ledger_account_id","source_ref"],"type":"object"},"Assessment":{"properties":{"amount":{"format":"int64","type":"integer"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"invoice_reference":{"type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"unit_change_id":{"type":"string"}},"required":["amount","due_date","invoice_reference","period_end","period_start","unit_change_id"],"type":"object"},"AssetDigest":{"properties":{"bytes":{"format":"int64","type":"integer"},"name":{"type":"string"},"sha256":{"type":"string"},"source":{"type":"string"}},"required":["bytes","name","sha256"],"type":"object"},"Assumption":{"description":"Assumption rates are per month, not annual CPR. Each zero must be explicit. Runoff applies to nonmaturity liabilities; prepayment to amortizing assets. InflowHaircutBPS is an unrecovered reduction to stressed asset receipts only.","properties":{"base_monthly_prepayment_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"base_monthly_runoff_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"deposit_beta_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"inflow_haircut_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"key":{"type":"string"},"stress_monthly_prepayment_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"stress_monthly_runoff_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["evidence","key"],"type":"object"},"AtmAddress":{"description":"Address of a terminal: the location Regulation E receipts print (12 CFR 1005.9(a)(5)).","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"AtmCommand":{"description":"Command is a queued terminal command.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/AtmCommandRequest"},"status":{"description":"queued, delivered","type":"string"},"terminal_ref":{"type":"string"}},"required":["actor","created_at","id","request","status","terminal_ref"],"type":"object"},"AtmCommandRequest":{"description":"CommandRequest queues a command for a terminal.","properties":{"command":{"description":"in_service, out_of_service, send_counters, send_journal, send_config","type":"string"},"reason":{"type":"string"}},"required":["command","reason"],"type":"object"},"AtmReview":{"description":"Review is an independent decision on a maker's proposal.","properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"evidence":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","approve","evidence","recorded_at"],"type":"object"},"AtmSettlementReport":{"description":"SettlementReport is the shared network's settlement report for one participant and date, as the network adapter delivers it.","properties":{"acquired_inquiries":{"format":"int64","type":"integer"},"acquired_withdrawal_amount":{"format":"int64","type":"integer"},"acquired_withdrawals":{"format":"int64","type":"integer"},"acquirer_interchange_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"issued_inquiries":{"format":"int64","type":"integer"},"issued_withdrawal_amount":{"description":"cash plus the acquirer's surcharge","format":"int64","type":"integer"},"issued_withdrawals":{"format":"int64","type":"integer"},"issuer_interchange_amount":{"format":"int64","type":"integer"},"net_settlement_amount":{"description":"positive: the network pays the bank","format":"int64","type":"integer"},"network":{"type":"string"},"participant":{"type":"string"},"report_sha256":{"type":"string"},"surcharge_amount":{"format":"int64","type":"integer"},"switch_fee_amount":{"format":"int64","type":"integer"}},"required":["acquired_inquiries","acquired_withdrawal_amount","acquired_withdrawals","acquirer_interchange_amount","business_date","issued_inquiries","issued_withdrawal_amount","issued_withdrawals","issuer_interchange_amount","net_settlement_amount","network","participant","report_sha256","surcharge_amount","switch_fee_amount"],"type":"object"},"AtmTransaction":{"description":"Transaction is one cardholder transaction the switch carried.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"accounts_movement_id":{"type":"string"},"acquirer_id":{"type":"string"},"authorization_code":{"type":"string"},"authorized_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"deposited_amount":{"format":"int64","type":"integer"},"device_sequence":{"description":"the request's message sequence","format":"int64","type":"integer"},"dispense":{"additionalProperties":{"format":"int64","type":"integer"},"description":"notes planned by cassette position","type":"object"},"dispensed_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"journal_ids":{"items":{"type":"string"},"type":"array"},"network":{"type":"string"},"network_processing_code":{"type":"string"},"network_rrn":{"type":"string"},"network_stan":{"type":"string"},"network_transmitted_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"operation":{"type":"string"},"outcome":{"oneOf":[{"$ref":"#/components/schemas/Outcome"},{"type":"null"}]},"pan_masked":{"type":"string"},"payments_id":{"type":"string"},"reason":{"type":"string"},"requested_amount":{"format":"int64","type":"integer"},"response_code":{"type":"string"},"retracted_amount":{"format":"int64","type":"integer"},"reversed_amount":{"format":"int64","type":"integer"},"route":{"type":"string"},"serial":{"description":"the terminal's transaction serial","type":"string"},"status":{"type":"string"},"surcharge_amount":{"format":"int64","type":"integer"},"terminal_id":{"description":"the 8-character terminal identification","type":"string"},"terminal_location":{"type":"string"},"terminal_ref":{"description":"the bank's terminal (atmt_); empty for an issued transaction","type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["authorized_amount","business_date","created_at","deposited_amount","dispensed_amount","id","operation","pan_masked","reason","requested_amount","response_code","retracted_amount","reversed_amount","route","status","surcharge_amount","terminal_id","terminal_location","updated_at"],"type":"object"},"AttachmentContent":{"description":"AttachmentContent is one retained attachment's custody.","properties":{"attachment":{"type":"string"},"bytes":{"format":"int64","type":"integer"},"encoding":{"type":"string"},"ingest_id":{"type":"string"},"parts":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"sha256":{"type":"string"}},"required":["attachment","bytes","encoding","parts","recorded_at","recorded_by","sha256"],"type":"object"},"AttachmentFailure":{"description":"AttachmentFailure is an attachment the source refused for good: over the read bound, or changed or gone since the snapshot froze it, or that staff declared unretrievable after exhausted transport fetches. It is evidence that the record's content is incomplete, not a retry queue; a fresh ingest captures the row as it now stands.","properties":{"attachment":{"type":"string"},"code":{"type":"string"},"ingest_id":{"type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"}},"required":["attachment","code","ingest_id","reason","recorded_at","recorded_by"],"type":"object"},"AttachmentFailureRequest":{"description":"AttachmentFailureRequest names one declared, uncaptured attachment of an ingest that staff attest is unretrievable after exhausted source fetches, so the ingest can complete around it.","properties":{"column":{"type":"string"},"ordinal":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"reason":{"type":"string"}},"required":["column","ordinal","purpose","reason"],"type":"object"},"AuditChain":{"description":"AuditEvents lists the audit log newest first, optionally for one subject. AuditChain is one hash-chained audit table as the verify endpoint reports it.","properties":{"anchor":{"description":"Anchor is the operations signature over the verified head (AnchorSequence and its hash),\nto keep outside the database and pass back to a later verification.","type":"string"},"anchor_sequence":{"format":"int64","type":"integer"},"detail":{"type":"string"},"first_break":{"format":"int64","type":"integer"},"intact":{"type":"boolean"},"pending":{"description":"Pending counts rows committed within the last five minutes that the sequencer has not\nchained yet; an older unchained row is a break.","format":"int64","type":"integer"},"rows":{"format":"int64","type":"integer"},"table":{"type":"string"},"verified_at":{"format":"date-time","type":"string"}},"required":["intact","pending","rows","table","verified_at"],"type":"object"},"AuditEvent":{"description":"AuditEvent is one line of the append-only audit log.","properties":{"action":{"description":"request.submitted, request.approved, request.applied, case.closed, ...","type":"string"},"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"detail":{"additionalProperties":true,"type":"object"},"id":{"example":"audt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"subject_id":{"type":"string"},"subject_kind":{"type":"string"}},"required":["action","actor","at","detail","id","subject_id","subject_kind"],"type":"object"},"AuditVerification":{"description":"AuditVerification is the verify endpoint's answer: one chain per audited table.","properties":{"chains":{"items":{"$ref":"#/components/schemas/AuditChain"},"type":"array"}},"required":["chains"],"type":"object"},"Authority":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"book_id":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"evidence":{"type":"string"},"expected_authority_sha256":{"type":"string"},"id":{"type":"string"},"max_native_units":{"format":"int64","type":"integer"},"max_order_usd_minor":{"format":"int64","type":"integer"},"policy_reference":{"type":"string"},"public_keys":{"additionalProperties":{"type":"string"},"type":"object"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["actor","at","book_id","content_sha256","evidence","expected_authority_sha256","id","max_native_units","max_order_usd_minor","policy_reference","public_keys","valid_from","valid_through"],"type":"object"},"AuthorityRequest":{"properties":{"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"driver_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"driver_evidence":{"$ref":"#/components/schemas/FleetEvidence"},"driver_reference":{"description":"opaque terminal/processor identity, never a PIN","type":"string"},"expires_at":{"format":"date-time","type":"string"},"fuels":{"items":{"$ref":"#/components/schemas/FuelLimit"},"type":"array"},"max_authorization_amount":{"format":"int64","type":"integer"},"policy_evidence":{"$ref":"#/components/schemas/FleetEvidence"},"previous_authority_id":{"type":"string"},"product_code_system":{"type":"string"},"product_code_version":{"type":"string"},"reason":{"type":"string"},"vehicle_evidence":{"$ref":"#/components/schemas/FleetEvidence"},"vehicle_reference":{"type":"string"}},"required":["card_id","driver_customer_id","driver_evidence","driver_reference","expires_at","fuels","max_authorization_amount","policy_evidence","product_code_system","product_code_version","reason","vehicle_evidence","vehicle_reference"],"type":"object"},"Authorization":{"properties":{"amount":{"format":"int64","type":"integer"},"authorized_positive":{"type":"boolean"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cleared_amount":{"format":"int64","type":"integer"},"draw_id":{"type":"string"},"expires_at":{"type":"string"},"id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"purchase, refund, force_post","type":"string"},"merchant_id":{"type":"string"},"network":{"type":"string"},"original_network_ref":{"type":"string"},"overdraft_decision_id":{"type":"string"},"reason":{"type":"string"},"requested_amount":{"description":"a partial approval: what the merchant asked for","format":"int64","type":"integer"},"response_code":{"type":"string"},"status":{"type":"string"}},"required":["amount","authorized_positive","card_id","cleared_amount","id","journal_id","status"],"type":"object"},"AuthorizationData":{"description":"AuthorizationData is the token data an authorization carries after the network detokenized it: which token was used, by which requestor, and what the token service verified.","properties":{"assurance_method":{"description":"as the network carries it; retained as evidence","type":"string"},"cryptogram_result":{"description":"valid, invalid or not_present, as the token service verified it","type":"string"},"token_reference":{"type":"string"},"token_requestor_id":{"type":"string"}},"required":["cryptogram_result","token_reference","token_requestor_id"],"type":"object"},"AuthorizationRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"channel":{"type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"fleet_receipt":{"oneOf":[{"$ref":"#/components/schemas/FleetReceipt"},{"type":"null"}]},"mcc":{"type":"string"},"merchant_id":{"type":"string"},"merchant_location":{"type":"string"},"merchant_name":{"type":"string"},"merchant_postal_code":{"description":"the merchant's postal code, when the network carries it","type":"string"},"merchant_region":{"description":"ISO 3166-2 subdivision, full (\"UA-43\") or the part after the country","type":"string"},"network_ref":{"type":"string"},"network_token":{"description":"token data the network carries after detokenizing","oneOf":[{"$ref":"#/components/schemas/AuthorizationData"},{"type":"null"}]},"pan_token":{"type":"string"},"partial_approval_allowed":{"type":"boolean"},"three_ds":{"description":"an e-commerce purchase's 3-D Secure authentication value and ECI","oneOf":[{"$ref":"#/components/schemas/ThreeDSEvidence"},{"type":"null"}]},"wallet_receipt":{"oneOf":[{"$ref":"#/components/schemas/WalletsReceipt"},{"type":"null"}]}},"required":["amount","channel","country","currency_code","mcc","merchant_name","network_ref","pan_token"],"type":"object"},"AuthorizationUse":{"properties":{"accepted_at":{"format":"date-time","type":"string"},"authority":{"$ref":"#/components/schemas/FleetAuthority"},"network_ref":{"type":"string"},"receipt":{"$ref":"#/components/schemas/FleetReceipt"},"transaction":{"$ref":"#/components/schemas/FleetTransaction"},"trust_config_sha256":{"type":"string"},"verification_key":{"$ref":"#/components/schemas/TrustedKey"}},"required":["accepted_at","authority","network_ref","receipt","transaction","trust_config_sha256","verification_key"],"type":"object"},"Balance":{"properties":{"adjustment_amount":{"format":"int64","type":"integer"},"allocated_amount":{"format":"int64","type":"integer"},"assessed_amount":{"format":"int64","type":"integer"},"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"invoice_reference":{"type":"string"},"occupancy_reference":{"type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"released_amount":{"format":"int64","type":"integer"},"returned_amount":{"format":"int64","type":"integer"},"unit_change_id":{"type":"string"},"unit_reference":{"type":"string"}},"required":["adjustment_amount","allocated_amount","assessed_amount","assessment_id","due_date","invoice_reference","occupancy_reference","outstanding_amount","released_amount","returned_amount","unit_change_id","unit_reference"],"type":"object"},"BalanceProof":{"description":"BalanceProof explains a statement's closing booked balance from the ledger at the statement's closing date: the ledger balance by effective date, plus the statement items the ledger does not have, less the ledger items the statement does not have, plus the matched statement items inside the cut, less the matched ledger items inside the cut (a match whose sides fall on either side of the cut). A nonzero difference means the retained statement chain does not add up to its own closing balance: a statement missing from the chain, or a page not yet received.","properties":{"closing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"difference_amount":{"format":"int64","type":"integer"},"explained_amount":{"format":"int64","type":"integer"},"ledger_balance_amount":{"format":"int64","type":"integer"},"matched_ledger_in_cut_amount":{"format":"int64","type":"integer"},"matched_statement_in_cut_amount":{"format":"int64","type":"integer"},"statement_closing_amount":{"format":"int64","type":"integer"},"unmatched_ledger_amount":{"format":"int64","type":"integer"},"unmatched_statement_amount":{"format":"int64","type":"integer"}},"required":["closing_date","difference_amount","explained_amount","ledger_balance_amount","matched_ledger_in_cut_amount","matched_statement_in_cut_amount","statement_closing_amount","unmatched_ledger_amount","unmatched_statement_amount"],"type":"object"},"Balances":{"description":"Balances of an account.","properties":{"available_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"holding_amount":{"format":"int64","type":"integer"},"last_activity_date":{"description":"the customer's last movement; dormancy counts from here","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"ledger_amount":{"format":"int64","type":"integer"},"locked_amount":{"format":"int64","type":"integer"},"pending_amount":{"format":"int64","type":"integer"}},"required":["available_amount","currency_code","holding_amount","ledger_amount","locked_amount","pending_amount"],"type":"object"},"Bank":{"properties":{"address":{"type":"string"},"error_notice":{"type":"string"},"local":{"type":"boolean"},"name":{"type":"string"},"phone":{"type":"string"}},"required":["address","error_notice","local","name","phone"],"type":"object"},"BankTransferRequest":{"description":"BankTransferRequest moves the bank's own funds to another institution (a Fedwire pacs.009).","properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"creditor_aba":{"type":"string"},"creditor_account":{"type":"string"},"creditor_name":{"type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"gl_code":{"type":"string"},"info":{"type":"string"},"operator":{"type":"string"},"receiver_aba":{"type":"string"},"receiver_name":{"type":"string"},"reference":{"type":"string"}},"required":["amount","currency_code","gl_code","operator","receiver_aba","receiver_name"],"type":"object"},"BankcashDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["actor","at","content_sha256","decision","note"],"type":"object"},"BankcashDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["content_sha256","decision","note"],"type":"object"},"BankcashMatch":{"properties":{"content_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BankcashDecision"},{"type":"null"}]},"id":{"type":"string"},"journal_ids":{"items":{"type":"string"},"type":"array"},"journals":{"items":{"$ref":"#/components/schemas/CashJournal"},"type":"array"},"line":{"$ref":"#/components/schemas/Line"},"line_id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"reason":{"type":"string"},"statement":{"$ref":"#/components/schemas/StatementIdentity"},"statement_id":{"type":"string"},"statement_sha256":{"type":"string"}},"required":["content_sha256","id","journal_ids","journals","line","line_id","proposed_at","proposed_by","reason","statement","statement_id","statement_sha256"],"type":"object"},"BankingProduct":{"properties":{"ProductIdentification":{"$ref":"#/components/schemas/BianIdentification"},"ProductLifecycleStatus":{"$ref":"#/components/schemas/LifecycleStatus"},"ProductName":{"$ref":"#/components/schemas/Name"},"ProductType":{"type":"string"},"ProductVersion":{"type":"string"}},"required":["ProductIdentification","ProductLifecycleStatus","ProductName","ProductType","ProductVersion"],"type":"object"},"BankrecordsItemDecision":{"properties":{"actor":{"type":"string"},"basis":{"type":"string"},"decided_at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","basis","decided_at","reason"],"type":"object"},"BankrecordsRecord":{"properties":{"active_holds":{"items":{"type":"string"},"type":"array"},"attachment_failures":{"items":{"$ref":"#/components/schemas/AttachmentFailure"},"type":"array"},"attachments":{"items":{"$ref":"#/components/schemas/ExpectedAttachment"},"type":"array"},"captured_at":{"format":"date-time","type":"string"},"captured_attachments":{"items":{"$ref":"#/components/schemas/AttachmentContent"},"type":"array"},"category":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"creation_basis":{"type":"string"},"disposed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"document_bytes":{"format":"int64","type":"integer"},"document_sha256":{"type":"string"},"external":{"oneOf":[{"$ref":"#/components/schemas/ExternalDocument"},{"type":"null"}]},"generation":{"format":"int64","type":"integer"},"id":{"type":"string"},"ingest_id":{"type":"string"},"permanent":{"type":"boolean"},"projection_sha256":{"type":"string"},"projection_version":{"type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance"},"provenance_sha256":{"type":"string"},"recorded_by":{"type":"string"},"retain_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"retention_event_id":{"type":"string"},"retention_starts_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"schedule_id":{"type":"string"},"sequence":{"format":"int64","type":"integer"},"source_key":{"type":"string"},"target":{"$ref":"#/components/schemas/Target"}},"required":["active_holds","captured_at","category","created_at","creation_basis","document_bytes","document_sha256","generation","id","ingest_id","permanent","projection_sha256","projection_version","provenance","provenance_sha256","recorded_by","schedule_id","sequence","source_key","target"],"type":"object"},"BankrecordsSource":{"properties":{"capture":{"type":"string"},"configured":{"type":"boolean"},"coverage":{"type":"string"},"excluded":{"items":{"type":"string"},"type":"array"},"policy":{"oneOf":[{"$ref":"#/components/schemas/Action"},{"type":"null"}]},"projection_sha256":{"type":"string"},"service":{"type":"string"},"source":{"type":"string"},"version":{"type":"string"}},"required":["configured","coverage","excluded","projection_sha256","service","source","version"],"type":"object"},"BankrepoControl":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"id":{"type":"string"},"kind":{"description":"program","type":"string"},"program":{"oneOf":[{"$ref":"#/components/schemas/BankrepoProgram"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","kind"],"type":"object"},"BankrepoCounterparty":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"external_reference":{"type":"string"},"identity":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"legal_name":{"type":"string"}},"required":["customer_id","external_reference","identity","legal_name"],"type":"object"},"BankrepoInstruction":{"properties":{"collateral":{"items":{"$ref":"#/components/schemas/CollateralBinding"},"type":"array"},"content_sha256":{"type":"string"},"currency_code":{"type":"string"},"decision_sha256":{"type":"string"},"id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"legal_entity":{"type":"string"},"lender_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_reference":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"repurchase_amount":{"format":"int64","type":"integer"},"schedule":{"$ref":"#/components/schemas/InterestSchedule"},"sha256":{"type":"string"},"transaction_id":{"type":"string"},"version":{"type":"string"}},"required":["collateral","content_sha256","currency_code","decision_sha256","id","issued_at","legal_entity","lender_customer_id","lender_reference","master_cash_external_account_reference","master_cash_ledger_account_id","program_id","program_sha256","repurchase_amount","schedule","sha256","transaction_id","version"],"type":"object"},"BankrepoProgram":{"properties":{"agreement":{"$ref":"#/components/schemas/Document"},"authority":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"cash_bridge_subject":{"type":"string"},"cash_evidence_keys":{"additionalProperties":{"type":"string"},"type":"object"},"custodian_reference":{"type":"string"},"custody_bridge_subject":{"type":"string"},"custody_provider":{"type":"string"},"enabled":{"type":"boolean"},"haircut_bps":{"format":"int64","type":"integer"},"intermediaries":{"items":{"$ref":"#/components/schemas/BankrepoCounterparty"},"type":"array"},"legal_entity":{"type":"string"},"lender":{"$ref":"#/components/schemas/BankrepoCounterparty"},"master_cash_external_account_reference":{"type":"string"},"master_cash_identity":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_excess_collateral_amount":{"format":"int64","type":"integer"},"max_principal_amount":{"format":"int64","type":"integer"},"max_rate_bps":{"format":"int64","type":"integer"},"max_term_days":{"format":"int64","type":"integer"},"provider":{"type":"string"},"terms":{"$ref":"#/components/schemas/Terms"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["agreement","authority","cash_bridge_subject","cash_evidence_keys","custodian_reference","custody_bridge_subject","custody_provider","enabled","haircut_bps","intermediaries","legal_entity","lender","master_cash_external_account_reference","master_cash_identity","master_cash_ledger_account_id","max_excess_collateral_amount","max_principal_amount","max_rate_bps","max_term_days","provider","terms","valid_from","valid_through"],"type":"object"},"BankrepoReservation":{"description":"Reservation is a ledger-owned exclusive sidecar. Revision is the fixed source revision at reservation, not the later mutable accounting revision.","properties":{"custody_proof_sha256":{"type":"string"},"instruction_sha256":{"type":"string"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"original_settlement_sha256":{"type":"string"},"pledge_reference":{"type":"string"},"state":{"description":"reserved, pledged, releasing, released","type":"string"},"transaction_id":{"type":"string"},"units":{"format":"int64","type":"integer"}},"required":["instruction_sha256","lot_id","lot_revision","original_settlement_sha256","state","transaction_id","units"],"type":"object"},"BankrepoSnapshot":{"description":"Snapshot retains a current observation and the requested accounting date separately. It does not reconstruct historical custody or external cash.","properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"captured_at":{"format":"date-time","type":"string"},"cash_evidence":{"items":{"$ref":"#/components/schemas/SnapshotCashEvidence"},"type":"array"},"content_sha256":{"type":"string"},"counterparty_checks":{"items":{"$ref":"#/components/schemas/SnapshotAdmission"},"type":"array"},"id":{"type":"string"},"journals":{"items":{"$ref":"#/components/schemas/SnapshotJournal"},"type":"array"},"legal_entity":{"type":"string"},"managed_accounts":{"items":{"$ref":"#/components/schemas/SnapshotAccount"},"type":"array"},"observation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"positions":{"items":{"$ref":"#/components/schemas/SnapshotPosition"},"type":"array"},"ready":{"type":"boolean"},"version":{"type":"string"}},"required":["blockers","business_date","captured_at","cash_evidence","content_sha256","counterparty_checks","id","journals","legal_entity","managed_accounts","observation_date","positions","ready","version"],"type":"object"},"BanksecuritiesDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["actor","at","content_sha256","decision","note"],"type":"object"},"BanksecuritiesDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["content_sha256","decision","note"],"type":"object"},"BanksecuritiesEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"Beneficiary":{"description":"Beneficiary is a named person the account is held for or passes to.","properties":{"customer_id":{"description":"the customer record carrying the beneficiary's TIN (required for utma and custodial)","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date_of_birth":{"type":"string"},"name":{"type":"string"},"relationship":{"type":"string"},"share_bps":{"format":"int64","type":"integer"}},"required":["name","share_bps"],"type":"object"},"BeneficiaryPaymentEvidence":{"description":"BeneficiaryPaymentEvidence supports full cash settlement to the sole adult individual named in the original IRA title, with death before the owner's RBD.","properties":{"authority_ref":{"type":"string"},"authority_sha256":{"type":"string"},"authority_valid_until":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"death_report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"death_revision":{"format":"int64","type":"integer"},"election_ref":{"type":"string"},"election_sha256":{"type":"string"},"jurisdiction":{"type":"string"},"minimum_recipient_age":{"format":"int64","type":"integer"},"policy_ref":{"type":"string"},"policy_sha256":{"type":"string"},"restriction_id":{"type":"string"},"rmd_policy_id":{"type":"string"},"tax_rule_id":{"type":"string"}},"required":["authority_ref","authority_sha256","authority_valid_until","customer_id","death_report_id","death_revision","election_ref","election_sha256","jurisdiction","minimum_recipient_age","policy_ref","policy_sha256","restriction_id","rmd_policy_id","tax_rule_id"],"type":"object"},"BianIdentification":{"properties":{"ProductIdentification":{"$ref":"#/components/schemas/BianIdentifier"},"ProductIdentificationType":{"type":"string"}},"required":["ProductIdentification","ProductIdentificationType"],"type":"object"},"BianIdentifier":{"properties":{"IdentifierValue":{"type":"string"}},"required":["IdentifierValue"],"type":"object"},"BianRecord":{"description":"Record is Corgi's read-only profile, not a BIAN Retrieve operation response. Bank-specific terms remain explicit and retain their original units and version.","properties":{"Product":{"$ref":"#/components/schemas/BankingProduct"},"ProductDirectoryEntry":{"$ref":"#/components/schemas/DirectoryEntry"},"bian_version":{"type":"string"},"profile":{"type":"string"},"x-corgi-terms":{"$ref":"#/components/schemas/Product"}},"required":["Product","ProductDirectoryEntry","bian_version","profile","x-corgi-terms"],"type":"object"},"BillingAmounts":{"properties":{"fees_amount":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"}},"required":["fees_amount","interest_amount","principal_amount"],"type":"object"},"BillingCycle":{"properties":{"actor":{"type":"string"},"ends_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"facility_id":{"type":"string"},"period":{"type":"string"},"policy":{"$ref":"#/components/schemas/BillingPolicy"},"recorded_at":{"format":"date-time","type":"string"},"reference":{"type":"string"},"sent_at":{"format":"date-time","type":"string"},"sha256":{"type":"string"},"starts_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"statement":{"$ref":"#/components/schemas/FacilityStatement"}},"required":["actor","ends_on","facility_id","period","policy","recorded_at","reference","sent_at","sha256","starts_on","statement"],"type":"object"},"BillingCycleRequest":{"properties":{"ends_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period":{"type":"string"},"reference":{"type":"string"},"sent_at":{"format":"date-time","type":"string"},"sha256":{"type":"string"},"starts_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["ends_on","period","reference","sent_at","sha256","starts_on"],"type":"object"},"BillingDecision":{"properties":{"actor":{"type":"string"},"approved":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","approved","at","reason"],"type":"object"},"BillingDecisionRequest":{"properties":{"approved":{"type":"boolean"},"reason":{"type":"string"}},"required":["approved","reason"],"type":"object"},"BillingError":{"properties":{"acknowledgment_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"facility_id":{"type":"string"},"id":{"type":"string"},"interest_review":{"$ref":"#/components/schemas/BillingInterestReview"},"policy":{"$ref":"#/components/schemas/BillingPolicy"},"request":{"$ref":"#/components/schemas/BillingErrorRequest"},"resolution_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"state":{"$ref":"#/components/schemas/BillingErrorState"}},"required":["acknowledgment_due","created_at","created_by","customer_id","facility_id","id","interest_review","policy","request","resolution_due","state"],"type":"object"},"BillingErrorRequest":{"properties":{"amounts":{"$ref":"#/components/schemas/BillingAmounts"},"channel":{"type":"string"},"draw_id":{"type":"string"},"kind":{"type":"string"},"period":{"type":"string"},"reason":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["amounts","channel","draw_id","kind","period","reason","received_at","reference","sha256"],"type":"object"},"BillingErrorState":{"properties":{"acknowledged_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"corrected":{"$ref":"#/components/schemas/BillingAmounts"},"interest_correction_noticed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"interest_reconciled_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"interest_reconciliation_required":{"type":"boolean"},"noticed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"outcome":{"type":"string"},"pending_resolution_id":{"type":"string"},"released_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"resume_after":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"status":{"type":"string"}},"required":["corrected","interest_reconciliation_required","status"],"type":"object"},"BillingEvent":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"detail":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"kind":{"type":"string"}},"required":["actor","at","case_id","detail","id","idempotency_key","kind"],"type":"object"},"BillingEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"},"summary":{"type":"string"}},"required":["reference","sha256","summary"],"type":"object"},"BillingInterestAccrual":{"properties":{"accrued_exact":{"type":"string"},"basis_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"days":{"format":"int64","type":"integer"}},"required":["accrued_exact","basis_amount","business_date","days"],"type":"object"},"BillingInterestBasis":{"properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"charged_dates":{"items":{"$ref":"#/components/schemas/Day"},"type":"array"}},"required":["annual_rate_bps","business_date","charged_dates"],"type":"object"},"BillingInterestCredit":{"properties":{"allocated":{"type":"boolean"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"resolution_id":{"type":"string"}},"required":["allocated","case_id","interest_amount","resolution_id"],"type":"object"},"BillingInterestReconciliation":{"properties":{"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BillingDecision"},{"type":"null"}]},"executed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"executed_by":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"recognized_credit_amount":{"format":"int64","type":"integer"},"request":{"$ref":"#/components/schemas/BillingInterestReconciliationRequest"},"rounding_credit_exact":{"type":"string"},"waived_exact":{"type":"string"}},"required":["case_id","id","proposed_at","proposed_by","request"],"type":"object"},"BillingInterestReconciliationRequest":{"properties":{"evidence_keys":{"items":{"type":"string"},"type":"array"},"prior_resolution_ids":{"items":{"type":"string"},"type":"array"},"reason":{"type":"string"},"refunds":{"items":{"$ref":"#/components/schemas/BillingInterestRefund"},"type":"array"},"rounding_credits":{"items":{"$ref":"#/components/schemas/BillingInterestRoundingCredit"},"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/BillingInterestBasis"},"type":"array"},"unpaid_exact":{"type":"string"}},"required":["evidence_keys","reason","sources","unpaid_exact"],"type":"object"},"BillingInterestRefund":{"properties":{"amount":{"format":"int64","type":"integer"},"payment_key":{"type":"string"}},"required":["amount","payment_key"],"type":"object"},"BillingInterestReview":{"properties":{"accrued_at_intake":{"type":"string"},"last_accrued":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"overlapping_accrual_rows":{"format":"int64","type":"integer"},"overlapping_accrual_total":{"type":"string"},"overlapping_paid_amount":{"format":"int64","type":"integer"},"overlapping_payment_rows":{"format":"int64","type":"integer"},"overlapping_pending_recognition_rows":{"format":"int64","type":"integer"},"overlapping_recognition_rows":{"format":"int64","type":"integer"},"overlapping_recognized_amount":{"format":"int64","type":"integer"},"recognized_interest_at_intake":{"format":"int64","type":"integer"},"required":{"type":"boolean"}},"required":["accrued_at_intake","overlapping_accrual_rows","overlapping_accrual_total","overlapping_paid_amount","overlapping_payment_rows","overlapping_pending_recognition_rows","overlapping_recognition_rows","overlapping_recognized_amount","recognized_interest_at_intake","required"],"type":"object"},"BillingInterestRoundingCredit":{"properties":{"amount_exact":{"type":"string"},"reconciliation_id":{"type":"string"}},"required":["amount_exact","reconciliation_id"],"type":"object"},"BillingInterestRoundingSource":{"properties":{"available_exact":{"type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reconciliation_id":{"type":"string"}},"required":["available_exact","case_id","reconciliation_id"],"type":"object"},"BillingInterestSources":{"properties":{"accruals":{"items":{"$ref":"#/components/schemas/BillingInterestAccrual"},"type":"array"},"accrued_exact":{"type":"string"},"history_balances":{"type":"boolean"},"merits_credits":{"items":{"$ref":"#/components/schemas/BillingInterestCredit"},"type":"array"},"recognized_amount":{"format":"int64","type":"integer"},"rounding_credits":{"items":{"$ref":"#/components/schemas/BillingInterestRoundingSource"},"type":"array"}},"required":["accruals","accrued_exact","history_balances","merits_credits","recognized_amount","rounding_credits"],"type":"object"},"BillingNotice":{"properties":{"documents_available":{"type":"boolean"},"kind":{"type":"string"},"payment_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"reference":{"type":"string"},"sent_at":{"format":"date-time","type":"string"},"sha256":{"type":"string"}},"required":["documents_available","kind","reference","sent_at","sha256"],"type":"object"},"BillingPolicy":{"properties":{"cycle_close_day":{"format":"int64","type":"integer"},"expense_gl_code":{"type":"string"},"id":{"type":"string"},"interest_refund_rounding":{"type":"string"},"interest_refund_route":{"type":"string"},"max_claim_amount":{"format":"int64","type":"integer"},"product_codes":{"items":{"type":"string"},"type":"array"},"resumption_grace_days":{"format":"int64","type":"integer"},"suspend_all_interest":{"type":"boolean"},"timezone":{"type":"string"}},"required":["cycle_close_day","expense_gl_code","id","max_claim_amount","product_codes","resumption_grace_days","suspend_all_interest","timezone"],"type":"object"},"BillingResolution":{"properties":{"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BillingDecision"},{"type":"null"}]},"executed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"executed_by":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/BillingResolutionRequest"}},"required":["case_id","id","proposed_at","proposed_by","request"],"type":"object"},"BillingResolutionRequest":{"properties":{"amounts":{"$ref":"#/components/schemas/BillingAmounts"},"evidence_keys":{"items":{"type":"string"},"type":"array"},"outcome":{"type":"string"},"reason":{"type":"string"}},"required":["amounts","evidence_keys","outcome","reason"],"type":"object"},"Binding":{"properties":{"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["loan_id"],"type":"object"},"BlockClearance":{"description":"BlockClearance is a request to clear a merchant block and its second-person decision.","properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision":{"description":"pending, approved, rejected, withdrawn","type":"string"},"decision_note":{"type":"string"},"id":{"format":"int64","type":"integer"},"note":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"requested_by":{"type":"string"}},"required":["decision","id","note","requested_at","requested_by"],"type":"object"},"BlockClearanceBody":{"description":"BlockClearanceBody asks for a merchant block to be cleared, with the reason.","properties":{"note":{"type":"string"}},"required":["note"],"type":"object"},"BlockDecisionBody":{"description":"BlockDecisionBody decides a merchant-block clearance or a jurisdiction proposal.","properties":{"decision":{"description":"approved, rejected or withdrawn","type":"string"},"note":{"type":"string"}},"required":["decision","note"],"type":"object"},"Book":{"properties":{"accounting_purpose":{"type":"string"},"actor":{"type":"string"},"asset_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"at":{"format":"date-time","type":"string"},"bic":{"type":"string"},"bridge_subject":{"type":"string"},"content_sha256":{"type":"string"},"correspondent_name":{"type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"current_authority":{"oneOf":[{"$ref":"#/components/schemas/Authority"},{"type":"null"}]},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"evidence":{"type":"string"},"external_account_ref":{"type":"string"},"id":{"type":"string"},"legal_entity":{"type":"string"},"master_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_native_units":{"format":"int64","type":"integer"},"max_order_usd_minor":{"format":"int64","type":"integer"},"paused":{"type":"boolean"},"policy_reference":{"type":"string"},"provider":{"type":"string"},"public_keys":{"additionalProperties":{"type":"string"},"type":"object"},"status_revision":{"format":"int64","type":"integer"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accounting_purpose","actor","at","bic","bridge_subject","content_sha256","correspondent_name","country","currency_code","evidence","external_account_ref","id","legal_entity","master_ledger_account_id","max_native_units","max_order_usd_minor","paused","policy_reference","provider","public_keys","status_revision","valid_from","valid_through"],"type":"object"},"BookRequest":{"properties":{"accounting_purpose":{"type":"string"},"bic":{"type":"string"},"bridge_subject":{"type":"string"},"correspondent_name":{"type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"evidence":{"type":"string"},"external_account_ref":{"type":"string"},"legal_entity":{"type":"string"},"master_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_native_units":{"format":"int64","type":"integer"},"max_order_usd_minor":{"format":"int64","type":"integer"},"policy_reference":{"type":"string"},"provider":{"type":"string"},"public_keys":{"additionalProperties":{"type":"string"},"type":"object"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accounting_purpose","bic","bridge_subject","correspondent_name","country","currency_code","evidence","external_account_ref","legal_entity","master_ledger_account_id","max_native_units","max_order_usd_minor","policy_reference","provider","public_keys","valid_from","valid_through"],"type":"object"},"BookTransfer":{"properties":{"amount":{"format":"int64","type":"integer"},"from_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"example":"book_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","from_account_id","id","journal_id","status","to_account_id"],"type":"object"},"BookTransferRequest":{"properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"description":{"type":"string"},"from_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"to_account_number":{"type":"string"}},"required":["amount","currency_code","description","from_account_id"],"type":"object"},"BorrowingBase":{"description":"BorrowingBase is a borrower's collateral certificate.","properties":{"base_amount":{"format":"int64","type":"integer"},"certified_at":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"inventory_advance_bps":{"format":"int64","type":"integer"},"inventory_amount":{"format":"int64","type":"integer"},"receivables_advance_bps":{"format":"int64","type":"integer"},"receivables_amount":{"format":"int64","type":"integer"}},"required":["inventory_amount","receivables_amount"],"type":"object"},"Break":{"description":"Break is one item in the reconciliation break queue.","properties":{"amount":{"description":"signed as the item moves the account; a difference is statement less expected","format":"int64","type":"integer"},"clears_by":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"counter_ref":{"description":"a difference: the ledger item, a charge, an interest period or an invoice","type":"string"},"currency_code":{"type":"string"},"detail":{"type":"string"},"id":{"type":"string"},"item_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"item_ref":{"type":"string"},"item_side":{"type":"string"},"kind":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opened_at":{"format":"date-time","type":"string"},"reference":{"type":"string"},"resolution":{"type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"run_id":{"type":"string"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["amount","currency_code","detail","id","kind","nostro_account_id","opened_at","status","version"],"type":"object"},"BreakDecision":{"description":"BreakDecision explains or resolves a break.","properties":{"by":{"type":"string"},"note":{"type":"string"}},"required":["by","note"],"type":"object"},"BreakProposal":{"description":"BreakProposal is a retained proposal and its review.","properties":{"action":{"type":"string"},"break_id":{"type":"string"},"break_version":{"format":"int64","type":"integer"},"clears_by":{"description":"accept_timing","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"gl_code":{"description":"post_adjustment","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_refs":{"description":"match: the ledger items","items":{"type":"string"},"type":"array"},"maker":{"type":"string"},"note":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"review_status":{"description":"pending_review, approved or rejected","type":"string"},"statement_refs":{"description":"match: the other statement items","items":{"type":"string"},"type":"array"}},"required":["action","break_id","break_version","id","maker","note","recorded_at","review_status"],"type":"object"},"BreakProposalRequest":{"description":"BreakProposalRequest proposes how to resolve a break.","properties":{"action":{"type":"string"},"break_version":{"format":"int64","type":"integer"},"clears_by":{"description":"accept_timing","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"gl_code":{"description":"post_adjustment","type":"string"},"ledger_refs":{"description":"match: the ledger items","items":{"type":"string"},"type":"array"},"note":{"type":"string"},"statement_refs":{"description":"match: the other statement items","items":{"type":"string"},"type":"array"}},"required":["action","break_version","note"],"type":"object"},"BridgePayload":{"description":"BridgePayload attests actual validator or transmission-system evidence. It is not a FinCEN protocol. The bridge must supply the real retained document bytes; a SHA entered by bank staff alone never establishes validation or acceptance.","properties":{"batch_sha256":{"type":"string"},"correlation_id":{"type":"string"},"document_sha256":{"type":"string"},"environment":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"kind":{"description":"validation, transmission, acknowledgment, rejection","type":"string"},"observed_at":{"format":"date-time","type":"string"},"packet_id":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"version":{"type":"string"}},"required":["batch_sha256","document_sha256","environment","issued_at","key_id","kind","observed_at","packet_id","receipt_id","version"],"type":"object"},"Bucket":{"properties":{"end_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"inflow_amount":{"format":"int64","type":"integer"},"interest_expense_amount":{"format":"int64","type":"integer"},"interest_income_amount":{"format":"int64","type":"integer"},"liquidity_amount":{"format":"int64","type":"integer"},"month":{"format":"int64","type":"integer"},"net_cash_amount":{"format":"int64","type":"integer"},"nii_amount":{"format":"int64","type":"integer"},"outflow_amount":{"format":"int64","type":"integer"}},"required":["end_date","inflow_amount","interest_expense_amount","interest_income_amount","liquidity_amount","month","net_cash_amount","nii_amount","outflow_amount"],"type":"object"},"BuildCashLetterBody":{"description":"BuildCashLetterBody names the letter to file: forward (the deposited checks) or return.","properties":{"kind":{"type":"string"}},"type":"object"},"BureauAck":{"description":"BureauAck is a consumer reporting agency's acknowledgment of a furnishing file.","properties":{"acknowledgment_id":{"type":"string"},"base_records":{"format":"int64","type":"integer"},"bureau":{"type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"received_at":{"format":"date-time","type":"string"},"status":{"type":"string"}},"required":["acknowledgment_id","base_records","bureau","file_id","received_at","status"],"type":"object"},"BusinessParties":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_ref":{"type":"string"},"parties":{"items":{"$ref":"#/components/schemas/BusinessParty"},"type":"array"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["customer_id","evidence_ref","parties","reason","recorded_at","recorded_by","version"],"type":"object"},"BusinessPartiesRequest":{"properties":{"evidence_ref":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"parties":{"items":{"$ref":"#/components/schemas/BusinessParty"},"type":"array"},"reason":{"type":"string"}},"required":["evidence_ref","expected_version","parties","reason"],"type":"object"},"BusinessParty":{"properties":{"control_person":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_bps":{"format":"int64","type":"integer"}},"required":["control_person","customer_id","ownership_bps"],"type":"object"},"BusinessUser":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"active":{"type":"boolean"},"changed_by":{"type":"string"},"payment_limit_amount":{"format":"int64","type":"integer"},"role":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","active","changed_by","payment_limit_amount","role","updated_at","user_id"],"type":"object"},"BusinessUserRequest":{"properties":{"active":{"type":"boolean"},"payment_limit_amount":{"format":"int64","type":"integer"},"role":{"type":"string"}},"required":["active","payment_limit_amount","role"],"type":"object"},"CBLRCriteria":{"properties":{"consolidated_assets_amount":{"format":"int64","type":"integer"},"criteria_met":{"type":"boolean"},"election_reported":{"type":"boolean"},"failed_criteria":{"items":{"type":"string"},"type":"array"},"leverage":{"$ref":"#/components/schemas/CapitalRatio"},"off_balance_notional_amount":{"format":"int64","type":"integer"},"reliance_status":{"type":"string"},"threshold_exclusive_bps":{"format":"int64","type":"integer"},"trading_assets_and_liabilities_amount":{"format":"int64","type":"integer"}},"required":["consolidated_assets_amount","criteria_met","election_reported","failed_criteria","leverage","off_balance_notional_amount","reliance_status","threshold_exclusive_bps","trading_assets_and_liabilities_amount"],"type":"object"},"CTRAddress":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"required":["city","country","state","street","zip"],"type":"object"},"CTRBank":{"properties":{"address":{"$ref":"#/components/schemas/CTRAddress"},"alternate_name":{"type":"string"},"contact_extension":{"type":"string"},"contact_office":{"type":"string"},"contact_phone":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ein":{"type":"string"},"evidence":{"$ref":"#/components/schemas/CTRMetadataEvidence"},"legal_entity":{"type":"string"},"legal_name":{"type":"string"},"location":{"description":"exact native cash-unit location, never parsed into an address","type":"string"},"location_address":{"$ref":"#/components/schemas/CTRAddress"},"location_rssd":{"description":"blank if that location has no assigned RSSD","type":"string"},"primary_regulator":{"description":"actual FRB=1,FDIC=2,NCUA=3,OCC=4,IRS=7","type":"string"},"rssd":{"type":"string"},"self_transmitter":{"type":"boolean"},"transmitter_contact":{"type":"string"},"transmitter_control_code":{"type":"string"},"transmitter_phone":{"type":"string"}},"required":["address","contact_office","contact_phone","effective_from","effective_through","ein","evidence","legal_entity","legal_name","location","location_address","primary_regulator","rssd","self_transmitter","transmitter_contact","transmitter_control_code","transmitter_phone"],"type":"object"},"CTRDirectedInstruction":{"properties":{"document_sha256":{"type":"string"},"instruction_id":{"type":"string"},"issued_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"source_reference":{"type":"string"}},"required":["document_sha256","instruction_id","issued_on","reference","source_reference"],"type":"object"},"CTREntity":{"description":"CTREntity is a reviewed entity customer that owns an account in the cut. It can only appear as a person on whose behalf cash moved; an identified natural person conducts. NAICS is optional reviewed data validated against the pinned official code list; the business description is the form's occupation text.","properties":{"address":{"$ref":"#/components/schemas/CTRAddress"},"alternate_name":{"type":"string"},"business_description":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ein":{"type":"string"},"email":{"type":"string"},"evidence":{"$ref":"#/components/schemas/CTRMetadataEvidence"},"legal_name":{"type":"string"},"naics":{"type":"string"},"phone":{"type":"string"},"phone_extension":{"type":"string"},"tin_country":{"type":"string"},"tin_type":{"description":"empty or 2 = EIN, 9 = foreign","type":"string"}},"required":["address","business_description","customer_id","ein","evidence","legal_name"],"type":"object"},"CTRExemption":{"description":"CTRExemption is a designation with its status: pending, active, lapsed, revoked, rejected or withdrawn.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"category":{"type":"string"},"decided_by":{"type":"string"},"decided_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"directions":{"items":{"type":"string"},"type":"array"},"eligibility":{"$ref":"#/components/schemas/EligibilityFacts"},"fincen110_filed_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fincen110_ref":{"type":"string"},"id":{"format":"int64","type":"integer"},"legal_name":{"type":"string"},"phase":{"type":"string"},"proposed_by":{"type":"string"},"review_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"status":{"type":"string"},"subject":{"type":"string"}},"required":["account_ids","category","directions","eligibility","fincen110_filed_on","fincen110_ref","id","legal_name","phase","proposed_by","status","subject"],"type":"object"},"CTRExemptionApplication":{"description":"CTRExemptionApplication is a cash event on which an exemption kept ctr_required from firing.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ctr_threshold_minor":{"format":"int64","type":"integer"},"day_total":{"format":"int64","type":"integer"},"direction":{"type":"string"},"event_id":{"type":"string"},"exempt_amount":{"format":"int64","type":"integer"},"exemption_ids":{"items":{"format":"int64","type":"integer"},"type":"array"},"id":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"reportable_amount":{"format":"int64","type":"integer"},"subject":{"type":"string"}},"required":["business_date","ctr_threshold_minor","day_total","direction","event_id","exempt_amount","exemption_ids","id","recorded_at","reportable_amount","subject"],"type":"object"},"CTRExemptionRequest":{"description":"CTRExemptionRequest designates an exempt person (31 CFR 1020.315).","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"category":{"type":"string"},"directions":{"items":{"type":"string"},"type":"array"},"eligibility":{"$ref":"#/components/schemas/EligibilityFacts"},"fincen110_filed_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fincen110_ref":{"type":"string"},"legal_name":{"type":"string"},"reason":{"type":"string"},"subject":{"type":"string"}},"required":["category","eligibility","fincen110_filed_on","fincen110_ref","legal_name","reason","subject"],"type":"object"},"CTRExemptionReview":{"description":"CTRExemptionReview is one annual review.","properties":{"exemption_id":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"next_review_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reviewed_by":{"type":"string"},"reviewed_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["exemption_id","id","next_review_due","reviewed_by","reviewed_on"],"type":"object"},"CTRExemptionReviewRequest":{"description":"CTRExemptionReviewRequest records the annual eligibility review of an exemption.","properties":{"eligibility":{"$ref":"#/components/schemas/EligibilityFacts"},"note":{"type":"string"}},"required":["eligibility","note"],"type":"object"},"CTRLocation":{"description":"CTRLocation is one transaction location: the exact native custody unit location string and kind, with its reviewed address and any assigned RSSD.","properties":{"address":{"$ref":"#/components/schemas/CTRAddress"},"kind":{"description":"teller, atm, vault or shared_branch","type":"string"},"location":{"type":"string"},"rssd":{"type":"string"}},"required":["address","kind","location"],"type":"object"},"CTRMetadataEvidence":{"properties":{"document_sha256":{"type":"string"},"known_data_complete":{"type":"boolean"},"source_reference":{"type":"string"},"verified_at":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["document_sha256","known_data_complete","source_reference","verified_at","version"],"type":"object"},"CTRPerson":{"properties":{"address":{"$ref":"#/components/schemas/CTRAddress"},"alternate_name":{"type":"string"},"birth_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"drivers_license":{"type":"string"},"email":{"type":"string"},"evidence":{"$ref":"#/components/schemas/CTRMetadataEvidence"},"first_name":{"type":"string"},"gender":{"description":"male, female, unknown; never inferred","type":"string"},"identification_country":{"type":"string"},"identification_issuer":{"description":"other identification type text","type":"string"},"identification_number":{"type":"string"},"identification_type":{"description":"5 license, 6 passport, 7 alien registration, 999 other; empty is v1/v2 US license","type":"string"},"last_name":{"type":"string"},"license_state":{"type":"string"},"middle_name":{"type":"string"},"occupation":{"type":"string"},"phone":{"type":"string"},"phone_extension":{"type":"string"},"suffix":{"type":"string"},"tin":{"description":"actual SSN/ITIN, retained only in encrypted filing documents","type":"string"},"tin_country":{"type":"string"},"tin_type":{"description":"empty or 1 = SSN/ITIN, 9 = foreign","type":"string"}},"required":["address","birth_date","customer_id","drivers_license","evidence","first_name","gender","last_name","license_state","tin"],"type":"object"},"CTRRequest":{"description":"CTRRequest contains only reviewed form metadata. Monetary amounts, account numbers, ownership, dates and complete activity membership come from native source records; there are no caller-supplied financial totals. An empty Profile is the original own-account teller profile, which uses Person and the Bank location fields. CTRProfileV2 uses Persons, Entities, Locations and, for a corrected report, PriorPacketID; those fields are absent from v1 requests so retained v1 input digests never change. CTRProfileV3 uses the v2 fields plus directed-backfile instruction evidence and extended party identity.","properties":{"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"bank":{"$ref":"#/components/schemas/CTRBank"},"directed":{"oneOf":[{"$ref":"#/components/schemas/CTRDirectedInstruction"},{"type":"null"}]},"directed_backfile":{"type":"boolean"},"entities":{"items":{"$ref":"#/components/schemas/CTREntity"},"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/CTRLocation"},"type":"array"},"person":{"$ref":"#/components/schemas/CTRPerson"},"persons":{"items":{"$ref":"#/components/schemas/CTRPerson"},"type":"array"},"prior_packet_id":{"type":"string"},"profile":{"type":"string"}},"required":["alert_id","bank","person"],"type":"object"},"Calculation":{"properties":{"amount_financed_amount":{"format":"int64","type":"integer"},"apr":{"type":"string"},"apr_lower":{"type":"string"},"apr_upper":{"type":"string"},"cash_to_close_amount":{"format":"int64","type":"integer"},"closing_costs_amount":{"format":"int64","type":"integer"},"finance_charge_amount":{"format":"int64","type":"integer"},"five_year_principal_amount":{"format":"int64","type":"integer"},"five_year_total_amount":{"format":"int64","type":"integer"},"origination_amount":{"format":"int64","type":"integer"},"payments":{"items":{"$ref":"#/components/schemas/LendingdisclosuresPayment"},"type":"array"},"tip":{"type":"string"},"total_interest_amount":{"format":"int64","type":"integer"},"total_payments_amount":{"format":"int64","type":"integer"}},"required":["amount_financed_amount","apr","apr_lower","apr_upper","cash_to_close_amount","closing_costs_amount","finance_charge_amount","five_year_principal_amount","five_year_total_amount","origination_amount","payments","tip","total_interest_amount","total_payments_amount"],"type":"object"},"Calendar":{"properties":{"closed":{"items":{"$ref":"#/components/schemas/Day"},"type":"array"},"weekdays":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["closed","weekdays"],"type":"object"},"CallReportBalances":{"description":"CallReportBalances is one page of the bank-wide listing of loan and facility receivables: the principal the bank carries of each credit at the close of each business date from From through AsOf, net of participations sold, read from the ledger history of the credit's own receivable account, with the Schedule RC-C category its product version names.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"data":{"items":{"$ref":"#/components/schemas/CreditBalance"},"type":"array"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"gl_codes":{"description":"every GL code a lending product posts receivables under","items":{"type":"string"},"type":"array"},"has_more":{"type":"boolean"}},"required":["as_of","data","from","gl_codes","has_more"],"type":"object"},"CallReportClosingCredits":{"description":"CallReportClosingCredits is one page of the loan and facility records the closing-day source retained for a business date, verified against the source's digests and each listed credit's dated ledger receivable.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"close_source_id":{"type":"string"},"close_source_sha256":{"type":"string"},"credit_records_id":{"type":"string"},"credit_records_sha256":{"type":"string"},"data":{"items":{"$ref":"#/components/schemas/ClosingCredit"},"type":"array"},"gl_codes":{"items":{"type":"string"},"type":"array"},"has_more":{"type":"boolean"},"observed_at":{"format":"date-time","type":"string"}},"required":["as_of","close_source_id","close_source_sha256","credit_records_id","credit_records_sha256","data","gl_codes","has_more","observed_at"],"type":"object"},"CallReportCreditLosses":{"description":"CallReportCreditLosses is one page of the charge-offs against, and recoveries credited to, the allowance for credit losses on loans and facilities, dated from From through Through.","properties":{"data":{"items":{"$ref":"#/components/schemas/CreditLoss"},"type":"array"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"has_more":{"type":"boolean"},"through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["data","from","has_more","through"],"type":"object"},"CallreportPlan":{"properties":{"capital_framework":{"type":"string"},"capital_state":{"$ref":"#/components/schemas/CapitalState"},"cblr_threshold_percent_exclusive":{"format":"int64","type":"integer"},"form":{"type":"string"},"form_reason":{"type":"string"},"leverage_ratio_percent":{"type":"string"},"rules_version":{"type":"string"},"schedules":{"items":{"$ref":"#/components/schemas/CallreportSchedule"},"type":"array"},"selection_issues":{"items":{"type":"string"},"type":"array"},"selection_ready":{"type":"boolean"},"sources":{"items":{"type":"string"},"type":"array"},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"}},"required":["capital_framework","capital_state","cblr_threshold_percent_exclusive","form","form_reason","rules_version","schedules","selection_issues","selection_ready","sources","submission_blockers","submission_ready"],"type":"object"},"CallreportProfile":{"description":"Profile concerns the consolidated bank, not its parent holding company's filings. Amounts are USD cents. Nil facts are unknown, never a negative attestation.","properties":{"additional_100m":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"additional_1b":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"additional_300m":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"advanced_approaches":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"annual_form":{"type":"string"},"bank_name":{"type":"string"},"capital_evidence_ref":{"type":"string"},"capital_framework":{"type":"string"},"category_iii":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"cblr_grace_requested":{"type":"boolean"},"cblr_history":{"oneOf":[{"$ref":"#/components/schemas/CapitalHistory"},{"type":"null"}]},"charter":{"type":"string"},"derived_facts":{"items":{"$ref":"#/components/schemas/DerivedFact"},"type":"array"},"domestic_offices":{"format":"int64","type":"integer"},"fdic_certificate":{"type":"string"},"fdic_insured":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"fiduciary_activity":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"fiduciary_assets_prior_year_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"fiduciary_income_prior_year_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"fiduciary_powers":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"foreign_offices":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"form_assets_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"form_assets_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"form_continuity_reviewed":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"form_evidence_ref":{"type":"string"},"gsib_or_category_ii":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"holding_company_context":{"type":"string"},"initial_form_ref":{"type":"string"},"initial_report":{"type":"boolean"},"institution_status":{"type":"string"},"large_complex_fdic":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"leverage_denominator_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"off_balance_exposure_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"rationale":{"type":"string"},"regulator_form_ref":{"type":"string"},"regulator_required_form":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rssd_id":{"type":"string"},"supersedes":{"type":"string"},"supervisory_conditions_reviewed":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"threshold_history_reviewed":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"tier1_capital_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"total_assets_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"trading_exposure_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["annual_form","bank_name","capital_evidence_ref","capital_framework","cblr_grace_requested","charter","domestic_offices","form_assets_date","form_evidence_ref","initial_report","institution_status","rationale","report_date"],"type":"object"},"CallreportRecord":{"properties":{"id":{"type":"string"},"plan":{"$ref":"#/components/schemas/CallreportPlan"},"profile":{"$ref":"#/components/schemas/CallreportProfile"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/CallreportReview"},{"type":"null"}]}},"required":["id","plan","profile","proposed_at","proposed_by"],"type":"object"},"CallreportReview":{"properties":{"actor":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"schedules":{"items":{"$ref":"#/components/schemas/ScheduleReview"},"type":"array"}},"required":["actor","decision","evidence_ref","rationale","reviewed_at"],"type":"object"},"CallreportReviewRequest":{"properties":{"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"schedules":{"items":{"$ref":"#/components/schemas/ScheduleReview"},"type":"array"}},"required":["decision","evidence_ref","rationale"],"type":"object"},"CallreportSchedule":{"properties":{"applicability":{"type":"string"},"code":{"type":"string"},"data_path":{"type":"string"},"local_coverage":{"type":"string"},"reason":{"type":"string"}},"required":["applicability","code","local_coverage","reason"],"type":"object"},"CancelReceivedPayment":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"},"CancelRequestBody":{"description":"CancelRequestBody asks the payer's institution to cancel a request the bank sent.","properties":{"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["operator","reason_code"],"type":"object"},"Cancellation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","at","reason"],"type":"object"},"CancellationRequest":{"properties":{"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","reason"],"type":"object"},"Candidate":{"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"matched_by":{"items":{"type":"string"},"type":"array"},"source_sha256":{"type":"string"}},"required":["created_at","customer_id","matched_by","source_sha256"],"type":"object"},"Capacity":{"properties":{"capacity":{"description":"single only in this implementation","type":"string"},"evidence":{"$ref":"#/components/schemas/PlacementsEvidence"},"external_amount":{"description":"includes principal + accrued interest, excludes this module's positions","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"fdic_certificate":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"owner_id":{"type":"string"},"valid_until":{"format":"date-time","type":"string"}},"required":["capacity","evidence","fdic_certificate","observed_at","owner_id","valid_until"],"type":"object"},"CapitalAmount":{"properties":{"amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"treatment":{"type":"string"}},"required":["evidence","treatment"],"type":"object"},"CapitalComponent":{"description":"BookAmount consumes a signed portion of a retained GL balance. RegulatoryAmount is the independently evidenced eligible amount after eligibility adjustments; expenses ordinarily contribute negatively. Empty GLCode means a disclosed consolidation/external import, never a purported core-derived component.","properties":{"book_amount":{"format":"int64","type":"integer"},"bucket":{"description":"cet1, additional_tier1, tier2, allowance, excluded","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"gl_code":{"type":"string"},"id":{"type":"string"},"regulatory_amount":{"format":"int64","type":"integer"},"treatment":{"type":"string"}},"required":["book_amount","bucket","evidence","id","regulatory_amount","treatment"],"type":"object"},"CapitalDeduction":{"properties":{"amount":{"format":"int64","type":"integer"},"bucket":{"description":"cet1, additional_tier1, tier2","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"id":{"type":"string"},"treatment":{"type":"string"}},"required":["amount","bucket","evidence","id","treatment"],"type":"object"},"CapitalDenominators":{"description":"AverageAssets is an evidenced whole-calendar-quarter average prepared under the applicable Call Report instructions. A closing balance is never substituted.","properties":{"additional_credit_rwa":{"$ref":"#/components/schemas/CapitalAmount"},"average_assets":{"$ref":"#/components/schemas/CapitalAmount"},"average_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"average_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"consolidation_adjustment":{"$ref":"#/components/schemas/CapitalAmount"},"leverage_deductions":{"$ref":"#/components/schemas/CapitalAmount"},"market_rwa":{"$ref":"#/components/schemas/CapitalAmount"},"trading_assets_and_liabilities":{"$ref":"#/components/schemas/CapitalAmount"}},"required":["additional_credit_rwa","average_assets","average_from","average_through","consolidation_adjustment","leverage_deductions","market_rwa","trading_assets_and_liabilities"],"type":"object"},"CapitalEligibility":{"properties":{"advanced_approaches":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"cblr_election_reported":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"supervisory_restriction":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["evidence"],"type":"object"},"CapitalExposure":{"description":"Every asset and contra-asset carrying balance is allocated. RegulatoryExposure is the documented exposure after prudential adjustments, not automatically book. Excluded allocations must have zero exposure and a retained reason. Unsupported consolidated instruments are explicit imports with no GLCode and zero BookAmount.","properties":{"book_amount":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"excluded":{"type":"boolean"},"gl_code":{"type":"string"},"id":{"type":"string"},"regulatory_exposure_amount":{"format":"int64","type":"integer"},"risk_class":{"type":"string"},"treatment":{"type":"string"}},"required":["book_amount","evidence","excluded","id","regulatory_exposure_amount","treatment"],"type":"object"},"CapitalExposureResult":{"properties":{"credit_equivalent_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"rwa_amount":{"format":"int64","type":"integer"}},"required":["credit_equivalent_amount","id","rwa_amount"],"type":"object"},"CapitalHistory":{"description":"CapitalHistory captures the surviving bank's reported elections, including periods outside CBLR. OtherCriteriaMet refers to the rules in force for that historical return.","properties":{"election":{"description":"opt_in, continue, opt_out","type":"string"},"election_ref":{"type":"string"},"merger_caused_failure":{"type":"boolean"},"opening_evidence_ref":{"type":"string"},"opening_grace_quarter":{"format":"int64","type":"integer"},"opening_status":{"type":"string"},"quarters":{"items":{"$ref":"#/components/schemas/CapitalQuarter"},"type":"array"}},"required":["election","election_ref","merger_caused_failure","opening_evidence_ref","opening_grace_quarter","opening_status","quarters"],"type":"object"},"CapitalMonthEndResult":{"description":"CapitalMonthEndResult is a month-end run's tier 1 capital as Schedule RC-R Part I item 26 measures it: the CBLR numerator, without a tier 2 shortfall transfer, when the run reports a CBLR election, otherwise tier 1 capital. ClosingDate is the retained closing it was measured on; Carried says the month-end was not a Federal Reserve banking day, so that closing is the last banking day's. Both are omitted when zero, so a result retained before they were recorded re-encodes to its digest.","properties":{"carried":{"type":"boolean"},"cblr_election_reported":{"type":"boolean"},"closing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"tier1_amount":{"format":"int64","type":"integer"}},"required":["carried","cblr_election_reported","closing_date","tier1_amount"],"type":"object"},"CapitalOffBalance":{"properties":{"cblr_included":{"description":"notional inclusion under 3.12, distinct from risk-based CCF","oneOf":[{"type":"boolean"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"id":{"type":"string"},"notional_amount":{"format":"int64","type":"integer"},"risk_class":{"type":"string"},"treatment":{"type":"string"}},"required":["evidence","id","notional_amount","risk_class","treatment"],"type":"object"},"CapitalPolicy":{"description":"CapitalPolicy is a reviewed classification policy, not a rule that infers risk weights or instrument eligibility from a loan/product label.","properties":{"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"methodology":{"type":"string"},"minimum_cet1_bps":{"format":"int64","type":"integer"},"minimum_leverage_bps":{"format":"int64","type":"integer"},"minimum_tier1_bps":{"format":"int64","type":"integer"},"minimum_total_bps":{"format":"int64","type":"integer"},"name":{"type":"string"},"risk_classes":{"items":{"$ref":"#/components/schemas/CapitalRiskClass"},"type":"array"}},"required":["effective_from","effective_through","evidence","methodology","minimum_cet1_bps","minimum_leverage_bps","minimum_tier1_bps","minimum_total_bps","name","risk_classes"],"type":"object"},"CapitalQuarter":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"leverage_denominator_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"merger_caused_failure":{"type":"boolean"},"other_criteria_met":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"qualified, grace, risk_based, not_operating","type":"string"},"tier1_capital_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["evidence_ref","evidence_sha256","merger_caused_failure","report_date","status"],"type":"object"},"CapitalRatio":{"properties":{"bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"denominator_amount":{"format":"int64","type":"integer"},"meets_minimum":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"minimum_bps":{"format":"int64","type":"integer"},"numerator_amount":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["denominator_amount","minimum_bps","numerator_amount","status"],"type":"object"},"CapitalResults":{"description":"CapitalResults of a quarter-end run always carry the leverage ratio and the CBLR criteria; a month-end run carries neither, because both are measured over a whole-quarter average.","properties":{"additional_tier1_amount":{"format":"int64","type":"integer"},"allowance_excluded_amount":{"format":"int64","type":"integer"},"allowance_included_amount":{"format":"int64","type":"integer"},"cblr":{"oneOf":[{"$ref":"#/components/schemas/CBLRCriteria"},{"type":"null"}]},"cet1_amount":{"format":"int64","type":"integer"},"cet1_ratio":{"$ref":"#/components/schemas/CapitalRatio"},"credit_rwa_amount":{"format":"int64","type":"integer"},"engine_version":{"type":"string"},"exposures":{"items":{"$ref":"#/components/schemas/CapitalExposureResult"},"type":"array"},"leverage_ratio":{"oneOf":[{"$ref":"#/components/schemas/CapitalRatio"},{"type":"null"}]},"limitations":{"items":{"type":"string"},"type":"array"},"month_end":{"oneOf":[{"$ref":"#/components/schemas/CapitalMonthEndResult"},{"type":"null"}]},"tier1_amount":{"format":"int64","type":"integer"},"tier1_ratio":{"$ref":"#/components/schemas/CapitalRatio"},"tier2_amount":{"format":"int64","type":"integer"},"total_capital_amount":{"format":"int64","type":"integer"},"total_ratio":{"$ref":"#/components/schemas/CapitalRatio"},"total_rwa_amount":{"format":"int64","type":"integer"}},"required":["additional_tier1_amount","allowance_excluded_amount","allowance_included_amount","cet1_amount","cet1_ratio","credit_rwa_amount","engine_version","exposures","limitations","tier1_amount","tier1_ratio","tier2_amount","total_capital_amount","total_ratio","total_rwa_amount"],"type":"object"},"CapitalRiskClass":{"properties":{"conversion_factor_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"key":{"type":"string"},"risk_weight_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"treatment":{"type":"string"}},"required":["evidence","key","treatment"],"type":"object"},"CapitalRun":{"properties":{"policy":{"$ref":"#/components/schemas/CapitalPolicy"},"policy_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/CapitalRunRequest"},"results":{"$ref":"#/components/schemas/CapitalResults"},"source":{"$ref":"#/components/schemas/AlmSource"}},"required":["policy","policy_sha256","request","results","source"],"type":"object"},"CapitalRunRequest":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"components":{"items":{"$ref":"#/components/schemas/CapitalComponent"},"type":"array"},"coverage_evidence":{"$ref":"#/components/schemas/AlmEvidence"},"deductions":{"items":{"$ref":"#/components/schemas/CapitalDeduction"},"type":"array"},"denominators":{"$ref":"#/components/schemas/CapitalDenominators"},"eligibility":{"$ref":"#/components/schemas/CapitalEligibility"},"exposures":{"items":{"$ref":"#/components/schemas/CapitalExposure"},"type":"array"},"measurement":{"description":"omitted for a quarter-end run; month_end at a quarter's first or second month-end","type":"string"},"off_balance":{"items":{"$ref":"#/components/schemas/CapitalOffBalance"},"type":"array"},"policy_id":{"type":"string"},"rationale":{"type":"string"}},"required":["as_of","components","coverage_evidence","deductions","denominators","eligibility","exposures","off_balance","policy_id","rationale"],"type":"object"},"CapitalState":{"properties":{"consecutive_grace_limit":{"format":"int64","type":"integer"},"grace_floor_bps_exclusive":{"format":"int64","type":"integer"},"grace_quarter":{"format":"int64","type":"integer"},"history_validated":{"type":"boolean"},"prior_twenty_quarters_grace":{"format":"int64","type":"integer"},"qualifying_threshold_bps_exclusive":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["consecutive_grace_limit","grace_floor_bps_exclusive","grace_quarter","history_validated","prior_twenty_quarters_grace","qualifying_threshold_bps_exclusive","status"],"type":"object"},"Capture":{"description":"Capture may be approved while collection is in progress, but only complete, reportable records enter a draft LAR export. Keys are the FIG's 1-based field numbers; explicit blanks are preserved and never replaced with invented codes.","properties":{"collection_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"fields":{"additionalProperties":{"type":"string"},"type":"object"},"geography":{"oneOf":[{"$ref":"#/components/schemas/Geography"},{"type":"null"}]},"hmda_reportability":{"description":"reportable, not_reportable, undetermined","type":"string"},"readiness":{"description":"in_progress, complete","type":"string"},"reportability_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"reporting_year":{"format":"int64","type":"integer"},"schema_id":{"type":"string"}},"required":["collection_evidence","fields","hmda_reportability","readiness","reportability_evidence","reporting_year","schema_id"],"type":"object"},"CaptureRemoteDepositRequest":{"description":"CaptureRemoteDepositRequest is one remotely captured item: the account, the two TIFF images, and optionally the amount and payee the customer typed.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"back_image":{"format":"byte","type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"drawer":{"type":"string"},"front_image":{"format":"byte","type":"string"},"payee":{"type":"string"}},"required":["account_id","amount","back_image","currency_code","front_image"],"type":"object"},"CaptureRequest":{"properties":{"category":{"type":"string"},"content":{"description":"base64 in JSON; maximum 256 KiB per evidenced record","format":"byte","type":"string"},"content_sha256":{"type":"string"},"content_type":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"},"retention_event_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["category","content","content_sha256","content_type","created_at","evidence_ref","evidence_sha256","reason","source_ref","source_service"],"type":"object"},"Card":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cardholder_authority_id":{"example":"chra_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cardholder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"controls":{"$ref":"#/components/schemas/Controls"},"expiry_month":{"format":"int64","type":"integer"},"expiry_year":{"format":"int64","type":"integer"},"facility_id":{"type":"string"},"form":{"type":"string"},"id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"last4":{"type":"string"},"network":{"type":"string"},"pan_token":{"type":"string"},"status":{"type":"string"}},"required":["account_id","controls","expiry_month","expiry_year","form","id","kind","last4","network","pan_token","status"],"type":"object"},"CardOverdraftFeeRequest":{"properties":{"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision_id":{"type":"string"}},"required":["authorization_id","decision_id"],"type":"object"},"CardPIN":{"description":"CardPIN is a card's PIN verification record without the value.","properties":{"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"changed_at":{"format":"date-time","type":"string"},"locked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"method":{"type":"string"},"pvk_key_id":{"type":"string"},"pvki":{"format":"int64","type":"integer"},"set_at":{"format":"date-time","type":"string"},"status":{"type":"string"},"tries":{"format":"int64","type":"integer"},"try_limit":{"format":"int64","type":"integer"},"unlocked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"unlocked_by":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["card_id","changed_at","method","pvk_key_id","pvki","set_at","status","tries","try_limit","updated_at"],"type":"object"},"CardSecurityBinding":{"description":"CardSecurityBinding is what personalisation fixed for one card.","properties":{"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cvk_key_id":{"type":"string"},"imk_key_id":{"type":"string"},"last_atc":{"format":"int64","type":"integer"},"pan_sequence":{"type":"string"},"personalized_at":{"format":"date-time","type":"string"},"personalized_by":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["card_id","cvk_key_id","last_atc","pan_sequence","personalized_at","personalized_by","updated_at"],"type":"object"},"CardVerification":{"description":"CardVerification is what the issuer processor's security module found on the credentials the token service forwarded: the core never sees the CVV2 or the PAN.","properties":{"avs":{"description":"match, partial, no_match or not_checked","type":"string"},"cvv2":{"description":"match, no_match or not_checked","type":"string"},"expiry":{"description":"match, no_match or not_checked","type":"string"}},"required":["avs","cvv2","expiry"],"type":"object"},"CardholderAuthority":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"eligibility":{"$ref":"#/components/schemas/CardholderEligibility"},"id":{"example":"chra_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request":{"$ref":"#/components/schemas/CardholderAuthorityRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/CardholderReview"},{"type":"null"}]},"revocation":{"oneOf":[{"$ref":"#/components/schemas/CardholderRevocation"},{"type":"null"}]}},"required":["actor","at","content_sha256","eligibility","id","request"],"type":"object"},"CardholderAuthorityRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"facility_id":{"type":"string"},"holder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"}},"required":["account_id","evidence_ref","evidence_sha256","expires_at","holder_customer_id","reason"],"type":"object"},"CardholderEligibility":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_open":{"type":"boolean"},"active":{"type":"boolean"},"death_revision":{"format":"int64","type":"integer"},"deceased":{"type":"boolean"},"funding_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"holder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kyc_verified":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owner":{"type":"boolean"},"owners":{"items":{"type":"string"},"type":"array"},"ownership_revision":{"format":"int64","type":"integer"},"person":{"type":"boolean"}},"required":["account_id","account_open","active","deceased","funding_customer_id","holder_customer_id","kyc_verified","ledger_account_id","owner","owners","ownership_revision","person"],"type":"object"},"CardholderReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["actor","approve","at","content_sha256","reason"],"type":"object"},"CardholderReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["approve","content_sha256","reason"],"type":"object"},"CardholderRevocation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"reason":{"type":"string"}},"required":["actor","at","evidence_ref","reason"],"type":"object"},"CardholderRevocationRequest":{"properties":{"evidence_ref":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","reason"],"type":"object"},"CardsDecision":{"properties":{"approved_amount":{"description":"a partial approval (response 10) or an increment","format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"},"replayed":{"type":"boolean"},"response_code":{"type":"string"}},"required":["authorization_id","decision","reason","replayed","response_code"],"type":"object"},"CardsSettlement":{"properties":{"attempt":{"format":"int64","type":"integer"},"batch_key":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cash_effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"cleared_amount":{"format":"int64","type":"integer"},"count":{"format":"int64","type":"integer"},"inventory_known":{"type":"boolean"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"more_available":{"type":"boolean"},"network":{"type":"string"},"replayed":{"type":"boolean"},"source_sha256":{"type":"string"}},"required":["business_date","cleared_amount","count","inventory_known","more_available","network","replayed"],"type":"object"},"CardsSettlementRequest":{"properties":{"business_date":{"type":"string"},"network":{"type":"string"}},"required":["business_date","network"],"type":"object"},"Carrier":{"properties":{"actor":{"type":"string"},"code":{"type":"string"},"contact":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["actor","code","contact","created_at","evidence","id","name"],"type":"object"},"CarrierReceipt":{"description":"CarrierReceipt is the carrier module's acknowledgement of an order.","properties":{"accepted_at":{"format":"date-time","type":"string"},"reference":{"type":"string"}},"required":["accepted_at","reference"],"type":"object"},"CarrierRequest":{"properties":{"code":{"type":"string"},"contact":{"type":"string"},"evidence":{"type":"string"},"name":{"type":"string"}},"required":["code","contact","evidence","name"],"type":"object"},"Case":{"description":"Case is a unit of work for the back office.","properties":{"assignee":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"dispute, compliance_alert, customer_request","type":"string"},"notes":{"items":{"$ref":"#/components/schemas/Note"},"type":"array"},"ref":{"description":"the thing the case is about: an alert id, a transfer id","type":"string"},"status":{"description":"open, in_progress, closed","type":"string"},"subject":{"type":"string"},"summary":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["created_at","id","kind","notes","ref","status","subject","summary","updated_at"],"type":"object"},"CaseRequest":{"properties":{"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"claim_minor":{"format":"int64","type":"integer"},"eligibility":{"$ref":"#/components/schemas/SchemesReceipt"},"evidence":{"items":{"$ref":"#/components/schemas/SchemesEvidence"},"type":"array"}},"required":["authorization_id","claim_minor","eligibility","evidence"],"type":"object"},"CashCollateral":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/Evidence"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"no_other_lien":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"owner_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"perfected_and_enforceable":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"segregated_and_earmarked":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["account_id","amount","evidence","ledger_account_id","owner_customer_id"],"type":"object"},"CashConfirmation":{"properties":{"actor":{"type":"string"},"evidence":{"type":"string"},"movement_id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","evidence","recorded_at"],"type":"object"},"CashDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"evidence":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","approve","evidence","recorded_at"],"type":"object"},"CashDecisionRequest":{"properties":{"approve":{"type":"boolean"},"evidence":{"type":"string"}},"required":["approve","evidence"],"type":"object"},"CashExecution":{"properties":{"actor":{"type":"string"},"credit_id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"movement_id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","journal_id","movement_id","recorded_at"],"type":"object"},"CashFlow":{"description":"CashFlow is a receipt for an asset and a payment for a liability; negative interest is supported explicitly, but principal cannot be negative.","properties":{"interest_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"}},"required":["interest_amount","principal_amount"],"type":"object"},"CashInstruction":{"description":"Instruction is a captured FedCash instruction with its review, Fed submission, carrier shipment, receipt, discrepancy and posting.","properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"discrepancy":{"oneOf":[{"$ref":"#/components/schemas/Discrepancy"},{"type":"null"}]},"endpoint":{"type":"string"},"evidence":{"type":"string"},"execution":{"oneOf":[{"$ref":"#/components/schemas/FedExecution"},{"type":"null"}]},"fee_amount":{"format":"int64","type":"integer"},"fees":{"items":{"$ref":"#/components/schemas/FedcashFee"},"type":"array"},"id":{"type":"string"},"kind":{"description":"order, deposit","type":"string"},"office_code":{"type":"string"},"packages":{"items":{"$ref":"#/components/schemas/FedcashPackage"},"type":"array"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/CashReceipt"},{"type":"null"}]},"ship_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"shipment":{"oneOf":[{"$ref":"#/components/schemas/FedCashShipment"},{"type":"null"}]},"status":{"type":"string"},"submission":{"oneOf":[{"$ref":"#/components/schemas/Submission"},{"type":"null"}]},"unit_id":{"type":"string"}},"required":["actor","amount","created_at","endpoint","evidence","fee_amount","fees","id","kind","office_code","packages","ship_date","status","unit_id"],"type":"object"},"CashInvoice":{"properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"carrier_id":{"type":"string"},"contract_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]},"period_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_until":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"posting":{"oneOf":[{"$ref":"#/components/schemas/CashExecution"},{"type":"null"}]},"reference":{"type":"string"},"stops":{"format":"int64","type":"integer"}},"required":["actor","amount","business_date","carrier_id","contract_id","created_at","evidence","evidence_sha256","id","period_from","period_until","reference","stops"],"type":"object"},"CashJournal":{"properties":{"delta_amount":{"format":"int64","type":"integer"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"type":"string"},"sha256":{"type":"string"},"source_reference":{"type":"string"},"source_service":{"type":"string"}},"required":["delta_amount","effective_date","id","sha256","source_reference","source_service"],"type":"object"},"CashLetter":{"description":"CashLetter is an image cash letter file sent or received.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"direction":{"description":"outbound or inbound","type":"string"},"id":{"type":"string"},"item_count":{"format":"int64","type":"integer"},"kind":{"description":"forward or return","type":"string"},"rail_ref":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"built, sent, send_failed, settled, received","type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["business_date","created_at","direction","id","item_count","kind","status","total_amount"],"type":"object"},"CashManifest":{"properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"id":{"type":"string"},"seal_numbers":{"items":{"type":"string"},"type":"array"},"shipment_id":{"type":"string"}},"required":["actor","amount","created_at","denominations","id","seal_numbers","shipment_id"],"type":"object"},"CashObservation":{"description":"CashObservation is a read of the actual ledger's immutable command digest and permanent claim, alongside its retained exact command. It is not broker cash.","properties":{"claim_key":{"type":"string"},"committed_at":{"format":"date-time","type":"string"},"journal":{"$ref":"#/components/schemas/Journal"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_sha256":{"type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["claim_key","committed_at","journal","journal_id","journal_sha256","posting_date"],"type":"object"},"CashOrder":{"properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"atm_order_id":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cadence":{"description":"ad_hoc, scheduled","type":"string"},"carrier_id":{"type":"string"},"confirmation":{"oneOf":[{"$ref":"#/components/schemas/CashConfirmation"},{"type":"null"}]},"contract_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"description":"USD face value in cents -> number of pieces","type":"object"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"fedcash_order_id":{"type":"string"},"from_unit_id":{"type":"string"},"id":{"type":"string"},"kind":{"description":"delivery, pickup","type":"string"},"maker":{"type":"string"},"movement_id":{"type":"string"},"needed_by":{"format":"date-time","type":"string"},"reference":{"type":"string"},"service":{"description":"branch, vault, atm, fedcash","type":"string"},"shipment_id":{"type":"string"},"status":{"description":"proposed, confirmed, approved, rejected, cancelled","type":"string"},"to_unit_id":{"type":"string"}},"required":["actor","amount","business_date","cadence","carrier_id","contract_id","created_at","denominations","evidence","evidence_sha256","id","kind","needed_by","reference","service","status"],"type":"object"},"CashReceipt":{"description":"Receipt is a captured physical count against the instruction.","properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"difference_amount":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"packages":{"items":{"$ref":"#/components/schemas/FedcashPackage"},"type":"array"},"recorded_at":{"format":"date-time","type":"string"},"seal_numbers":{"items":{"type":"string"},"type":"array"}},"required":["actor","amount","difference_amount","evidence","packages","recorded_at","seal_numbers"],"type":"object"},"CashReceiptRequest":{"description":"Receipt is the counted amount that arrived (order) or that the office credited (deposit).","properties":{"difference_amount":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"packages":{"items":{"$ref":"#/components/schemas/FedcashPackage"},"type":"array"},"seal_numbers":{"items":{"type":"string"},"type":"array"}},"required":["difference_amount","evidence","packages","seal_numbers"],"type":"object"},"CashReconciliation":{"description":"CashReconciliation compares a terminal's counters with the custody ledger.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cassettes":{"items":{"$ref":"#/components/schemas/CassetteState"},"type":"array"},"counters_sha256":{"type":"string"},"cycle":{"format":"int64","type":"integer"},"difference_amount":{"format":"int64","type":"integer"},"exceptions":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"ledger_amount":{"description":"the unit's posted GL 1020 balance","format":"int64","type":"integer"},"pending_postings":{"items":{"type":"string"},"type":"array"},"physical_amount":{"description":"cassettes plus the reject, retract and deposit bins","format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"retract_bin_notes":{"format":"int64","type":"integer"},"retracted_notes":{"description":"notes the switch recorded as retracted in the cycle","format":"int64","type":"integer"},"status":{"description":"balanced, out_of_balance, pending_postings","type":"string"},"terminal_ref":{"type":"string"}},"required":["business_date","cassettes","counters_sha256","cycle","difference_amount","exceptions","id","ledger_amount","pending_postings","physical_amount","recorded_at","retract_bin_notes","retracted_notes","status","terminal_ref"],"type":"object"},"CashRequest":{"properties":{"evidence":{"$ref":"#/components/schemas/NetworkfinanceEvidence"},"external_cash_minor":{"description":"Signed cash movement: receipt positive, payment negative. Includes any\nlinked principal settlement which has already been posted by cards.","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"external_reference":{"type":"string"},"settlement_batch_key":{"type":"string"},"statement_id":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["evidence","external_reference","statement_id","value_date"],"type":"object"},"CashStatement":{"description":"Statement is a retained office statement.","properties":{"actor":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence":{"type":"string"},"id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/CashStatementLine"},"type":"array"},"office_code":{"type":"string"}},"required":["actor","business_date","created_at","evidence","id","lines","office_code"],"type":"object"},"CashStatementLine":{"description":"StatementLine is one master-account cash movement on the Fed statement.","properties":{"amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"direction":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"reference":{"type":"string"}},"required":["amount","description","direction","id","kind","reference"],"type":"object"},"CashStatementRequest":{"description":"StatementRequest is a FedCash office statement the bank ingests.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/CashStatementLine"},"type":"array"},"office_code":{"type":"string"}},"required":["business_date","evidence","lines","office_code"],"type":"object"},"Cassette":{"description":"Cassette is one note cassette's configuration.","properties":{"capacity_notes":{"description":"what a replenishment fills the cassette to","format":"int64","type":"integer"},"denomination_amount":{"format":"int64","type":"integer"},"position":{"format":"int64","type":"integer"}},"required":["capacity_notes","denomination_amount","position"],"type":"object"},"CassetteState":{"description":"CassetteState is what the switch knows of a cassette: its configuration, the notes it estimates remain (from the last counters less what it has since presented) and the supply state the terminal last reported.","properties":{"denomination_amount":{"format":"int64","type":"integer"},"notes":{"format":"int64","type":"integer"},"position":{"format":"int64","type":"integer"},"supply":{"description":"OK, LOW, OUT","type":"string"}},"required":["denomination_amount","notes","position","supply"],"type":"object"},"Catalog":{"description":"Catalog is the published offices, packing units, windows and 2026 fees.","properties":{"cross_shipping_fee_amount":{"format":"int64","type":"integer"},"denominations":{"items":{"$ref":"#/components/schemas/Standard"},"type":"array"},"offices":{"items":{"$ref":"#/components/schemas/Office"},"type":"array"},"ucap_fee_amount":{"format":"int64","type":"integer"},"windows":{"items":{"$ref":"#/components/schemas/Window"},"type":"array"}},"required":["cross_shipping_fee_amount","denominations","offices","ucap_fee_amount","windows"],"type":"object"},"CeclExecution":{"properties":{"output":{"$ref":"#/components/schemas/Output"},"request":{"$ref":"#/components/schemas/Execute"},"source_export_id":{"type":"string"},"source_export_sha256":{"type":"string"}},"required":["output","request","source_export_id","source_export_sha256"],"type":"object"},"CeclGroup":{"description":"Group matches one explicit product, grade scale/version and grade. Separate groups allow an individually assessed credit to use a dedicated risk grade. Method selects the model family; an empty method is the PD/LGD default so previously approved models keep their exact behaviour and hash inputs.","properties":{"annual_loss_rate_bps":{"format":"int64","type":"integer"},"contractual_extensions_months":{"format":"int64","type":"integer"},"evergreen_remaining_months":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"forecast_monthly_pd_bps":{"items":{"format":"int64","type":"integer"},"type":"array"},"grade":{"type":"string"},"historical_monthly_pd_bps":{"format":"int64","type":"integer"},"id":{"type":"string"},"lgd_bps":{"format":"int64","type":"integer"},"lifetime_loss_rate_bps":{"format":"int64","type":"integer"},"method":{"type":"string"},"monthly_prepayment_bps":{"format":"int64","type":"integer"},"past_maturity_months":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"reversion_months":{"format":"int64","type":"integer"},"scale_id":{"type":"string"},"scale_version":{"type":"string"},"unconditionally_cancellable":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"unfunded_conversion_bps":{"format":"int64","type":"integer"}},"required":["contractual_extensions_months","evergreen_remaining_months","evidence","grade","id","monthly_prepayment_bps","past_maturity_months","product_code","scale_id","scale_version","unfunded_conversion_bps"],"type":"object"},"CeclRecord":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/MonitoringDecision"},{"type":"null"}]},"execution":{"oneOf":[{"$ref":"#/components/schemas/CeclExecution"},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string"},"model":{"oneOf":[{"$ref":"#/components/schemas/Model"},{"type":"null"}]},"sha256":{"type":"string"},"subject":{"type":"string"}},"required":["actor","created_at","id","kind","sha256","subject"],"type":"object"},"CeremonyComponent":{"description":"CeremonyComponent is one custodian's entry.","properties":{"check_value":{"type":"string"},"custodian":{"type":"string"},"entered_at":{"format":"date-time","type":"string"},"ordinal":{"format":"int64","type":"integer"}},"required":["check_value","custodian","entered_at","ordinal"],"type":"object"},"CeremonyDecision":{"description":"CeremonyDecision is the approver's decision.","properties":{"decided_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["decided_at","decided_by","decision"],"type":"object"},"CeremonyDecisionRequest":{"description":"CeremonyDecisionRequest decides a ceremony.","properties":{"decision":{"type":"string"},"document_sha256":{"type":"string"},"note":{"type":"string"}},"required":["decision"],"type":"object"},"CeremonyRequest":{"description":"CeremonyRequest opens a key ceremony.","properties":{"components_required":{"format":"int64","type":"integer"},"decimalization":{"type":"string"},"kek_key_id":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"network":{"type":"string"},"pvki":{"format":"int64","type":"integer"},"reason":{"type":"string"},"received_key_block":{"type":"string"},"template":{"$ref":"#/components/schemas/KeyTemplate"},"zone_key_index":{"type":"string"}},"required":["kind","reason","template"],"type":"object"},"CertificateStatus":{"description":"CertificateStatus is where a certificate stands today.","properties":{"at_maturity":{"description":"rollover or pay_out","type":"string"},"grace_days":{"format":"int64","type":"integer"},"grace_ends":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"in_grace":{"type":"boolean"},"matured":{"type":"boolean"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"penalty_days":{"format":"int64","type":"integer"},"renewals":{"format":"int64","type":"integer"},"rollover_product_code":{"type":"string"},"term_months":{"format":"int64","type":"integer"},"withdrawable":{"type":"boolean"}},"required":["at_maturity","grace_days","grace_ends","in_grace","matured","maturity_date","penalty_days","renewals","term_months","withdrawable"],"type":"object"},"CertificateTerms":{"description":"CertificateTerms are a certificate account's contract.","properties":{"at_maturity":{"description":"rollover or pay_out","type":"string"},"grace_days":{"format":"int64","type":"integer"},"matured":{"type":"boolean"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"penalty_days":{"format":"int64","type":"integer"},"renewals":{"format":"int64","type":"integer"},"rollover_product_code":{"type":"string"},"term_months":{"format":"int64","type":"integer"}},"required":["at_maturity","grace_days","matured","maturity_date","penalty_days","renewals","term_months"],"type":"object"},"Challenge":{"description":"Challenge is one one-time code the bank issued. The code itself is sealed at rest and never leaves the bank except in the notification to the cardholder.","properties":{"created_at":{"format":"date-time","type":"string"},"delivery":{"description":"sent, queued or undeliverable","type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"method":{"type":"string"},"notification_id":{"example":"ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"number":{"format":"int64","type":"integer"},"token_id":{"type":"string"}},"required":["created_at","expires_at","id","method","number","token_id"],"type":"object"},"Change":{"description":"Change is a notification of change: received as the ODFI about an entry the bank originated (applied to the next entries to the same account), or sent as the RDFI about an entry it received.","properties":{"account_number":{"type":"string"},"change_code":{"type":"string"},"change_reason":{"type":"string"},"corrected":{"$ref":"#/components/schemas/Corrected"},"corrected_data":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"direction":{"description":"inbound or outbound","type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"original_dfi":{"type":"string"},"original_trace":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"refused_code":{"type":"string"},"refused_file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"refused_reason":{"type":"string"},"routing_number":{"type":"string"},"status":{"description":"received, applied, refused, sent","type":"string"},"trace_number":{"type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_number","change_code","change_reason","corrected","corrected_data","created_at","direction","id","original_trace","routing_number","status","updated_at"],"type":"object"},"ChangePasswordRequest":{"description":"ChangePasswordRequest changes the password and revokes the other sessions.","properties":{"current_password":{"type":"string"},"new_password":{"type":"string"}},"required":["current_password","new_password"],"type":"object"},"Channels":{"description":"Channels a card may be used on.","properties":{"atm":{"type":"boolean"},"contactless":{"type":"boolean"},"ecommerce":{"type":"boolean"},"pos":{"type":"boolean"}},"required":["atm","contactless","ecommerce","pos"],"type":"object"},"Check":{"description":"Check is forwarded only by a verified staff/service caller using the original token's identity.","properties":{"amount":{"format":"int64","type":"integer"},"api_accounts":{"items":{"type":"string"},"type":"array"},"api_key_id":{"type":"string"},"customer_bound":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"permission":{"type":"string"},"subject":{"type":"string"}},"required":["amount","customer_bound","customer_id","permission","subject"],"type":"object"},"CheckDeposit":{"description":"CheckDeposit is a check a customer deposited.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"cash_letter_id":{"type":"string"},"channel":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"deposited_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"has_images":{"type":"boolean"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lockbox_remittance_id":{"type":"string"},"micr":{"$ref":"#/components/schemas/MICR"},"payee":{"type":"string"},"return_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"return_reason":{"type":"string"},"return_reason_text":{"type":"string"},"screening":{"description":"held (parked on transit for sanctions review), released or blocked","type":"string"},"screening_reason":{"description":"what screening found and, once blocked, the blocked-property note","type":"string"},"sequence_number":{"type":"string"},"status":{"description":"deposited, presented, settled, returned","type":"string"}},"required":["account_id","amount","channel","created_at","currency_code","has_images","id","micr","sequence_number","status"],"type":"object"},"CheckExceptionHold":{"description":"CheckExceptionHold is a Reg CC exception hold on a check deposit.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"available_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"deposit_id":{"type":"string"},"hold_ids":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"notice":{"$ref":"#/components/schemas/CheckHoldNotice"},"placed_by":{"type":"string"},"reason":{"type":"string"},"return_reference":{"type":"string"},"returned_deposit_id":{"type":"string"},"status":{"type":"string"}},"required":["account_id","amount","available_on","created_at","deposit_id","hold_ids","id","notice","placed_by","reason","return_reference","returned_deposit_id","status"],"type":"object"},"CheckExceptionRequest":{"description":"CheckExceptionRequest places the Reg CC redeposited-check exception (12 CFR 229.13(c)) on a check deposit: the earlier deposit of the same item and the ledger key of the committed return that charged it back (payments:check-return:<earlier deposit id>).","properties":{"available_on":{"description":"a shorter hold the bank chooses, within the exception period","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"explanation":{"type":"string"},"operator":{"description":"names the staff member only on the open local stack","type":"string"},"return_reference":{"type":"string"},"returned_deposit_id":{"type":"string"}},"required":["return_reference","returned_deposit_id"],"type":"object"},"CheckHoldNotice":{"description":"CheckHoldNotice is the 229.16(c)(1) notice of an exception hold.","properties":{"account_number_last4":{"type":"string"},"available_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"citation":{"type":"string"},"deposit_amount":{"format":"int64","type":"integer"},"deposited_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"held_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"reason_text":{"type":"string"}},"required":["account_number_last4","available_on","citation","deposit_amount","deposited_on","held_amount","reason","reason_text"],"type":"object"},"CheckScreeningReview":{"description":"CheckScreeningReview is the one decision on a parked deposit.","properties":{"decided_by":{"type":"string"},"decision":{"description":"approved or blocked","type":"string"},"deposit":{"$ref":"#/components/schemas/CheckDeposit"},"deposit_id":{"type":"string"},"hold_ids":{"items":{"type":"string"},"type":"array"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["decided_by","decision","deposit","deposit_id"],"type":"object"},"CheckScreeningReviewBody":{"description":"CheckScreeningReviewBody decides a check deposit that sanctions screening parked on the transit account: approve (the funds go to the customer under the deposit's Reg CC availability) or block (they stay on the transit account as blocked property).","properties":{"actor":{"description":"names the reviewer only on the open local stack","type":"string"},"decision":{"description":"approve or block","type":"string"}},"required":["decision"],"type":"object"},"ChildSupportTerms":{"description":"ChildSupportTerms bind one served child support order to its state disbursement unit.","properties":{"application_id":{"type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disbursement_unit":{"type":"string"},"fips":{"type":"string"},"medical_support":{"type":"string"},"ncp_identifier_id":{"type":"string"},"ncp_identifier_last4":{"type":"string"},"ncp_name":{"type":"string"},"order_evidence_reference":{"type":"string"},"order_evidence_sha256":{"type":"string"},"state":{"type":"string"}},"required":["application_id","case_id","disbursement_unit","medical_support","ncp_identifier_id","ncp_identifier_last4","order_evidence_reference","order_evidence_sha256","state"],"type":"object"},"Choice":{"properties":{"method":{"type":"string"},"months":{"format":"int64","type":"integer"}},"required":["method"],"type":"object"},"Claim":{"properties":{"actor":{"type":"string"},"adjustment_id":{"type":"string"},"amount":{"format":"int64","type":"integer"},"carrier_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"direction":{"description":"shortage, surplus","type":"string"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"shipment_id":{"type":"string"}},"required":["actor","amount","carrier_id","created_at","direction","evidence","evidence_sha256","id","shipment_id"],"type":"object"},"ClaimRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"direction":{"description":"shortage, surplus","type":"string"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"shipment_id":{"type":"string"}},"required":["amount","direction","evidence","evidence_sha256","shipment_id"],"type":"object"},"Classification":{"description":"Classification is the reviewed reporting attribute of one approved instrument from an effective date: its accounting designation, the RC-B item it is reported in, whether its rate is fixed (remaining maturity governs Memorandum 2) or floating (its next repricing date does), and whether it is a structured note (Memorandum 4).","properties":{"basis":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"designation":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"instrument_id":{"type":"string"},"rate_type":{"type":"string"},"rationale":{"type":"string"},"rcb_line":{"type":"string"},"structured_note":{"type":"boolean"}},"required":["basis","designation","effective_date","instrument_id","rate_type","rationale","rcb_line","structured_note"],"type":"object"},"ClassificationRecord":{"description":"ClassificationRecord is a retained classification version bound to the exact approved instrument control content, with its independent decision.","properties":{"actor":{"type":"string"},"classification":{"$ref":"#/components/schemas/Classification"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"id":{"type":"string"},"instrument_sha256":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["actor","classification","content_sha256","created_at","id","instrument_sha256","version"],"type":"object"},"ClearingConversion":{"description":"Conversion is the currency conversion a presentment carries when the merchant's currency is not the cardholder's: the amount in the transaction currency and the rate the network applied. Rate is eight digits: the first is the number of decimal places, the other seven the rate (the ISO 8583 conversion-rate representation).","properties":{"rate":{"type":"string"},"source_amount_minor":{"format":"int64","type":"integer"},"source_currency":{"type":"string"}},"required":["rate","source_amount_minor","source_currency"],"type":"object"},"ClearingDetail":{"description":"Detail explains how a record was matched and posted.","properties":{"match":{"description":"authorization, presentment, late_presentment, force_post, refund, reversal, fee, return, exception","type":"string"},"network_ref":{"type":"string"},"note":{"type":"string"},"remainder_hold_id":{"description":"a non-final debit presentment: the hold kept for the rest of the authorisation","example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["match"],"type":"object"},"ClearingEvidence":{"description":"Evidence is a retained document staff rely on.","properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"ClearingException":{"description":"Exception is a record in the exception queue, with its resolution history.","properties":{"amount_minor":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"detail":{"type":"string"},"direction":{"type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"network":{"type":"string"},"record":{"$ref":"#/components/schemas/ClearingRecord"},"record_id":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/Resolution"},"type":"array"},"status":{"description":"open, returned (awaiting the network's return credit or debit), resolved","type":"string"}},"required":["amount_minor","created_at","detail","direction","file_id","id","kind","network","record","record_id","resolutions","status"],"type":"object"},"ClearingIngestRequest":{"description":"IngestRequest delivers a file by upload.","properties":{"content_base64":{"type":"string"},"network":{"type":"string"}},"required":["content_base64","network"],"type":"object"},"ClearingRecord":{"description":"Record is one transaction in a clearing file.","properties":{"amount_minor":{"description":"the cardholder billing and settlement amount in USD","format":"int64","type":"integer"},"approval_code":{"type":"string"},"arn":{"type":"string"},"authorization_ref":{"description":"the network reference the authorisation carried; empty for an offline presentment","type":"string"},"channel":{"type":"string"},"clearing_count":{"description":"multiple clearing: how many presentments the authorisation will have","format":"int64","type":"integer"},"clearing_sequence":{"description":"multiple clearing: this presentment's number","format":"int64","type":"integer"},"conversion":{"oneOf":[{"$ref":"#/components/schemas/ClearingConversion"},{"type":"null"}]},"currency":{"type":"string"},"fee_reason":{"type":"string"},"interchange_minor":{"description":"signed: positive is paid to the issuer","format":"int64","type":"integer"},"mcc":{"type":"string"},"merchant_city":{"type":"string"},"merchant_country":{"type":"string"},"merchant_id":{"type":"string"},"merchant_name":{"type":"string"},"merchant_postal_code":{"type":"string"},"merchant_region":{"type":"string"},"original_arn":{"description":"a reversal, a refund naming its purchase, or a return: the record it refers to","type":"string"},"pan_token":{"type":"string"},"scheme_fee_minor":{"description":"signed: positive is paid by the issuer","format":"int64","type":"integer"},"sequence":{"format":"int64","type":"integer"},"transaction_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"type":{"type":"string"}},"required":["amount_minor","arn","currency","interchange_minor","scheme_fee_minor","sequence","transaction_date","type"],"type":"object"},"ClearingResolutionRequest":{"description":"ResolutionRequest proposes how an exception ends.","properties":{"action":{"type":"string"},"card_id":{"description":"post: the card the record belongs to","example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/ClearingEvidence"},"type":"array"},"reason":{"type":"string"}},"required":["action","evidence","reason"],"type":"object"},"ClearingResolutionResult":{"description":"ResolutionResult is what applying a resolution did.","properties":{"actor":{"type":"string"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"completed_at":{"format":"date-time","type":"string"},"detail":{"type":"string"},"journal_ids":{"items":{"type":"string"},"type":"array"},"outcome":{"description":"posted, returned, written_off, refused","type":"string"},"return":{"oneOf":[{"$ref":"#/components/schemas/ReturnReceipt"},{"type":"null"}]}},"required":["actor","completed_at","journal_ids","outcome"],"type":"object"},"ClearingReview":{"description":"Review is a retained independent decision.","properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","content_sha256","created_at","decision","reason"],"type":"object"},"ClearingReviewRequest":{"description":"ReviewRequest approves or rejects an exact proposal.","properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","decision","reason"],"type":"object"},"ClearingSettlement":{"description":"Settlement is a file's settlement reconciliation: the reported settlement, each record's category, the principal batches, network finance statements and cash, and the direct journal.","properties":{"chunks":{"items":{"$ref":"#/components/schemas/SettlementChunk"},"type":"array"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"figures":{"$ref":"#/components/schemas/SettlementFigures"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"file_sha256":{"type":"string"},"header":{"$ref":"#/components/schemas/Header"},"id":{"type":"string"},"journal":{"allOf":[{"$ref":"#/components/schemas/LedgerJournal"}],"description":"the direct legs; effective date set at execution"},"ordinal":{"format":"int64","type":"integer"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/ClearingSettlementRequest"},"result":{"oneOf":[{"$ref":"#/components/schemas/SettlementResult"},{"type":"null"}]},"review":{"oneOf":[{"$ref":"#/components/schemas/ClearingReview"},{"type":"null"}]},"sources":{"items":{"$ref":"#/components/schemas/SettlementSource"},"type":"array"}},"required":["chunks","content_sha256","created_at","figures","file_id","file_sha256","header","id","journal","ordinal","proposed_by","request","sources"],"type":"object"},"ClearingSettlementRequest":{"description":"SettlementRequest proposes a file's settlement reconciliation.","properties":{"external_cash":{"$ref":"#/components/schemas/ExternalCash"},"reason":{"type":"string"}},"required":["external_cash","reason"],"type":"object"},"CloseAttempt":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"cursor":{"type":"string"},"error":{"type":"string"},"number":{"format":"int64","type":"integer"},"reason":{"type":"string"},"result":{"additionalProperties":true,"type":"object"},"source_sha256":{"description":"SourceSHA256 is the digest of the fenced module source this attempt judged, when the source\ncarries one; it is the close's own record of exactly what it read.","type":"string"},"state":{"type":"string"},"step":{"type":"string"}},"required":["actor","at","number","result","state","step"],"type":"object"},"CloseBlocker":{"properties":{"action_id":{"type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"reason":{"type":"string"},"source_business_date":{"type":"string"}},"required":["action_id","case_id","kind","reason","source_business_date"],"type":"object"},"CloseEvidence":{"description":"CloseEvidence is a closed date's multi-currency record.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/USDEquivalentLine"},"type":"array"},"runs":{"items":{"$ref":"#/components/schemas/FxCloseRun"},"type":"array"}},"required":["business_date","lines","runs"],"type":"object"},"ClosePlan":{"description":"ClosePlan is captured in an independently approved bank_close_plan request. Version 1 uses the ledger's Federal Reserve calendar and disclosed cutoff; it cannot silently select a different calendar from the posting engine. Version 3 adds the product modules whose own closing source the run asks for.","properties":{"enabled":{"type":"boolean"},"lending":{"type":"boolean"},"no_lending_reason":{"type":"string"},"no_products_reason":{"type":"string"},"no_reconciliation_reason":{"type":"string"},"policy_evidence":{"type":"string"},"products":{"items":{"type":"string"},"type":"array"},"reconciliation_sources":{"items":{"type":"string"},"type":"array"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["enabled","lending","policy_evidence","reconciliation_sources","start_date","version"],"type":"object"},"CloseReadiness":{"properties":{"authorization_ids":{"items":{"type":"string"},"type":"array"},"business_date":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"ready":{"type":"boolean"},"truncated":{"type":"boolean"}},"required":["authorization_ids","business_date","observed_at","ready","truncated"],"type":"object"},"CloseRun":{"properties":{"attempts":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"completed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"cursor":{"type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/CloseAttempt"},"type":"array"},"id":{"type":"string"},"last_error":{"type":"string"},"last_reason":{"description":"LastReason is why the step blocked, in the words the module gave, so an operator reads the\nblocker itself instead of the problem code alone.","type":"string"},"lease_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"plan":{"$ref":"#/components/schemas/ClosePlan"},"plan_request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"},"step_index":{"format":"int64","type":"integer"},"steps":{"items":{"type":"string"},"type":"array"}},"required":["attempts","business_date","created_at","id","plan","plan_request_id","status","step_index","steps"],"type":"object"},"ClosingBalances":{"description":"ClosingBalances are one lot's managed account balances in the ledger's original (version one) closing of a business date. Recorded is false when the closing holds no balance snapshot for the lot's cost account: the lot was booked after that day closed.","properties":{"cost_amount":{"format":"int64","type":"integer"},"credit_allowance_amount":{"format":"int64","type":"integer"},"fair_value_adjustment_amount":{"format":"int64","type":"integer"},"recorded":{"type":"boolean"}},"required":["cost_amount","credit_allowance_amount","fair_value_adjustment_amount","recorded"],"type":"object"},"ClosingCredit":{"description":"ClosingCredit is one loan or facility as the closing-day source recorded it.","properties":{"booked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"bucket":{"type":"string"},"carried_amount":{"description":"loan outstanding less participations sold, facility drawn","format":"int64","type":"integer"},"charged_off_amount":{"format":"int64","type":"integer"},"charged_off_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"credit_id":{"type":"string"},"credit_kind":{"description":"loan or facility","type":"string"},"currency_code":{"type":"string"},"customer_id":{"description":"the borrower, so Schedule RC-C Part II can combine a borrower's loans","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"days_past_due":{"format":"int64","type":"integer"},"draw_period_ends":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"expiry":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"facility_kind":{"type":"string"},"gl_code":{"type":"string"},"guarantee_program":{"description":"GuaranteeProgram and GuaranteedBps are the government guarantee the source recorded on the credit\n(sba_7a, sba_504 or usda, and the guaranteed share in basis points).","type":"string"},"guaranteed_bps":{"format":"int64","type":"integer"},"limit_amount":{"description":"facilities: the approved limit","format":"int64","type":"integer"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"nonaccrual_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"participations_sold_amount":{"format":"int64","type":"integer"},"principal_amount":{"description":"loans: the principal the loan was made for","format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"purchased_participation":{"description":"PurchasedParticipation marks a loan bought from a lead bank: its principal is the bank's\nshare, not the whole credit the lead lender originated.","type":"boolean"},"rc_c_item":{"type":"string"},"status":{"type":"string"},"undrawn_amount":{"format":"int64","type":"integer"}},"required":["bucket","carried_amount","charged_off_amount","credit_id","credit_kind","currency_code","customer_id","days_past_due","gl_code","limit_amount","participations_sold_amount","principal_amount","product_code","product_version","rc_c_item","status","undrawn_amount"],"type":"object"},"ClosingLine":{"properties":{"balance_amount":{"format":"int64","type":"integer"},"call_report_line":{"description":"CallReportLine is the chart's Call Report line for the GL code when the day closed, so a\nlater sync reports under the chart as it was. Closings retained before it was captured\nhave none; omitted when empty, so their sealed digest is unchanged.","type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"holds_amount":{"format":"int64","type":"integer"},"ledger_accounts":{"format":"int64","type":"integer"},"name":{"type":"string"},"normal_balance":{"type":"string"},"type":{"type":"string"}},"required":["balance_amount","currency_code","gl_code","holds_amount","ledger_accounts","name","normal_balance","type"],"type":"object"},"ClosingSnapshot":{"description":"ClosingSnapshot retains the original version-one balances and their classification. Later backdated journals belong to restatements, not this completed closing.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/ClosingLine"},"type":"array"},"operator":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"sha256":{"type":"string"},"snapshots":{"format":"int64","type":"integer"},"version":{"format":"int64","type":"integer"}},"required":["business_date","lines","operator","recorded_at","snapshots","version"],"type":"object"},"ClosingdayReadiness":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"can_capture":{"type":"boolean"},"source":{"oneOf":[{"$ref":"#/components/schemas/ClosingdaySource"},{"type":"null"}]},"window_ends":{"format":"date-time","type":"string"},"window_starts":{"format":"date-time","type":"string"}},"required":["business_date","can_capture","window_ends","window_starts"],"type":"object"},"ClosingdayRequest":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"plan_version":{"type":"string"}},"required":["business_date","plan_version"],"type":"object"},"ClosingdaySource":{"properties":{"actor":{"type":"string"},"basis":{"type":"string"},"billing_count":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"plan_version":{"type":"string"},"risk_export_id":{"type":"string"},"risk_sha256":{"type":"string"},"sealed_until":{"format":"date-time","type":"string"}},"required":["actor","basis","billing_count","business_date","content_sha256","id","observed_at","plan_version","risk_export_id","risk_sha256","sealed_until"],"type":"object"},"Closure":{"properties":{"accrual_journal_id":{"description":"brings the accrued liability to the interest paid","example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"closing_fee_amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"forgiven_interest":{"description":"Forgiven is interest the customer was overpaid (a correction left the plan's accrual\nnegative) and the closure wrote off, as a positive decimal: the ledger never debits a\ncustomer for interest, so the bank bears it and the liability returns to zero.","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"interest_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"key":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_amount":{"format":"int64","type":"integer"},"payout_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"remittance_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"remitted_amount":{"format":"int64","type":"integer"},"rounding_adjustment":{"type":"string"},"withheld_amount":{"format":"int64","type":"integer"},"withholding_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["closing_fee_amount","date","interest_amount","key","ledger_account_id","payout_amount","payout_ledger_account_id","principal_amount","remitted_amount","rounding_adjustment","withheld_amount"],"type":"object"},"ClosureAddress":{"properties":{"city":{"type":"string"},"country_code":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country_code","line_1"],"type":"object"},"ClosureCheckRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id"],"type":"object"},"ClosurePayout":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"address":{"$ref":"#/components/schemas/ClosureAddress"},"key":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payee":{"type":"string"}},"required":["account_id","actor","address","key","ledger_account_id","payee"],"type":"object"},"ClosureReadiness":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"blockers":{"items":{"type":"string"},"type":"array"},"distribution_ids":{"items":{"type":"string"},"type":"array"},"lot_ids":{"items":{"type":"string"},"type":"array"},"observed_at":{"format":"date-time","type":"string"},"order_ids":{"items":{"type":"string"},"type":"array"},"ready":{"type":"boolean"},"source_sha256":{"type":"string"}},"required":["account_id","blockers","distribution_ids","lot_ids","observed_at","order_ids","ready","source_sha256"],"type":"object"},"ClosureRequest":{"properties":{"actor":{"type":"string"},"payout_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_method":{"type":"string"},"reason":{"type":"string"}},"required":["actor","payout_account_id","reason"],"type":"object"},"CodeAttemptRequest":{"description":"CodeAttemptRequest relays the code the cardholder entered into the wallet.","properties":{"code":{"description":"never retained; the event keeps a domain-separated digest beside the record","type":"string"},"network":{"type":"string"},"request_reference":{"type":"string"},"token_reference":{"type":"string"}},"required":["network","request_reference","token_reference"],"type":"object"},"CodeRequest":{"description":"CodeRequest is the token service relaying the cardholder's chosen verification method.","properties":{"method":{"description":"otp_sms or otp_email","type":"string"},"network":{"type":"string"},"request_reference":{"type":"string"},"token_reference":{"type":"string"}},"required":["method","network","request_reference","token_reference"],"type":"object"},"Collateral":{"description":"Collateral is an immutable admission snapshot, never a replacement for a locked current lot read and the ledger's exclusive reservation sidecar.","properties":{"custody_account":{"$ref":"#/components/schemas/Control"},"lot":{"$ref":"#/components/schemas/Lot"},"observation":{"$ref":"#/components/schemas/Observation"}},"required":["custody_account","lot","observation"],"type":"object"},"CollateralAdjustment":{"description":"CollateralAdjustment records execution of one independently approved proposal. ID equals RecordID so the proposal can execute only once. HoldID names the separate actual ledger restriction and cannot be reused for another pledge.","properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"record_id":{"type":"string"},"reservation_id":{"type":"string"}},"required":["actor","amount","created_at","hold_id","id","record_id","reservation_id"],"type":"object"},"CollateralAdjustmentRequest":{"description":"CollateralAdjustmentRequest adds cash to an existing commitment's collateral. Amount is the additional pledge, not a replacement for the original pledge.","properties":{"cash_collateral":{"$ref":"#/components/schemas/CashCollateral"},"rationale":{"type":"string"},"reservation_id":{"type":"string"}},"required":["cash_collateral","rationale","reservation_id"],"type":"object"},"CollateralBinding":{"properties":{"cusip":{"type":"string"},"custody_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"custody_account_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"observation_sha256":{"type":"string"},"original_program_id":{"type":"string"},"original_program_sha256":{"type":"string"},"original_settlement_sha256":{"type":"string"},"units":{"format":"int64","type":"integer"}},"required":["cusip","custody_account_id","custody_account_sha256","external_account_reference","lot_id","lot_revision","observation_sha256","original_program_id","original_program_sha256","original_settlement_sha256","units"],"type":"object"},"CollateralDecision":{"description":"CollateralDecision answers a collateral submission item by item.","properties":{"action":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ItemDecision"},"type":"array"},"reference":{"type":"string"}},"required":["action","items","reference"],"type":"object"},"CollateralItem":{"description":"CollateralItem is an invoice, vehicle or mortgage note financed by a draw.","properties":{"debtor":{"type":"string"},"description":{"type":"string"},"due_date":{"type":"string"},"face_amount":{"format":"int64","type":"integer"},"kind":{"type":"string"},"reference":{"type":"string"}},"required":["face_amount","reference"],"type":"object"},"CollateralLoan":{"description":"CollateralLoan is what the ledger's collateral register asks lending about a loan: the facts it values and judges eligibility on, and the loan's current encumbrance in that register.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"asset_class":{"description":"the collateral class the product's Call Report RC-C item maps to","type":"string"},"charged_off":{"type":"boolean"},"days_past_due":{"format":"int64","type":"integer"},"encumbrance":{"oneOf":[{"$ref":"#/components/schemas/LoanEncumbrance"},{"type":"null"}]},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"maturity_unresolved":{"description":"a legacy loan whose maturity could not be derived; never pledgeable","type":"boolean"},"nonaccrual":{"type":"boolean"},"participations_sold_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"status":{"type":"string"},"unpaid_principal_amount":{"description":"outstanding less the participated-out share","format":"int64","type":"integer"}},"required":["as_of","asset_class","charged_off","days_past_due","loan_id","maturity_unresolved","nonaccrual","participations_sold_amount","product_code","status","unpaid_principal_amount"],"type":"object"},"CollateralReport":{"description":"CollateralReport is what one report of pledged loans' changed facts to the register did.","properties":{"pending":{"description":"loans whose current facts the register has not acknowledged; they hold lending's close","items":{"type":"string"},"type":"array"},"reported":{"format":"int64","type":"integer"}},"required":["pending","reported"],"type":"object"},"CollateralSchedule":{"description":"CollateralSchedule is the lender's collateral schedule in force from a date.","properties":{"classes":{"items":{"$ref":"#/components/schemas/ScheduleClass"},"type":"array"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source":{"type":"string"}},"required":["classes","effective_date","source"],"type":"object"},"CollateralSnapshot":{"properties":{"amount":{"format":"int64","type":"integer"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"record_id":{"type":"string"},"source_service":{"type":"string"},"status":{"type":"string"}},"required":["amount","hold_id","ledger_account_id","record_id","source_service","status"],"type":"object"},"CollateralStatement":{"description":"CollateralStatement is the lender's collateral valuation and margin statement at the close of a day: every item, the total lendable value, the principal of advances outstanding, the interest accrued on them and unpaid, and what remains available. Collateral secures the interest as well as the principal: a Reserve Bank's Advance Repayment Amount is the advance plus accrued interest, and its security interest secures all Obligations (Operating Circular No. 10, 2.1 and 6.0), so the available value is the lendable value less both.","properties":{"accrued_interest_amount":{"format":"int64","type":"integer"},"advances":{"items":{"$ref":"#/components/schemas/StatementAdvance"},"type":"array"},"advances_outstanding_amount":{"format":"int64","type":"integer"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"available_amount":{"format":"int64","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/StatementItem"},"type":"array"},"lendable_amount":{"format":"int64","type":"integer"}},"required":["accrued_interest_amount","advances","advances_outstanding_amount","as_of","available_amount","items","lendable_amount"],"type":"object"},"CollateralSubmission":{"description":"CollateralSubmission pledges or withdraws loans on the lender's collateral schedule, or gives notice of securities pledged through Fedwire Securities, or asks for their release.","properties":{"action":{"type":"string"},"borrower":{"type":"string"},"lender":{"type":"string"},"loans":{"items":{"$ref":"#/components/schemas/LoanItem"},"type":"array"},"reference":{"type":"string"},"securities":{"items":{"$ref":"#/components/schemas/SecurityItem"},"type":"array"},"version":{"type":"string"}},"required":["action","borrower","lender","reference","version"],"type":"object"},"Column":{"description":"Column and Shape record the table an inventory snapshot actually read: its columns in ordinal order, primary key, the columns whose values may be attachments, the columns a reviewed include-list left out and the column names redacted as secrets.","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"],"type":"object"},"Command":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decedent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"executed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"payments":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/EstateRequest"},"source_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"}},"required":["account_id","decedent_customer_id","id","ownership_revision","payments","proposed_at","proposed_by","request","source_ledger_account_id","status"],"type":"object"},"CommandAttempt":{"description":"CommandAttempt is one delivery attempt of a command.","properties":{"acknowledgment":{"oneOf":[{"$ref":"#/components/schemas/NetworktokensAcknowledgment"},{"type":"null"}]},"actor":{"type":"string"},"adapter":{"type":"string"},"at":{"format":"date-time","type":"string"},"attempt":{"format":"int64","type":"integer"},"command_id":{"type":"string"},"error":{"type":"string"},"outcome":{"description":"delivered, refused or failed","type":"string"},"token_id":{"type":"string"}},"required":["actor","adapter","at","attempt","command_id","outcome","token_id"],"type":"object"},"CommandRecipient":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"distribution_code":{"type":"string"},"inheritance_id":{"type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"share_bps":{"format":"int64","type":"integer"}},"required":["account_id","amount_minor","customer_id","inheritance_id","ownership_revision","share_bps"],"type":"object"},"CommandRequest":{"properties":{"beneficiary_payment":{"oneOf":[{"$ref":"#/components/schemas/BeneficiaryPaymentEvidence"},{"type":"null"}]},"conversion":{"oneOf":[{"$ref":"#/components/schemas/ConversionEvidence"},{"type":"null"}]},"custodian":{"oneOf":[{"$ref":"#/components/schemas/CustodianTransferEvidence"},{"type":"null"}]},"earnings_minor":{"description":"evidenced signed net income attributable, return_excess only","format":"int64","type":"integer"},"eligibility_id":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"inbound_transfer":{"oneOf":[{"$ref":"#/components/schemas/InboundReceiptEvidence"},{"type":"null"}]},"income_tax_year":{"description":"return_excess income attribution, reviewed against tax code","format":"int64","type":"integer"},"inheritance":{"oneOf":[{"$ref":"#/components/schemas/InheritanceCommandEvidence"},{"type":"null"}]},"kind":{"description":"contribution, distribution, return_excess, rollover, trustee_transfer, conversion, beneficiary_distribution, death_transfer, death_distribution, inherited_distribution, recharacterization, custodian_transfer, custodian_transfer_in","type":"string"},"medical_use_attested":{"description":"evidence only: trustee does not determine HSA expense deductibility","type":"boolean"},"movement":{"oneOf":[{"$ref":"#/components/schemas/MovementEvidence"},{"type":"null"}]},"original_command_id":{"description":"the bank's original regular contribution","type":"string"},"other_account_id":{"description":"same-owner ordinary account; trustee_transfer/conversion name the protected destination","example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"principal_minor":{"format":"int64","type":"integer"},"reason":{"type":"string"},"recharacterization":{"oneOf":[{"$ref":"#/components/schemas/RecharacterizationEvidence"},{"type":"null"}]},"tax_year":{"format":"int64","type":"integer"},"withholding_bps":{"description":"nil uses reviewed traditional-IRA nonperiodic default","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"withholding_election_ref":{"type":"string"},"withholding_election_sha256":{"type":"string"}},"required":["eligibility_id","evidence_ref","evidence_sha256","kind","other_account_id","principal_minor","reason","tax_year"],"type":"object"},"CommandView":{"description":"CommandView is a command with its delivery attempts.","properties":{"attempts":{"items":{"$ref":"#/components/schemas/CommandAttempt"},"type":"array"},"command":{"$ref":"#/components/schemas/NetworktokensCommand"},"status":{"description":"pending, delivered or refused","type":"string"}},"required":["attempts","command","status"],"type":"object"},"Complaint":{"properties":{"acknowledge_by":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"acknowledge_escalate_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"acknowledged_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"assignee":{"type":"string"},"channel":{"type":"string"},"contact":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"escalate_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"escalated_deadlines":{"items":{"type":"string"},"type":"array"},"escalation_level":{"format":"int64","type":"integer"},"evidence_version":{"format":"int64","type":"integer"},"external_ref":{"type":"string"},"id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"name":{"type":"string"},"occurred_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"policy_id":{"type":"string"},"product":{"type":"string"},"public_response_ids":{"items":{"type":"string"},"type":"array"},"published_response_id":{"example":"cprs_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"received_at":{"format":"date-time","type":"string"},"related_customer_id":{"description":"Alleged reference, never portal access authority.","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"resolve_by":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"revision":{"format":"int64","type":"integer"},"round":{"format":"int64","type":"integer"},"round_started_at":{"format":"date-time","type":"string"},"status":{"type":"string"},"summary":{"type":"string"},"third_party":{"type":"string"}},"required":["channel","contact","created_at","created_by","escalation_level","evidence_version","id","name","product","revision","round","round_started_at","status","summary"],"type":"object"},"ComplaintAcknowledgement":{"properties":{"response_id":{"example":"cprs_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sha256":{"type":"string"}},"required":["response_id","sha256"],"type":"object"},"ComplaintAction":{"properties":{"policy_id":{"type":"string"},"reason":{"type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["reason","revision"],"type":"object"},"ComplaintAssessment":{"properties":{"basis":{"type":"string"},"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"consumer_harm":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"determination":{"type":"string"},"evidence_ids":{"items":{"type":"string"},"type":"array"},"evidence_version":{"format":"int64","type":"integer"},"findings":{"type":"string"},"id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"monetary_remedy":{"type":"boolean"},"referral_evidence_ids":{"items":{"type":"string"},"type":"array"},"referral_required":{"type":"boolean"},"remedies":{"items":{"$ref":"#/components/schemas/ComplaintRemedy"},"type":"array"},"remedy_evidence":{"items":{"$ref":"#/components/schemas/ComplaintRemedyEvidence"},"type":"array"},"review":{"oneOf":[{"$ref":"#/components/schemas/ComplaintReview"},{"type":"null"}]},"revision":{"format":"int64","type":"integer"},"root_cause":{"type":"string"},"round":{"format":"int64","type":"integer"}},"required":["basis","complaint_id","consumer_harm","created_at","created_by","determination","evidence_ids","evidence_version","findings","id","monetary_remedy","referral_evidence_ids","referral_required","remedies","remedy_evidence","revision","root_cause","round"],"type":"object"},"ComplaintAssessmentRequest":{"properties":{"basis":{"type":"string"},"consumer_harm":{"type":"string"},"determination":{"type":"string"},"evidence_ids":{"items":{"type":"string"},"type":"array"},"findings":{"type":"string"},"monetary_remedy":{"type":"boolean"},"referral_evidence_ids":{"items":{"type":"string"},"type":"array"},"referral_required":{"type":"boolean"},"remedies":{"items":{"$ref":"#/components/schemas/ComplaintRemedy"},"type":"array"},"revision":{"format":"int64","type":"integer"},"root_cause":{"type":"string"}},"required":["basis","consumer_harm","determination","evidence_ids","findings","monetary_remedy","referral_evidence_ids","referral_required","remedies","revision","root_cause"],"type":"object"},"ComplaintDecision":{"properties":{"decision":{"type":"string"},"reason":{"type":"string"}},"required":["decision","reason"],"type":"object"},"ComplaintDeliveryRequest":{"properties":{"evidence_id":{"type":"string"},"method":{"description":"paper_dispatched, paper_delivered or customer_acknowledged.","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"recipient":{"type":"string"},"response_id":{"example":"cprs_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"},"sha256":{"type":"string"}},"required":["evidence_id","method","occurred_at","recipient","response_id","revision","sha256"],"type":"object"},"ComplaintDocument":{"properties":{"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_type":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"data":{"format":"byte","type":"string"},"id":{"example":"cpdo_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"purpose":{"type":"string"},"round":{"format":"int64","type":"integer"},"sha256":{"type":"string"}},"required":["complaint_id","content_type","created_at","created_by","id","name","public","purpose","round","sha256"],"type":"object"},"ComplaintEntry":{"properties":{"action":{"type":"string"},"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"detail":{"additionalProperties":true,"type":"object"},"id":{"example":"cpev_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["action","actor","at","detail","id","revision"],"type":"object"},"ComplaintEscalationRun":{"properties":{"escalated":{"format":"int64","type":"integer"},"inspected":{"format":"int64","type":"integer"}},"required":["escalated","inspected"],"type":"object"},"ComplaintEvidenceRequest":{"properties":{"content_type":{"type":"string"},"data":{"format":"byte","type":"string"},"name":{"type":"string"},"purpose":{"description":"investigation or delivery","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["content_type","data","name","purpose","revision"],"type":"object"},"ComplaintIntake":{"properties":{"channel":{"type":"string"},"contact":{"type":"string"},"external_ref":{"type":"string"},"name":{"type":"string"},"occurred_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"product":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"related_customer_id":{"description":"Alleged reference, never portal access authority.","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"summary":{"type":"string"},"third_party":{"type":"string"}},"required":["channel","contact","name","product","summary"],"type":"object"},"ComplaintPolicy":{"properties":{"acknowledge_days":{"format":"int64","type":"integer"},"calendar":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"document":{"description":"Exact bank-supplied policy text, independently reviewed.","type":"string"},"due_hour":{"format":"int64","type":"integer"},"due_minute":{"format":"int64","type":"integer"},"escalate_after_days":{"format":"int64","type":"integer"},"id":{"example":"cppl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"name":{"type":"string"},"resolve_days":{"format":"int64","type":"integer"},"review":{"oneOf":[{"$ref":"#/components/schemas/ComplaintReview"},{"type":"null"}]},"sha256":{"type":"string"},"source":{"type":"string"},"time_zone":{"type":"string"},"version":{"type":"string"}},"required":["acknowledge_days","calendar","created_at","created_by","document","due_hour","due_minute","escalate_after_days","id","name","resolve_days","sha256","source","time_zone","version"],"type":"object"},"ComplaintPolicyRequest":{"properties":{"acknowledge_days":{"format":"int64","type":"integer"},"calendar":{"type":"string"},"document":{"description":"Exact bank-supplied policy text, independently reviewed.","type":"string"},"due_hour":{"format":"int64","type":"integer"},"due_minute":{"format":"int64","type":"integer"},"escalate_after_days":{"format":"int64","type":"integer"},"name":{"type":"string"},"resolve_days":{"format":"int64","type":"integer"},"source":{"type":"string"},"time_zone":{"type":"string"},"version":{"type":"string"}},"required":["acknowledge_days","calendar","document","due_hour","due_minute","escalate_after_days","name","resolve_days","source","time_zone","version"],"type":"object"},"ComplaintPublication":{"properties":{"response_id":{"example":"cprs_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["response_id","revision"],"type":"object"},"ComplaintRemedy":{"description":"A remedy links actual completed maker/checker work; a narrative cannot prove money moved.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"offset_gl_code":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"result_sha256":{"type":"string"}},"required":["account_id","amount_minor","currency_code","customer_id","description","offset_gl_code","request_id","result_sha256"],"type":"object"},"ComplaintRemedyEvidence":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal":{"additionalProperties":true,"type":"object"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"offset_gl_code":{"type":"string"},"offset_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_recorded_at":{"format":"date-time","type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request_sha256":{"type":"string"}},"required":["account_id","amount_minor","currency_code","customer_id","journal","journal_id","journal_key","journal_sha256","ledger_account_id","offset_gl_code","offset_ledger_account_id","ownership_recorded_at","ownership_revision","request_id","request_sha256"],"type":"object"},"ComplaintReport":{"properties":{"generated_at":{"format":"date-time","type":"string"},"rows":{"items":{"$ref":"#/components/schemas/ComplaintReportRow"},"type":"array"}},"required":["generated_at","rows"],"type":"object"},"ComplaintReportRow":{"properties":{"channel":{"type":"string"},"count":{"format":"int64","type":"integer"},"overdue":{"format":"int64","type":"integer"},"product":{"type":"string"},"status":{"type":"string"},"third_party":{"type":"string"}},"required":["channel","count","overdue","product","status","third_party"],"type":"object"},"ComplaintResponse":{"properties":{"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"body":{"type":"string"},"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"evidence_version":{"format":"int64","type":"integer"},"id":{"example":"cprs_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ComplaintReview"},{"type":"null"}]},"revision":{"format":"int64","type":"integer"},"round":{"format":"int64","type":"integer"},"sha256":{"type":"string"},"subject":{"type":"string"}},"required":["assessment_id","body","complaint_id","created_at","created_by","evidence_version","id","revision","round","sha256","subject"],"type":"object"},"ComplaintResponseRequest":{"properties":{"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"body":{"type":"string"},"revision":{"format":"int64","type":"integer"},"subject":{"type":"string"}},"required":["assessment_id","body","revision","subject"],"type":"object"},"ComplaintReview":{"properties":{"at":{"format":"date-time","type":"string"},"by":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["at","by","decision","reason"],"type":"object"},"CompletenessResult":{"properties":{"full_report_complete":{"type":"boolean"},"instruction_asset":{"$ref":"#/components/schemas/AssetDigest"},"items":{"items":{"$ref":"#/components/schemas/RequiredItem"},"type":"array"},"missing":{"format":"int64","type":"integer"},"missing_categories":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"not_due":{"format":"int64","type":"integer"},"reference_asset":{"$ref":"#/components/schemas/AssetDigest"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"required":{"format":"int64","type":"integer"},"schedule":{"type":"string"},"scope":{"type":"string"},"source_coverage_complete":{"type":"boolean"},"source_explained":{"format":"int64","type":"integer"},"source_missing":{"format":"int64","type":"integer"},"source_supplied":{"description":"Source coverage counts each retained position once: supplied by a capture, explained by\na capture's missing item, or uncovered. The fields are omitted when zero so evidence\nretained before they existed re-encodes to its original digest.","format":"int64","type":"integer"},"source_uncovered":{"format":"int64","type":"integer"},"sourced":{"format":"int64","type":"integer"},"supported_matrix_complete":{"type":"boolean"},"taxonomy_sha256":{"type":"string"},"unexpected":{"format":"int64","type":"integer"},"unresolved":{"format":"int64","type":"integer"}},"required":["full_report_complete","instruction_asset","items","missing","not_due","reference_asset","report_date","required","schedule","scope","source_missing","sourced","supported_matrix_complete","taxonomy_sha256","unexpected","unresolved"],"type":"object"},"ComponentEntry":{"description":"ComponentEntry is one custodian's clear key component, in hexadecimal.","properties":{"component":{"type":"string"}},"required":["component"],"type":"object"},"ConfirmRequest":{"properties":{"evidence":{"type":"string"}},"required":["evidence"],"type":"object"},"Confirmation":{"description":"Confirmation is the delivering custodian's validation or exception. Simulated is true for every confirmation the simulator produces and must be false from a certified integration.","properties":{"amount_minor":{"format":"int64","type":"integer"},"delivering_reference":{"type":"string"},"delivering_routing_number":{"type":"string"},"delivery_method":{"type":"string"},"distribution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"exception_code":{"type":"string"},"exception_reason":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"simulated":{"type":"boolean"},"status":{"description":"accepted or rejected","type":"string"}},"required":["distribution_date","request_id","settlement_date","simulated","status"],"type":"object"},"Consent":{"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"grant":{"$ref":"#/components/schemas/PurposeGrant"},"id":{"type":"string"},"provider_name":{"type":"string"},"provider_subject":{"type":"string"},"request":{"$ref":"#/components/schemas/OpenbankingConsentRequest"},"revoked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"session_id":{"example":"sess_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["created_at","customer_id","grant","id","provider_name","provider_subject","request","session_id","user_id","version"],"type":"object"},"ConsentChallenge":{"properties":{"disclosure":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"}},"required":["disclosure","expires_at","id"],"type":"object"},"ConsentRequest":{"properties":{"accepted":{"type":"boolean"},"action":{"type":"string"},"challenge_id":{"type":"string"},"code":{"type":"string"}},"required":["accepted","action"],"type":"object"},"Consumer":{"description":"Consumer is the confidential identity a tradeline is furnished under. It is accepted on build and sealed at rest; packet reads never return it.","properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"type":"string"},"ecoa_code":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"phone":{"type":"string"},"postal_code":{"type":"string"},"ssn":{"type":"string"},"state":{"type":"string"},"surname":{"type":"string"}},"required":["first_name","surname"],"type":"object"},"Consummation":{"properties":{"at":{"format":"date-time","type":"string"},"initial_rate_notice_id":{"type":"string"}},"required":["at"],"type":"object"},"Contact":{"properties":{"address":{"type":"string"},"email":{"type":"string"},"license_id":{"type":"string"},"name":{"type":"string"},"nmls_id":{"type":"string"},"person":{"type":"string"},"person_license_id":{"type":"string"},"person_nmls_id":{"type":"string"},"phone":{"type":"string"}},"required":["address","email","name","person","phone"],"type":"object"},"Content":{"properties":{"document":{"additionalProperties":true,"type":"object"},"record":{"$ref":"#/components/schemas/BankrecordsRecord"}},"required":["document","record"],"type":"object"},"ContingencyAction":{"description":"Actions are escalation instructions, never assumed available money or executed funding.","properties":{"action":{"type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"id":{"type":"string"},"owner":{"type":"string"},"trigger_below_amount":{"format":"int64","type":"integer"}},"required":["action","evidence","id","owner","trigger_below_amount"],"type":"object"},"ContingencyAdvance":{"description":"ContingencyAdvance is a register advance at its original closing balance on the as-of date.","properties":{"balance_amount":{"format":"int64","type":"integer"},"gl_code":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"lender_id":{"format":"int64","type":"integer"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["balance_amount","gl_code","id","kind","maturity_date"],"type":"object"},"ContingencyAssumption":{"description":"ContingencyAssumption is a class's reviewed assumption under one severity. Every zero is explicit.","properties":{"available_day":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"cumulative_runoff_bps":{"items":{"format":"int64","type":"integer"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"haircut_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"severity":{"type":"string"}},"required":["evidence","severity"],"type":"object"},"ContingencyBalances":{"description":"ContingencyBalances are the classified retained balances and the register totals a run used.","properties":{"advances_amount":{"format":"int64","type":"integer"},"brokered_deposits_amount":{"format":"int64","type":"integer"},"cash_amount":{"format":"int64","type":"integer"},"deposits_amount":{"format":"int64","type":"integer"},"encumbered_securities_amount":{"format":"int64","type":"integer"},"liabilities_amount":{"format":"int64","type":"integer"},"other_liabilities_amount":{"format":"int64","type":"integer"},"register_capacity_amount":{"format":"int64","type":"integer"},"register_lendable_amount":{"format":"int64","type":"integer"},"register_outstanding_amount":{"format":"int64","type":"integer"},"register_securities_pledged_amount":{"format":"int64","type":"integer"},"register_shortfall_amount":{"format":"int64","type":"integer"},"securities_amount":{"format":"int64","type":"integer"}},"required":["advances_amount","brokered_deposits_amount","cash_amount","deposits_amount","encumbered_securities_amount","liabilities_amount","other_liabilities_amount","register_capacity_amount","register_lendable_amount","register_outstanding_amount","register_securities_pledged_amount","register_shortfall_amount","securities_amount"],"type":"object"},"ContingencyBucket":{"properties":{"advance_maturities_amount":{"format":"int64","type":"integer"},"borrowing_capacity_amount":{"format":"int64","type":"integer"},"cash_amount":{"format":"int64","type":"integer"},"contingent_sources_amount":{"format":"int64","type":"integer"},"contingent_uses_amount":{"format":"int64","type":"integer"},"cumulative_borrowing_capacity_amount":{"format":"int64","type":"integer"},"cumulative_sources_amount":{"format":"int64","type":"integer"},"cumulative_uses_amount":{"format":"int64","type":"integer"},"deposit_runoff_amount":{"format":"int64","type":"integer"},"end_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"end_day":{"format":"int64","type":"integer"},"index":{"format":"int64","type":"integer"},"kind":{"description":"daily or intramonth","type":"string"},"net_position_amount":{"format":"int64","type":"integer"},"other_liability_runoff_amount":{"format":"int64","type":"integer"},"securities_amount":{"format":"int64","type":"integer"},"sources_amount":{"format":"int64","type":"integer"},"start_day":{"format":"int64","type":"integer"},"uses_amount":{"format":"int64","type":"integer"}},"required":["advance_maturities_amount","borrowing_capacity_amount","cash_amount","contingent_sources_amount","contingent_uses_amount","cumulative_borrowing_capacity_amount","cumulative_sources_amount","cumulative_uses_amount","deposit_runoff_amount","end_date","end_day","index","kind","net_position_amount","other_liability_runoff_amount","securities_amount","sources_amount","start_day","uses_amount"],"type":"object"},"ContingencyClass":{"description":"ContingencyClass assigns a retained GL to a liquidity role. Cash and marketable securities carry a haircut and the first day their value can be used; deposits and other liabilities carry their cumulative runoff at the end of each bucket; advances run off at their contractual maturities; an excluded GL generates no flow, for the reason its treatment gives.","properties":{"assumptions":{"items":{"$ref":"#/components/schemas/ContingencyAssumption"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"gl_code":{"type":"string"},"role":{"type":"string"},"treatment":{"type":"string"}},"required":["assumptions","evidence","gl_code","role","treatment"],"type":"object"},"ContingencyEncumbrance":{"description":"ContingencyEncumbrance is the carrying amount of a marketable security GL that is pledged, sold under repurchase or otherwise not available to sell, including an explicit zero.","properties":{"encumbered_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"gl_code":{"type":"string"},"treatment":{"type":"string"}},"required":["evidence","gl_code","treatment"],"type":"object"},"ContingencyFlow":{"description":"ContingencyFlow is an evidenced cumulative flow the retained positions do not produce, such as commitment draws or scheduled loan receipts, at the end of each bucket under one severity.","properties":{"cumulative_amounts":{"items":{"format":"int64","type":"integer"},"type":"array"},"direction":{"description":"use or source","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"id":{"type":"string"},"severity":{"type":"string"},"treatment":{"type":"string"}},"required":["cumulative_amounts","direction","evidence","id","severity","treatment"],"type":"object"},"ContingencyIndicator":{"description":"ContingencyIndicator is an early-warning indicator with a reviewed threshold and the escalation it triggers. A breach is an instruction to its owner, never an executed funding action.","properties":{"action":{"type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"key":{"type":"string"},"metric":{"type":"string"},"owner":{"type":"string"},"severity":{"type":"string"},"threshold":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"trigger":{"description":"below or above","type":"string"}},"required":["action","evidence","key","metric","owner","trigger"],"type":"object"},"ContingencyIndicatorResult":{"properties":{"action":{"type":"string"},"key":{"type":"string"},"metric":{"type":"string"},"owner":{"type":"string"},"severity":{"type":"string"},"status":{"description":"breached, within or undefined (a zero denominator)","type":"string"},"threshold":{"format":"int64","type":"integer"},"trigger":{"type":"string"},"value":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["action","key","metric","owner","status","threshold","trigger"],"type":"object"},"ContingencyLender":{"description":"ContingencyLender is one approved lender's position as the collateral register reported it.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"capacity_amount":{"format":"int64","type":"integer"},"gl_code":{"type":"string"},"ineligible_pledges":{"format":"int64","type":"integer"},"legal_name":{"type":"string"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"live_pledges":{"format":"int64","type":"integer"},"outstanding_amount":{"format":"int64","type":"integer"},"schedule_id":{"format":"int64","type":"integer"},"securities_pledged_amount":{"description":"register value of live securities lot pledges","format":"int64","type":"integer"},"shortfall_amount":{"format":"int64","type":"integer"}},"required":["as_of","capacity_amount","gl_code","ineligible_pledges","legal_name","lendable_amount","lender_id","lender_kind","live_pledges","outstanding_amount","securities_pledged_amount","shortfall_amount"],"type":"object"},"ContingencyLenderResult":{"properties":{"available_day":{"format":"int64","type":"integer"},"capacity_amount":{"format":"int64","type":"integer"},"lendable_amount":{"format":"int64","type":"integer"},"lendable_haircut_bps":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"stressed_lendable_amount":{"format":"int64","type":"integer"}},"required":["available_day","capacity_amount","lendable_amount","lendable_haircut_bps","lender_id","lender_kind","outstanding_amount","stressed_lendable_amount"],"type":"object"},"ContingencyLenderTerm":{"description":"ContingencyLenderTerm stresses the collateral register's position with every lender of one kind under one severity: a haircut on the register's lendable value (10000 treats the line as unavailable) and the first day a draw can settle.","properties":{"available_day":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"lendable_haircut_bps":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"lender_kind":{"type":"string"},"severity":{"type":"string"},"treatment":{"type":"string"}},"required":["evidence","lender_kind","severity","treatment"],"type":"object"},"ContingencyPosition":{"description":"ContingencyPosition is one GL balance of the exact retained closing, with the deposit class the closing's chart line gave it.","properties":{"balance_amount":{"format":"int64","type":"integer"},"brokered":{"type":"boolean"},"call_report_line":{"type":"string"},"currency_code":{"type":"string"},"deposit":{"type":"boolean"},"gl_code":{"type":"string"},"type":{"type":"string"}},"required":["balance_amount","brokered","call_report_line","currency_code","deposit","gl_code","type"],"type":"object"},"ContingencyProjection":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/ContingencyBucket"},"type":"array"},"first_shortfall_bucket":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"lenders":{"items":{"$ref":"#/components/schemas/ContingencyLenderResult"},"type":"array"},"minimum_net_position_amount":{"format":"int64","type":"integer"},"severity":{"type":"string"},"survival_days":{"description":"the end day of the last bucket before the first shortfall","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"survives_horizon":{"type":"boolean"}},"required":["buckets","lenders","minimum_net_position_amount","severity","survives_horizon"],"type":"object"},"ContingencyResults":{"properties":{"balances":{"$ref":"#/components/schemas/ContingencyBalances"},"engine_version":{"type":"string"},"horizon_days":{"format":"int64","type":"integer"},"indicators":{"items":{"$ref":"#/components/schemas/ContingencyIndicatorResult"},"type":"array"},"limitations":{"items":{"type":"string"},"type":"array"},"projections":{"items":{"$ref":"#/components/schemas/ContingencyProjection"},"type":"array"},"scope":{"type":"string"},"triggered_indicators":{"items":{"type":"string"},"type":"array"}},"required":["balances","engine_version","horizon_days","indicators","limitations","projections","scope","triggered_indicators"],"type":"object"},"ContingencyRun":{"properties":{"request":{"$ref":"#/components/schemas/ContingencyRunRequest"},"results":{"$ref":"#/components/schemas/ContingencyResults"},"scenario":{"$ref":"#/components/schemas/ContingencyScenario"},"scenario_sha256":{"type":"string"},"source":{"$ref":"#/components/schemas/ContingencySource"}},"required":["request","results","scenario","scenario_sha256","source"],"type":"object"},"ContingencyRunRequest":{"description":"ContingencyRunRequest names the approved scenario and the as-of closing, and supplies what the core does not retain: securities encumbrance and evidenced contingent flows, each explicit.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"contingent_flows":{"items":{"$ref":"#/components/schemas/ContingencyFlow"},"type":"array"},"coverage_evidence":{"$ref":"#/components/schemas/AlmEvidence"},"encumbrances":{"items":{"$ref":"#/components/schemas/ContingencyEncumbrance"},"type":"array"},"rationale":{"type":"string"},"scenario_id":{"type":"string"}},"required":["as_of","contingent_flows","coverage_evidence","encumbrances","rationale","scenario_id"],"type":"object"},"ContingencyScenario":{"description":"ContingencyScenario is one reviewed version of a contingency funding stress event. Each version is its own record; a version that supersedes an approved one names it, and runs refuse a version an approved successor has superseded.","properties":{"classes":{"items":{"$ref":"#/components/schemas/ContingencyClass"},"type":"array"},"daily_days":{"description":"one bucket for each calendar day 1..daily_days","format":"int64","type":"integer"},"event_description":{"type":"string"},"event_kind":{"description":"institution_specific, market_wide or combined","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"indicators":{"items":{"$ref":"#/components/schemas/ContingencyIndicator"},"type":"array"},"intramonth_end_days":{"description":"then buckets ending on these days, the last no later than day 31","items":{"format":"int64","type":"integer"},"type":"array"},"lenders":{"items":{"$ref":"#/components/schemas/ContingencyLenderTerm"},"type":"array"},"methodology":{"type":"string"},"name":{"type":"string"},"severities":{"items":{"$ref":"#/components/schemas/ContingencySeverity"},"type":"array"},"supersedes":{"type":"string"}},"required":["classes","daily_days","event_description","event_kind","evidence","indicators","intramonth_end_days","lenders","methodology","name","severities"],"type":"object"},"ContingencySeverity":{"description":"ContingencySeverity is one level of stress of the event.","properties":{"description":{"type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"key":{"type":"string"}},"required":["description","evidence","key"],"type":"object"},"ContingencySource":{"description":"ContingencySource is what a run captured: the exact tied closing, the dated register advances and the collateral register, each with its digest and one digest over all of them.","properties":{"advances":{"items":{"$ref":"#/components/schemas/ContingencyAdvance"},"type":"array"},"advances_sha256":{"type":"string"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ledger_sha256":{"type":"string"},"lenders":{"items":{"$ref":"#/components/schemas/ContingencyLender"},"type":"array"},"positions":{"items":{"$ref":"#/components/schemas/ContingencyPosition"},"type":"array"},"positions_sha256":{"type":"string"},"register_business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"register_captured_at":{"format":"date-time","type":"string"},"register_sha256":{"type":"string"},"sha256":{"type":"string"},"sync_id":{"format":"int64","type":"integer"}},"required":["advances","advances_sha256","as_of","ledger_sha256","lenders","positions","positions_sha256","register_business_date","register_captured_at","register_sha256","sha256","sync_id"],"type":"object"},"ContingentFlow":{"description":"ContingentFlow records actual scenario assumptions about off-balance funding, growth, expenses or other liquidity items; each side is an explicit net cash receipt/payment. These affect liquidity but not instrument EVE or NII.","properties":{"base_amounts":{"items":{"format":"int64","type":"integer"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"id":{"type":"string"},"stress_amounts":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["base_amounts","evidence","id","stress_amounts"],"type":"object"},"ContinuingCandidateView":{"description":"ContinuingCandidateView lists the obligations whose reviewed determinations reference the candidate. Stage is obligation only while one of them has a current independently approved required determination for it.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"cursor":{"type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"obligations":{"items":{"$ref":"#/components/schemas/ObligationView"},"type":"array"},"packet_id":{"type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"policy_version":{"format":"int64","type":"integer"},"prior_filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"report_kind":{"description":"the predecessor's kind: initial or continuing","type":"string"},"rules_id":{"type":"string"},"stage":{"description":"needs_determination or obligation","type":"string"}},"required":["activity_sequence","created_at","cursor","due_date","obligations","packet_id","period_end","period_start","policy_version","prior_filing_date","report_kind","rules_id","stage"],"type":"object"},"ContinuingPolicyProposalRequest":{"description":"ContinuingPolicyProposalRequest opts the bank in to or out of the elective convention from a future calendar date. It never applies retroactively.","properties":{"base_version":{"format":"int64","type":"integer"},"basis":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"elected":{"type":"boolean"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"}},"required":["base_version","basis","effective_from","elected","evidence_reference","evidence_sha256"],"type":"object"},"ContinuingPolicyReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"}},"required":["actor","approve","at","content_sha256"],"type":"object"},"ContinuingPolicyReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"}},"required":["approve","content_sha256"],"type":"object"},"ContinuingPolicyVersion":{"properties":{"base_version":{"format":"int64","type":"integer"},"basis":{"type":"string"},"content_sha256":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"elected":{"type":"boolean"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ContinuingPolicyReview"},{"type":"null"}]},"rules_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["base_version","basis","content_sha256","effective_from","elected","evidence_reference","evidence_sha256","proposed_at","proposed_by","rules_id","version"],"type":"object"},"ContinuingPolicyView":{"description":"ContinuingPolicyView is the complete reviewed history and the version in force on AsOf. No approved opt-in in force means the convention is not elected.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"current_version":{"format":"int64","type":"integer"},"elected":{"type":"boolean"},"in_force":{"oneOf":[{"$ref":"#/components/schemas/ContinuingPolicyVersion"},{"type":"null"}]},"versions":{"items":{"$ref":"#/components/schemas/ContinuingPolicyVersion"},"type":"array"}},"required":["as_of","current_version","elected","versions"],"type":"object"},"ContinuingReference":{"description":"ContinuingReference names the exact accepted SAR activity a continuing report follows. It is plaintext packet content so admission guards can bind it.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"packet_id":{"type":"string"}},"required":["activity_sequence","packet_id"],"type":"object"},"ContinuityQuarter":{"properties":{"filing_id":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"simulated":{"type":"boolean"},"status":{"description":"accepted, before_initial_report or missing","type":"string"}},"required":["report_date","status"],"type":"object"},"Contract":{"properties":{"actor":{"type":"string"},"carrier_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_until":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"id":{"type":"string"},"per_run_amount":{"format":"int64","type":"integer"},"per_stop_amount":{"format":"int64","type":"integer"},"services":{"description":"branch, vault, atm, fedcash","items":{"type":"string"},"type":"array"},"vault_unit_id":{"description":"default vault the ATM and FedCash interfaces draw from or return to","type":"string"}},"required":["actor","carrier_id","created_at","effective_from","effective_until","evidence","id","per_run_amount","per_stop_amount","services","vault_unit_id"],"type":"object"},"ContractRequest":{"properties":{"carrier_id":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_until":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"per_run_amount":{"format":"int64","type":"integer"},"per_stop_amount":{"format":"int64","type":"integer"},"services":{"description":"branch, vault, atm, fedcash","items":{"type":"string"},"type":"array"},"vault_unit_id":{"description":"default vault the ATM and FedCash interfaces draw from or return to","type":"string"}},"required":["carrier_id","effective_from","effective_until","evidence","per_run_amount","per_stop_amount","services","vault_unit_id"],"type":"object"},"Control":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"custody_account":{"oneOf":[{"$ref":"#/components/schemas/CustodyAccount"},{"type":"null"}]},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"id":{"type":"string"},"instrument":{"oneOf":[{"$ref":"#/components/schemas/Instrument"},{"type":"null"}]},"kind":{"type":"string"},"program":{"oneOf":[{"$ref":"#/components/schemas/Program"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","kind"],"type":"object"},"ControlChange":{"description":"ControlChange is one proposed loosening of a bank control over a customer's payments — an account's payment limits or an ACH Originator's limits, classes, exposure window, prenotification requirement or status — with its decision. Before is the control's state the change was raised against and After the state it asks for; only an approval by a second operator applies After, and only while the control still reads as Before.","properties":{"after":{"additionalProperties":true,"type":"object"},"before":{"additionalProperties":true,"type":"object"},"control":{"description":"payment_limit or ach_originator","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision_note":{"type":"string"},"id":{"format":"int64","type":"integer"},"loosening":{"description":"the fields it loosens","items":{"type":"string"},"type":"array"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"status":{"description":"pending, approved, rejected or withdrawn","type":"string"},"subject_id":{"description":"the account or the Originator","type":"string"}},"required":["after","before","control","id","loosening","proposed_at","proposed_by","status","subject_id"],"type":"object"},"ControlChangeRequest":{"description":"ControlChangeRequest proposes a control status for a correspondent or a nostro account.","properties":{"reason":{"type":"string"},"status":{"type":"string"},"target_id":{"type":"string"},"target_kind":{"description":"correspondent or nostro_account","type":"string"}},"required":["reason","status","target_id","target_kind"],"type":"object"},"ControlRequest":{"properties":{"action":{"description":"suspend, resume, delete; delete is terminal in core","type":"string"},"expected_sequence":{"format":"int64","type":"integer"},"reason":{"type":"string"}},"required":["action","expected_sequence","reason"],"type":"object"},"ControlSource":{"properties":{"acknowledgment_sha256":{"type":"string"},"acknowledgment_status":{"type":"string"},"derived_facts":{"items":{"type":"string"},"type":"array"},"document_sha256":{"type":"string"},"document_source":{"type":"string"},"facts_sha256":{"type":"string"},"filing_id":{"description":"Filed history only; empty for workpaper candidates, so earlier results keep their digest.","type":"string"},"incompatible_concepts":{"items":{"type":"string"},"type":"array"},"kind":{"type":"string"},"profile_sha256":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"review_sha256":{"type":"string"},"taxonomy_sha256":{"type":"string"},"taxonomy_status":{"type":"string"},"workpaper_id":{"type":"string"},"workpaper_sha256":{"type":"string"}},"required":["kind","profile_sha256","report_date","review_sha256","workpaper_id","workpaper_sha256"],"type":"object"},"Controls":{"description":"Controls are the cardholder's spending rules, checked on every authorization.","properties":{"allowed_countries":{"description":"empty means any","items":{"type":"string"},"type":"array"},"blocked_mccs":{"items":{"type":"string"},"type":"array"},"channels":{"$ref":"#/components/schemas/Channels"},"daily_limit_amount":{"format":"int64","type":"integer"},"merchant_id":{"type":"string"},"per_transaction_limit_amount":{"format":"int64","type":"integer"},"single_use":{"type":"boolean"},"valid_from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"valid_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["channels","daily_limit_amount","per_transaction_limit_amount"],"type":"object"},"ControlsRequest":{"description":"ControlsRequest replaces a token's controls at an exact sequence.","properties":{"controls":{"$ref":"#/components/schemas/NetworktokensControls"},"expected_sequence":{"format":"int64","type":"integer"},"reason":{"type":"string"}},"required":["controls","expected_sequence","reason"],"type":"object"},"Conversion":{"description":"Conversion is a posted customer conversion.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"caller":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owner":{"type":"string"},"price":{"$ref":"#/components/schemas/ConversionPrice"},"quote_id":{"type":"string"},"rate_sheet_id":{"type":"string"},"source_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["business_date","caller","created_at","id","journal_id","owner","price","quote_id","rate_sheet_id","source_ledger_account_id","target_ledger_account_id"],"type":"object"},"ConversionEvidence":{"description":"ConversionEvidence authorizes only an immediate same-bank cash conversion. It does not authorize a recharacterization, inherited transfer or 60-day deposit.","properties":{"as_of_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"authority_ref":{"type":"string"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"policy_sha256":{"type":"string"},"rmd_policy_id":{"type":"string"},"rmd_review_ids":{"items":{"type":"string"},"type":"array"}},"required":["as_of_date","authority_ref","instruction_ref","instruction_sha256","policy_sha256","rmd_policy_id"],"type":"object"},"ConversionPrice":{"description":"ConversionPrice is the exact result of pricing a conversion on a customer sheet.","properties":{"customer_rate":{"description":"target major units per source major unit, ten decimals, for display only","type":"string"},"source_amount":{"format":"int64","type":"integer"},"source_currency_code":{"type":"string"},"source_usd_equivalent":{"format":"int64","type":"integer"},"source_usd_per_major":{"type":"string"},"spread_usd_minor":{"format":"int64","type":"integer"},"target_amount":{"format":"int64","type":"integer"},"target_currency_code":{"type":"string"},"target_usd_equivalent":{"format":"int64","type":"integer"},"target_usd_per_major":{"type":"string"}},"required":["customer_rate","source_currency_code","source_usd_equivalent","source_usd_per_major","spread_usd_minor","target_currency_code","target_usd_equivalent","target_usd_per_major"],"type":"object"},"ConversionRMDSource":{"properties":{"bank_command_ids":{"items":{"type":"string"},"type":"array"},"bank_paid_minor":{"format":"int64","type":"integer"},"outside_paid_minor":{"format":"int64","type":"integer"},"required_minor":{"format":"int64","type":"integer"},"review_id":{"type":"string"},"review_sha256":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["bank_command_ids","bank_paid_minor","outside_paid_minor","required_minor","review_id","review_sha256","tax_year"],"type":"object"},"ConvertRequest":{"description":"ConvertRequest turns a construction facility into its permanent loan.","properties":{"operator":{"type":"string"},"term_months":{"format":"int64","type":"integer"}},"required":["operator"],"type":"object"},"Corrected":{"description":"Corrected are the fields a notification of change corrects.","properties":{"account_number":{"type":"string"},"individual_id":{"type":"string"},"name":{"type":"string"},"routing_number":{"type":"string"},"transaction_code":{"type":"string"}},"type":"object"},"Correction":{"properties":{"replaces_id":{"type":"string"},"replaces_issued_at":{"format":"date-time","type":"string"},"summary":{"type":"string"}},"required":["replaces_id","replaces_issued_at","summary"],"type":"object"},"CorrectionDetermination":{"description":"CorrectionDetermination is the reviewed conclusion. Grounds: - primary_error_notification: required corrected report; names the retained warnings the reviewer classified as primary errors; trigger is the day the acknowledgment was received; due 30 calendar days later as FinCEN recommends. - errors_discovered: required corrected report; trigger is the reviewed day the errors were discovered; no FinCEN due date. - additional_data_discovered: required amended report; trigger is the reviewed day the data was discovered; no FinCEN due date. - warnings_not_primary: not required; names the retained warnings reviewed as secondary only. - no_correction_needed: not required.","properties":{"disposition":{"description":"required or not_required","type":"string"},"ground":{"type":"string"},"report_kind":{"description":"corrected or amended","type":"string"},"trigger_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"warning_sequences":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["disposition","ground","trigger_date"],"type":"object"},"CorrectionPacket":{"description":"CorrectionPacket is an actual packet naming the predecessor as the report it corrects.","properties":{"content_sha256":{"type":"string"},"environment":{"type":"string"},"packet_id":{"type":"string"},"status":{"type":"string"}},"required":["content_sha256","environment","packet_id","status"],"type":"object"},"CorrectionPredecessor":{"description":"CorrectionPredecessor is the accepted production activity as its authenticated evidence establishes it: the retained packet and batch, a digest of the assigned BSA identifier, the transmission (filing) day, the day the acknowledgment carrying any error notification was received, and that activity's retained warning numbers.","properties":{"batch_sha256":{"type":"string"},"bsa_id_sha256":{"type":"string"},"content_sha256":{"type":"string"},"filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"form":{"type":"string"},"notification_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"warning_sequences":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["batch_sha256","bsa_id_sha256","content_sha256","filing_date","form","notification_date"],"type":"object"},"CorrectionProposalRequest":{"properties":{"base_version":{"format":"int64","type":"integer"},"basis":{"type":"string"},"determination":{"$ref":"#/components/schemas/CorrectionDetermination"},"evidence":{"format":"byte","type":"string"},"evidence_reference":{"type":"string"},"predecessor_content_sha256":{"type":"string"}},"required":["base_version","basis","determination","evidence","evidence_reference","predecessor_content_sha256"],"type":"object"},"CorrectionSummary":{"description":"CorrectionSummary lists a correction obligation on an obligation's accepted filing.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"due_date_rule":{"type":"string"},"packet_id":{"type":"string"},"stage":{"type":"string"}},"required":["activity_sequence","due_date","packet_id","stage"],"type":"object"},"CorrectionVersion":{"properties":{"activity_sequence":{"format":"int64","type":"integer"},"base_version":{"format":"int64","type":"integer"},"basis_sha256":{"type":"string"},"content_sha256":{"type":"string"},"determination":{"$ref":"#/components/schemas/CorrectionDetermination"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"due_date_rule":{"type":"string"},"packet_id":{"type":"string"},"predecessor":{"$ref":"#/components/schemas/CorrectionPredecessor"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ObligationReview"},{"type":"null"}]},"rules_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["activity_sequence","base_version","basis_sha256","content_sha256","determination","due_date","due_date_rule","packet_id","predecessor","proposed_at","proposed_by","rules_id","version"],"type":"object"},"CorrectionView":{"description":"CorrectionView is one queue entry. FilingTiming is unproven until an accepted linked correction, then on_time or late against a FinCEN-stated date, or no_due_date when FinCEN states none.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"bsa_id":{"type":"string"},"correction_packets":{"items":{"$ref":"#/components/schemas/CorrectionPacket"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"current_version":{"format":"int64","type":"integer"},"cursor":{"type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"due_date_rule":{"type":"string"},"filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"filing_timing":{"type":"string"},"form":{"type":"string"},"linked_packet_id":{"type":"string"},"links":{"items":{"$ref":"#/components/schemas/ObligationLink"},"type":"array"},"overdue":{"type":"boolean"},"packet_id":{"type":"string"},"predecessor":{"$ref":"#/components/schemas/CorrectionPredecessor"},"stage":{"type":"string"},"versions":{"items":{"$ref":"#/components/schemas/CorrectionVersion"},"type":"array"},"warnings":{"items":{"$ref":"#/components/schemas/AcknowledgmentError"},"type":"array"}},"required":["activity_sequence","correction_packets","created_at","current_version","cursor","due_date","filing_date","filing_timing","form","links","overdue","packet_id","predecessor","stage","versions","warnings"],"type":"object"},"Correspondent":{"description":"Correspondent is a retained correspondent record, its review and its current control status.","properties":{"bic":{"type":"string"},"control_status":{"description":"active, suspended or terminated once approved","type":"string"},"country":{"type":"string"},"due_diligence_ref":{"type":"string"},"id":{"type":"string"},"legal_name":{"type":"string"},"lei":{"type":"string"},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"relationship":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["bic","country","due_diligence_ref","id","legal_name","maker","recorded_at","relationship","source_ref","status"],"type":"object"},"CorrespondentControlChange":{"description":"ControlChange is a retained status proposal and its review.","properties":{"from_status":{"type":"string"},"id":{"type":"string"},"maker":{"type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"review_status":{"type":"string"},"status":{"type":"string"},"target_id":{"type":"string"},"target_kind":{"description":"correspondent or nostro_account","type":"string"}},"required":["from_status","id","maker","reason","recorded_at","review_status","status","target_id","target_kind"],"type":"object"},"CorrespondentInvoice":{"description":"Invoice is a retained invoice, its line matching and its review.","properties":{"accrued_amount":{"description":"the accrued charges the invoice billed","format":"int64","type":"integer"},"accrued_not_invoiced":{"description":"accrued charge ids of the period the invoice did not bill","items":{"type":"string"},"type":"array"},"billed_charge_ids":{"items":{"type":"string"},"type":"array"},"currency_code":{"type":"string"},"document_sha256":{"type":"string"},"exceptions":{"type":"boolean"},"id":{"type":"string"},"invoice_number":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"matches":{"items":{"$ref":"#/components/schemas/InvoiceLineMatch"},"type":"array"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"settlement_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_ref":{"type":"string"},"statement_item_ref":{"type":"string"},"status":{"description":"pending_review, approved, rejected or settled","type":"string"},"total_amount":{"format":"int64","type":"integer"},"variance_amount":{"description":"total less the accrued charges it billed","format":"int64","type":"integer"}},"required":["accrued_amount","accrued_not_invoiced","billed_charge_ids","currency_code","document_sha256","exceptions","id","invoice_number","lines","matches","nostro_account_id","period","recorded_at","recorded_by","source_ref","status","total_amount","variance_amount"],"type":"object"},"CorrespondentInvoiceRequest":{"description":"InvoiceRequest records a correspondent's invoice as treasury transcribed it from the document the correspondent sent (an account analysis statement, a PDF, or an ISO 20022 camt.086 bank services billing statement): the lines the matching needs and the SHA-256 of the document.","properties":{"currency_code":{"type":"string"},"document_sha256":{"type":"string"},"invoice_number":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InvoiceLine"},"type":"array"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period":{"type":"string"},"source_ref":{"type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["currency_code","document_sha256","invoice_number","lines","nostro_account_id","period","source_ref","total_amount"],"type":"object"},"CorrespondentMovement":{"description":"Movement is a retained gateway posting.","properties":{"amount":{"format":"int64","type":"integer"},"charge_bearer":{"type":"string"},"counter_entries":{"description":"CounterEntries are the other side of the journal, netting against the nostro entry; none\nputs the other side on the bank's payments in transit and suspense account (GL 2320) in the\nmovement's currency, where the leg that converts or pays it out picks it up.","items":{"$ref":"#/components/schemas/PostingEntry"},"type":"array"},"currency_code":{"type":"string"},"direction":{"description":"credit or debit, as the account moves at the correspondent","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"end_to_end_id":{"type":"string"},"entry_sequence":{"format":"int64","type":"integer"},"expected_charge":{"oneOf":[{"$ref":"#/components/schemas/ExpectedCharge"},{"type":"null"}]},"id":{"type":"string"},"instruction_id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_kind":{"type":"string"},"kind":{"description":"customer_transfer, bank_transfer, cover, return or funding","type":"string"},"message_id":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_movement_id":{"description":"a return: the movement it returns","type":"string"},"prepaid_charges_amount":{"description":"PrepaidChargesMinor is what a DEBT transfer added to the settlement amount to prepay the\nchain's charges; the correspondent's own charge is then taken from it and not billed again.","format":"int64","type":"integer"},"reason":{"type":"string"},"registered_at":{"format":"date-time","type":"string"},"registered_by":{"type":"string"},"release_hold_id":{"description":"a customer's hold the debit consumes","example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source":{"description":"the posting service","type":"string"},"source_ref":{"type":"string"},"uetr":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["amount","currency_code","direction","entry_sequence","id","journal_id","journal_kind","kind","nostro_account_id","registered_at","registered_by","source","source_ref","value_date"],"type":"object"},"CorrespondentMovementRequest":{"description":"MovementRequest is the SWIFT gateway's posting of a payment it settles through a nostro account: the journal (its counter entries; the ledger writes the nostro side) and the references the correspondent's statement will carry, so the reconciliation matches the statement entry to the journal and the charge schedule applies to the charge bearer.","properties":{"amount":{"format":"int64","type":"integer"},"charge_bearer":{"type":"string"},"counter_entries":{"description":"CounterEntries are the other side of the journal, netting against the nostro entry; none\nputs the other side on the bank's payments in transit and suspense account (GL 2320) in the\nmovement's currency, where the leg that converts or pays it out picks it up.","items":{"$ref":"#/components/schemas/PostingEntry"},"type":"array"},"currency_code":{"type":"string"},"direction":{"description":"credit or debit, as the account moves at the correspondent","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"end_to_end_id":{"type":"string"},"instruction_id":{"type":"string"},"journal_kind":{"type":"string"},"kind":{"description":"customer_transfer, bank_transfer, cover, return or funding","type":"string"},"message_id":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_movement_id":{"description":"a return: the movement it returns","type":"string"},"prepaid_charges_amount":{"description":"PrepaidChargesMinor is what a DEBT transfer added to the settlement amount to prepay the\nchain's charges; the correspondent's own charge is then taken from it and not billed again.","format":"int64","type":"integer"},"reason":{"type":"string"},"release_hold_id":{"description":"a customer's hold the debit consumes","example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_ref":{"type":"string"},"uetr":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["amount","currency_code","direction","journal_kind","kind","nostro_account_id","source_ref","value_date"],"type":"object"},"CorrespondentPosition":{"description":"Position is one nostro account's position at a date: the ledger balance by effective date split the way the Call Report reads it (a due-from balance on Schedule RC item 1.a or 1.b; an overdrawn due-from account as a borrowing on item 16 and Schedule RC-M item 5.b), the latest statement closing on or before the date, and what is still unreconciled.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"correspondent_bic":{"type":"string"},"currency_code":{"type":"string"},"due_from_amount":{"format":"int64","type":"integer"},"gl_code":{"type":"string"},"interest_bearing":{"type":"boolean"},"ledger_balance":{"format":"int64","type":"integer"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"open_breaks":{"format":"int64","type":"integer"},"open_liquidity_alerts":{"format":"int64","type":"integer"},"overdrawn_amount":{"format":"int64","type":"integer"},"statement_closing_balance":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"statement_closing_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["as_of","correspondent_bic","currency_code","due_from_amount","gl_code","interest_bearing","ledger_balance","nostro_account_id","open_breaks","open_liquidity_alerts","overdrawn_amount"],"type":"object"},"CorrespondentReconciliationRun":{"description":"ReconciliationRun is the retained evidence of one reconciliation pass.","properties":{"balance":{"oneOf":[{"$ref":"#/components/schemas/BalanceProof"},{"type":"null"}]},"breaks_opened":{"format":"int64","type":"integer"},"breaks_reopened":{"format":"int64","type":"integer"},"breaks_resolved":{"format":"int64","type":"integer"},"charges_posted":{"format":"int64","type":"integer"},"id":{"type":"string"},"input_sha256":{"type":"string"},"interest_settled":{"format":"int64","type":"integer"},"invoices_settled":{"format":"int64","type":"integer"},"matched":{"format":"int64","type":"integer"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"notifications_linked":{"format":"int64","type":"integer"},"open_breaks":{"format":"int64","type":"integer"},"run_at":{"format":"date-time","type":"string"},"run_by":{"type":"string"},"settled_through":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"statement_page_id":{"type":"string"},"trigger":{"type":"string"},"unmatched_within_tolerance":{"format":"int64","type":"integer"}},"required":["breaks_opened","breaks_reopened","breaks_resolved","charges_posted","id","input_sha256","interest_settled","invoices_settled","matched","nostro_account_id","notifications_linked","open_breaks","run_at","run_by","trigger","unmatched_within_tolerance"],"type":"object"},"CorrespondentRequest":{"description":"CorrespondentRequest proposes a correspondent, pending independent review.","properties":{"bic":{"type":"string"},"country":{"type":"string"},"due_diligence_ref":{"description":"DueDiligenceRef names the bank's review of the correspondent's financial condition, the\nperiodic review Regulation F (12 CFR 206.3) asks of a correspondent the bank has exposure to.","type":"string"},"legal_name":{"type":"string"},"lei":{"type":"string"},"relationship":{"type":"string"},"source_ref":{"description":"the account agreement or relationship approval","type":"string"}},"required":["bic","country","due_diligence_ref","legal_name","relationship","source_ref"],"type":"object"},"CorrespondentReview":{"description":"Review is an independent decision on a correspondent control record.","properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"CorrespondentStatement":{"description":"Statement is a retained report, statement or notification page.","properties":{"complete":{"description":"a camt.053 whose every page to the last is retained","type":"boolean"},"id":{"type":"string"},"message_sha256":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"page":{"$ref":"#/components/schemas/NormalizedStatement"},"received_at":{"format":"date-time","type":"string"},"received_by":{"type":"string"},"source":{"description":"pull:<adapter>, gateway or staff","type":"string"}},"required":["complete","id","message_sha256","nostro_account_id","page","received_at","received_by","source"],"type":"object"},"CorrespondentTerms":{"description":"Terms is a retained terms version and its review.","properties":{"cutoff":{"$ref":"#/components/schemas/CutoffWindow"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"format":"int64","type":"integer"},"interest":{"$ref":"#/components/schemas/InterestTerms"},"liquidity":{"$ref":"#/components/schemas/LiquidityTerms"},"maker":{"type":"string"},"monthly_fees":{"items":{"$ref":"#/components/schemas/MonthlyFee"},"type":"array"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payment_charges":{"items":{"$ref":"#/components/schemas/PaymentCharge"},"type":"array"},"reconciliation":{"$ref":"#/components/schemas/ReconciliationTerms"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"routed_bic_prefixes":{"description":"RoutedBICPrefixes are the destination banks this account reaches, as BIC prefixes at the\nlengths a BIC is meaningful at: four characters for an institution anywhere, six for it in\none country, eight for one of its offices and eleven for one branch. A payment to a\ndestination one of them heads settles through this account rather than the currency's\nprimary one, which is how a currency with more than one correspondent is split by\nwhere the money is going. Empty leaves the account to the primary route.","items":{"type":"string"},"type":"array"},"source_ref":{"type":"string"},"status":{"type":"string"}},"required":["cutoff","effective_date","id","interest","liquidity","maker","monthly_fees","nostro_account_id","payment_charges","reconciliation","recorded_at","source_ref","status"],"type":"object"},"Cost":{"properties":{"affiliate":{"type":"boolean"},"amount":{"format":"int64","type":"integer"},"bona_fide_reasonable":{"type":"boolean"},"can_shop":{"type":"boolean"},"category":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"insurer_choice_disclosed":{"type":"boolean"},"label":{"type":"string"},"on_provider_list":{"type":"boolean"},"paid_before_amount":{"format":"int64","type":"integer"},"paid_before_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"paid_by":{"description":"borrower, seller, other","type":"string"},"payee":{"type":"string"},"prepaid_months":{"format":"int64","type":"integer"},"recording_deed_amount":{"format":"int64","type":"integer"},"recording_mortgage_amount":{"format":"int64","type":"integer"},"required":{"type":"boolean"},"shopped":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["affiliate","amount","bona_fide_reasonable","can_shop","category","evidence_sha256","id","insurer_choice_disclosed","label","on_provider_list","paid_before_amount","paid_by","payee","required"],"type":"object"},"Count":{"properties":{"actor":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"counted_amount":{"format":"int64","type":"integer"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"description":"USD face value in cents -> number of pieces","type":"object"},"difference":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"posted_amount":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"source_sha256":{"type":"string"},"unit_id":{"type":"string"}},"required":["actor","business_date","counted_amount","denominations","difference","evidence","evidence_sha256","id","posted_amount","recorded_at","source_sha256","unit_id"],"type":"object"},"CountRequest":{"properties":{"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"description":"USD face value in cents -> number of pieces","type":"object"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"unit_id":{"type":"string"}},"required":["denominations","evidence","evidence_sha256","unit_id"],"type":"object"},"Counterparty":{"properties":{"account_number":{"type":"string"},"account_type":{"type":"string"},"name":{"type":"string"},"routing_number":{"type":"string"}},"required":["account_number","account_type","name","routing_number"],"type":"object"},"CounterpartyRequest":{"description":"CounterpartyRequest saves a counterparty to pay: the create-a-counterparty body, with pay_by when the bank should not infer it.","properties":{"account_number":{"type":"string"},"account_type":{"description":"checking (default), savings, general_ledger or loan","type":"string"},"address":{"oneOf":[{"$ref":"#/components/schemas/PostalAddress"},{"type":"null"}]},"bank_name":{"description":"required to wire","type":"string"},"bic":{"description":"the counterparty's bank abroad; giving it pays the counterparty by international wire","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"iban":{"description":"the international account number, on a counterparty paid by international wire","type":"string"},"legal_id":{"type":"string"},"legal_type":{"description":"business, non_profit, individual or sole_proprietor","type":"string"},"name":{"type":"string"},"pay_by":{"description":"ach (default with a routing number), book (an account at this bank), realtime, wire, international_wire (default with a BIC) or check (no routing number)","type":"string"},"phone":{"type":"string"},"routing_number":{"type":"string"},"routing_number_type":{"description":"aba","type":"string"}},"required":["customer_id","name"],"type":"object"},"Coverage":{"properties":{"adjusted_collateral_amount":{"format":"int64","type":"integer"},"blockers":{"items":{"type":"string"},"type":"array"},"excess_amount":{"format":"int64","type":"integer"},"fair_value_amount":{"format":"int64","type":"integer"},"ready":{"type":"boolean"},"required_amount":{"format":"int64","type":"integer"},"shortfall_amount":{"format":"int64","type":"integer"}},"required":["adjusted_collateral_amount","blockers","excess_amount","fair_value_amount","ready","required_amount","shortfall_amount"],"type":"object"},"CoverageItem":{"description":"CoverageItem is one declared position and what the workpaper did with it.","properties":{"caption":{"type":"string"},"figure_code":{"type":"string"},"item":{"type":"string"},"key":{"description":"SCHEDULE:item, the item without its separators (SC:4a, SCM:M11f)","type":"string"},"mdrm":{"type":"string"},"missing_category":{"type":"string"},"reason":{"type":"string"},"schedule":{"type":"string"},"source_kind":{"type":"string"},"status":{"description":"supplied, explained or uncovered","type":"string"},"unit":{"description":"usd_cents, integer or boolean","type":"string"}},"required":["caption","item","key","mdrm","schedule","status","unit"],"type":"object"},"CreateOrderRequest":{"properties":{"cash_limit_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"custody_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"dealer_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"dealer_reference":{"type":"string"},"instrument_id":{"type":"string"},"limit_price":{"format":"int64","type":"integer"},"lot_id":{"type":"string"},"max_fee_amount":{"format":"int64","type":"integer"},"program_id":{"type":"string"},"rationale":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"side":{"type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"}},"required":["cash_limit_amount","currency_code","custody_account_id","dealer_customer_id","dealer_reference","instrument_id","limit_price","max_fee_amount","program_id","rationale","settlement_date","side","trade_date","units"],"type":"object"},"CreateRequest":{"properties":{"currency_code":{"type":"string"},"lot_ids":{"items":{"type":"string"},"type":"array"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"proceeds_beneficiary_customer_ids":{"items":{"type":"string"},"type":"array"},"proceeds_use":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"program_id":{"type":"string"},"rate_bps":{"format":"int64","type":"integer"},"rationale":{"type":"string"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["currency_code","lot_ids","maturity_date","principal_amount","proceeds_beneficiary_customer_ids","proceeds_use","program_id","rate_bps","rationale","start_date"],"type":"object"},"Credit":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"availability":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"description":{"type":"string"},"hold_ids":{"items":{"type":"string"},"type":"array"},"id":{"example":"crdt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_ref":{"type":"string"}},"required":["account_id","amount","created_at","currency_code","description","id","journal_id","source_ref"],"type":"object"},"CreditBalance":{"description":"CreditBalance is one loan's or facility's retained principal history.","properties":{"as_of_amount":{"description":"retained principal at the close of as_of","format":"int64","type":"integer"},"changes":{"items":{"$ref":"#/components/schemas/CreditBalanceChange"},"type":"array"},"credit_id":{"type":"string"},"credit_kind":{"description":"loan or facility","type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"held_from":{"description":"a loan converted from a construction facility carries the receivable from this business date","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"held_through":{"description":"a construction facility converted into a loan carried it through this date","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opening_amount":{"description":"retained principal at the close of the day before from","format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"rc_c_item":{"description":"the Schedule RC-C loan category the product version names, as the catalogue writes it","type":"string"},"status":{"description":"the credit's status when listed","type":"string"}},"required":["as_of_amount","changes","credit_id","credit_kind","currency_code","gl_code","ledger_account_id","opening_amount","product_code","product_version","rc_c_item","status"],"type":"object"},"CreditBalanceChange":{"description":"CreditBalanceChange is the movement of one credit's retained principal on one business date.","properties":{"amount":{"description":"signed change on the date","format":"int64","type":"integer"},"balance_amount":{"description":"retained principal at the close of the date","format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"conversion":{"description":"the receivable passed between a construction facility and its permanent loan on this date","type":"boolean"},"journal_ids":{"items":{"type":"string"},"type":"array"}},"required":["amount","balance_amount","business_date","journal_ids"],"type":"object"},"CreditDecisionRequest":{"properties":{"actor":{"type":"string"},"decision":{"type":"string"},"reasons":{"description":"the principal reasons; a decline needs at least one","items":{"type":"string"},"type":"array"}},"required":["decision"],"type":"object"},"CreditExposure":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"kind":{"type":"string"}},"required":["amount_minor","currency","customer_id","id","kind"],"type":"object"},"CreditLoss":{"description":"CreditLoss is one charge-off or recovery; only the net amount reaches the allowance.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"credit_id":{"type":"string"},"credit_kind":{"type":"string"},"currency_code":{"type":"string"},"gross_amount":{"description":"charged off or recovered on the whole credit","format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"charge_off or recovery","type":"string"},"net_amount":{"description":"the bank's share, charged against or credited to the allowance","format":"int64","type":"integer"},"participants_amount":{"description":"the participants' share","format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"rc_c_item":{"type":"string"},"record_id":{"description":"the charge-off command key, or the recovery's loan payment id","type":"string"}},"required":["business_date","credit_id","credit_kind","currency_code","gross_amount","kind","net_amount","participants_amount","product_code","product_version","rc_c_item","record_id"],"type":"object"},"CreditRequest":{"description":"CreditRequest is created by the lending service from its immutable legal terms, never accepted from a customer as an authorization assertion. Amount is gross full commitment, including undrawn obligatory funds, not net cash after fees.","properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"destination_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"term_loan or facility; affiliate facility execution is refused","type":"string"},"terms_sha256":{"type":"string"},"transaction_ref":{"type":"string"}},"required":["amount","currency_code","customer_id","destination_account_id","kind","terms_sha256","transaction_ref"],"type":"object"},"CreditResult":{"properties":{"funded_exposure":{"format":"int64","type":"integer"},"funded_loss":{"format":"int64","type":"integer"},"group_id":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"method":{"type":"string"},"product_code":{"type":"string"},"remaining_months":{"format":"int64","type":"integer"},"risk_grade_revision_id":{"type":"string"},"source_table":{"type":"string"},"unfunded_exposure":{"format":"int64","type":"integer"},"unfunded_loss":{"format":"int64","type":"integer"}},"required":["funded_exposure","funded_loss","group_id","id","kind","method","product_code","remaining_months","risk_grade_revision_id","source_table","unfunded_exposure","unfunded_loss"],"type":"object"},"CreditTerms":{"properties":{"commitment_minor":{"format":"int64","type":"integer"},"credit_terms_sha256":{"type":"string"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"facility_terms":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"kind":{"type":"string"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"rate_nanos":{"format":"int64","type":"integer"},"term_months":{"format":"int64","type":"integer"}},"required":["commitment_minor","currency","customer_id","id","kind","product_code","product_version","rate_nanos","term_months"],"type":"object"},"Currency":{"description":"Currency is one ISO 4217 currency the ledger knows, whether new accounts may open in it, and its FX position pair once one exists.","properties":{"currency_code":{"type":"string"},"enabled":{"type":"boolean"},"fx_position":{"oneOf":[{"$ref":"#/components/schemas/PositionPair"},{"type":"null"}]},"iso_numeric":{"type":"string"},"minor_units":{"format":"int64","type":"integer"}},"required":["currency_code","enabled","iso_numeric","minor_units"],"type":"object"},"CustodianTransferEvidence":{"description":"CustodianTransferEvidence retains the successor trustee's acceptance of a direct transfer that involves no payment to the owner or beneficiary. ReceivingPlanType is the plan the successor trustee accepted into, which must be the source's own plan type.","properties":{"acceptance_ref":{"type":"string"},"acceptance_sha256":{"type":"string"},"inheritance_id":{"type":"string"},"inherited_rmd_review_id":{"type":"string"},"inherited_title":{"type":"boolean"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"payee_reference":{"type":"string"},"receiving_account_reference":{"type":"string"},"receiving_custodian":{"type":"string"},"receiving_plan_type":{"type":"string"},"receiving_title_sha256":{"type":"string"},"rmd_policy_id":{"type":"string"},"rmd_review_ids":{"items":{"type":"string"},"type":"array"}},"required":["acceptance_ref","acceptance_sha256","inherited_title","instruction_ref","instruction_sha256","payee_reference","receiving_account_reference","receiving_custodian","receiving_plan_type","receiving_title_sha256"],"type":"object"},"CustodiantransferRequest":{"description":"Request is what the receiving custodian sends.","properties":{"account_holder_name":{"type":"string"},"amount_minor":{"format":"int64","type":"integer"},"authorization_sha256":{"type":"string"},"decedent_name":{"type":"string"},"delivering_account_reference":{"type":"string"},"match_reference":{"type":"string"},"plan_type":{"type":"string"},"receiving_account_number":{"type":"string"},"receiving_account_title":{"type":"string"},"receiving_institution":{"type":"string"},"receiving_routing_number":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"transfer_scope":{"description":"full or partial","type":"string"}},"required":["account_holder_name","authorization_sha256","delivering_account_reference","match_reference","plan_type","receiving_account_number","receiving_account_title","receiving_institution","receiving_routing_number","request_id","transfer_scope"],"type":"object"},"CustodyAccount":{"properties":{"bank_owned":{"type":"boolean"},"custodian_reference":{"type":"string"},"enabled":{"type":"boolean"},"exclusive_core_instructions":{"type":"boolean"},"external_account_reference":{"type":"string"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"no_third_party_lien":{"type":"boolean"},"observed_at":{"format":"date-time","type":"string"},"onboarding":{"$ref":"#/components/schemas/Document"},"opening_inventory_empty":{"type":"boolean"},"ownership":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"signature":{"type":"string"},"valid_until":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["bank_owned","custodian_reference","enabled","exclusive_core_instructions","external_account_reference","key_id","legal_entity","master_cash_ledger_account_id","no_third_party_lien","observed_at","onboarding","opening_inventory_empty","ownership","program_id","program_sha256","signature","valid_until","version"],"type":"object"},"CustodyEntry":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"chain_sha256":{"type":"string"},"detail":{"type":"string"},"event":{"type":"string"},"sequence":{"format":"int64","type":"integer"}},"required":["actor","at","chain_sha256","detail","event","sequence"],"type":"object"},"CustodyProof":{"description":"CustodyProof must be signed by the ORIGINAL bank-securities program key. The embedded observation must independently verify using that same retained authority. A repo cash bridge can never create a collateral ownership proof.","properties":{"evidence":{"$ref":"#/components/schemas/Document"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"lot_id":{"type":"string"},"observation":{"$ref":"#/components/schemas/Observation"},"observed_at":{"format":"date-time","type":"string"},"original_program_id":{"type":"string"},"original_program_sha256":{"type":"string"},"pledge_reference":{"type":"string"},"signature":{"type":"string"},"state":{"description":"pledged or released","type":"string"},"transaction_id":{"type":"string"},"version":{"type":"string"}},"required":["evidence","instruction_sha256","key_id","lot_id","observation","observed_at","original_program_id","original_program_sha256","pledge_reference","signature","state","transaction_id","version"],"type":"object"},"Customer":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"backup_withholding":{"description":"24% is taken from interest while true (26 U.S.C. §3406)","type":"boolean"},"backup_withholding_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"date_of_birth":{"type":"string"},"death":{"oneOf":[{"$ref":"#/components/schemas/DeathStatus"},{"type":"null"}]},"email":{"type":"string"},"id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kyc_decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"kyc_status":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"},"risk_rating":{"type":"string"},"status":{"type":"string"},"tax_form":{"description":"w9, w8ben or w8bene on file","type":"string"},"tax_form_expires_at":{"description":"W-8BEN: the last day of the third calendar year after it was signed","type":"string"},"tax_form_received_at":{"type":"string"},"tax_id_last4":{"type":"string"},"tax_id_on_file":{"description":"a sealed tax id is stored","type":"boolean"},"tax_status_recorded_at":{"description":"Since this tax state was recorded; nil for legacy provenance.","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"tin_certified":{"type":"boolean"},"treaty_country":{"type":"string"},"type":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["address","backup_withholding","created_at","date_of_birth","email","id","kyc_status","legal_name","phone","risk_rating","status","tax_id_last4","tax_id_on_file","tin_certified","type","updated_at"],"type":"object"},"CustomerBindingRequest":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_ref":{"type":"string"}},"required":["customer_id","evidence_ref"],"type":"object"},"CutoffWindow":{"description":"CutoffWindow is when the correspondent values a payment in the currency on the same day: from the opening to the cutoff, local to the correspondent's time zone, on its business days. The times and the market holidays come from the account agreement; SWIFT delivers at any hour.","properties":{"cutoff":{"description":"HH:MM","type":"string"},"holidays":{"description":"YYYY-MM-DD weekdays the correspondent's market is closed","items":{"type":"string"},"type":"array"},"opens":{"description":"HH:MM","type":"string"},"time_zone":{"type":"string"}},"required":["cutoff","opens","time_zone"],"type":"object"},"CycleAccountResult":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"attempts":{"description":"cycle passes that reached this account, including reconciliations","format":"int64","type":"integer"},"error_code":{"description":"failed: the problem code of the last attempt","type":"string"},"error_detail":{"description":"failed: what the operator has to fix before reconciling","type":"string"},"period":{"type":"string"},"report":{"oneOf":[{"$ref":"#/components/schemas/CycleReport"},{"type":"null"}]},"source_sha256":{"type":"string"},"statement_id":{"type":"string"},"status":{"description":"pending, complete or failed","type":"string"}},"required":["account_id","period","status"],"type":"object"},"CycleReport":{"description":"CycleReport is the evidence a statement cycle leaves behind.","properties":{"accounts":{"format":"int64","type":"integer"},"actor":{"type":"string"},"analysis_accounts":{"description":"business accounts analysed","format":"int64","type":"integer"},"earnings_credit_amount":{"description":"earnings credit applied against their fees","format":"int64","type":"integer"},"execution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"failed_accounts":{"description":"accounts whose last pass failed; reconcile them one by one","format":"int64","type":"integer"},"fees_posted":{"format":"int64","type":"integer"},"fees_skipped":{"format":"int64","type":"integer"},"fees_waived":{"format":"int64","type":"integer"},"foreign_currency_interest_amounts":{"additionalProperties":{"format":"int64","type":"integer"},"description":"ForeignInterest is the interest paid on accounts held in currencies other than USD, by\ncurrency in that currency's own minor units; interest_amount and withheld_amount are USD.","type":"object"},"interest_accounts":{"description":"accounts paid interest in the period","format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"pending_accounts":{"format":"int64","type":"integer"},"period":{"type":"string"},"replayed":{"type":"boolean"},"statements":{"format":"int64","type":"integer"},"status":{"type":"string"},"total_accounts":{"format":"int64","type":"integer"},"withheld_amount":{"description":"backup withholding taken","format":"int64","type":"integer"}},"required":["accounts","actor","analysis_accounts","earnings_credit_amount","execution_date","failed_accounts","fees_posted","fees_skipped","fees_waived","interest_accounts","interest_amount","pending_accounts","period","replayed","statements","status","total_accounts","withheld_amount"],"type":"object"},"CycleRequest":{"properties":{"limit":{"format":"int64","type":"integer"},"operator":{"type":"string"},"period":{"type":"string"}},"required":["period"],"type":"object"},"DailyFlash":{"properties":{"basis":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"compared_to":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"comparison":{"oneOf":[{"$ref":"#/components/schemas/ClosingSnapshot"},{"type":"null"}]},"comparison_sha256":{"type":"string"},"currencies":{"additionalProperties":{"properties":{"allowance_amount":{"format":"int64","type":"integer"},"assets_amount":{"format":"int64","type":"integer"},"cash_amount":{"format":"int64","type":"integer"},"cash_change":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"deposit_accounts_amount":{"format":"int64","type":"integer"},"deposit_accounts_change":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"equity_amount":{"format":"int64","type":"integer"},"gross_loans_amount":{"format":"int64","type":"integer"},"gross_loans_change":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"liabilities_amount":{"format":"int64","type":"integer"},"net_loans_amount":{"format":"int64","type":"integer"},"unclosed_net_income_amount":{"format":"int64","type":"integer"}},"required":["allowance_amount","assets_amount","cash_amount","deposit_accounts_amount","equity_amount","gross_loans_amount","liabilities_amount","net_loans_amount","unclosed_net_income_amount"],"type":"object"},"type":"object"},"source":{"$ref":"#/components/schemas/ClosingSnapshot"},"source_sha256":{"type":"string"}},"required":["basis","business_date","currencies","source","source_sha256"],"type":"object"},"DailyInterestBalance":{"description":"Accrual is one day's interest on one account. DailyInterestBalance is the dated principal before negative balances are clipped to zero.","properties":{"amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["amount","date"],"type":"object"},"Data":{"properties":{"access_id":{"type":"string"},"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"captured_at":{"format":"date-time","type":"string"},"consent_id":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"data":{"additionalProperties":true,"type":"object"},"sha256":{"type":"string"}},"required":["access_id","captured_at","consent_id","customer_id","data","sha256"],"type":"object"},"DatedClassification":{"description":"DatedClassification is one approved classification revision effective at the date.","properties":{"content_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"type":"string"},"review_by":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"}},"required":["content_sha256","customer_id","effective_date","id","review_by","status"],"type":"object"},"DatedCredit":{"description":"DatedCredit is one covered credit at the date: a loan or facility whose borrower was an insider or was linked to one by a reviewed relationship, or an external inventory entry of the policy recorded for such a customer.","properties":{"affiliate_insider_customer_ids":{"items":{"type":"string"},"type":"array"},"amount_minor":{"format":"int64","type":"integer"},"bank_insider_customer_ids":{"items":{"type":"string"},"type":"array"},"basis":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"description":"the loan or facility id, or the inventory entry's reference","type":"string"},"kind":{"description":"loan, facility, external","type":"string"},"product_code":{"type":"string"},"status":{"type":"string"},"undetermined_reason":{"type":"string"}},"required":["affiliate_insider_customer_ids","amount_minor","bank_insider_customer_ids","customer_id","id","kind"],"type":"object"},"DatedExposure":{"description":"DatedExposure is lending's evidence for FFIEC 051 Schedule RC-M items 1.a and 1.b at one past date: every loan and facility the closing-day source retained for that date, and every entry of the external exposure inventory of the policy effective on it, attributed to insiders through the reviewed classification revisions effective on it. It reports credits the records cannot place as undetermined instead of counting or dropping them.","properties":{"aggregate_minor":{"description":"determined credits attributed to a bank insider, each counted once","format":"int64","type":"integer"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"classifications":{"description":"every revision applied: each borrower with credit and each linked insider","items":{"$ref":"#/components/schemas/DatedClassification"},"type":"array"},"close_source_content_sha256":{"type":"string"},"close_source_id":{"type":"string"},"credit_records_export_id":{"type":"string"},"credit_records_sha256":{"type":"string"},"credits":{"items":{"$ref":"#/components/schemas/DatedCredit"},"type":"array"},"insiders":{"items":{"$ref":"#/components/schemas/DatedInsider"},"type":"array"},"policy":{"$ref":"#/components/schemas/DatedPolicy"},"registry_sha256":{"description":"digest of the policy and classification revisions applied","type":"string"}},"required":["aggregate_minor","as_of","classifications","close_source_content_sha256","close_source_id","credit_records_export_id","credit_records_sha256","credits","insiders","policy","registry_sha256"],"type":"object"},"DatedInsider":{"description":"DatedInsider is one person a covered credit is attributed to. A bank insider holds a reviewed executive officer, director or principal shareholder role at the bank on the date; an affiliate insider holds such roles only at an affiliate.","properties":{"amount_minor":{"description":"every determined credit to the person and related interests, each in full","format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"institution":{"description":"bank, affiliate","type":"string"},"roles":{"items":{"type":"string"},"type":"array"},"undetermined_credits":{"description":"attributed credits whose amount the records cannot place","format":"int64","type":"integer"}},"required":["amount_minor","customer_id","institution","roles","undetermined_credits"],"type":"object"},"DatedPolicy":{"description":"DatedPolicy is the approved Regulation O policy revision effective at the date. Its external exposure inventory is the bank's reviewed record of insider credit held outside lending (overdrafts on deposit accounts, cash items, repurchase agreements and the like), which the instruction counts and which no dated source in lending places at the date.","properties":{"content_sha256":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"external_exposure_entries":{"format":"int64","type":"integer"},"id":{"type":"string"},"review_by":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["content_sha256","effective_date","external_exposure_entries","id","review_by"],"type":"object"},"Day":{"description":"Day is a calendar date with no time or zone, the unit of effective dates and end of day.","format":"date","type":"string"},"DayCharge":{"description":"DayCharge is one 24-hour measurement day's daylight overdraft pricing: the time-weighted average uncollateralized overdraft over 1,440 minutes at 50 basis points a year (the Federal Reserve's PSR policy, section V of its guide). Elapsed minutes no sample describes are priced at the day's peak; complete is false until the samples cover the whole day.","properties":{"average_uncollateralized_overdraft_amount":{"format":"int64","type":"integer"},"charge_amount":{"format":"int64","type":"integer"},"complete":{"type":"boolean"},"minutes_covered":{"format":"int64","type":"integer"},"minutes_unsampled":{"format":"int64","type":"integer"},"peak_uncollateralized_overdraft_amount":{"format":"int64","type":"integer"},"psr_day":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"samples":{"format":"int64","type":"integer"},"unsampled_priced_at_amount":{"format":"int64","type":"integer"}},"required":["average_uncollateralized_overdraft_amount","charge_amount","complete","minutes_covered","minutes_unsampled","peak_uncollateralized_overdraft_amount","psr_day","samples","unsampled_priced_at_amount"],"type":"object"},"Dealer":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"external_reference":{"type":"string"},"identity":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"legal_name":{"type":"string"}},"required":["customer_id","external_reference","identity","legal_name"],"type":"object"},"DealerCheck":{"properties":{"external_dealer_reference":{"type":"string"},"observation":{"$ref":"#/components/schemas/RegistryObservation"},"order_id":{"type":"string"},"stage":{"type":"string"}},"required":["external_dealer_reference","observation","order_id","stage"],"type":"object"},"DeathControl":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/DeathControlDecision"},{"type":"null"}]},"id":{"example":"dctl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"$ref":"#/components/schemas/DomainOwnership"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/DeathControlRequest"},"status":{"type":"string"}},"required":["account_id","id","owners","ownership","proposed_at","proposed_by","request","status"],"type":"object"},"DeathControlDecision":{"properties":{"approve":{"type":"boolean"},"decided_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"evidence_ref":{"type":"string"},"reason":{"type":"string"}},"required":["approve","decided_at","decided_by","evidence_ref","reason"],"type":"object"},"DeathControlDecisionRequest":{"properties":{"approve":{"type":"boolean"},"evidence_ref":{"type":"string"},"reason":{"type":"string"}},"required":["approve","evidence_ref","reason"],"type":"object"},"DeathControlRequest":{"example":{"customer_id":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","report_id":"drep_2tVh8nqLxq4GbDe0K1F6S9zRcWm","revision":1,"action":"restrict_debits","policy_ref":"policy:deceased-accounts","evidence_ref":"case:account-title-review","reason":"Reviewed account ownership and agreement"},"properties":{"action":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_ref":{"type":"string"},"policy_ref":{"type":"string"},"reason":{"type":"string"},"report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"restriction_id":{"type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["action","customer_id","evidence_ref","policy_ref","reason","report_id","revision"],"type":"object"},"DeathCorrection":{"properties":{"decision":{"oneOf":[{"$ref":"#/components/schemas/DeathCorrectionDecision"},{"type":"null"}]},"evidence_ref":{"type":"string"},"id":{"example":"dcor_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"reason":{"type":"string"},"report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["evidence_ref","id","proposed_at","proposed_by","reason","report_id","revision","status"],"type":"object"},"DeathCorrectionDecision":{"properties":{"approve":{"type":"boolean"},"decided_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"reason":{"type":"string"}},"required":["approve","decided_at","decided_by","reason"],"type":"object"},"DeathCorrectionDecisionRequest":{"properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"DeathCorrectionRequest":{"properties":{"evidence_ref":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","reason"],"type":"object"},"DeathDecision":{"properties":{"decided_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"evidence_ref":{"type":"string"},"outcome":{"type":"string"},"reason":{"type":"string"}},"required":["decided_at","decided_by","evidence_ref","outcome","reason"],"type":"object"},"DeathDecisionRequest":{"properties":{"evidence_ref":{"type":"string"},"outcome":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","outcome","reason"],"type":"object"},"DeathReport":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date_of_death":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/DeathDecision"},{"type":"null"}]},"evidence_ref":{"type":"string"},"id":{"example":"drep_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reported_at":{"format":"date-time","type":"string"},"reported_by":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"}},"required":["customer_id","date_of_death","evidence_ref","id","reported_at","reported_by","source","status"],"type":"object"},"DeathReportRequest":{"properties":{"date_of_death":{"type":"string"},"evidence_ref":{"type":"string"},"source":{"type":"string"}},"required":["date_of_death","evidence_ref","source"],"type":"object"},"DeathStatus":{"properties":{"date_of_death":{"type":"string"},"report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["date_of_death","report_id","revision"],"type":"object"},"Decision":{"properties":{"decided_at":{"type":"string"},"decided_by":{"description":"the credit officer who decided a file in review","type":"string"},"dti_bps":{"format":"int64","type":"integer"},"outcome":{"type":"string"},"payment_amount":{"format":"int64","type":"integer"},"rate_bps":{"format":"int64","type":"integer"},"reasons":{"items":{"type":"string"},"type":"array"},"review_reasons":{"description":"the automated triggers that sent it to review","items":{"type":"string"},"type":"array"}},"required":["decided_at","dti_bps","outcome","payment_amount","rate_bps","reasons"],"type":"object"},"DecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence":{"$ref":"#/components/schemas/Evidence"},"rationale":{"type":"string"}},"required":["content_sha256","decision","evidence","rationale"],"type":"object"},"DeclineRequestBody":{"description":"DeclineRequestBody says why the bank's customer will not pay a request.","properties":{"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["reason_code"],"type":"object"},"DelinquencyRun":{"description":"DelinquencyRun is what a past-due sweep did.","properties":{"business_date":{"type":"string"},"charged_off":{"description":"loans and facilities charged off against the allowance","format":"int64","type":"integer"},"installments_late":{"format":"int64","type":"integer"},"nonaccrual":{"description":"loans and facilities moved to nonaccrual","format":"int64","type":"integer"},"statements_late":{"description":"facility statements that went late","format":"int64","type":"integer"}},"required":["business_date","charged_off","installments_late","nonaccrual","statements_late"],"type":"object"},"Delivery":{"properties":{"channel":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"document_sha256":{"type":"string"},"electronic_consent_sha256":{"type":"string"},"evidence_sha256":{"type":"string"},"provider_reference":{"type":"string"}},"required":["channel","delivered_at","document_sha256","evidence_sha256","provider_reference"],"type":"object"},"DeliveryEvidence":{"properties":{"actor":{"type":"string"},"channel":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"provider_ref":{"type":"string"},"status":{"type":"string"}},"required":["actor","channel","created_at","provider_ref","status"],"type":"object"},"DeliveryUpdate":{"properties":{"provider_ref":{"type":"string"},"statement_id":{"type":"string"},"status":{"type":"string"}},"required":["provider_ref","status"],"type":"object"},"Deposit":{"description":"Deposit is one deposit obligation: the liabilities it covers, the period they accumulated in and the date a deposit is timely by.","properties":{"amount_minor":{"format":"int64","type":"integer"},"citation":{"type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"form":{"type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"references":{"items":{"type":"string"},"type":"array"},"rule":{"type":"string"}},"required":["amount_minor","citation","due_date","form","period_end","period_start","references","rule"],"type":"object"},"DepositCheckRequest":{"description":"DepositCheckRequest deposits one check. Channel says where the deposit was taken, which is what Reg CC schedules on: \"branch\" (handed to an employee, the default), \"mobile\" (an image the customer captured) or \"atm\" — an ATM the bank owns or operates, a proprietary ATM under 12 CFR 229.2(aaa). A driver that cannot say the terminal is the bank's sends \"nonproprietary_atm\", which is refused with payments.unsupported_deposit_channel: the bank has no deposit-taking arrangement at a terminal it does not operate, and 12 CFR 229.12(f) schedules such a deposit to the fifth business day.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"back_image":{"format":"byte","type":"string"},"channel":{"description":"branch, mobile, atm (proprietary only), or lockbox; nonproprietary_atm is explicitly refused with payments.unsupported_deposit_channel","enum":["branch","mobile","atm","lockbox","nonproprietary_atm"],"type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"drawer":{"description":"who wrote the check, as captured; screened with the payee","type":"string"},"front_image":{"description":"TIFF, base64 in JSON","format":"byte","type":"string"},"micr":{"$ref":"#/components/schemas/MICR"},"payee":{"type":"string"}},"required":["account_id","amount","currency_code","micr"],"type":"object"},"DepositPlan":{"description":"DepositPlan is the computed deposits for one set of liabilities.","properties":{"became_semiweekly":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"deposits":{"items":{"$ref":"#/components/schemas/Deposit"},"type":"array"},"form":{"type":"string"},"notes":{"items":{"type":"string"},"type":"array"},"start_schedule":{"type":"string"}},"required":["deposits","form"],"type":"object"},"DepositScreening":{"description":"DepositScreening is a ChexSystems inquiry's lifecycle record (no sealed identity).","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"consumer_score":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"inquiry_id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ScreeningItem"},"type":"array"},"recommendation":{"type":"string"},"ssn_last4":{"type":"string"}},"required":["consumer_score","created_at","customer_id","id","idempotency_key","inquiry_id","recommendation","ssn_last4"],"type":"object"},"DerivedFact":{"description":"DerivedFact is a profile amount the reporting service computed from retained data (an exact dated ledger closing or an independently approved capital run) with its provenance. A caller's assertion of the same field must agree with it; elections and regulator directions stay caller-asserted because no retained data decides them.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"field":{"type":"string"},"source":{"type":"string"},"source_ref":{"type":"string"},"source_sha256":{"type":"string"},"value":{"format":"int64","type":"integer"}},"required":["as_of","field","source","source_ref","source_sha256","value"],"type":"object"},"Description":{"properties":{"capture":{"type":"string"},"coverage":{"type":"string"},"excluded":{"items":{"type":"string"},"type":"array"},"projection_sha256":{"type":"string"},"service":{"type":"string"},"source":{"type":"string"},"version":{"type":"string"}},"required":["coverage","excluded","projection_sha256","service","source","version"],"type":"object"},"Destination":{"description":"Destination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.","properties":{"account_number":{"type":"string"},"legal_name":{"type":"string"},"routing_number":{"type":"string"}},"required":["account_number","legal_name","routing_number"],"type":"object"},"Detail":{"properties":{"counterparty":{"type":"string"},"description":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"location":{"type":"string"},"terminal":{"type":"boolean"}},"required":["counterparty","description","journal_id","terminal"],"type":"object"},"Determination":{"description":"Determination records the evidence of a notice a withholding basis requires before release. A SAR withheld from legal process needs two: bsa_confidentiality_fincen (31 CFR 1020.320(e)(1)(i): decline, citing the rule and 31 U.S.C. 5318(g)(2)(A)(i), and notify FinCEN of the request and the response) and bsa_confidentiality_occ (12 CFR 21.11(k)(1)(i)(A): a national bank also notifies the Director, Litigation Division, OCC). Non-public OCC information withheld needs occ_non_public (12 CFR 4.37(b)(3)(i): notify the Director of the OCC's Litigation Division). The evidence is the bank's; the code records it.","properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"kind":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","kind","reason"],"type":"object"},"Device":{"description":"Device is a device a customer signed in from.","properties":{"created_at":{"format":"date-time","type":"string"},"id":{"example":"dev_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"last_seen_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"revoked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"trusted":{"type":"boolean"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["created_at","id","last_seen_at","name","platform","trusted","user_id"],"type":"object"},"DeviceSignals":{"description":"DeviceSignals is what the app reports about the device it runs on; the server fingerprints them into a device id.","properties":{"device_uid":{"description":"the platform's stable install id","type":"string"},"hardware_id":{"description":"model identifier","type":"string"},"name":{"description":"what the customer calls the device","type":"string"},"platform":{"description":"ios, android, web","type":"string"},"screen_height":{"format":"int64","type":"integer"},"screen_width":{"format":"int64","type":"integer"}},"required":["device_uid","hardware_id","name","platform","screen_height","screen_width"],"type":"object"},"Director":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"staff_subject":{"type":"string"}},"required":["customer_id","id","staff_subject"],"type":"object"},"DirectoryEntry":{"properties":{"ProductVersion":{"type":"string"}},"required":["ProductVersion"],"type":"object"},"Disclosed":{"properties":{"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingdisclosuresDecision"},{"type":"null"}]},"deliveries":{"items":{"$ref":"#/components/schemas/LendingdisclosuresDelivery"},"type":"array"},"issue":{"oneOf":[{"$ref":"#/components/schemas/Issue"},{"type":"null"}]},"revision":{"$ref":"#/components/schemas/LendingdisclosuresRevision"}},"required":["deliveries","revision"],"type":"object"},"Disclosure":{"properties":{"assumptions":{"type":"string"},"compounding":{"type":"string"},"day_count":{"type":"string"},"days_in_term":{"format":"int64","type":"integer"},"method":{"type":"string"},"reference_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"yields":{"items":{"$ref":"#/components/schemas/Yield"},"type":"array"}},"required":["assumptions","compounding","day_count","days_in_term","method","reference_start","yields"],"type":"object"},"DisclosuresDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"evidence":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","approve","evidence","recorded_at"],"type":"object"},"DisclosuresDecisionRequest":{"properties":{"approve":{"type":"boolean"},"evidence":{"type":"string"}},"required":["approve","evidence"],"type":"object"},"DisclosuresPolicy":{"properties":{"actor":{"type":"string"},"agreement":{"type":"string"},"agreement_version":{"type":"string"},"apy":{"$ref":"#/components/schemas/Disclosure"},"apy_assumed_maximum_minor":{"format":"int64","type":"integer"},"apy_reference_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/DisclosuresDecision"},{"type":"null"}]},"e_sign_disclosure":{"type":"string"},"e_sign_version":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"expires_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"type":"string"},"policy_evidence":{"type":"string"},"product_code":{"type":"string"},"product_sha256":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["actor","agreement","agreement_version","apy","apy_reference_start","e_sign_disclosure","e_sign_version","effective_date","expires_date","id","policy_evidence","product_code","product_sha256","product_version","recorded_at","revision"],"type":"object"},"DisclosuresRequest":{"properties":{"agreement":{"type":"string"},"agreement_version":{"type":"string"},"apy_assumed_maximum_minor":{"format":"int64","type":"integer"},"apy_reference_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"e_sign_disclosure":{"type":"string"},"e_sign_version":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"expires_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"policy_evidence":{"type":"string"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"revision":{"format":"int64","type":"integer"}},"required":["agreement","agreement_version","apy_reference_start","e_sign_disclosure","e_sign_version","effective_date","expires_date","policy_evidence","product_code","product_version","revision"],"type":"object"},"Discovery":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"high_water":{"format":"int64","type":"integer"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/DiscoveryRequest"},"request_sha256":{"type":"string"},"root_sha256":{"type":"string"},"rows":{"format":"int64","type":"integer"}},"required":["actor","created_at","high_water","id","request","request_sha256","root_sha256","rows"],"type":"object"},"DiscoveryItem":{"properties":{"captured_metadata_sha256":{"type":"string"},"chain_sha256":{"type":"string"},"current_active_holds":{"items":{"type":"string"},"type":"array"},"current_disposed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"ordinal":{"format":"int64","type":"integer"},"record":{"$ref":"#/components/schemas/BankrecordsRecord"}},"required":["captured_metadata_sha256","chain_sha256","current_active_holds","ordinal","record"],"type":"object"},"DiscoveryPage":{"properties":{"after":{"format":"int64","type":"integer"},"before_sha256":{"type":"string"},"complete":{"type":"boolean"},"discovery":{"$ref":"#/components/schemas/Discovery"},"items":{"items":{"$ref":"#/components/schemas/DiscoveryItem"},"type":"array"},"next_cursor":{"format":"int64","type":"integer"}},"required":["after","before_sha256","complete","discovery","items","next_cursor"],"type":"object"},"DiscoveryRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"created_through":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"purpose":{"type":"string"},"service":{"type":"string"},"source":{"type":"string"}},"required":["purpose"],"type":"object"},"Discrepancy":{"description":"Discrepancy is a Fed difference advice or a counted difference that needs independent review.","properties":{"actor":{"type":"string"},"amount":{"description":"signed: short is negative","format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"evidence":{"type":"string"},"id":{"type":"string"},"instruction_id":{"type":"string"}},"required":["actor","amount","created_at","evidence","id","instruction_id"],"type":"object"},"DisposalReceipt":{"description":"DisposalReceipt is the retained evidence of one destroyed encrypted document: its plaintext digest, the destroyed envelope digest and the data key it used.","properties":{"content_sha256":{"type":"string"},"disposition_version":{"format":"int64","type":"integer"},"envelope_sha256":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"packet_id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["content_sha256","disposition_version","envelope_sha256","key_id","kind","packet_id","recorded_at"],"type":"object"},"Disposition":{"description":"Disposition is one recorded decision on an alert.","properties":{"actor":{"type":"string"},"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"filing_packet_id":{"type":"string"},"from_status":{"type":"string"},"id":{"type":"string"},"note":{"type":"string"},"role":{"description":"decided, proposed, approved","type":"string"},"to_status":{"type":"string"}},"required":["actor","alert_id","created_at","from_status","id","note","role","to_status"],"type":"object"},"Dispositions":{"description":"Dispositions count a file's records by outcome.","properties":{"exceptions":{"format":"int64","type":"integer"},"fees":{"format":"int64","type":"integer"},"pending":{"format":"int64","type":"integer"},"posted":{"format":"int64","type":"integer"},"return_matched":{"format":"int64","type":"integer"}},"required":["exceptions","fees","pending","posted","return_matched"],"type":"object"},"Dispute":{"properties":{"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"deadlines":{"$ref":"#/components/schemas/DisputeDeadlines"},"id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"policy":{"$ref":"#/components/schemas/DisputePolicy"},"product_code":{"type":"string"},"request":{"$ref":"#/components/schemas/DisputeRequest"},"state":{"$ref":"#/components/schemas/DisputeState"}},"required":["created_at","created_by","deadlines","id","ledger_account_id","policy","product_code","request","state"],"type":"object"},"DisputeAction":{"properties":{"cancellation":{"oneOf":[{"$ref":"#/components/schemas/DisputeCancellation"},{"type":"null"}]},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/DisputeDecision"},{"type":"null"}]},"executed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"idempotency_key":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/DisputeActionRequest"}},"required":["case_id","id","idempotency_key","proposed_at","proposed_by","request"],"type":"object"},"DisputeActionRequest":{"properties":{"amounts":{"$ref":"#/components/schemas/DisputeAmounts"},"evidence_keys":{"items":{"type":"string"},"type":"array"},"kind":{"description":"provisional, resolve, recover, waive_recovery","type":"string"},"outcome":{"description":"error, partial_error, no_error, documentation","type":"string"},"reason":{"type":"string"}},"required":["amounts","evidence_keys","kind","reason"],"type":"object"},"DisputeAmounts":{"properties":{"fees_amount":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"}},"required":["fees_amount","interest_amount","principal_amount"],"type":"object"},"DisputeCancellation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"cancelled_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"reason":{"type":"string"}},"required":["actor","at","reason"],"type":"object"},"DisputeCancellationRequest":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"},"DisputeDeadlineView":{"properties":{"id":{"type":"string"},"tasks":{"items":{"$ref":"#/components/schemas/DisputeTask"},"type":"array"}},"required":["id","tasks"],"type":"object"},"DisputeDeadlines":{"properties":{"extended":{"type":"boolean"},"initial_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"investigation_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"new_account":{"type":"boolean"}},"required":["extended","initial_due","investigation_due","new_account"],"type":"object"},"DisputeDecision":{"properties":{"actor":{"type":"string"},"approved":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","approved","at","reason"],"type":"object"},"DisputeDecisionRequest":{"properties":{"approved":{"type":"boolean"},"reason":{"type":"string"}},"required":["approved","reason"],"type":"object"},"DisputeEvent":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"detail":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"kind":{"type":"string"}},"required":["actor","at","case_id","detail","id","idempotency_key","kind"],"type":"object"},"DisputeEvidenceRequest":{"properties":{"kind":{"type":"string"},"reference":{"type":"string"},"sha256":{"type":"string"},"summary":{"type":"string"}},"required":["kind","reference","sha256","summary"],"type":"object"},"DisputeNoticeRequest":{"description":"Notice evidence records actual transmission; creating a draft is not delivery.","properties":{"amount":{"format":"int64","type":"integer"},"debit_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"documents_available":{"type":"boolean"},"kind":{"type":"string"},"recipient_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reference":{"type":"string"},"sent_at":{"format":"date-time","type":"string"},"sha256":{"type":"string"}},"required":["amount","documents_available","kind","recipient_customer_id","reference","sent_at","sha256"],"type":"object"},"DisputePolicy":{"description":"DisputePolicy is an explicitly configured, versioned consumer deposit EFT policy.","properties":{"business_days":{"items":{"format":"int64","type":"integer"},"type":"array"},"closed_dates":{"items":{"$ref":"#/components/schemas/Day"},"type":"array"},"expense_gl_code":{"type":"string"},"id":{"type":"string"},"legal_entity":{"type":"string"},"max_claim_amount":{"format":"int64","type":"integer"},"product_codes":{"items":{"type":"string"},"type":"array"},"suspense_gl_code":{"type":"string"},"timezone":{"type":"string"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["business_days","closed_dates","expense_gl_code","id","legal_entity","max_claim_amount","product_codes","suspense_gl_code","timezone","valid_from","valid_through"],"type":"object"},"DisputeRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"error_kind":{"type":"string"},"evidence_ref":{"type":"string"},"fees_amount":{"format":"int64","type":"integer"},"first_deposit_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"notice_method":{"type":"string"},"original_journal_key":{"type":"string"},"outside_state":{"type":"boolean"},"point_of_sale":{"type":"boolean"},"principal_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"statement_sent_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"transaction_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"transaction_ref":{"type":"string"}},"required":["account_id","customer_id","error_kind","evidence_ref","fees_amount","interest_amount","notice_method","outside_state","point_of_sale","principal_amount","reason","received_at","transaction_date","transaction_ref"],"type":"object"},"DisputeResolution":{"description":"DisputeResolution closes a dispute as corrected or verified.","properties":{"resolution":{"type":"string"},"status":{"type":"string"}},"required":["resolution","status"],"type":"object"},"DisputeState":{"properties":{"corrected_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"determined_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"final_amounts":{"$ref":"#/components/schemas/DisputeAmounts"},"outcome":{"type":"string"},"pending_action_id":{"type":"string"},"provisional_amount":{"format":"int64","type":"integer"},"provisional_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"provisional_notice_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"recovered_amount":{"format":"int64","type":"integer"},"recovery_amount":{"format":"int64","type":"integer"},"recovery_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"recovery_notice_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"results_notice_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"},"written_off_amount":{"format":"int64","type":"integer"}},"required":["final_amounts","provisional_amount","recovered_amount","recovery_amount","status","written_off_amount"],"type":"object"},"DisputeTask":{"properties":{"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"kind":{"type":"string"},"overdue":{"type":"boolean"}},"required":["case_id","due","kind","overdue"],"type":"object"},"Distribution":{"description":"Distribution is actual external cash evidence. Neither a forecast dividend nor a reached Treasury maturity date authorizes a customer credit.","properties":{"cash_evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"cash_reference":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"custody_evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"external_account_reference":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"gross_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"key_id":{"type":"string"},"kind":{"description":"cash_distribution or maturity","type":"string"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"original_settlement_sha256":{"type":"string"},"owner_id":{"type":"string"},"payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"payment_reference":{"type":"string"},"record_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"signature":{"type":"string"},"tax_character":{"description":"explicit actual classification, including unknown","type":"string"},"tax_evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"units":{"description":"original full lot; distribution does not remove units","format":"int64","type":"integer"},"version":{"type":"string"},"withholding_amount":{"format":"int64","type":"integer"}},"required":["cash_evidence","cash_reference","currency_code","cusip","custodian_reference","custody_evidence","external_account_reference","fee_amount","gross_amount","id","key_id","kind","lot_id","lot_revision","net_cash_amount","observed_at","original_settlement_sha256","owner_id","payment_date","payment_reference","record_date","signature","tax_character","tax_evidence","units","version","withholding_amount"],"type":"object"},"DistributionObservation":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"cash":{"oneOf":[{"$ref":"#/components/schemas/CashObservation"},{"type":"null"}]},"distribution":{"$ref":"#/components/schemas/DistributionRecord"}},"required":["blockers","distribution"],"type":"object"},"DistributionRecord":{"properties":{"accounting_plan_sha256":{"type":"string"},"accounting_plans":{"items":{"$ref":"#/components/schemas/InvestmentsAccountingPlan"},"type":"array"},"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"exceptions":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"receipt":{"$ref":"#/components/schemas/Distribution"},"request_sha256":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/InvestmentsDecision"},"type":"array"},"status":{"type":"string"}},"required":["actor","created_at","exceptions","id","receipt","request_sha256","status"],"type":"object"},"Document":{"properties":{"data":{"format":"byte","type":"string"},"format":{"type":"string"},"sha256":{"type":"string"}},"required":["data","format","sha256"],"type":"object"},"DocumentRequest":{"description":"DocumentRequest opens the evidenced ingest of one full external document. Its bytes follow in PartBytes parts and must reproduce SHA256 and Bytes exactly before the document is archived.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"bsa_confidential":{"description":"BSAConfidential marks a SAR, or material that would reveal one; a production never\ncollects it (31 CFR 1020.320(e)).","type":"boolean"},"bytes":{"format":"int64","type":"integer"},"category":{"type":"string"},"content_type":{"type":"string"},"custodian":{"type":"string"},"customer_ids":{"items":{"type":"string"},"type":"array"},"document_date":{"format":"date-time","type":"string"},"email":{"oneOf":[{"$ref":"#/components/schemas/EmailMetadata"},{"type":"null"}]},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"filename":{"type":"string"},"kind":{"description":"document or email","type":"string"},"reason":{"type":"string"},"sha256":{"type":"string"},"source_ref":{"type":"string"},"source_system":{"type":"string"},"title":{"type":"string"}},"required":["account_ids","bsa_confidential","bytes","category","content_type","custodian","customer_ids","document_date","evidence_ref","evidence_sha256","filename","kind","reason","sha256","source_ref","source_system","title"],"type":"object"},"DomainAuthorization":{"description":"Authorization is the decision and its lifecycle.","properties":{"amount":{"format":"int64","type":"integer"},"authorized_positive":{"type":"boolean"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"channel":{"type":"string"},"cleared_amount":{"format":"int64","type":"integer"},"country":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"decision":{"type":"string"},"draw_id":{"description":"a credit card clearing's draw on the facility","type":"string"},"expires_at":{"description":"an authorised purchase not cleared by then expires","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"purchase, refund, force_post","type":"string"},"mcc":{"type":"string"},"merchant_id":{"type":"string"},"merchant_location":{"type":"string"},"merchant_name":{"type":"string"},"network":{"type":"string"},"network_ref":{"type":"string"},"original_network_ref":{"description":"a refund: the purchase it credits","type":"string"},"overdraft_decision_id":{"type":"string"},"reason":{"type":"string"},"requested_amount":{"description":"partial approval: what the merchant asked for","format":"int64","type":"integer"},"response_code":{"type":"string"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["amount","authorized_positive","business_date","card_id","channel","cleared_amount","country","created_at","currency_code","decision","id","mcc","merchant_name","network_ref","reason","response_code","status","updated_at"],"type":"object"},"DomainBeneficiary":{"description":"Beneficiary is a named person the account is held for or passes to.","properties":{"customer_id":{"description":"the customer record carrying the beneficiary's TIN; required where the interest is reported to the beneficiary (utma, custodial)","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date_of_birth":{"type":"string"},"name":{"type":"string"},"relationship":{"type":"string"},"share_bps":{"description":"pod: the beneficiaries' shares sum to 10,000","format":"int64","type":"integer"}},"required":["name","share_bps"],"type":"object"},"DomainCardholderEligibility":{"description":"CardholderEligibility contains only the identity and authority facts cards needs.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_open":{"type":"boolean"},"active":{"type":"boolean"},"death_revision":{"format":"int64","type":"integer"},"deceased":{"type":"boolean"},"funding_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"holder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kyc_verified":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owner":{"type":"boolean"},"owners":{"items":{"type":"string"},"type":"array"},"ownership_revision":{"format":"int64","type":"integer"},"person":{"type":"boolean"}},"required":["account_id","account_open","active","deceased","funding_customer_id","holder_customer_id","kyc_verified","ledger_account_id","owner","owners","ownership_revision","person"],"type":"object"},"DomainControls":{"description":"DomainControls are the token domain restriction controls the issuer sets at provisioning.","properties":{"channels":{"items":{"type":"string"},"type":"array"},"cryptogram_required":{"type":"boolean"},"merchant_id":{"type":"string"},"token_requestor_id":{"type":"string"}},"required":["channels","cryptogram_required","token_requestor_id"],"type":"object"},"DomainInterestSchedule":{"properties":{"actor":{"type":"string"},"annual_rate_bps":{"format":"int64","type":"integer"},"cancellation":{"oneOf":[{"$ref":"#/components/schemas/InterestScheduleCancellation"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"day_count":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_ref":{"type":"string"},"status":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]}},"required":["annual_rate_bps","created_at","day_count","effective_date","id","ledger_account_id","source_ref","status"],"type":"object"},"DomainOwnership":{"description":"Ownership is how an account is titled, apart from who its owners are: the form of ownership decides who can act on it, who takes it at death, how it is insured and how its interest is reported. The owners themselves are customer ids on the account.","properties":{"beneficiaries":{"description":"pod (payable on death / in trust for), custodial (for the benefit of), utma (the minor)","items":{"$ref":"#/components/schemas/DomainBeneficiary"},"type":"array"},"custodian":{"description":"utma, custodial: the custodian's customer id (an owner)","type":"string"},"decedent":{"description":"estate, inherited ira: confirmed deceased customer ID","type":"string"},"fiduciary":{"description":"estate: separately verified executor/administrator customer ID, not an ownership grant","type":"string"},"firm":{"description":"iolta: the law firm as titled","type":"string"},"ira_type":{"description":"ira: traditional, roth, sep, simple","type":"string"},"survivorship":{"description":"joint: with right of survivorship","type":"boolean"},"tax_reporting":{"description":"derived: how the interest is reported","type":"string"},"trust_name":{"description":"trust: the trust's name as titled","type":"string"},"trustees":{"description":"trust: customer ids among the owners acting as trustees","items":{"type":"string"},"type":"array"},"type":{"description":"individual, joint, pod, trust, estate, utma, iolta, hsa, ira, custodial","type":"string"}},"required":["type"],"type":"object"},"DomainTaxRecipientAddress":{"description":"TaxRecipientAddress is the recipient's address as the customers service holds it.","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"DormancyCandidate":{"description":"DormancyCandidate is one account the dormancy review looked at.","properties":{"abandonment_basis":{"description":"statute, tables or default","type":"string"},"abandonment_citation":{"type":"string"},"abandonment_years":{"format":"int64","type":"integer"},"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"balance_amount":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"eligible":{"type":"boolean"},"eligible_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"inactive_months":{"format":"int64","type":"integer"},"last_activity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"notice_sent_at":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"notice_window":{"$ref":"#/components/schemas/DueDiligence"},"state":{"type":"string"},"status":{"type":"string"}},"required":["abandonment_basis","abandonment_citation","abandonment_years","account_id","balance_amount","customer_id","eligible","eligible_on","inactive_months","last_activity_date","notice_window","state","status"],"type":"object"},"DormancyReport":{"description":"DormancyReport is one run of the dormancy review: accounts with no customer activity for the policy period become dormant; dormant accounts past their state's abandonment period are escheat candidates.","properties":{"accounts":{"items":{"$ref":"#/components/schemas/DormancyCandidate"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"escheat_candidates":{"format":"int64","type":"integer"},"newly_dormant":{"format":"int64","type":"integer"},"operator":{"type":"string"},"replayed":{"type":"boolean"},"reviewed":{"format":"int64","type":"integer"}},"required":["accounts","business_date","escheat_candidates","newly_dormant","operator","replayed","reviewed"],"type":"object"},"Draw":{"description":"Draw is one advance or financed item.","properties":{"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"curtailment_amount":{"description":"floor plan: principal due at each curtailment date","format":"int64","type":"integer"},"curtailment_days":{"format":"int64","type":"integer"},"description":{"type":"string"},"due_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"face_amount":{"format":"int64","type":"integer"},"facility_id":{"type":"string"},"id":{"type":"string"},"item":{"oneOf":[{"$ref":"#/components/schemas/CollateralItem"},{"type":"null"}]},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"reference":{"type":"string"},"reserve_amount":{"format":"int64","type":"integer"},"settled_amount":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["amount","business_date","created_at","facility_id","id","journal_id","kind","settled_amount","status"],"type":"object"},"DrawAuthorization":{"description":"DrawAuthorization is a request for that authority, the decision on it, and the advance it funded.","properties":{"amount":{"format":"int64","type":"integer"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision":{"description":"approved, rejected, withdrawn","type":"string"},"decision_note":{"type":"string"},"draw_id":{"type":"string"},"facility_id":{"type":"string"},"id":{"format":"int64","type":"integer"},"note":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"requested_by":{"type":"string"},"used_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"used_by":{"type":"string"}},"required":["amount","facility_id","id","note","requested_at","requested_by"],"type":"object"},"DrawAuthorizationDecision":{"description":"DrawAuthorizationDecision is a second officer's approve or reject, or the requester's withdraw.","properties":{"decision":{"description":"approve, reject or withdraw","type":"string"},"note":{"type":"string"}},"required":["decision"],"type":"object"},"DrawAuthorizationRequest":{"description":"DrawAuthorizationRequest asks for the authority to make one advance on a facility, with its purpose. Dual control: a second officer decides it, and only then does the advance post.","properties":{"amount":{"format":"int64","type":"integer"},"note":{"type":"string"}},"required":["amount","note"],"type":"object"},"DrawRequest":{"description":"DrawRequest asks for an advance on a facility.","properties":{"amount":{"format":"int64","type":"integer"},"authorization_id":{"description":"the approved draw authorisation this advance uses","format":"int64","type":"integer"},"description":{"type":"string"},"item":{"oneOf":[{"$ref":"#/components/schemas/CollateralItem"},{"type":"null"}]},"kind":{"description":"advance, presentation, receivable, unit or note","type":"string"},"reference":{"type":"string"}},"type":"object"},"DrawResult":{"description":"DrawResult is a draw and the facility after it.","properties":{"draw":{"$ref":"#/components/schemas/Draw"},"facility":{"$ref":"#/components/schemas/LendingFacility"}},"required":["draw","facility"],"type":"object"},"DueDiligence":{"description":"DueDiligence is a state's due-diligence notice window before an escheat.","properties":{"citation":{"type":"string"},"max_days":{"format":"int64","type":"integer"},"min_days":{"format":"int64","type":"integer"}},"required":["citation","max_days","min_days"],"type":"object"},"ESignConsent":{"description":"ESignConsent is the consumer's affirmative electronic consent to the served E-SIGN disclosure.","properties":{"accepted":{"type":"boolean"},"disclosure_sha256":{"type":"string"},"disclosure_version":{"type":"string"},"method":{"description":"electronic","type":"string"}},"required":["accepted","disclosure_sha256","disclosure_version","method"],"type":"object"},"EarlyWithdrawal":{"description":"EarlyWithdrawal is the withdrawal and the penalty it cost.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"penalty_amount":{"format":"int64","type":"integer"},"penalty_days":{"format":"int64","type":"integer"},"rate_bps":{"format":"int64","type":"integer"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount","effective_date","journal_id","maturity_date","penalty_amount","penalty_days","rate_bps","to_account_id"],"type":"object"},"EarlyWithdrawalRequest":{"description":"EarlyWithdrawalRequest takes money out of a certificate inside its term.","properties":{"amount":{"format":"int64","type":"integer"},"operator":{"type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","operator","to_account_id"],"type":"object"},"Edit":{"description":"Edit is the exact retained FFIEC expression, not a caller-supplied program. Role is retained verbatim; this engine does not equate a local result with CDR acceptance.","properties":{"dependencies":{"items":{"$ref":"#/components/schemas/EditDependency"},"type":"array"},"expression":{"type":"string"},"expression_sha256":{"type":"string"},"id":{"type":"string"},"role":{"type":"string"},"supported":{"type":"boolean"},"unsupported_reason":{"type":"string"}},"required":["dependencies","expression","expression_sha256","id","role","supported"],"type":"object"},"EditCatalog":{"properties":{"edits":{"items":{"$ref":"#/components/schemas/Edit"},"type":"array"},"engine_version":{"type":"string"},"formula_asset":{"$ref":"#/components/schemas/AssetDigest"},"message_asset":{"$ref":"#/components/schemas/AssetDigest"},"sha256":{"type":"string"},"taxonomy_sha256":{"type":"string"}},"required":["edits","engine_version","formula_asset","message_asset","sha256","taxonomy_sha256"],"type":"object"},"EditCheck":{"properties":{"dependencies":{"items":{"$ref":"#/components/schemas/EditDependency"},"type":"array"},"expression_sha256":{"type":"string"},"id":{"type":"string"},"reason":{"type":"string"},"role":{"type":"string"},"status":{"type":"string"},"uses_historical_workpaper":{"type":"boolean"},"visited":{"items":{"$ref":"#/components/schemas/EditDependency"},"type":"array"}},"required":["dependencies","expression_sha256","id","role","status","uses_historical_workpaper","visited"],"type":"object"},"EditDependency":{"properties":{"mdrm":{"type":"string"},"period":{"type":"string"}},"required":["mdrm","period"],"type":"object"},"Eligibility":{"properties":{"eligible":{"type":"boolean"},"reasons":{"items":{"type":"string"},"type":"array"}},"required":["eligible","reasons"],"type":"object"},"EligibilityFacts":{"description":"EligibilityFacts are the facts a CTR exemption designation or review rests on.","properties":{"account_opened_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"business_activity":{"type":"string"},"exchange":{"description":"nyse, nyse_american, nasdaq_global_select or nasdaq_global_market, the exchanges 31 CFR\n1020.315(b)(4) names (ListedExchangeCodes); case, spaces and hyphens are read loosely on\ninput (\"NYSE American\") and the code is stored. Any other listing, including the Nasdaq\nCapital Market and an over-the-counter quotation, is refused.","enum":["nasdaq_global_market","nasdaq_global_select","nyse","nyse_american"],"type":"string"},"ineligible_revenue_percent":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"jurisdiction":{"type":"string"},"organized_in_us":{"type":"boolean"},"ownership_percent":{"format":"int64","type":"integer"},"parent_name":{"type":"string"},"pays_us_employees":{"type":"boolean"},"regulator_id":{"type":"string"},"reportable_transactions_12m":{"format":"int64","type":"integer"},"ticker":{"type":"string"}},"type":"object"},"EligibilityRequest":{"properties":{"compensation_minor":{"description":"evidenced own taxable compensation; spousal sharing is not inferred","format":"int64","type":"integer"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"filing_status":{"description":"single, joint, separate_lived_with_spouse","type":"string"},"hsa_coverage":{"description":"12 month-start eligibility values: none, self, family","items":{"type":"string"},"type":"array"},"hsa_dependent":{"type":"boolean"},"hsa_last_month_rule":{"description":"unsupported: this workflow uses the monthly limit","type":"boolean"},"inherited":{"description":"unsupported; requires inherited-account servicing","type":"boolean"},"modified_agi_minor":{"format":"int64","type":"integer"},"outside_hsa_minor":{"description":"employee/employer/other-person amounts outside this bank","format":"int64","type":"integer"},"outside_ira_minor":{"description":"all regular traditional + Roth contributions outside this bank","format":"int64","type":"integer"},"outside_roth_minor":{"description":"subset of outside_ira_minor","format":"int64","type":"integer"},"reason":{"type":"string"},"roth_first_tax_year":{"format":"int64","type":"integer"},"rule_id":{"type":"string"},"spouse_hsa_regular_minor":{"description":"spouse family-base share, excluding their separate catch-up","format":"int64","type":"integer"},"tax_year":{"format":"int64","type":"integer"}},"required":["compensation_minor","evidence_ref","evidence_sha256","expected_version","filing_status","hsa_coverage","hsa_dependent","hsa_last_month_rule","inherited","modified_agi_minor","outside_hsa_minor","outside_ira_minor","outside_roth_minor","reason","rule_id","spouse_hsa_regular_minor","tax_year"],"type":"object"},"EmailMetadata":{"description":"EmailMetadata describes an email ingested as a complete message/rfc822 document. Mailbox and journaling connectors are vendor systems outside this archive; the bank exports the message.","properties":{"cc":{"items":{"type":"string"},"type":"array"},"from":{"type":"string"},"message_id":{"type":"string"},"sent_at":{"format":"date-time","type":"string"},"subject":{"type":"string"},"to":{"items":{"type":"string"},"type":"array"}},"required":["from","message_id","sent_at","subject","to"],"type":"object"},"EncumbranceRequest":{"description":"EncumbranceRequest sets or clears a loan's encumbrance; only the ledger's register calls it.","properties":{"encumbrance":{"description":"nil clears","oneOf":[{"$ref":"#/components/schemas/LoanEncumbrance"},{"type":"null"}]},"pledge_id":{"description":"with a nil encumbrance, the released pledge being cleared; a clear naming another pledge is refused","format":"int64","type":"integer"}},"type":"object"},"EnrollmentRequest":{"properties":{"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"device_sha256":{"description":"opaque device binding digest, not raw device identifiers","type":"string"},"requestor_id":{"type":"string"},"terms_sha256":{"type":"string"},"terms_version":{"type":"string"}},"required":["card_id","device_sha256","requestor_id","terms_sha256","terms_version"],"type":"object"},"EntityBalances":{"description":"EntityBalances is one member's accounts and subtotals.","properties":{"accounts":{"items":{"$ref":"#/components/schemas/AccountBalance"},"type":"array"},"available_amount":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_amount":{"format":"int64","type":"integer"},"legal_name":{"type":"string"},"role":{"type":"string"}},"required":["accounts","available_amount","customer_id","ledger_amount","legal_name","role"],"type":"object"},"Entry":{"properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"direction":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","currency_code","direction","ledger_account_id"],"type":"object"},"Escheatment":{"description":"Escheatment is an abandoned balance booked to a state-specific unclaimed-property payable.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"interest_amount":{"description":"interest accrued to the turnover and credited before it","format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"last_activity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"notice_sent_at":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"operator":{"type":"string"},"state":{"type":"string"},"withheld_amount":{"description":"backup withholding taken from that interest","format":"int64","type":"integer"}},"required":["account_id","amount","created_at","customer_id","id","interest_amount","journal_id","last_activity_date","notice_sent_at","operator","state","withheld_amount"],"type":"object"},"EscrowAdjustment":{"properties":{"amount":{"format":"int64","type":"integer"},"analysis_id":{"type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"}},"required":["amount","analysis_id","date","journal_id","kind"],"type":"object"},"EscrowAnalysis":{"properties":{"actual_balance":{"format":"int64","type":"integer"},"annual_disbursements":{"format":"int64","type":"integer"},"base_monthly":{"format":"int64","type":"integer"},"deficiency":{"format":"int64","type":"integer"},"deficiency_options":{"items":{"$ref":"#/components/schemas/Option"},"type":"array"},"input":{"$ref":"#/components/schemas/Input"},"months":{"items":{"$ref":"#/components/schemas/Month"},"type":"array"},"opening_target":{"format":"int64","type":"integer"},"rounding_undercollection":{"format":"int64","type":"integer"},"shortage":{"format":"int64","type":"integer"},"shortage_options":{"items":{"$ref":"#/components/schemas/Option"},"type":"array"},"surplus":{"format":"int64","type":"integer"},"surplus_options":{"items":{"$ref":"#/components/schemas/Option"},"type":"array"},"unfunded_target":{"format":"int64","type":"integer"}},"required":["actual_balance","annual_disbursements","base_monthly","deficiency","deficiency_options","input","months","opening_target","rounding_undercollection","shortage","shortage_options","surplus","surplus_options","unfunded_target"],"type":"object"},"EscrowDelivery":{"properties":{"channel":{"type":"string"},"consent_reference":{"type":"string"},"delivered_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"}},"required":["channel","delivered_on","reference"],"type":"object"},"EscrowDisbursement":{"description":"EscrowDisbursement is one such payment.","properties":{"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payee":{"type":"string"},"purpose":{"type":"string"}},"required":["amount","created_at","id","journal_id","loan_id","payee","purpose"],"type":"object"},"EscrowDisbursementRequest":{"description":"EscrowDisbursementRequest pays a bill from a mortgage's escrow.","properties":{"amount":{"format":"int64","type":"integer"},"payee":{"type":"string"},"purpose":{"description":"property_tax, hazard_insurance, mortgage_insurance, other","type":"string"}},"required":["amount","payee","purpose"],"type":"object"},"EscrowLine":{"properties":{"kind":{"type":"string"},"monthly_amount":{"format":"int64","type":"integer"},"months":{"format":"int64","type":"integer"}},"required":["kind","monthly_amount","months"],"type":"object"},"EscrowPayment":{"properties":{"base":{"format":"int64","type":"integer"},"credit":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"deficiency":{"format":"int64","type":"integer"},"shortage":{"format":"int64","type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["base","credit","date","deficiency","shortage","total"],"type":"object"},"EscrowPlan":{"properties":{"lump_sum":{"format":"int64","type":"integer"},"payments":{"items":{"$ref":"#/components/schemas/EscrowPayment"},"type":"array"},"refund":{"format":"int64","type":"integer"},"retained":{"format":"int64","type":"integer"}},"required":["lump_sum","payments","refund","retained"],"type":"object"},"EscrowPolicy":{"properties":{"cushion":{"format":"int64","type":"integer"},"cushion_limit":{"format":"int64","type":"integer"},"reference":{"type":"string"}},"required":["cushion","cushion_limit","reference"],"type":"object"},"EscrowResolution":{"properties":{"deficiency":{"$ref":"#/components/schemas/Choice"},"evidence":{"type":"string"},"shortage":{"$ref":"#/components/schemas/Choice"},"surplus":{"type":"string"}},"required":["deficiency","evidence","shortage"],"type":"object"},"EscrowStatement":{"properties":{"actor":{"type":"string"},"analysis":{"$ref":"#/components/schemas/EscrowAnalysis"},"bank":{"$ref":"#/components/schemas/Bank"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"history":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"id":{"type":"string"},"initial_deposit":{"format":"int64","type":"integer"},"kind":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"monthly_escrow":{"format":"int64","type":"integer"},"monthly_mortgage":{"format":"int64","type":"integer"},"opening_balance":{"format":"int64","type":"integer"},"paid_out_by_purpose":{"items":{"$ref":"#/components/schemas/PurposeTotal"},"type":"array"},"payment_effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_end":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"plan":{"$ref":"#/components/schemas/EscrowPlan"},"principal_and_interest":{"format":"int64","type":"integer"},"prior_analysis":{"oneOf":[{"$ref":"#/components/schemas/EscrowAnalysis"},{"type":"null"}]},"prior_monthly_escrow":{"format":"int64","type":"integer"},"prior_monthly_mortgage":{"format":"int64","type":"integer"},"resolution":{"$ref":"#/components/schemas/EscrowResolution"},"submission_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"total_paid_in":{"format":"int64","type":"integer"},"total_paid_out":{"format":"int64","type":"integer"},"variance_explanation":{"type":"string"}},"required":["actor","analysis","bank","customer_id","date","history","id","initial_deposit","kind","loan_id","monthly_escrow","monthly_mortgage","opening_balance","paid_out_by_purpose","payment_effective_date","plan","principal_and_interest","prior_monthly_escrow","prior_monthly_mortgage","resolution","submission_deadline","total_paid_in","total_paid_out"],"type":"object"},"EstateRecipient":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"beneficiary_index":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"identity_evidence":{"$ref":"#/components/schemas/RecordsEvidence"}},"required":["account_id","beneficiary_index","customer_id","identity_evidence"],"type":"object"},"EstateRequest":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"authority_ref":{"type":"string"},"authority_sha256":{"type":"string"},"authority_type":{"description":"pod_contract, letters_testamentary, letters_of_administration","type":"string"},"authority_valid_until":{"format":"date-time","type":"string"},"death_report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"death_revision":{"format":"int64","type":"integer"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"executor_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"jurisdiction":{"type":"string"},"minimum_recipient_age":{"format":"int64","type":"integer"},"policy_ref":{"type":"string"},"policy_sha256":{"type":"string"},"reason":{"type":"string"},"recipients":{"items":{"$ref":"#/components/schemas/EstateRecipient"},"type":"array"},"restriction_id":{"type":"string"}},"required":["amount_minor","authority_ref","authority_sha256","authority_type","authority_valid_until","death_report_id","death_revision","evidence_ref","evidence_sha256","jurisdiction","minimum_recipient_age","policy_ref","policy_sha256","reason","recipients","restriction_id"],"type":"object"},"Event":{"description":"Event as delivered to webhooks.","properties":{"created_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":{},"type":"object"},"id":{"example":"evt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source":{"type":"string"},"type":{"type":"string"}},"required":["created_at","data","id","source","type"],"type":"object"},"Evidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"Exception":{"description":"Exception is a discrepancy a person resolves.","properties":{"amount":{"description":"the signed difference: positive when the customer or the network owes the bank","format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"detail":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/ExceptionResolution"},"type":"array"},"source":{"description":"the journal upload, reconciliation or network message that raised it","type":"string"},"status":{"description":"open, resolved","type":"string"},"terminal_ref":{"type":"string"},"transaction_id":{"type":"string"}},"required":["amount","created_at","detail","id","kind","source","status"],"type":"object"},"ExceptionHold":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"the amount held past the schedule","format":"int64","type":"integer"},"available_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"credit_id":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"hold_ids":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"notice":{"$ref":"#/components/schemas/HoldNotice"},"placed_by":{"type":"string"},"reason":{"description":"new_account, large_deposit, redeposited, repeated_overdraft, doubtful_collectability, emergency","type":"string"},"status":{"type":"string"}},"required":["account_id","amount","available_on","created_at","credit_id","customer_id","hold_ids","id","notice","placed_by","reason","status"],"type":"object"},"ExceptionRequest":{"properties":{"available_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"credit_id":{"type":"string"},"explanation":{"type":"string"},"operator":{"type":"string"},"reason":{"type":"string"},"return_reference":{"description":"redeposited: the ledger idempotency key of the committed check_return journal that charged the earlier deposit back","type":"string"},"returned_credit_id":{"description":"redeposited: the earlier deposit of the same check that was returned","type":"string"}},"required":["credit_id","operator","reason"],"type":"object"},"ExceptionResolution":{"description":"ExceptionResolution is a proposal with its review and result.","properties":{"created_at":{"format":"date-time","type":"string"},"exception_id":{"type":"string"},"id":{"type":"string"},"maker":{"type":"string"},"request":{"$ref":"#/components/schemas/ResolutionRequest"},"result":{"oneOf":[{"$ref":"#/components/schemas/ResolutionResult"},{"type":"null"}]},"review":{"oneOf":[{"$ref":"#/components/schemas/AtmReview"},{"type":"null"}]}},"required":["created_at","exception_id","id","maker","request"],"type":"object"},"Exclusion":{"properties":{"amount":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"gl_code":{"type":"string"},"reason":{"type":"string"}},"required":["amount","evidence","gl_code","reason"],"type":"object"},"Execute":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"close_source_id":{"type":"string"},"model_id":{"type":"string"},"previous_id":{"type":"string"},"purpose":{"type":"string"}},"required":["business_date","model_id","previous_id","purpose"],"type":"object"},"Execution":{"properties":{"broker_reference":{"type":"string"},"confirmation":{"$ref":"#/components/schemas/Document"},"counterparty":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"dealer_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"dealer_reference":{"type":"string"},"executed_at":{"format":"date-time","type":"string"},"execution_reference":{"type":"string"},"external_account_reference":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"price":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"side":{"type":"string"},"signature":{"type":"string"},"status":{"description":"executed, cancelled or rejected (no fill)","type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","confirmation","counterparty","currency_code","cusip","custodian_reference","dealer_customer_id","dealer_reference","executed_at","execution_reference","external_account_reference","fee_amount","instruction_sha256","key_id","legal_entity","master_cash_ledger_account_id","net_cash_amount","observed_at","order_id","price","principal_amount","side","signature","status","trade_date","units","version"],"type":"object"},"ExecutionRequest":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"ExistingExposure":{"properties":{"affiliate_id":{"type":"string"},"amount":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/Evidence"}},"required":["affiliate_id","amount","evidence"],"type":"object"},"ExpectedAttachment":{"description":"ExpectedAttachment is an attachment a captured source row declared, with the SHA-256 its source snapshot froze; the record's content is complete once every one is captured.","properties":{"bytes":{"format":"int64","type":"integer"},"column":{"type":"string"},"encoding":{"type":"string"},"sha256":{"type":"string"}},"required":["bytes","column","encoding","sha256"],"type":"object"},"ExpectedCharge":{"description":"ExpectedCharge is a correspondent charge the bank expects under the reviewed terms: one for a payment the SWIFT gateway posted, or a monthly fee for a period.","properties":{"accrual_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"billing":{"type":"string"},"charge_bearer":{"type":"string"},"charge_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"code":{"description":"payment_charge or the monthly fee code","type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"direction":{"type":"string"},"id":{"type":"string"},"invoice_id":{"type":"string"},"movement_id":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period":{"description":"YYYY-MM, a monthly fee","type":"string"},"posting_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source":{"type":"string"},"statement_item_ref":{"type":"string"},"status":{"type":"string"},"terms_id":{"format":"int64","type":"integer"},"uetr":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["amount","billing","charge_date","code","created_at","currency_code","id","nostro_account_id","source","status","terms_id","updated_at"],"type":"object"},"Expense":{"properties":{"amount":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"export_id":{"type":"string"},"id":{"type":"string"},"replaced_by_expense_id":{"type":"string"},"request":{"$ref":"#/components/schemas/SpendRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/SpendReview"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/SpendSource"},"submitted_by":{"$ref":"#/components/schemas/SpendAuthority"}},"required":["amount","content_sha256","created_at","id","request","source","submitted_by"],"type":"object"},"Export":{"properties":{"artifact":{"$ref":"#/components/schemas/SpendArtifact"},"artifact_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"prepared_by":{"$ref":"#/components/schemas/SpendAuthority"},"request":{"$ref":"#/components/schemas/ExportRequest"}},"required":["artifact","artifact_sha256","created_at","id","prepared_by","request"],"type":"object"},"ExportRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expense_ids":{"items":{"type":"string"},"type":"array"},"format_version":{"type":"string"}},"required":["account_id","expense_ids","format_version"],"type":"object"},"ExportSourceStatus":{"properties":{"changed_expense_ids":{"items":{"type":"string"},"type":"array"},"current":{"type":"boolean"},"export_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"}},"required":["changed_expense_ids","current","export_id","observed_at"],"type":"object"},"ExportedKeyBlock":{"description":"ExportedKeyBlock is the key block an approved export produced.","properties":{"key_block":{"type":"string"}},"required":["key_block"],"type":"object"},"Exposure":{"description":"Exposure is an Originator's position against its limits.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"credit_limit_amount":{"format":"int64","type":"integer"},"credits_amount":{"format":"int64","type":"integer"},"debit_limit_amount":{"format":"int64","type":"integer"},"debits_amount":{"format":"int64","type":"integer"},"exposure_limit_amount":{"format":"int64","type":"integer"},"headroom_amount":{"format":"int64","type":"integer"},"originator_id":{"type":"string"},"outstanding_amount":{"format":"int64","type":"integer"}},"required":["as_of","credit_limit_amount","credits_amount","debit_limit_amount","debits_amount","exposure_limit_amount","headroom_amount","originator_id","outstanding_amount"],"type":"object"},"ExternalCash":{"description":"ExternalCash is the actual master account movement for the file's settlement: the Federal Reserve advice or statement line, positive when the network paid the bank.","properties":{"amount_minor":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"reference":{"type":"string"},"sha256":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["reference","sha256","value_date"],"type":"object"},"ExternalDocument":{"description":"ExternalDocument is the archived metadata of a completed external document.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"bsa_confidential":{"description":"BSAConfidential marks a SAR, or material that would reveal one; a production never\ncollects it (31 CFR 1020.320(e)).","type":"boolean"},"bytes":{"format":"int64","type":"integer"},"category":{"type":"string"},"content_type":{"type":"string"},"custodian":{"type":"string"},"customer_ids":{"items":{"type":"string"},"type":"array"},"document_date":{"format":"date-time","type":"string"},"email":{"oneOf":[{"$ref":"#/components/schemas/EmailMetadata"},{"type":"null"}]},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"filename":{"type":"string"},"kind":{"description":"document or email","type":"string"},"parts":{"format":"int64","type":"integer"},"reason":{"type":"string"},"sha256":{"type":"string"},"source_ref":{"type":"string"},"source_system":{"type":"string"},"title":{"type":"string"}},"required":["account_ids","bsa_confidential","bytes","category","content_type","custodian","customer_ids","document_date","evidence_ref","evidence_sha256","filename","kind","parts","reason","sha256","source_ref","source_system","title"],"type":"object"},"ExternalExposure":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"reference":{"type":"string"}},"required":["amount_minor","customer_id","evidence","reference"],"type":"object"},"FATCAAccount":{"properties":{"account_number":{"type":"string"},"balance_minor":{"format":"int64","type":"integer"},"closed":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"interest_minor":{"format":"int64","type":"integer"},"payments":{"items":{"$ref":"#/components/schemas/FATCAPayment"},"type":"array"}},"required":["account_number","balance_minor","closed","customer_id"],"type":"object"},"FATCADecisionRequest":{"properties":{"decision":{"type":"string"},"note":{"type":"string"}},"required":["decision","note"],"type":"object"},"FATCAPayment":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"deposit_interest":{"type":"boolean"},"type":{"type":"string"}},"required":["amount_minor","type"],"type":"object"},"FATCAProposeRequest":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/FATCAAccount"},"type":"array"},"corr_report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"doc_type":{"type":"string"},"tax_year":{"format":"int64","type":"integer"},"test_file":{"type":"boolean"}},"required":["accounts","tax_year","test_file"],"type":"object"},"FATCAReport":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/FATCAAccount"},"type":"array"},"corr_report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"doc_type":{"type":"string"},"id":{"type":"string"},"message_ref_id":{"type":"string"},"notification_cd":{"type":"string"},"packet_filename":{"type":"string"},"proposed_by":{"type":"string"},"status":{"type":"string"},"tax_year":{"format":"int64","type":"integer"},"transmission_id":{"type":"string"}},"required":["accounts","doc_type","id","message_ref_id","proposed_by","status","tax_year"],"type":"object"},"FR2900":{"description":"FR2900 is the report of deposits: the average of each day's closing position by class and the five weekly items the April 2021 form collects.","properties":{"complete":{"description":"every day of the week had a position","type":"boolean"},"de_novo":{"type":"string"},"form_page":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/FR2900Line"},"type":"array"},"note":{"type":"string"},"official_items":{"items":{"$ref":"#/components/schemas/FR2900Item"},"type":"array"},"panel":{"type":"string"},"report":{"type":"string"},"week_ending":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["complete","lines","note","report","week_ending"],"type":"object"},"FR2900Item":{"description":"FR2900Item is one of the five weekly items on the April 2021 FR 2900 form.","properties":{"average_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"caption":{"type":"string"},"category":{"description":"supplied or not_retained","type":"string"},"days":{"format":"int64","type":"integer"},"item":{"description":"A.1, A.2, B.1, C.1 or D.1","type":"string"},"reason":{"type":"string"}},"required":["caption","category","item"],"type":"object"},"FR2900Line":{"description":"FR2900Line is one deposit class of the weekly report of deposits.","properties":{"average_amount":{"format":"int64","type":"integer"},"class":{"description":"transaction, savings or time","type":"string"},"days":{"format":"int64","type":"integer"},"demand_average_amount":{"description":"transaction only: demand deposits within the class","format":"int64","type":"integer"},"products":{"type":"string"}},"required":["average_amount","class","days"],"type":"object"},"FR2915":{"description":"FR2915 is the report of foreign-currency deposits for one reporting week.","properties":{"complete":{"type":"boolean"},"days":{"items":{"$ref":"#/components/schemas/FR2915Day"},"type":"array"},"lines":{"items":{"$ref":"#/components/schemas/FR2915Line"},"type":"array"},"note":{"type":"string"},"nothing_to_report":{"type":"boolean"},"quarterly_reporting_week":{"type":"boolean"},"report":{"type":"string"},"valuation_method":{"type":"string"},"week_ending":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["complete","days","lines","note","nothing_to_report","quarterly_reporting_week","report","valuation_method","week_ending"],"type":"object"},"FR2915CurrencyLine":{"description":"FR2915CurrencyLine is one foreign-currency deposit GL line a day's sync translated to USD.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_rate_sheet_id":{"type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"native_amount":{"format":"int64","type":"integer"},"normal_balance":{"type":"string"},"sync_id":{"format":"int64","type":"integer"},"usd_equivalent_amount":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["business_date","closing_rate_sheet_id","currency_code","gl_code","native_amount","normal_balance","sync_id","usd_equivalent_amount","usd_per_foreign_major"],"type":"object"},"FR2915Day":{"description":"FR2915Day is one day of the reporting week and the positions it carries.","properties":{"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"deposit_lines":{"items":{"$ref":"#/components/schemas/FR2915CurrencyLine"},"type":"array"},"item_amounts":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"positions_as_of":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"sync_id":{"format":"int64","type":"integer"}},"required":["date","deposit_lines","item_amounts"],"type":"object"},"FR2915Line":{"description":"FR2915Line is one item of the Report of Foreign (Non-U.S.) Currency Deposits.","properties":{"amount_thousands_usd":{"format":"int64","type":"integer"},"average_amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"item":{"type":"string"},"mdrm":{"type":"string"}},"required":["amount_thousands_usd","average_amount","description","item","mdrm"],"type":"object"},"FXConversion":{"description":"FXConversion is a conversion the ledger posted from a quote, once.","properties":{"actor":{"type":"string"},"conversion":{"$ref":"#/components/schemas/Conversion"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"kind":{"description":"quote or conversion","type":"string"},"quote_id":{"type":"string"},"source_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["actor","conversion","created_at","customer_id","id","kind","quote_id","source_account_id","target_account_id"],"type":"object"},"FXConversionRequest":{"description":"FXConversionRequest accepts a quote the same customer was given on the account in the path.","properties":{"quote_id":{"type":"string"}},"required":["quote_id"],"type":"object"},"FXCustomerRate":{"description":"FXCustomerRate is one currency pair on the bank's current customer rate sheet, in the direction a customer reads it: the mid rate the bank prices from, the rate the customer buys the base currency at, the rate they sell it at, the spreads either side of mid and the largest conversion the pair prices. Rates are quote-currency major units per one base major unit.","properties":{"base_currency":{"type":"string"},"buy_spread_bps":{"format":"int64","type":"integer"},"customer_buy_rate":{"type":"string"},"customer_sell_rate":{"type":"string"},"max_amount_usd_minor":{"format":"int64","type":"integer"},"mid_rate":{"type":"string"},"pair":{"description":"BASE/QUOTE, for example EUR/USD","type":"string"},"quote_currency":{"type":"string"},"sell_spread_bps":{"format":"int64","type":"integer"}},"required":["base_currency","buy_spread_bps","customer_buy_rate","customer_sell_rate","max_amount_usd_minor","mid_rate","pair","quote_currency","sell_spread_bps"],"type":"object"},"FXLeg":{"description":"FXLeg records one foreign currency crossing the FX position inside a cross-currency journal: the signed change to the currency's position account, the signed change to its USD equivalent account, and the approved rate that ties them. Signs are debit-positive; the USD change is the exact negative of the native change translated at the rate, rounded once.","properties":{"currency_code":{"type":"string"},"equivalent_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"native_amount":{"format":"int64","type":"integer"},"position_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rate_sheet_id":{"type":"string"},"usd_equivalent_amount":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["currency_code","equivalent_ledger_account_id","native_amount","position_ledger_account_id","rate_sheet_id","usd_equivalent_amount","usd_per_foreign_major"],"type":"object"},"FXQuote":{"description":"FXQuote is a priced, short-lived offer on the bank's approved customer rate sheet: the rate, the spread either side of mid, both amounts, their USD equivalents and when it expires.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"kind":{"description":"quote or conversion","type":"string"},"quote":{"$ref":"#/components/schemas/Quote"},"quote_id":{"type":"string"},"source_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["actor","created_at","customer_id","id","kind","quote","quote_id","source_account_id","target_account_id"],"type":"object"},"FXQuoteExpiryRun":{"description":"FXQuoteExpiryRun is what one pass of the expiry scheduler did.","properties":{"expired_quote_ids":{"items":{"type":"string"},"type":"array"},"ran_at":{"format":"date-time","type":"string"}},"required":["expired_quote_ids","ran_at"],"type":"object"},"FXQuoteOrder":{"description":"FXQuoteOrder asks the bank to price one currency pair for the customer. The side says which way the customer is going, and exactly one leg carries the amount: base_amount is in the base currency's minor units, quote_amount in the quote currency's. The accounts name the customer's own deposit accounts the conversion would move between.","properties":{"base_amount":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"pair":{"type":"string"},"quote_amount":{"format":"int64","type":"integer"},"side":{"type":"string"},"source_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["customer_id","pair","side","source_account_id","target_account_id"],"type":"object"},"FXQuoteRequest":{"description":"FXQuoteRequest asks for a price to convert from the account in the path to another deposit account of the same customer in a different currency. Exactly one amount is fixed, in its own account currency's minor units: what leaves the source, or what arrives in the target.","properties":{"source_amount":{"format":"int64","type":"integer"},"target_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_amount":{"format":"int64","type":"integer"}},"required":["target_account_id"],"type":"object"},"FXQuoteResource":{"description":"FXQuoteResource is a customer FX quote as its own resource: what was asked, the rate the bank struck, both amounts, when the rate lapses and where the quote has got to. A booked quote is a firm rate the bank honours until it expires.","properties":{"base_amount":{"format":"int64","type":"integer"},"booked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"cancelled_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expired_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"pair":{"type":"string"},"quote_amount":{"format":"int64","type":"integer"},"rate":{"description":"target major units per source major unit","type":"string"},"rate_sheet_id":{"type":"string"},"side":{"type":"string"},"source_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_amount":{"format":"int64","type":"integer"},"source_currency":{"type":"string"},"state":{"type":"string"},"target_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_amount":{"format":"int64","type":"integer"},"target_currency":{"type":"string"}},"required":["base_amount","created_at","customer_id","expires_at","id","pair","quote_amount","rate","rate_sheet_id","side","source_account_id","source_amount","source_currency","state","target_account_id","target_amount","target_currency"],"type":"object"},"FXRateSheet":{"description":"FXRateSheet is the bank's current customer rates: the approved sheet that prices a quote asked for now, in the bank's own customer-facing terms. Every pair is quoted against USD, which is how the sheet is approved; a conversion between two foreign currencies is priced through USD on the same sheet.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"daily_limit_usd_minor":{"format":"int64","type":"integer"},"id":{"type":"string"},"rates":{"items":{"$ref":"#/components/schemas/FXCustomerRate"},"type":"array"},"valid_from":{"format":"date-time","type":"string"},"valid_until":{"format":"date-time","type":"string"}},"required":["business_date","daily_limit_usd_minor","id","rates","valid_from","valid_until"],"type":"object"},"Facility":{"description":"Facility describes a credit facility: how it is drawn, billed and paid down.","properties":{"advance_bps":{"description":"factoring, floor plan, warehouse: advance against the item's face","format":"int64","type":"integer"},"borrowing_base":{"description":"availability is the lesser of the limit and the certified base","type":"boolean"},"converts_to_product_code":{"description":"construction: the permanent loan product","type":"string"},"curtailment_bps":{"description":"floor plan: share of the advance due at each curtailment","format":"int64","type":"integer"},"curtailment_days":{"description":"floor plan: days until the first principal curtailment","format":"int64","type":"integer"},"draw_period_months":{"description":"revolving: draws allowed for this long; 0 is open-ended","format":"int64","type":"integer"},"expiry_months":{"description":"letters of credit","format":"int64","type":"integer"},"factor_rate_bps":{"description":"merchant cash advance: owed = purchase × factor","format":"int64","type":"integer"},"fee_bps":{"description":"letters of credit: annual fee; factoring: per invoice","format":"int64","type":"integer"},"holdback_bps":{"description":"merchant cash advance: share of card receipts remitted","format":"int64","type":"integer"},"interest_only":{"type":"boolean"},"inventory_advance_bps":{"format":"int64","type":"integer"},"max_days_on_line":{"description":"factoring, floor plan, warehouse: an item outstanding longer is past due","format":"int64","type":"integer"},"min_payment_bps":{"description":"revolving: the principal share of the minimum payment","format":"int64","type":"integer"},"min_payment_floor_minor":{"description":"revolving: the minimum payment floor","format":"int64","type":"integer"},"payment_due_days":{"description":"days after the statement the payment is due (the CARD Act's 21-day floor)","format":"int64","type":"integer"},"receivables_advance_bps":{"format":"int64","type":"integer"},"recourse":{"description":"factoring: the client stands behind uncollected invoices","type":"boolean"},"repayment_months":{"description":"revolving: the amortising period after the draw period","format":"int64","type":"integer"},"secured_by":{"type":"string"},"type":{"description":"revolving, construction, letter_of_credit, factoring, floor_plan, merchant_cash_advance, warehouse","type":"string"}},"required":["type"],"type":"object"},"FacilityApplication":{"description":"FacilityApplication asks for a credit facility.","properties":{"beneficiary":{"type":"string"},"borrowing_base":{"oneOf":[{"$ref":"#/components/schemas/BorrowingBase"},{"type":"null"}]},"collateral":{"type":"string"},"credit_score":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"guarantee":{"oneOf":[{"$ref":"#/components/schemas/LendingGuarantee"},{"type":"null"}]},"limit_amount":{"format":"int64","type":"integer"},"monthly_debt_amount":{"format":"int64","type":"integer"},"monthly_income_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"purpose":{"type":"string"},"settlement_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"term_months":{"format":"int64","type":"integer"}},"required":["customer_id","limit_amount","product_code","settlement_account_id"],"type":"object"},"FacilityBook":{"description":"FacilityBook is one product's facilities.","properties":{"buckets":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"charged_off_amount":{"format":"int64","type":"integer"},"committed_amount":{"format":"int64","type":"integer"},"drawn_amount":{"format":"int64","type":"integer"},"facilities":{"format":"int64","type":"integer"},"kind":{"type":"string"},"nonaccrual_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"unused_amount":{"format":"int64","type":"integer"}},"required":["buckets","charged_off_amount","committed_amount","drawn_amount","facilities","kind","nonaccrual_amount","product_code","unused_amount"],"type":"object"},"FacilityPayment":{"description":"FacilityPayment is money applied to a facility.","properties":{"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"facility_id":{"type":"string"},"fees_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"income_amount":{"description":"factor income recognised on a remittance, or a factoring fee","format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"payment, remittance (merchant cash advance), settlement (of an item)","type":"string"},"principal_amount":{"format":"int64","type":"integer"}},"required":["amount","created_at","facility_id","fees_amount","id","income_amount","interest_amount","journal_id","kind","principal_amount"],"type":"object"},"FacilityPaymentCancellation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"completed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"executed_by":{"type":"string"},"facility_id":{"type":"string"},"outcome":{"type":"string"},"payment":{"oneOf":[{"$ref":"#/components/schemas/FacilityPayment"},{"type":"null"}]},"payment_key":{"type":"string"},"reason":{"type":"string"}},"required":["actor","at","facility_id","payment_key","reason"],"type":"object"},"FacilityPaymentCancellationRequest":{"properties":{"payment_key":{"type":"string"},"reason":{"type":"string"}},"required":["payment_key","reason"],"type":"object"},"FacilityPaymentCommand":{"properties":{"cancellation":{"oneOf":[{"$ref":"#/components/schemas/FacilityPaymentCancellation"},{"type":"null"}]},"currency":{"type":"string"},"done":{"type":"boolean"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"facility_id":{"type":"string"},"key":{"type":"string"},"payment":{"$ref":"#/components/schemas/FacilityPayment"},"requested_amount":{"format":"int64","type":"integer"},"requested_by":{"type":"string"}},"required":["currency","done","effective_date","facility_id","key","payment","requested_amount","requested_by"],"type":"object"},"FacilityStatement":{"description":"FacilityStatement is a billing cycle on a facility.","properties":{"closing_amount":{"format":"int64","type":"integer"},"collectible_minimum_due":{"format":"int64","type":"integer"},"collection_due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"facility_id":{"type":"string"},"fees_amount":{"format":"int64","type":"integer"},"generated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"interest_amount":{"format":"int64","type":"integer"},"minimum_due_amount":{"format":"int64","type":"integer"},"paid_amount":{"format":"int64","type":"integer"},"period":{"type":"string"},"protected_amount":{"format":"int64","type":"integer"},"statement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"open, paid, late","type":"string"}},"required":["closing_amount","collectible_minimum_due","collection_due_date","due_date","facility_id","fees_amount","interest_amount","minimum_due_amount","paid_amount","period","protected_amount","statement_date","status"],"type":"object"},"FacilityTerms":{"description":"FacilityTerms are the product's facility rules as snapshotted on the facility.","properties":{"advance_bps":{"format":"int64","type":"integer"},"borrowing_base":{"type":"boolean"},"converts_to_product_code":{"type":"string"},"curtailment_bps":{"format":"int64","type":"integer"},"curtailment_days":{"format":"int64","type":"integer"},"draw_period_months":{"format":"int64","type":"integer"},"expiry_months":{"format":"int64","type":"integer"},"factor_rate_bps":{"format":"int64","type":"integer"},"fee_bps":{"format":"int64","type":"integer"},"holdback_bps":{"format":"int64","type":"integer"},"interest_only":{"type":"boolean"},"inventory_advance_bps":{"format":"int64","type":"integer"},"max_days_on_line":{"format":"int64","type":"integer"},"min_payment_bps":{"format":"int64","type":"integer"},"min_payment_floor_minor":{"format":"int64","type":"integer"},"payment_due_days":{"format":"int64","type":"integer"},"receivables_advance_bps":{"format":"int64","type":"integer"},"recourse":{"type":"boolean"},"repayment_months":{"format":"int64","type":"integer"},"secured_by":{"type":"string"},"type":{"type":"string"}},"required":["type"],"type":"object"},"FedCashOrder":{"description":"FedCashOrder is a Reserve Bank currency or coin order or deposit the FedCash module hands this carrier for physical shipment. Kind order is cash into a named vault; kind deposit is cash leaving a named vault for a Reserve Bank office.","properties":{"amount":{"format":"int64","type":"integer"},"cash_unit_id":{"type":"string"},"id":{"type":"string"},"kind":{"description":"order, deposit","type":"string"},"location":{"type":"string"},"needed_by":{"format":"date-time","type":"string"},"notes":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"window":{"type":"string"}},"required":["amount","cash_unit_id","id","kind","location","needed_by","notes","window"],"type":"object"},"FedCashShipment":{"description":"FedCashShipment is the armored-carrier hand-off.","properties":{"actor":{"type":"string"},"carrier_reference":{"type":"string"},"id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","carrier_reference","id","recorded_at"],"type":"object"},"FedExecution":{"description":"FedExecution is the committed custody and fee posting.","properties":{"actor":{"type":"string"},"cash_movement_id":{"type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","cash_movement_id","journal_id","recorded_at"],"type":"object"},"FedPeak":{"description":"FedPeak is the day's worst Fed position reading.","properties":{"cap_breached":{"type":"boolean"},"lowest_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"lowest_projected_amount":{"format":"int64","type":"integer"},"peak_overdraft_amount":{"format":"int64","type":"integer"},"peak_uncollateralized_overdraft_amount":{"format":"int64","type":"integer"},"samples":{"format":"int64","type":"integer"}},"required":["cap_breached","lowest_projected_amount","peak_overdraft_amount","peak_uncollateralized_overdraft_amount","samples"],"type":"object"},"FedPosition":{"description":"FedPosition is the bank's intraday position at the Federal Reserve: the master account on the ledger, less the outbound payments accepted and not yet settled, against the net debit cap the PSR policy gives the bank (cap multiple × capital measure, Table II-1 of the Fed's guide).","properties":{"as_of":{"format":"date-time","type":"string"},"balance_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cap_category":{"description":"zero, exempt_from_filing, de_minimis, average, above_average or high","type":"string"},"cap_multiple":{"type":"string"},"capital_measure_amount":{"format":"int64","type":"integer"},"collateral_available_amount":{"description":"the register's lendable value pledged to the Reserve Bank less discount window advances outstanding; zero while unknown","format":"int64","type":"integer"},"collateral_known":{"description":"false when the collateral register could not answer","type":"boolean"},"collateral_lendable_amount":{"description":"the register's lendable value pledged to the Reserve Bank, before discount window advances","format":"int64","type":"integer"},"collateral_unavailable":{"description":"why the collateral is unknown","type":"string"},"discount_window_advances_amount":{"format":"int64","type":"integer"},"headroom_amount":{"description":"projected position plus the cap and the collateral: what more can go out","format":"int64","type":"integer"},"ledger_balance_amount":{"format":"int64","type":"integer"},"maintenance_period":{"$ref":"#/components/schemas/PeriodCharge"},"net_debit_cap_amount":{"format":"int64","type":"integer"},"overdraft_amount":{"format":"int64","type":"integer"},"pending_by_rail":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"pending_items":{"format":"int64","type":"integer"},"pending_outbound_amount":{"format":"int64","type":"integer"},"pending_outbound_known":{"type":"boolean"},"position_source":{"type":"string"},"projected_amount":{"description":"balance less pending outbound","format":"int64","type":"integer"},"psr_day":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source":{"type":"string"},"status":{"description":"within_cap, overdraft (inside the cap), cap_breached, or collateral_unavailable (an overdraft the register cannot split)","type":"string"},"today":{"$ref":"#/components/schemas/FedPeak"},"today_charge":{"$ref":"#/components/schemas/DayCharge"},"uncollateralized_overdraft_amount":{"description":"what the cap limits and the fee prices","format":"int64","type":"integer"}},"required":["as_of","balance_amount","business_date","cap_category","cap_multiple","capital_measure_amount","collateral_available_amount","collateral_known","collateral_lendable_amount","discount_window_advances_amount","headroom_amount","maintenance_period","net_debit_cap_amount","overdraft_amount","pending_by_rail","pending_items","pending_outbound_amount","pending_outbound_known","projected_amount","psr_day","source","status","today","today_charge","uncollateralized_overdraft_amount"],"type":"object"},"FedReadiness":{"description":"FedReadiness blocks close when FedCash instructions or statement matches are unfinished.","properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ready":{"type":"boolean"}},"required":["blockers","business_date","ready"],"type":"object"},"FedSample":{"description":"FedSample is one recorded reading of the Fed position.","properties":{"balance_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"collateral_available_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"net_debit_cap_amount":{"format":"int64","type":"integer"},"overdraft_amount":{"format":"int64","type":"integer"},"pending_outbound_amount":{"format":"int64","type":"integer"},"projected_amount":{"format":"int64","type":"integer"},"psr_day":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"sampled_at":{"format":"date-time","type":"string"},"status":{"type":"string"},"uncollateralized_overdraft_amount":{"format":"int64","type":"integer"}},"required":["balance_amount","business_date","collateral_available_amount","id","net_debit_cap_amount","overdraft_amount","pending_outbound_amount","projected_amount","psr_day","sampled_at","status","uncollateralized_overdraft_amount"],"type":"object"},"FedcashFee":{"description":"Fee is one assessed FedCash priced-service charge.","properties":{"amount":{"format":"int64","type":"integer"},"billing_code":{"description":"FRB billing code","type":"string"},"code":{"description":"ucap, cross_shipping","type":"string"},"description":{"type":"string"},"units":{"format":"int64","type":"integer"}},"required":["amount","billing_code","code","description","units"],"type":"object"},"FedcashPackage":{"description":"Package is one denomination line on an order or deposit, in the Fed's standard unit.","properties":{"denomination_amount":{"format":"int64","type":"integer"},"form":{"description":"currency, coin","type":"string"},"quality":{"description":"fit, new, unfit, mixed","type":"string"},"quantity":{"format":"int64","type":"integer"},"series":{"description":"ike: Eisenhower dollar bags (deposit only)","type":"string"},"unit":{"description":"bundle, strap, bag","type":"string"}},"required":["denomination_amount","form","quantity","unit"],"type":"object"},"FedsecuritiesPosition":{"description":"Position is one security's par amount in an account at the close of a business day.","properties":{"cusip":{"type":"string"},"par_amount":{"format":"int64","type":"integer"}},"required":["cusip","par_amount"],"type":"object"},"FedsecuritiesTransfer":{"description":"Transfer is a transfer message: an entitlement order to debit the Sender's securities account and credit the Receiver's for a par amount of one security, with a payment when it is against payment (6.1.1, 6.1.2).","properties":{"against_payment":{"type":"boolean"},"beneficiary_reference":{"description":"the Receiver's reference, quoted back on the advice","type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"cusip":{"type":"string"},"original_operator_reference":{"description":"the transfer a reversal reverses","type":"string"},"par_amount":{"format":"int64","type":"integer"},"payment_amount":{"format":"int64","type":"integer"},"receiver":{"$ref":"#/components/schemas/Account"},"sender":{"$ref":"#/components/schemas/Account"},"sender_reference":{"description":"unique for the Sender; a resend returns the original answer","type":"string"},"type_code":{"type":"string"},"version":{"type":"string"}},"required":["against_payment","business_date","created_at","cusip","par_amount","payment_amount","receiver","sender","sender_reference","type_code","version"],"type":"object"},"Fee":{"description":"Fee is a charge the product may assess.","properties":{"amount_minor":{"format":"int64","type":"integer"},"kind":{"type":"string"},"trigger":{"description":"monthly, or per_event_* (assessed by the service that sees the event)","type":"string"},"waiver_method":{"description":"how the minimum balance is measured, as disclosed under Reg DD 1030.4(b)(4)(ii): daily (every day of the cycle) or average_daily","type":"string"},"waiver_min_balance_minor":{"format":"int64","type":"integer"}},"required":["amount_minor","kind","trigger","waiver_min_balance_minor"],"type":"object"},"FeeCorrection":{"description":"FeeCorrection is the maker-checker record for a fee reverse or adjustment.","properties":{"actor":{"type":"string"},"application":{"oneOf":[{"$ref":"#/components/schemas/FeeCorrectionApplication"},{"type":"null"}]},"content_sha256":{"type":"string"},"correction_minor":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PayablesDecision"},{"type":"null"}]},"fee":{"$ref":"#/components/schemas/AssessedFee"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/FeeCorrectionRequest"}},"required":["actor","content_sha256","correction_minor","created_at","fee","id","request"],"type":"object"},"FeeCorrectionApplication":{"description":"FeeCorrectionApplication is the posted balanced ledger correction.","properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"correction_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["actor","at","correction_journal_id"],"type":"object"},"FeeCorrectionRequest":{"description":"FeeCorrectionRequest is a maker's proposal to reverse or adjust a fee the payments service assessed. The amount refunded is read from the retained fee journal, never from the request.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"method":{"type":"string"},"reason":{"type":"string"},"target_fee_minor":{"format":"int64","type":"integer"}},"required":["account_id","fee_journal_id","method","reason"],"type":"object"},"FeePosting":{"properties":{"amount":{"format":"int64","type":"integer"},"fee_kind":{"type":"string"},"id":{"example":"fee_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"note":{"type":"string"},"period":{"type":"string"},"status":{"type":"string"}},"required":["amount","fee_kind","id","journal_id","note","period","status"],"type":"object"},"FeeTotals":{"properties":{"overdraft_amount":{"format":"int64","type":"integer"},"returned_item_amount":{"format":"int64","type":"integer"}},"required":["overdraft_amount","returned_item_amount"],"type":"object"},"FetchRequest":{"description":"FetchRequest pulls a processing date's files from the configured source.","properties":{"network":{"type":"string"},"processing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["network","processing_date"],"type":"object"},"Field":{"properties":{"allow_blank":{"type":"boolean"},"codes":{"items":{"type":"string"},"type":"array"},"exact_length":{"format":"int64","type":"integer"},"maximum_length":{"format":"int64","type":"integer"},"name":{"type":"string"},"number":{"format":"int64","type":"integer"},"numeric":{"type":"boolean"}},"required":["allow_blank","codes","exact_length","maximum_length","name","number","numeric"],"type":"object"},"Figure":{"properties":{"adjustment":{"type":"string"},"base_value":{"type":"string"},"code":{"type":"string"},"item":{"type":"string"},"mdrm":{"type":"string"},"schedule":{"type":"string"},"unit":{"type":"string"},"value":{"type":"string"}},"required":["adjustment","base_value","code","item","schedule","unit","value"],"type":"object"},"FigureAdjustment":{"properties":{"amount":{"description":"exact units of the integer or usd_cents figure","format":"int64","type":"integer"},"code":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["amount","code","evidence_ref","evidence_sha256","reason"],"type":"object"},"FigureMapping":{"properties":{"code":{"description":"local figure key; MDRM binding is separately reviewed","type":"string"},"item":{"type":"string"},"mdrm":{"type":"string"},"schedule":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/FigureTerm"},"type":"array"},"unit":{"type":"string"}},"required":["code","item","schedule","terms","unit"],"type":"object"},"FigureTerm":{"properties":{"coefficient":{"description":"+1 or -1; non-integer values require one +1 term","format":"int64","type":"integer"},"key":{"type":"string"},"source_id":{"type":"string"}},"required":["coefficient","key","source_id"],"type":"object"},"File":{"properties":{"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"code":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingclosingDecision"},{"type":"null"}]},"id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maker":{"type":"string"},"receipts":{"items":{"$ref":"#/components/schemas/LendingclosingReceipt"},"type":"array"},"reference":{"type":"string"},"sha256":{"type":"string"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["case_id","code","created_at","id","maker","receipts","reference","sha256","signatures"],"type":"object"},"FiledCapital":{"properties":{"allowance_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"allowance_excluded_from_tier2_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"deducted_financial_subsidiary_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"filed_at":{"format":"date-time","type":"string"},"filing_evidence":{"$ref":"#/components/schemas/Evidence"},"framework":{"description":"standardized or cblr","type":"string"},"framework_evidence":{"$ref":"#/components/schemas/Evidence"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"tier1_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"tier2_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["filed_at","filing_evidence","framework","framework_evidence","report_date"],"type":"object"},"FilingCash":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_number":{"type":"string"},"agent_of":{"description":"owner the conductor acts for as an agent","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"channel":{"type":"string"},"conductor_id":{"type":"string"},"conductor_kind":{"description":"customer (empty), non_customer, agent","type":"string"},"delivery_method":{"description":"armored_car, mail, night_deposit, shared_branch","type":"string"},"foreign_amount_minor":{"format":"int64","type":"integer"},"foreign_country":{"description":"ISO 3166-1 alpha-2 of the foreign currency","type":"string"},"foreign_currency":{"description":"ISO 4217, never USD","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_sha256":{"type":"string"},"kind":{"type":"string"},"location":{"type":"string"},"monitoring_event_id":{"type":"string"},"movement_id":{"type":"string"},"movement_sha256":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"owner_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership_type":{"type":"string"},"unit_id":{"type":"string"},"unit_kind":{"type":"string"}},"required":["account_id","account_number","amount_minor","channel","conductor_id","journal_id","journal_sha256","kind","location","monitoring_event_id","movement_id","movement_sha256","occurred_at","owner_customer_id","unit_id"],"type":"object"},"FilingContinuity":{"description":"FilingContinuity is the chain of accepted filings behind a quarter, back as far as the retained edits look (seven quarters) or to the bank's initial report.","properties":{"quarters":{"items":{"$ref":"#/components/schemas/ContinuityQuarter"},"type":"array"},"status":{"type":"string"}},"required":["quarters","status"],"type":"object"},"FilingSource":{"description":"FilingSource is a confidential, complete native cash cut for one customer/day. It is only available to the actual compliance service. Account numbers and conductor identity must not be copied into general audit discovery. Version native-own-account-teller-cash.v1 carries sole individual own-behalf teller cash only. Version native-cash-custody.v2 also carries every account owner, the titling form, the custody unit kind and a conductor acting for an owner; its fields are absent from v1 so retained v1 digests never change. Version native-cash-custody.v3 adds vault and shared-branch locations, every supported titling form, non-customer and agent conductors, delivery methods and foreign-currency cash; those fields are absent from v1 and v2.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"legal_entity":{"type":"string"},"movements":{"items":{"$ref":"#/components/schemas/FilingCash"},"type":"array"},"sha256":{"type":"string"},"version":{"type":"string"}},"required":["business_date","customer_id","legal_entity","movements","sha256","version"],"type":"object"},"FilingsAcknowledgment":{"description":"Acknowledgment is one complete FinCEN XML 2.0 batch response. Parsing establishes its structure and exact activity membership, not the response's authenticity or that it belongs to a particular submitted file. The filing service must bind the original response bytes to an authenticated transmission receipt before use.","properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityAcknowledgment"},"type":"array"},"batch_sequence":{"format":"int64","type":"integer"},"sha256":{"type":"string"},"submission_sequence":{"format":"int64","type":"integer"}},"required":["activities","batch_sequence","sha256","submission_sequence"],"type":"object"},"FilingsCancellation":{"properties":{"actor":{"type":"string"},"cancelled_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["actor","cancelled_at","content_sha256","reason"],"type":"object"},"FilingsDecision":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decided_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["actor","content_sha256","decided_at","decision","note"],"type":"object"},"FilingsDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["content_sha256","decision","note"],"type":"object"},"FilingsDocument":{"properties":{"content":{"format":"byte","type":"string"},"kind":{"type":"string"},"packet_id":{"type":"string"},"sha256":{"type":"string"},"support_document":{"oneOf":[{"$ref":"#/components/schemas/ReleasedSupportDocument"},{"type":"null"}]}},"required":["content","kind","packet_id","sha256"],"type":"object"},"FilingsManifest":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityManifest"},"type":"array"},"form":{"type":"string"},"sha256":{"type":"string"}},"required":["activities","form","sha256"],"type":"object"},"FilingsReceipt":{"properties":{"payload":{"$ref":"#/components/schemas/BridgePayload"},"signature":{"type":"string"}},"required":["payload","signature"],"type":"object"},"FilingsSource":{"properties":{"activity_sequence":{"format":"int64","type":"integer"},"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sha256":{"type":"string"}},"required":["activity_sequence","alert_id","sha256"],"type":"object"},"FinalCardDisputeLoss":{"description":"FinalCardDisputeLoss is a source observation, not a reservation or a customer credit instruction. A recovery consumer must permanently claim the actual loss journal before allocating any network recovery against it.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action_id":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"dispute_id":{"type":"string"},"expense_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expense_minor":{"format":"int64","type":"integer"},"loss_journal":{"$ref":"#/components/schemas/LedgerJournal"},"loss_journal_key":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"original_journal":{"$ref":"#/components/schemas/LedgerJournal"},"original_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_journal_key":{"type":"string"},"principal_minor":{"format":"int64","type":"integer"},"source_sha256":{"type":"string"}},"required":["account_id","action_id","customer_id","dispute_id","expense_ledger_account_id","expense_minor","loss_journal","loss_journal_key","observed_at","original_journal","original_journal_id","original_journal_key","principal_minor","source_sha256"],"type":"object"},"Flat":{"description":"Flat is the wire form of an Amount: an integer of minor units beside a currency code, two sibling fields on the object that carries the money (`\"amount\": 125000, \"currency_code\": \"USD\"`).","properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"}},"required":["amount","currency_code"],"type":"object"},"FleetApplyRequest":{"properties":{"content_sha256":{"type":"string"}},"required":["content_sha256"],"type":"object"},"FleetAuthority":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"cardholder_authority_id":{"example":"chra_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"funding_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"request":{"$ref":"#/components/schemas/AuthorityRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/FleetReview"},{"type":"null"}]},"revocation":{"oneOf":[{"$ref":"#/components/schemas/FleetRevocation"},{"type":"null"}]}},"required":["account_id","actor","at","cardholder_authority_id","content_sha256","funding_customer_id","id","ownership_revision","product_code","product_version","request"],"type":"object"},"FleetEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"FleetReceipt":{"properties":{"payload":{"$ref":"#/components/schemas/Payload"},"signature":{"type":"string"}},"required":["payload","signature"],"type":"object"},"FleetResult":{"properties":{"at":{"format":"date-time","type":"string"},"cleared_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["at","cleared_amount","journal_id"],"type":"object"},"FleetReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/FleetEvidence"},"reason":{"type":"string"}},"required":["actor","approve","at","content_sha256","evidence","reason"],"type":"object"},"FleetReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/FleetEvidence"},"reason":{"type":"string"}},"required":["approve","content_sha256","evidence","reason"],"type":"object"},"FleetRevocation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/FleetEvidence"},"reason":{"type":"string"}},"required":["actor","at","content_sha256","evidence","reason"],"type":"object"},"FleetTransaction":{"description":"Transaction deliberately excludes PAN/token secrets and includes every merchant and approval term which Authorize accepts. Final pump quantity is not asserted here.","properties":{"amount":{"format":"int64","type":"integer"},"channel":{"type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"mcc":{"type":"string"},"merchant_id":{"type":"string"},"merchant_location":{"type":"string"},"merchant_name":{"type":"string"},"merchant_postal_code":{"type":"string"},"merchant_region":{"type":"string"},"network_ref":{"type":"string"},"partial_approval_allowed":{"type":"boolean"}},"required":["amount","channel","country","currency_code","mcc","merchant_id","merchant_location","merchant_name","merchant_postal_code","merchant_region","network_ref","partial_approval_allowed"],"type":"object"},"ForwardingCancellation":{"properties":{"actor":{"type":"string"},"reason":{"type":"string"},"requested_at":{"format":"date-time","type":"string"}},"required":["actor","reason","requested_at"],"type":"object"},"ForwardingResult":{"properties":{"actor":{"type":"string"},"cancellation_reason":{"type":"string"},"in_transfer_60_day_window":{"type":"boolean"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_sha256":{"type":"string"},"obligation":{"oneOf":[{"$ref":"#/components/schemas/Obligation"},{"type":"null"}]},"received_at":{"description":"actual ledger commitment","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"received_date":{"description":"Eastern calendar date","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"recorded_at":{"format":"date-time","type":"string"},"state":{"description":"registered or cancelled; pending has no result","type":"string"},"timeliness_status":{"description":"unassessed; no contractual due/grace test inferred","type":"string"},"transfer_window_ends":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["actor","in_transfer_60_day_window","recorded_at","state","timeliness_status","transfer_window_ends"],"type":"object"},"ForwardingSource":{"properties":{"receiving_servicer_contact":{"type":"string"},"receiving_servicer_id":{"type":"string"},"receiving_servicer_name":{"type":"string"},"transfer_action_id":{"type":"string"},"transfer_action_sha256":{"type":"string"},"transfer_effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"transfer_review_sha256":{"type":"string"},"transfer_reviewed_at":{"format":"date-time","type":"string"},"transfer_reviewed_by":{"type":"string"},"transfer_snapshot_sha256":{"type":"string"}},"required":["receiving_servicer_contact","receiving_servicer_id","receiving_servicer_name","transfer_action_id","transfer_action_sha256","transfer_effective_date","transfer_review_sha256","transfer_reviewed_at","transfer_reviewed_by","transfer_snapshot_sha256"],"type":"object"},"ForwardingStatus":{"properties":{"payable":{"oneOf":[{"$ref":"#/components/schemas/ObligationStatus"},{"type":"null"}]},"received_payment":{"$ref":"#/components/schemas/ReceivedPayment"},"receiver_application_status":{"description":"not_reported","type":"string"}},"required":["received_payment","receiver_application_status"],"type":"object"},"FraudCallback":{"description":"FraudCallback is one recorded call-back to the customer; the number is the one on the customer record.","properties":{"called_at":{"format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"note":{"type":"string"},"number_called":{"type":"string"},"number_source":{"description":"customer_record","type":"string"},"outcome":{"description":"verified, not_verified or no_answer","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"}},"required":["called_at","id","number_called","number_source","outcome","recorded_at","recorded_by"],"type":"object"},"FraudCallbackRequest":{"description":"FraudCallbackRequest records a call-back. There is no number: the service dials from the customer record. Actor names the staff member only on the open local stack.","properties":{"actor":{"type":"string"},"called_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"note":{"type":"string"},"outcome":{"description":"verified, not_verified or no_answer","type":"string"}},"required":["outcome"],"type":"object"},"FraudCounterparty":{"description":"FraudCounterparty is who a held payment pays.","properties":{"account_number":{"type":"string"},"name":{"type":"string"},"routing_number":{"type":"string"}},"required":["account_number","name","routing_number"],"type":"object"},"FraudDecisionBody":{"description":"FraudDecisionBody releases or rejects a held payment with the reason.","properties":{"decision":{"description":"release or reject","type":"string"},"reason":{"type":"string"}},"required":["decision","reason"],"type":"object"},"FraudParameterChange":{"description":"FraudParameterChange is a recorded seed row or a proposal with its decision.","properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision_note":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"reason":{"type":"string"},"status":{"description":"recorded, pending, approved, rejected or withdrawn","type":"string"},"value":{"format":"int64","type":"integer"}},"required":["effective_from","name","proposed_at","proposed_by","reason","status","value"],"type":"object"},"FraudParameterDecisionBody":{"description":"FraudParameterDecisionBody approves or rejects another staff member's fraud threshold proposal (operations:approve), or withdraws one's own.","properties":{"decision":{"description":"approved, rejected or withdrawn","type":"string"},"note":{"type":"string"}},"required":["decision","note"],"type":"object"},"FraudParameterProposal":{"description":"FraudParameterProposal proposes one threshold from a later business date.","properties":{"actor":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"name":{"type":"string"},"reason":{"type":"string"},"value":{"format":"int64","type":"integer"}},"required":["effective_from","name","reason","value"],"type":"object"},"FraudParametersView":{"description":"FraudParametersView is the thresholds in force on a business date and every change.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"history":{"items":{"$ref":"#/components/schemas/FraudParameterChange"},"type":"array"},"parameters":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"}},"required":["business_date","history","parameters"],"type":"object"},"FraudReview":{"description":"FraudReview is a payment the outbound fraud rules held, with the evidence and the decision.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"callback_required":{"type":"boolean"},"callbacks":{"items":{"$ref":"#/components/schemas/FraudCallback"},"type":"array"},"counterparty":{"$ref":"#/components/schemas/FraudCounterparty"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision_reason":{"type":"string"},"facts":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"initiated_by":{"type":"string"},"opened_at":{"format":"date-time","type":"string"},"parameters":{"additionalProperties":true,"type":"object"},"parameters_read":{"type":"boolean"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payment_kind":{"description":"wire, instant or ach","type":"string"},"rail":{"type":"string"},"reasons":{"items":{"type":"string"},"type":"array"},"rules_hit":{"items":{"type":"string"},"type":"array"},"scores":{"items":{"$ref":"#/components/schemas/FraudScore"},"type":"array"},"status":{"description":"open, released or rejected","type":"string"}},"required":["account_id","amount","callback_required","counterparty","currency_code","facts","id","initiated_by","opened_at","parameters","parameters_read","payment_id","payment_kind","rail","reasons","rules_hit","scores","status"],"type":"object"},"FraudReviewList":{"description":"FraudReviewList is the fraud reviews a filter selects, newest first.","properties":{"data":{"items":{"$ref":"#/components/schemas/FraudReview"},"type":"array"}},"required":["data"],"type":"object"},"FraudScore":{"description":"FraudScore is one scorer's answer on a held payment.","properties":{"callback_required":{"type":"boolean"},"error":{"type":"string"},"hold":{"type":"boolean"},"reasons":{"items":{"type":"string"},"type":"array"},"rules_hit":{"items":{"type":"string"},"type":"array"},"score":{"format":"int64","type":"integer"},"scorer":{"type":"string"}},"required":["callback_required","hold","reasons","rules_hit","score","scorer"],"type":"object"},"Fry9spFigure":{"description":"Figure is one reviewed value at one declared position.","properties":{"adjustment":{"type":"string"},"base_value":{"type":"string"},"caption":{"type":"string"},"code":{"type":"string"},"item":{"type":"string"},"mdrm":{"type":"string"},"position":{"type":"string"},"schedule":{"type":"string"},"unit":{"type":"string"},"value":{"type":"string"}},"required":["adjustment","base_value","caption","code","item","mdrm","position","schedule","unit","value"],"type":"object"},"Fry9spFigureAdjustment":{"properties":{"amount":{"description":"exact units of the cents or integer position","format":"int64","type":"integer"},"code":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["amount","code","evidence_ref","evidence_sha256","reason"],"type":"object"},"Fry9spFigureMapping":{"description":"FigureMapping binds source values to one declared position. The position decides the unit, the item and the MDRM code; a mapping cannot invent any of them.","properties":{"code":{"type":"string"},"position":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/Fry9spFigureTerm"},"type":"array"}},"required":["code","position","terms"],"type":"object"},"Fry9spFigureTerm":{"properties":{"coefficient":{"description":"+1 or -1; a boolean position takes one +1 term","format":"int64","type":"integer"},"key":{"type":"string"},"source_id":{"type":"string"}},"required":["coefficient","key","source_id"],"type":"object"},"Fry9spMissingItem":{"description":"MissingItem is a declared position a capture could not supply from retained data.","properties":{"category":{"type":"string"},"item":{"type":"string"},"key":{"type":"string"},"mdrm":{"type":"string"},"reason":{"type":"string"}},"required":["category","item","key","mdrm","reason"],"type":"object"},"Fry9spPlan":{"description":"Plan is what the reviewed facts decide: the filing calendar, the schedules in scope, the unresolved facts and what this core cannot do.","properties":{"filing_basis":{"type":"string"},"form":{"type":"string"},"frequency":{"type":"string"},"rules_version":{"type":"string"},"schedules":{"items":{"$ref":"#/components/schemas/Fry9spSchedule"},"type":"array"},"scope":{"type":"string"},"selection_issues":{"items":{"type":"string"},"type":"array"},"selection_ready":{"type":"boolean"},"sources":{"items":{"type":"string"},"type":"array"},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"submission_ready":{"type":"boolean"}},"required":["filing_basis","form","frequency","rules_version","schedules","scope","selection_issues","selection_ready","sources","submission_blockers","submission_date","submission_ready"],"type":"object"},"Fry9spPosition":{"description":"Position is one declared position of the form: the item as the form numbers it, the MDRM item code printed beside it, its type and its caption.","properties":{"caption":{"type":"string"},"item":{"type":"string"},"key":{"description":"SCHEDULE:item, the item without its separators (SC:4a, SCM:M11f)","type":"string"},"mdrm":{"type":"string"},"schedule":{"type":"string"},"unit":{"description":"usd_cents, integer or boolean","type":"string"}},"required":["caption","item","key","mdrm","schedule","unit"],"type":"object"},"Fry9spProfile":{"description":"Profile is the reviewed holding-company fact set one report date is prepared under. Nil facts are unknown, never a negative attestation; amounts are USD cents.","properties":{"bank_held_directly":{"description":"BankHeldDirectly is true when the reporting company owns its whole interest in the bank\nsubsidiary itself. An interest held through a subsidiary holding company is that company's\ninvestment (Schedule SC item 6.a), recorded by the holding company directly owning the\nshares, not the reporting company's item 4.a.","oneOf":[{"type":"boolean"},{"type":"null"}]},"bank_ownership_bps":{"description":"basis points of the bank's equity capital the reporting parent holds","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"bank_ownership_evidence_ref":{"type":"string"},"bank_subsidiary_name":{"description":"The bank subsidiary whose books this core keeps, and the parent's interest in it.","type":"string"},"capital_purchase_program":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"consolidated_assets_under_3b":{"description":"Filing eligibility and organizational facts.","oneOf":[{"type":"boolean"},{"type":"null"}]},"core_is_bank_subsidiary_ledger":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"evidence_ref":{"type":"string"},"fair_value_option":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"financial_holding_company_election":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"fr_y9c_criteria_reviewed":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"holding_company_name":{"type":"string"},"nonbank_subsidiaries":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"other_depository_institutions":{"description":"OtherDepositoryInstitutions is true when the reporting company has a bank subsidiary, an\nassociated bank (20 to 25 percent) or another subsidiary or affiliated depository\ninstitution besides the bank subsidiary this core keeps. Items 4.a and 1.a total all of\nthem, so a capture of this bank alone is then only a component of each.","oneOf":[{"type":"boolean"},{"type":"null"}]},"parent_bank_balances_complete":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"parent_books_evidence_ref":{"type":"string"},"parent_customer_id":{"description":"The parent company as a customer of its bank subsidiary. ParentCustomerID names the\ncustomer record whose deposit accounts are the parent's balances with the bank;\nParentBankBalancesComplete attests that those accounts are the parent's only balances\nheld with or due from the bank in Schedule SC item 1.a.","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rationale":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rssd_id":{"type":"string"},"subsidiary_holding_companies":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"supersedes":{"type":"string"},"tier":{"type":"string"},"trust_preferred_subsidiaries":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["bank_ownership_evidence_ref","bank_subsidiary_name","evidence_ref","holding_company_name","parent_books_evidence_ref","rationale","report_date","tier"],"type":"object"},"Fry9spRecord":{"description":"Record is one proposed profile, its plan, its digest and its independent review.","properties":{"content_sha256":{"type":"string"},"id":{"type":"string"},"plan":{"$ref":"#/components/schemas/Fry9spPlan"},"profile":{"$ref":"#/components/schemas/Fry9spProfile"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/Fry9spReview"},{"type":"null"}]}},"required":["content_sha256","id","plan","profile","proposed_at","proposed_by"],"type":"object"},"Fry9spReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"}},"required":["actor","content_sha256","decision","evidence_ref","rationale","reviewed_at"],"type":"object"},"Fry9spReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"}},"required":["content_sha256","decision","evidence_ref","rationale"],"type":"object"},"Fry9spSchedule":{"description":"Schedule is one schedule of the report and the local kind that accounts for it.","properties":{"applicability":{"type":"string"},"code":{"type":"string"},"period":{"type":"string"},"positions":{"format":"int64","type":"integer"},"source_kind":{"type":"string"}},"required":["applicability","code","period","positions","source_kind"],"type":"object"},"Fry9spSource":{"description":"Source is a local kind the service captures, or an imported artifact the preparer supplies with its digest. Parent-company books reach a workpaper only as imports.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"values":{"items":{"$ref":"#/components/schemas/Fry9spSourceValue"},"type":"array"}},"required":["as_of","id","kind"],"type":"object"},"Fry9spSourceSnapshot":{"description":"SourceSnapshot is what one source held when the workpaper was proposed.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"captured_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":true,"type":"object"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"missing":{"items":{"$ref":"#/components/schemas/Fry9spMissingItem"},"type":"array"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"sha256":{"type":"string"},"values":{"items":{"$ref":"#/components/schemas/Fry9spSourceValue"},"type":"array"}},"required":["as_of","captured_at","data","id","kind","sha256"],"type":"object"},"Fry9spSourceValue":{"description":"SourceValue is one captured or imported value, exact and typed.","properties":{"key":{"type":"string"},"unit":{"type":"string"},"value":{"type":"string"}},"required":["key","unit","value"],"type":"object"},"Fry9spWorkpaper":{"description":"Workpaper is the immutable evidence one proposal left behind.","properties":{"content_sha256":{"type":"string"},"coverage":{"items":{"$ref":"#/components/schemas/ScheduleCoverage"},"type":"array"},"figures":{"items":{"$ref":"#/components/schemas/Fry9spFigure"},"type":"array"},"id":{"type":"string"},"mapping_sha256":{"type":"string"},"profile_sha256":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"request":{"$ref":"#/components/schemas/Fry9spWorkpaperRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/Fry9spWorkpaperReview"},{"type":"null"}]},"source_snapshots":{"items":{"$ref":"#/components/schemas/Fry9spSourceSnapshot"},"type":"array"},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"}},"required":["content_sha256","coverage","figures","id","mapping_sha256","profile_sha256","proposed_at","proposed_by","report_date","request","source_snapshots","submission_blockers","submission_ready"],"type":"object"},"Fry9spWorkpaperRequest":{"description":"WorkpaperRequest proposes one report date's figures: the reviewed profile they are prepared under, the sources to capture, the mapping of source values onto declared form positions and any evidenced adjustment.","properties":{"adjustments":{"items":{"$ref":"#/components/schemas/Fry9spFigureAdjustment"},"type":"array"},"mapping_ref":{"type":"string"},"mappings":{"items":{"$ref":"#/components/schemas/Fry9spFigureMapping"},"type":"array"},"profile_id":{"type":"string"},"rationale":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/Fry9spSource"},"type":"array"},"supersedes":{"type":"string"}},"required":["mapping_ref","mappings","profile_id","rationale","sources"],"type":"object"},"Fry9spWorkpaperReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"scope":{"description":"supplied_figures, never a filing attestation","type":"string"}},"required":["actor","content_sha256","decision","evidence_ref","rationale","reviewed_at","scope"],"type":"object"},"Fry9spWorkpaperReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"scope":{"description":"supplied_figures, never a filing attestation","type":"string"}},"required":["content_sha256","decision","evidence_ref","rationale","scope"],"type":"object"},"FuelLimit":{"description":"Quantities are thousandths of the named physical unit; prices are thousandths of one currency minor unit per whole physical unit. No implicit unit conversion.","properties":{"max_quantity_milli":{"format":"int64","type":"integer"},"max_unit_price_milli_minor":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"unit":{"description":"us_gallon or litre","type":"string"}},"required":["max_quantity_milli","max_unit_price_milli_minor","product_code","unit"],"type":"object"},"FuelLine":{"properties":{"product_code":{"type":"string"},"quantity_milli":{"format":"int64","type":"integer"},"reference":{"type":"string"},"total_amount":{"format":"int64","type":"integer"},"unit":{"type":"string"},"unit_price_milli_minor":{"format":"int64","type":"integer"}},"required":["product_code","quantity_milli","reference","total_amount","unit","unit_price_milli_minor"],"type":"object"},"Funding":{"properties":{"cash_evidence":{"$ref":"#/components/schemas/Document"},"cash_reference":{"type":"string"},"confirmation":{"$ref":"#/components/schemas/Document"},"currency_code":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"interest_amount":{"format":"int64","type":"integer"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"lender_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_reference":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_statement_line_reference":{"type":"string"},"master_cash_statement_reference":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"repayment_instruction_sha256":{"type":"string"},"settled_at":{"format":"date-time","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"signature":{"type":"string"},"transaction_id":{"type":"string"},"version":{"type":"string"}},"required":["cash_evidence","cash_reference","confirmation","currency_code","fee_amount","instruction_sha256","interest_amount","key_id","legal_entity","lender_customer_id","lender_reference","master_cash_external_account_reference","master_cash_ledger_account_id","master_cash_statement_line_reference","master_cash_statement_reference","net_cash_amount","observed_at","principal_amount","settled_at","settlement_date","signature","transaction_id","version"],"type":"object"},"FundingSource":{"properties":{"address":{"$ref":"#/components/schemas/SourceAddress"},"credit":{"$ref":"#/components/schemas/CreditRequest"},"gl_code":{"type":"string"},"known_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["address","credit","gl_code"],"type":"object"},"FurnishingPacket":{"description":"FurnishingPacket is a furnishing file's lifecycle record. It carries no consumer data.","properties":{"acknowledged_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"acknowledgment":{"oneOf":[{"$ref":"#/components/schemas/BureauAck"},{"type":"null"}]},"base_records":{"format":"int64","type":"integer"},"bureau":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"cycle":{"type":"string"},"file_sha256":{"type":"string"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"retain_until":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"},"submitted_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"updated_at":{"format":"date-time","type":"string"}},"required":["base_records","bureau","created_at","cycle","file_sha256","id","idempotency_key","retain_until","status","updated_at"],"type":"object"},"FurnishingRequest":{"description":"FurnishingRequest is a monthly furnishing run.","properties":{"cycle":{"type":"string"},"subjects":{"items":{"$ref":"#/components/schemas/FurnishingSubject"},"type":"array"}},"required":["cycle","subjects"],"type":"object"},"FurnishingSubject":{"description":"FurnishingSubject pairs one credit obligation with the consumer identity to furnish it under.","properties":{"consumer":{"$ref":"#/components/schemas/Consumer"},"facility_id":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_creditor":{"type":"string"}},"required":["consumer"],"type":"object"},"FxAuthorityRequest":{"description":"AuthorityRequest changes reviewed operating terms without creating a second currency position or altering the correspondent account's permanent identity.","properties":{"evidence":{"type":"string"},"expected_authority_sha256":{"type":"string"},"max_native_units":{"format":"int64","type":"integer"},"max_order_usd_minor":{"format":"int64","type":"integer"},"policy_reference":{"type":"string"},"public_keys":{"additionalProperties":{"type":"string"},"type":"object"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["evidence","expected_authority_sha256","max_native_units","max_order_usd_minor","policy_reference","public_keys","valid_from","valid_through"],"type":"object"},"FxCloseRun":{"description":"CloseRun is what the close did for one currency on a business date.","properties":{"adjustment_amount":{"description":"positive is a gain","format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_rate_sheet_id":{"type":"string"},"currency_code":{"type":"string"},"equivalent_before_amount":{"format":"int64","type":"integer"},"equivalent_target_amount":{"format":"int64","type":"integer"},"position_native_amount":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"revaluation_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sweep_journal_ids":{"items":{"type":"string"},"type":"array"},"usd_per_foreign_major":{"type":"string"}},"required":["adjustment_amount","business_date","closing_rate_sheet_id","currency_code","equivalent_before_amount","equivalent_target_amount","position_native_amount","recorded_at","sweep_journal_ids","usd_per_foreign_major"],"type":"object"},"FxConvertRequest":{"description":"ConvertRequest accepts a quote.","properties":{"quote_id":{"type":"string"}},"required":["quote_id"],"type":"object"},"FxDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"evidence":{"type":"string"}},"required":["actor","approve","at","content_sha256","evidence"],"type":"object"},"FxDecisionRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"evidence":{"type":"string"}},"required":["approve","content_sha256","evidence"],"type":"object"},"FxOrder":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"authority_sha256":{"type":"string"},"book_id":{"type":"string"},"cancel_evidence":{"type":"string"},"cancelled_by":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"dispatched_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"evidence":{"type":"string"},"foreign_minor":{"format":"int64","type":"integer"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"quote_observed_at":{"format":"date-time","type":"string"},"quote_reference":{"type":"string"},"quote_sha256":{"type":"string"},"quote_valid_until":{"format":"date-time","type":"string"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/FxReceipt"},{"type":"null"}]},"receipt_authority_sha256":{"type":"string"},"side":{"description":"buy or sell foreign units against USD","type":"string"},"status":{"type":"string"},"usd_minor":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"verified_receipt_public_key":{"type":"string"}},"required":["actor","at","authority_sha256","book_id","content_sha256","evidence","foreign_minor","id","quote_observed_at","quote_reference","quote_sha256","quote_valid_until","side","status","usd_minor","usd_per_foreign_major","value_date"],"type":"object"},"FxOrderRequest":{"properties":{"book_id":{"type":"string"},"evidence":{"type":"string"},"foreign_minor":{"format":"int64","type":"integer"},"quote_observed_at":{"format":"date-time","type":"string"},"quote_reference":{"type":"string"},"quote_sha256":{"type":"string"},"quote_valid_until":{"format":"date-time","type":"string"},"side":{"description":"buy or sell foreign units against USD","type":"string"},"usd_minor":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["book_id","evidence","foreign_minor","quote_observed_at","quote_reference","quote_sha256","quote_valid_until","side","usd_minor","usd_per_foreign_major","value_date"],"type":"object"},"FxPosition":{"properties":{"book_id":{"type":"string"},"carrying_usd_minor":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"foreign_minor":{"format":"int64","type":"integer"},"ledger_usd_minor":{"format":"int64","type":"integer"},"reconciles":{"type":"boolean"},"reserved_minor":{"format":"int64","type":"integer"},"revision":{"format":"int64","type":"integer"}},"required":["book_id","carrying_usd_minor","currency_code","foreign_minor","ledger_usd_minor","reconciles","reserved_minor","revision"],"type":"object"},"FxReadiness":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ready":{"type":"boolean"}},"required":["blockers","business_date","ready"],"type":"object"},"FxReceipt":{"description":"Receipt attests both actual external legs. This is a bank bridge contract, not a claim that an ISO message or SWIFT acknowledgement proves settlement.","properties":{"advice_sha256":{"type":"string"},"book_id":{"type":"string"},"currency_code":{"type":"string"},"external_account_ref":{"type":"string"},"foreign_minor":{"format":"int64","type":"integer"},"foreign_reference":{"type":"string"},"key_id":{"type":"string"},"master_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"order_sha256":{"type":"string"},"protocol":{"type":"string"},"side":{"type":"string"},"signature":{"type":"string"},"status":{"description":"settled, or cancelled with no cash movement","type":"string"},"usd_cash_reference":{"type":"string"},"usd_minor":{"format":"int64","type":"integer"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["advice_sha256","book_id","currency_code","external_account_ref","foreign_minor","foreign_reference","key_id","master_ledger_account_id","occurred_at","order_id","order_sha256","protocol","side","signature","status","usd_cash_reference","usd_minor","value_date"],"type":"object"},"FxStatement":{"properties":{"actor":{"type":"string"},"advice_sha256":{"type":"string"},"as_of":{"format":"date-time","type":"string"},"at":{"format":"date-time","type":"string"},"authority_sha256":{"type":"string"},"book_id":{"type":"string"},"breaks":{"items":{"type":"string"},"type":"array"},"closing_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"currency_code":{"type":"string"},"external_account_ref":{"type":"string"},"id":{"type":"string"},"key_id":{"type":"string"},"lines":{"description":"complete inventory from zero boarding through AsOf","items":{"$ref":"#/components/schemas/FxStatementLine"},"type":"array"},"protocol":{"type":"string"},"reconciles":{"type":"boolean"},"signature":{"type":"string"},"source":{"$ref":"#/components/schemas/FxPosition"},"source_event_id":{"type":"string"},"statement_reference":{"type":"string"},"verified_public_key":{"type":"string"}},"required":["actor","advice_sha256","as_of","at","authority_sha256","book_id","breaks","closing_minor","content_sha256","currency_code","external_account_ref","id","key_id","lines","protocol","reconciles","signature","source","source_event_id","statement_reference","verified_public_key"],"type":"object"},"FxStatementLine":{"properties":{"foreign_reference":{"type":"string"},"signed_minor":{"format":"int64","type":"integer"}},"required":["foreign_reference","signed_minor"],"type":"object"},"FxStatementRequest":{"properties":{"advice_sha256":{"type":"string"},"as_of":{"format":"date-time","type":"string"},"book_id":{"type":"string"},"closing_minor":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"external_account_ref":{"type":"string"},"key_id":{"type":"string"},"lines":{"description":"complete inventory from zero boarding through AsOf","items":{"$ref":"#/components/schemas/FxStatementLine"},"type":"array"},"protocol":{"type":"string"},"signature":{"type":"string"},"statement_reference":{"type":"string"}},"required":["advice_sha256","as_of","book_id","closing_minor","currency_code","external_account_ref","key_id","lines","protocol","signature","statement_reference"],"type":"object"},"FxValuationRequest":{"properties":{"book_id":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"rate_observed_at":{"format":"date-time","type":"string"},"rate_reference":{"type":"string"},"rate_sha256":{"type":"string"},"usd_per_foreign_major":{"type":"string"}},"required":["book_id","business_date","evidence","rate_observed_at","rate_reference","rate_sha256","usd_per_foreign_major"],"type":"object"},"GLSource":{"description":"GLSource is copied from a single retained, tied historical ledger sync.","properties":{"balance_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"type":{"type":"string"}},"required":["balance_amount","currency_code","gl_code","type"],"type":"object"},"Garnishment":{"description":"Garnishment is a served order and funds frozen, booked to the issuer payable, or released.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"benefit_credits_amount":{"description":"federal benefit payments found in the lookback","format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"held_amount":{"description":"the legal hold: the order's amount, capped at what was available after the protected funds","format":"int64","type":"integer"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"hold_until":{"description":"IRS levy: no remittance before the 21st day after service","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"id":{"type":"string"},"irs_levy":{"type":"boolean"},"issuer":{"type":"string"},"kind":{"type":"string"},"lookback_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"lookback_to":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"notes":{"type":"string"},"notice_channel":{"type":"string"},"notice_due_by":{"description":"212.7: three business days after the account review","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"notice_reference":{"type":"string"},"notice_sent_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"protected_amount":{"format":"int64","type":"integer"},"received_at":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"remit_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"remitted_amount":{"format":"int64","type":"integer"},"reviewed_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"open, payable, released; remitted is a legacy internal-transfer status","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","amount","benefit_credits_amount","created_at","customer_id","held_amount","id","irs_levy","issuer","kind","lookback_from","lookback_to","notes","protected_amount","received_at","reference","remitted_amount","reviewed_on","status","updated_at"],"type":"object"},"GarnishmentOrder":{"description":"GarnishmentOrder is a garnishment, levy or child-support order served on the bank.","properties":{"amount":{"format":"int64","type":"integer"},"irs_levy":{"description":"a levy served by the Internal Revenue Service: 21-day hold before surrender","type":"boolean"},"issuer":{"type":"string"},"kind":{"description":"garnishment, levy or child_support","type":"string"},"notes":{"type":"string"},"protected_amount":{"description":"state exemptions the operator established; federal benefit deposits in the lookback are found and added by the bank","format":"int64","type":"integer"},"received_at":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"}},"required":["amount","issuer","kind","protected_amount","received_at","reference"],"type":"object"},"Geography":{"description":"Geography preserves the supplied census/assessment-area determination and its vintage. An outside-area result is distinct from an unassessed result.","properties":{"assessment_area_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"assessment_area_id":{"type":"string"},"assessment_area_version":{"type":"string"},"census_tract":{"type":"string"},"census_vintage":{"format":"int64","type":"integer"},"county":{"type":"string"},"geocode":{"$ref":"#/components/schemas/MonitoringEvidence"},"in_assessment_area":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"state":{"type":"string"}},"required":["assessment_area_evidence","assessment_area_id","assessment_area_version","census_tract","census_vintage","county","geocode","state"],"type":"object"},"Group":{"description":"Group is a corporate customer's related legal entities under one relationship.","properties":{"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"members":{"items":{"$ref":"#/components/schemas/GroupMember"},"type":"array"},"name":{"type":"string"},"parent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"description":"active or closed","type":"string"},"transfer_policy":{"description":"any_member or parent_only","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["created_at","id","members","name","parent_customer_id","status","transfer_policy","updated_at"],"type":"object"},"GroupBalances":{"description":"GroupBalances is a multi-entity group's position: every member's accounts with balances, subtotals per entity and the group total.","properties":{"available_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"entities":{"items":{"$ref":"#/components/schemas/EntityBalances"},"type":"array"},"group_id":{"type":"string"},"ledger_amount":{"format":"int64","type":"integer"},"name":{"type":"string"},"status":{"type":"string"}},"required":["available_amount","currency_code","entities","group_id","ledger_amount","name","status"],"type":"object"},"GroupExposure":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"insider_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount_minor","insider_customer_id"],"type":"object"},"GroupMember":{"description":"GroupMember is one legal entity in a group.","properties":{"added_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"legal_name":{"type":"string"},"role":{"description":"parent, subsidiary or affiliate","type":"string"}},"required":["added_at","customer_id","legal_name","role"],"type":"object"},"GroupMemberRequest":{"description":"GroupMemberRequest adds a business to a group.","properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"role":{"description":"subsidiary (default) or affiliate","type":"string"}},"required":["customer_id"],"type":"object"},"Guarantee":{"description":"Guarantee is a government guarantee: the guaranteed share carries no allowance.","properties":{"guaranteed_bps":{"format":"int64","type":"integer"},"program":{"description":"sba_7a, sba_504, usda","type":"string"}},"required":["guaranteed_bps","program"],"type":"object"},"Header":{"description":"Header is a file without its records.","properties":{"file_reference":{"type":"string"},"format":{"type":"string"},"institution_id":{"type":"string"},"network":{"type":"string"},"processing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"totals":{"$ref":"#/components/schemas/Totals"}},"required":["file_reference","format","institution_id","network","processing_date","settlement_date","totals"],"type":"object"},"HistoricalCash":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]},"key":{"type":"string"},"legacy_row":{"oneOf":[{"$ref":"#/components/schemas/LegacyCashRow"},{"type":"null"}]}},"required":["business_date","key"],"type":"object"},"HistoricalClearing":{"properties":{"authorization":{"$ref":"#/components/schemas/DomainAuthorization"},"facility_id":{"type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"kind":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["authorization","journal","kind","ledger_account_id"],"type":"object"},"History":{"properties":{"authorities":{"items":{"$ref":"#/components/schemas/FleetAuthority"},"type":"array"},"more":{"type":"boolean"}},"required":["authorities","more"],"type":"object"},"HoaAllocation":{"properties":{"amount":{"format":"int64","type":"integer"},"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"check_deposit_id":{"type":"string"}},"required":["amount","assessment_id","check_deposit_id"],"type":"object"},"HoaAuthority":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"device_sha256":{"type":"string"},"membership_changed_by":{"type":"string"},"membership_updated_at":{"format":"date-time","type":"string"},"observed_at":{"format":"date-time","type":"string"},"organization_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payment_limit_amount":{"format":"int64","type":"integer"},"person_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"role":{"type":"string"},"session_sha256":{"type":"string"},"step_up_at":{"format":"date-time","type":"string"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","device_sha256","membership_changed_by","membership_updated_at","observed_at","organization_customer_id","payment_limit_amount","person_customer_id","role","session_sha256","step_up_at","user_id"],"type":"object"},"HoaChange":{"properties":{"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/HoaRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/HoaReview"},{"type":"null"}]},"source":{"oneOf":[{"$ref":"#/components/schemas/HoaSource"},{"type":"null"}]},"submitted_by":{"$ref":"#/components/schemas/HoaAuthority"}},"required":["content_sha256","created_at","id","request","submitted_by"],"type":"object"},"HoaEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"HoaInvoice":{"properties":{"amount":{"format":"int64","type":"integer"},"reference":{"type":"string"}},"required":["amount","reference"],"type":"object"},"HoaPage":{"properties":{"changes":{"items":{"$ref":"#/components/schemas/HoaChange"},"type":"array"},"more":{"type":"boolean"}},"required":["changes","more"],"type":"object"},"HoaRelease":{"properties":{"allocation_id":{"type":"string"},"amount":{"format":"int64","type":"integer"}},"required":["allocation_id","amount"],"type":"object"},"HoaRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"adjustment":{"oneOf":[{"$ref":"#/components/schemas/Adjustment"},{"type":"null"}]},"allocation":{"oneOf":[{"$ref":"#/components/schemas/HoaAllocation"},{"type":"null"}]},"assessment":{"oneOf":[{"$ref":"#/components/schemas/Assessment"},{"type":"null"}]},"evidence":{"$ref":"#/components/schemas/HoaEvidence"},"kind":{"type":"string"},"reason":{"type":"string"},"release":{"oneOf":[{"$ref":"#/components/schemas/HoaRelease"},{"type":"null"}]},"unit":{"oneOf":[{"$ref":"#/components/schemas/HoaUnit"},{"type":"null"}]}},"required":["account_id","evidence","kind","reason"],"type":"object"},"HoaReview":{"properties":{"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"authority":{"$ref":"#/components/schemas/HoaAuthority"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/HoaEvidence"},"reason":{"type":"string"}},"required":["approve","at","authority","content_sha256","evidence","reason"],"type":"object"},"HoaReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/HoaEvidence"},"reason":{"type":"string"}},"required":["approve","content_sha256","evidence","reason"],"type":"object"},"HoaSnapshot":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"balances":{"items":{"$ref":"#/components/schemas/Balance"},"type":"array"},"changes":{"items":{"$ref":"#/components/schemas/HoaChange"},"type":"array"},"observed_at":{"format":"date-time","type":"string"},"organization_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"receipts":{"items":{"$ref":"#/components/schemas/ReceiptObservation"},"type":"array"},"source_sha256":{"type":"string"}},"required":["account_id","balances","changes","observed_at","organization_customer_id","outstanding_amount","receipts","source_sha256"],"type":"object"},"HoaSource":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"check_deposit_id":{"type":"string"},"collection_journal":{"$ref":"#/components/schemas/LedgerJournal"},"collection_journal_sha256":{"type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"deposit_journal":{"$ref":"#/components/schemas/LedgerJournal"},"deposit_journal_sha256":{"type":"string"},"invoices":{"items":{"$ref":"#/components/schemas/HoaInvoice"},"type":"array"},"item_id":{"type":"string"},"lockbox_id":{"type":"string"},"remittance_id":{"type":"string"}},"required":["account_id","amount","check_deposit_id","collection_journal","collection_journal_sha256","currency_code","customer_id","deposit_journal","deposit_journal_sha256","invoices","item_id","lockbox_id","remittance_id"],"type":"object"},"HoaStatement":{"properties":{"artifact_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"prepared_by":{"$ref":"#/components/schemas/HoaAuthority"},"request":{"$ref":"#/components/schemas/HoaStatementRequest"},"snapshot":{"$ref":"#/components/schemas/HoaSnapshot"}},"required":["artifact_sha256","created_at","id","prepared_by","request","snapshot"],"type":"object"},"HoaStatementRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expected_source_sha256":{"type":"string"},"format_version":{"type":"string"}},"required":["account_id","expected_source_sha256","format_version"],"type":"object"},"HoaUnit":{"properties":{"active":{"type":"boolean"},"association_mandate":{"$ref":"#/components/schemas/HoaEvidence"},"occupancy_reference":{"type":"string"},"prior_change_id":{"type":"string"},"reference":{"type":"string"},"roster_evidence":{"$ref":"#/components/schemas/HoaEvidence"}},"required":["active","association_mandate","occupancy_reference","reference","roster_evidence"],"type":"object"},"HoldNotice":{"description":"HoldNotice is what 229.16(c)(1) requires the customer be told: the account, the date and amount of the deposit, the amount held, the reason and the day the funds will be available.","properties":{"account_number_last4":{"type":"string"},"available_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"citation":{"type":"string"},"deposit_amount":{"format":"int64","type":"integer"},"deposited_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"held_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"reason_text":{"type":"string"}},"required":["account_number_last4","available_on","citation","deposit_amount","deposited_on","held_amount","reason","reason_text"],"type":"object"},"HolderReportSchedule":{"description":"HolderReportSchedule is when a state wants a bank's unclaimed property report and remittance for a report year. RemitFrom is zero where the cited source gives no earliest date.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"citations":{"items":{"type":"string"},"type":"array"},"holder_class":{"type":"string"},"remit_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"remit_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"report_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"report_with_payment":{"type":"boolean"},"report_year":{"format":"int64","type":"integer"},"state":{"type":"string"},"two_phase":{"type":"boolean"},"weekend_adjustments":{"type":"string"}},"required":["as_of","citations","holder_class","remit_from","remit_through","report_due","report_with_payment","report_year","state","two_phase","weekend_adjustments"],"type":"object"},"HolderVerificationRequest":{"description":"HolderVerificationRequest is the bound holder approving a pending token in the bank app.","properties":{"expected_sequence":{"format":"int64","type":"integer"}},"required":["expected_sequence"],"type":"object"},"HoldingsStatement":{"description":"HoldingsStatement is a securities account's positions at the close of a business day and the day's activity.","properties":{"account":{"$ref":"#/components/schemas/Account"},"activity":{"items":{"$ref":"#/components/schemas/ActivityLine"},"type":"array"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"positions":{"items":{"$ref":"#/components/schemas/FedsecuritiesPosition"},"type":"array"},"signature":{"type":"string"},"version":{"type":"string"}},"required":["account","activity","as_of","issued_at","key_id","positions","signature","version"],"type":"object"},"IATDFI":{"description":"IATDFI is a bank on an international entry.","properties":{"branch_country":{"type":"string"},"id":{"type":"string"},"id_qualifier":{"description":"01 national clearing system, 02 BIC, 03 IBAN","type":"string"},"name":{"type":"string"}},"required":["branch_country","id","id_qualifier","name"],"type":"object"},"IATDetails":{"description":"IATDetails are the international addenda of an IAT entry. On an entry the bank originates the originator and originating DFI are filled from the customer and the bank when blank; the counterparty routing number is the U.S. Gateway Operator's and the foreign bank is the receiving DFI.","properties":{"correspondents":{"items":{"$ref":"#/components/schemas/IATDFI"},"type":"array"},"destination_country":{"type":"string"},"destination_currency":{"type":"string"},"foreign_amount":{"format":"int64","type":"integer"},"foreign_exchange_indicator":{"description":"FF (default), FV, VF","type":"string"},"foreign_exchange_reference":{"type":"string"},"foreign_trace":{"type":"string"},"ofac_indicator":{"description":"the Gateway Operator's: 0 no match, 1 a potential match","type":"string"},"originating_currency":{"description":"USD by default","type":"string"},"originating_dfi":{"$ref":"#/components/schemas/IATDFI"},"originator":{"$ref":"#/components/schemas/IATParty"},"receiver":{"$ref":"#/components/schemas/IATParty"},"receiving_dfi":{"$ref":"#/components/schemas/IATDFI"},"remittance":{"items":{"type":"string"},"type":"array"},"secondary_ofac_indicator":{"type":"string"},"transaction_type_code":{"description":"ANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB","type":"string"}},"required":["destination_country","destination_currency","originating_dfi","originator","receiver","receiving_dfi","transaction_type_code"],"type":"object"},"IATParty":{"description":"IATParty is the originator or the receiver of an international entry.","properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"postal_code":{"type":"string"},"region":{"type":"string"},"street":{"type":"string"}},"required":["city","country","name","street"],"type":"object"},"IATTransfer":{"description":"IATTransfer is an international entry the bank originated: the ACH entry underneath it, with the international parties, their banks and the currencies at the top level.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"correspondents":{"items":{"$ref":"#/components/schemas/IATDFI"},"type":"array"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"destination_country":{"type":"string"},"destination_currency":{"type":"string"},"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"foreign_amount":{"format":"int64","type":"integer"},"foreign_exchange_indicator":{"description":"FF (default), FV, VF","type":"string"},"foreign_exchange_reference":{"type":"string"},"foreign_trace":{"type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ofac_indicator":{"description":"the Gateway Operator's: 0 no match, 1 a potential match","type":"string"},"originating_currency":{"description":"USD by default","type":"string"},"originating_dfi":{"$ref":"#/components/schemas/IATDFI"},"originator":{"$ref":"#/components/schemas/IATParty"},"originator_id":{"type":"string"},"receiver":{"$ref":"#/components/schemas/IATParty"},"receiving_dfi":{"$ref":"#/components/schemas/IATDFI"},"remittance":{"items":{"type":"string"},"type":"array"},"return_code":{"type":"string"},"return_reason":{"type":"string"},"reversal_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"screening_result":{"type":"string"},"secondary_ofac_indicator":{"type":"string"},"status":{"type":"string"},"trace_number":{"type":"string"},"transaction_type_code":{"description":"ANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB","type":"string"},"transfer_id":{"description":"the ACH transfer this resource is a view of","example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","amount","counterparty","created_at","currency_code","description","destination_country","destination_currency","direction","effective_date","id","originating_dfi","originator","receiver","receiving_dfi","status","transaction_type_code","transfer_id","updated_at"],"type":"object"},"IATTransferRequest":{"description":"IATTransferRequest originates an international entry: an ACH origination with the international parties, their banks and the currencies at the top level. The addenda the Nacha Operating Rules require of an IAT entry are derived from it; Same Day settlement is refused.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"correspondents":{"items":{"$ref":"#/components/schemas/IATDFI"},"type":"array"},"counterparty":{"allOf":[{"$ref":"#/components/schemas/Counterparty"}],"description":"the U.S. Gateway Operator's routing number and the receiver's foreign account or IBAN"},"currency_code":{"description":"ISO 4217 code","type":"string"},"description":{"type":"string"},"destination_country":{"type":"string"},"destination_currency":{"type":"string"},"direction":{"type":"string"},"effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"foreign_amount":{"format":"int64","type":"integer"},"foreign_exchange_indicator":{"description":"FF (default), FV, VF","type":"string"},"foreign_exchange_reference":{"type":"string"},"foreign_trace":{"type":"string"},"ofac_indicator":{"description":"the Gateway Operator's: 0 no match, 1 a potential match","type":"string"},"originating_currency":{"description":"USD by default","type":"string"},"originating_dfi":{"$ref":"#/components/schemas/IATDFI"},"originator":{"$ref":"#/components/schemas/IATParty"},"receiver":{"$ref":"#/components/schemas/IATParty"},"receiving_dfi":{"$ref":"#/components/schemas/IATDFI"},"remittance":{"items":{"type":"string"},"type":"array"},"same_day":{"description":"refused: Same Day ACH excludes IAT entries","type":"boolean"},"secondary_ofac_indicator":{"type":"string"},"transaction_type_code":{"description":"ANN, BUS, DEP, LOA, MIS, MOR, PEN, REM, RLS, SAL, TAX, TEL, WEB","type":"string"}},"required":["account_id","amount","counterparty","currency_code","description","destination_country","destination_currency","direction","originating_dfi","originator","receiver","receiving_dfi","transaction_type_code"],"type":"object"},"Identification":{"properties":{"jurisdiction":{"type":"string"},"kind":{"type":"string"},"number":{"type":"string"}},"required":["kind","number"],"type":"object"},"Identifier":{"description":"Identifier is the sealed identifier's public record.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"last4":{"type":"string"}},"required":["actor","created_at","id","kind","last4"],"type":"object"},"IdentifierRequest":{"description":"IdentifierRequest seals an obligor SSN or a levied taxpayer TIN copied from a served order.","properties":{"kind":{"type":"string"},"value":{"type":"string"}},"required":["kind","value"],"type":"object"},"IdentityTokenRequest":{"description":"TokenRequest is the client-credentials grant.","properties":{"client_id":{"description":"the service account, svc_accounts","type":"string"},"client_secret":{"description":"its secret","type":"string"},"grant_type":{"description":"client_credentials","type":"string"},"scope":{"description":"space-separated scopes the token should carry; each must be granted to the client","type":"string"}},"required":["client_id","client_secret","grant_type","scope"],"type":"object"},"InboundCashLetterResult":{"description":"InboundCashLetterResult is what the bank did with a file the operator delivered.","properties":{"cash_letter":{"$ref":"#/components/schemas/CashLetter"},"items":{"items":{"$ref":"#/components/schemas/InclearingItem"},"type":"array"},"replayed":{"type":"boolean"},"return_cash_letter":{"oneOf":[{"$ref":"#/components/schemas/CashLetter"},{"type":"null"}]},"returns":{"items":{"$ref":"#/components/schemas/CheckDeposit"},"type":"array"}},"required":["cash_letter","replayed"],"type":"object"},"InboundReceipt":{"description":"InboundReceipt is the matched receipt as the command relies on it.","properties":{"amount_minor":{"format":"int64","type":"integer"},"confirmation_id":{"type":"string"},"delivering_reference":{"type":"string"},"distribution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"outstanding_at_year_end":{"type":"boolean"},"rail":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"received_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"sender_name":{"type":"string"},"sender_routing":{"type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount_minor","confirmation_id","delivering_reference","distribution_date","outstanding_at_year_end","rail","receipt_id","received_on","reference","sender_name","sender_routing","transfer_id"],"type":"object"},"InboundReceiptEvidence":{"description":"InboundReceiptEvidence names the payments receipt a custodian_transfer_in applies.","properties":{"rail":{"description":"wire or ach","type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["rail","receipt_id","transfer_id"],"type":"object"},"InboundResult":{"properties":{"file":{"$ref":"#/components/schemas/PaymentsFile"},"receipts":{"items":{"$ref":"#/components/schemas/Receipt"},"type":"array"},"replayed":{"type":"boolean"},"return_file":{"oneOf":[{"$ref":"#/components/schemas/PaymentsFile"},{"type":"null"}]}},"required":["file","receipts","replayed"],"type":"object"},"InboundTransfer":{"description":"InboundTransfer is the retained instruction. MatchReference is quoted by the delivering custodian on the cash (the wire originator-to-beneficiary information or the ACH individual identification number) so the receipt can be matched to it.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"confirmation":{"oneOf":[{"$ref":"#/components/schemas/InboundTransferConfirmation"},{"type":"null"}]},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decedent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"ira_type":{"type":"string"},"match_reference":{"type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/InboundTransferRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"},"wrapper":{"type":"string"}},"required":["account_id","customer_id","id","match_reference","ownership_revision","proposed_at","proposed_by","request","status","version","wrapper"],"type":"object"},"InboundTransferConfirmation":{"description":"InboundTransferConfirmation retains the request sent to the delivering custodian and its answer. Simulated is carried from the answer: a simulator's confirmation never claims to be a real custodian's.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"confirmation_sha256":{"type":"string"},"custodian_confirmation":{"$ref":"#/components/schemas/Confirmation"},"custodian_request":{"$ref":"#/components/schemas/CustodiantransferRequest"},"id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"requested_by":{"type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","confirmation_sha256","custodian_confirmation","custodian_request","id","recorded_at","requested_by","transfer_id"],"type":"object"},"InboundTransferCustodianRequest":{"description":"InboundTransferCustodianRequest records why a custodian request was sent.","properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"InboundTransferRequest":{"description":"InboundTransferRequest is a reviewed instruction to receive a direct trustee-to-trustee transfer of cash from another custodian into this protected account. It is not a contribution or a rollover: nothing is reported on Form 5498 or 5498-SA for it.","properties":{"acceptance_ref":{"type":"string"},"acceptance_sha256":{"type":"string"},"authority_ref":{"type":"string"},"customer_id":{"description":"the owner, or the beneficiary of an inherited IRA","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decedent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"delivering_account_reference":{"type":"string"},"delivering_custodian":{"type":"string"},"delivering_plan_type":{"type":"string"},"delivering_routing_number":{"type":"string"},"delivering_title_sha256":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_minor":{"format":"int64","type":"integer"},"expires_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"inheritance_id":{"type":"string"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"maximum_minor":{"format":"int64","type":"integer"},"policy_sha256":{"type":"string"},"reason":{"type":"string"},"transfer_scope":{"description":"full or partial","type":"string"}},"required":["acceptance_ref","acceptance_sha256","authority_ref","customer_id","delivering_account_reference","delivering_custodian","delivering_plan_type","delivering_routing_number","delivering_title_sha256","evidence_ref","evidence_sha256","expected_minor","expires_on","instruction_ref","instruction_sha256","maximum_minor","policy_sha256","reason","transfer_scope"],"type":"object"},"InclearingItem":{"description":"InclearingItem is a check drawn on the bank that the operator presented.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"cash_letter_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decide_by":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision":{"type":"string"},"exception_reason":{"description":"no_issue, amount_mismatch, payee_mismatch, duplicate_issue, void_issue, sanctions_screening or sanctions_screening_unavailable","type":"string"},"has_images":{"type":"boolean"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"micr":{"$ref":"#/components/schemas/MICR"},"official_check_id":{"type":"string"},"payee":{"type":"string"},"pending_actor":{"type":"string"},"pending_decision":{"type":"string"},"presented_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"return_cash_letter_id":{"type":"string"},"return_reason":{"type":"string"},"return_reason_text":{"type":"string"},"sequence_number":{"type":"string"},"status":{"description":"paid, returned, exception","type":"string"}},"required":["amount","cash_letter_id","created_at","has_images","id","micr","presented_on","sequence_number","status"],"type":"object"},"Info":{"description":"Info describes an HSM implementation.","properties":{"implementation":{"type":"string"},"master_key_check_value":{"type":"string"},"simulator":{"type":"boolean"}},"required":["implementation","master_key_check_value","simulator"],"type":"object"},"InfoSharingCounterparty":{"description":"InfoSharingCounterparty is a registry entry for a counterparty institution.","properties":{"counterparty_id":{"type":"string"},"expires_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"format":"int64","type":"integer"},"institution_type":{"type":"string"},"name":{"type":"string"},"registered_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"},"verified_how":{"type":"string"}},"required":["counterparty_id","expires_on","id","institution_type","name","registered_on","status","verified_how"],"type":"object"},"InfoSharingCounterpartyRequest":{"description":"InfoSharingCounterpartyRequest records a counterparty institution's verified 314(b) period.","properties":{"counterparty_id":{"type":"string"},"expires_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"institution_type":{"type":"string"},"name":{"type":"string"},"registered_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"verified_how":{"type":"string"}},"required":["counterparty_id","expires_on","institution_type","name","registered_on","verified_how"],"type":"object"},"InfoSharingEntry":{"description":"InfoSharingEntry is a logged exchange.","properties":{"counterparty_id":{"type":"string"},"direction":{"type":"string"},"id":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"shared":{"type":"string"},"shared_by":{"type":"string"},"shared_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"subject_id":{"type":"string"},"subject_name":{"type":"string"},"subject_type":{"type":"string"}},"required":["counterparty_id","direction","id","purpose","recorded_at","shared","shared_by","shared_on","subject_name","subject_type"],"type":"object"},"InfoSharingRegistration":{"description":"InfoSharingRegistration is one of the bank's 314(b) registrations.","properties":{"expires_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fincen_confirmation":{"type":"string"},"id":{"format":"int64","type":"integer"},"kind":{"type":"string"},"registered_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"}},"required":["expires_on","fincen_confirmation","id","kind","registered_on","status"],"type":"object"},"InfoSharingRegistrationRequest":{"description":"InfoSharingRegistrationRequest records the bank's 314(b) registration or renewal.","properties":{"fincen_confirmation":{"type":"string"},"kind":{"description":"initial or renewal","type":"string"},"registered_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["fincen_confirmation","kind","registered_on"],"type":"object"},"InfoSharingRequest":{"description":"InfoSharingRequest is one 314(b) exchange.","properties":{"counterparty_id":{"type":"string"},"direction":{"type":"string"},"purpose":{"type":"string"},"shared":{"type":"string"},"subject_id":{"type":"string"},"subject_name":{"type":"string"},"subject_type":{"type":"string"}},"required":["counterparty_id","direction","purpose","shared","subject_name","subject_type"],"type":"object"},"Information314Account":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"closed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"customer_ids":{"items":{"type":"string"},"type":"array"},"matched_by":{"items":{"type":"string"},"type":"array"},"number":{"type":"string"},"numbers":{"items":{"type":"string"},"type":"array"},"opened_at":{"format":"date-time","type":"string"},"owners":{"items":{"$ref":"#/components/schemas/AccountOwner"},"type":"array"},"ownership_revision":{"format":"int64","type":"integer"},"source_sha256":{"type":"string"},"type":{"type":"string"}},"required":["account_id","customer_ids","matched_by","number","numbers","opened_at","owners","ownership_revision","source_sha256","type"],"type":"object"},"Information314Address":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["line1"],"type":"object"},"Information314Authorization":{"properties":{"allowed":{"type":"boolean"},"query_sha256":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"search_id":{"type":"string"},"source":{"type":"string"}},"required":["allowed","query_sha256","request_id","search_id","source"],"type":"object"},"Information314Proof":{"properties":{"query_sha256":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"search_id":{"type":"string"},"source":{"type":"string"}},"required":["query_sha256","request_id","search_id","source"],"type":"object"},"Information314Transaction":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"direction":{"type":"string"},"kind":{"type":"string"},"matched_by":{"items":{"type":"string"},"type":"array"},"occurred_at":{"format":"date-time","type":"string"},"record_id":{"type":"string"},"source_sha256":{"type":"string"}},"required":["amount_minor","kind","matched_by","occurred_at","record_id","source_sha256"],"type":"object"},"InformationDocument":{"properties":{"content":{"format":"byte","type":"string"},"kind":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sha256":{"type":"string"}},"required":["content","kind","request_id","sha256"],"type":"object"},"InformationDocumentRequest":{"properties":{"content_sha256":{"type":"string"},"kind":{"type":"string"},"reason":{"type":"string"},"search_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["content_sha256","kind","reason"],"type":"object"},"InformationImportRequest":{"properties":{"manifest":{"$ref":"#/components/schemas/InformationManifest"},"original":{"format":"byte","type":"string"},"receipt":{"$ref":"#/components/schemas/InformationReceipt"}},"required":["manifest","original","receipt"],"type":"object"},"InformationManifest":{"description":"Manifest is a configured bridge's extraction from retained real portal bytes, not a FinCEN wire format or a FinCEN digital signature. PostedAt, receipt and deadline are explicit request facts, including emergency/retrospective cases.","properties":{"accounts_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cutoff":{"format":"date-time","type":"string"},"deadline":{"format":"date-time","type":"string"},"environment":{"type":"string"},"posted_at":{"format":"date-time","type":"string"},"received_at":{"format":"date-time","type":"string"},"request_reference":{"type":"string"},"retrospective":{"type":"boolean"},"subjects":{"items":{"$ref":"#/components/schemas/Subject"},"type":"array"},"transactions_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"type":"string"}},"required":["accounts_from","cutoff","deadline","environment","posted_at","received_at","request_reference","retrospective","subjects","transactions_from","version"],"type":"object"},"InformationMatch":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"basis_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"type":"string"},"kind":{"type":"string"},"record_id":{"type":"string"},"subject_reference":{"type":"string"}},"required":["actor","at","basis_sha256","decision","subject_reference"],"type":"object"},"InformationMatchRequest":{"properties":{"basis":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"description":"positive, false_positive, unresolved","type":"string"},"evidence":{"format":"byte","type":"string"},"record_id":{"type":"string"},"search_sha256":{"type":"string"},"subject_reference":{"type":"string"}},"required":["basis","decision","evidence","search_sha256","subject_reference"],"type":"object"},"InformationPage":{"description":"InformationPage windows the evidence items of a search in their retained order (subject, then source, then item); keys are zero-padded ordinals.","properties":{"ending_before":{"type":"string"},"first_key":{"type":"string"},"has_more":{"type":"boolean"},"items":{"format":"int64","type":"integer"},"last_key":{"type":"string"},"limit":{"format":"int64","type":"integer"},"starting_after":{"type":"string"}},"required":["has_more","items","limit"],"type":"object"},"InformationPlan":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"basis_sha256":{"type":"string"},"content_sha256":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/InformationReview"},{"type":"null"}]},"version":{"format":"int64","type":"integer"}},"required":["actor","at","basis_sha256","content_sha256","request_id","version"],"type":"object"},"InformationPlanRequest":{"properties":{"basis":{"type":"string"},"content_sha256":{"type":"string"},"evidence":{"format":"byte","type":"string"},"manifest_sha256":{"type":"string"},"original_sha256":{"type":"string"}},"required":["basis","content_sha256","evidence","manifest_sha256","original_sha256"],"type":"object"},"InformationReceipt":{"properties":{"payload":{"$ref":"#/components/schemas/InformationReceiptPayload"},"signature":{"type":"string"}},"required":["payload","signature"],"type":"object"},"InformationReceiptPayload":{"properties":{"document_sha256":{"type":"string"},"environment":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"manifest_sha256":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"version":{"type":"string"}},"required":["document_sha256","environment","issued_at","key_id","manifest_sha256","observed_at","receipt_id","version"],"type":"object"},"InformationReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"}},"required":["actor","approve","at","content_sha256"],"type":"object"},"InformationReviewItem":{"description":"InformationReviewItem is one candidate awaiting independent review: a customer, or a record (an account matched only by the subject's account number, or a transaction matched by the counterparty's own identifiers).","properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"record_id":{"type":"string"},"subject_reference":{"type":"string"}},"required":["subject_reference"],"type":"object"},"InformationReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"}},"required":["approve","content_sha256"],"type":"object"},"InformationSearch":{"description":"InformationSearch is one search run over every planned source for every subject. Source counts, hashes, holes and stage are always complete; the candidate, account and transaction lists inside each result hold only the requested page of evidence items, so a large cut is reviewed page by page instead of being refused.","properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"completed":{"type":"boolean"},"content_sha256":{"type":"string"},"holes":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"matches":{"items":{"$ref":"#/components/schemas/InformationMatch"},"type":"array"},"page":{"$ref":"#/components/schemas/InformationPage"},"pending":{"items":{"$ref":"#/components/schemas/InformationReviewItem"},"type":"array"},"plan_version":{"format":"int64","type":"integer"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sources":{"items":{"$ref":"#/components/schemas/InformationSource"},"type":"array"},"stage":{"type":"string"}},"required":["actor","at","completed","content_sha256","holes","id","matches","page","pending","plan_version","request_id","sources","stage"],"type":"object"},"InformationSearchRequest":{"properties":{"content_sha256":{"type":"string"},"plan_version":{"format":"int64","type":"integer"}},"required":["content_sha256","plan_version"],"type":"object"},"InformationSource":{"properties":{"accounts":{"format":"int64","type":"integer"},"candidates":{"format":"int64","type":"integer"},"result":{"$ref":"#/components/schemas/Result"},"source":{"type":"string"},"subject_reference":{"type":"string"},"transactions":{"format":"int64","type":"integer"}},"required":["accounts","candidates","result","source","subject_reference","transactions"],"type":"object"},"InformationView":{"properties":{"content_sha256":{"type":"string"},"current_plan":{"format":"int64","type":"integer"},"deadline":{"format":"date-time","type":"string"},"environment":{"type":"string"},"id":{"type":"string"},"import_sha256":{"type":"string"},"imported_at":{"format":"date-time","type":"string"},"imported_by":{"type":"string"},"manifest_sha256":{"type":"string"},"original_sha256":{"type":"string"},"overdue":{"type":"boolean"},"plans":{"items":{"$ref":"#/components/schemas/InformationPlan"},"type":"array"},"received_at":{"format":"date-time","type":"string"},"stage":{"type":"string"},"subject_count":{"format":"int64","type":"integer"},"verified_public_key":{"type":"string"}},"required":["content_sha256","current_plan","deadline","environment","id","import_sha256","imported_at","imported_by","manifest_sha256","original_sha256","overdue","plans","received_at","stage","subject_count","verified_public_key"],"type":"object"},"IngestRequest":{"properties":{"policy_id":{"type":"string"},"purpose":{"type":"string"}},"required":["policy_id","purpose"],"type":"object"},"IngestedFile":{"description":"IngestedFile is a retained clearing file.","properties":{"content_sha256":{"type":"string"},"dispositions":{"$ref":"#/components/schemas/Dispositions"},"header":{"$ref":"#/components/schemas/Header"},"id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"received_by":{"type":"string"},"replayed":{"type":"boolean"},"settlement_id":{"description":"the applied settlement reconciliation","type":"string"},"size_bytes":{"format":"int64","type":"integer"},"source":{"type":"string"},"source_reference":{"type":"string"}},"required":["content_sha256","dispositions","header","id","received_at","received_by","replayed","size_bytes","source","source_reference"],"type":"object"},"Inheritance":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"beneficiary_type":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decedent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"destination_ownership_revision":{"format":"int64","type":"integer"},"id":{"type":"string"},"ira_type":{"type":"string"},"original_owner_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"predecessor_inheritance_id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/InheritanceRequest"},"schedule":{"$ref":"#/components/schemas/InheritanceSchedule"},"share_bps":{"format":"int64","type":"integer"},"status":{"type":"string"},"title_shares":{"items":{"format":"int64","type":"integer"},"type":"array"},"version":{"format":"int64","type":"integer"},"wrapper":{"type":"string"}},"required":["account_id","beneficiary_type","customer_id","decedent_customer_id","destination_ownership_revision","id","original_owner_customer_id","ownership_revision","proposed_at","proposed_by","request","schedule","share_bps","status","title_shares","version","wrapper"],"type":"object"},"InheritanceCommandEvidence":{"description":"InheritanceCommandEvidence authorizes death_transfer and death_distribution (every captured beneficiary in title order) and inherited_distribution (one).","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"authority_ref":{"type":"string"},"authority_sha256":{"type":"string"},"authority_valid_until":{"format":"date-time","type":"string"},"inheritance_ids":{"items":{"type":"string"},"type":"array"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"tax_rule_id":{"type":"string"}},"required":["authority_valid_until","inheritance_ids","instruction_ref","instruction_sha256"],"type":"object"},"InheritanceRequest":{"description":"InheritanceRequest classifies one beneficiary interest captured in the original title of a deceased holder's cash IRA or HSA.","properties":{"beneficiary_index":{"format":"int64","type":"integer"},"category":{"type":"string"},"contract_default_method":{"type":"string"},"contract_permits_election":{"type":"boolean"},"contract_ref":{"type":"string"},"contract_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"death_report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"death_revision":{"format":"int64","type":"integer"},"destination_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"documentation_received":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"documentation_ref":{"type":"string"},"documentation_sha256":{"type":"string"},"election":{"type":"string"},"election_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"election_ref":{"type":"string"},"election_sha256":{"type":"string"},"estate_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"jurisdiction":{"type":"string"},"minimum_recipient_age":{"format":"int64","type":"integer"},"owner_rmd_review_id":{"type":"string"},"policy_ref":{"type":"string"},"policy_sha256":{"type":"string"},"predecessor_rmd_review_id":{"type":"string"},"reason":{"type":"string"},"relationship_ref":{"type":"string"},"relationship_sha256":{"type":"string"},"restriction_id":{"type":"string"},"rmd_policy_id":{"type":"string"},"trust_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"trust_determination_ref":{"type":"string"},"trust_determination_sha256":{"type":"string"},"trust_instrument_ref":{"type":"string"},"trust_instrument_sha256":{"type":"string"}},"required":["beneficiary_index","category","contract_ref","contract_sha256","customer_id","death_report_id","death_revision","destination_account_id","documentation_received","election_date","evidence_ref","evidence_sha256","expected_version","jurisdiction","minimum_recipient_age","policy_ref","policy_sha256","reason","restriction_id"],"type":"object"},"InheritanceSchedule":{"description":"InheritanceSchedule is the distribution rule fixed at classification. Life expectancies are read from the reviewed Single Life Table for each year.","properties":{"annual_distributions":{"type":"boolean"},"beneficiary_base_year":{"format":"int64","type":"integer"},"beneficiary_birth_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"beneficiary_life":{"description":"fixed or recalculated","type":"string"},"date_of_death":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"death_year_entire_balance":{"type":"boolean"},"death_year_required_minor":{"description":"DeathYearRequiredMinor is this beneficiary's allocated share of the requirement for\nthe year of death that the deceased holder had not taken; DeathYearEntireBalance\nmarks a successor whose predecessor's entire interest was due in that year.","format":"int64","type":"integer"},"died_before_required_beginning_date":{"type":"boolean"},"election_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"eligible_designated":{"type":"boolean"},"final_distribution_year":{"format":"int64","type":"integer"},"first_distribution_year":{"format":"int64","type":"integer"},"majority_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"method":{"type":"string"},"owner_birth_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"owner_date_of_death":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"owner_life":{"type":"boolean"},"owner_required_age":{"format":"int64","type":"integer"},"predecessor_date_of_death":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"required_beginning_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"transfer_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["annual_distributions","beneficiary_birth_date","date_of_death","died_before_required_beginning_date","election_deadline","eligible_designated","majority_date","method","owner_birth_date","owner_date_of_death","predecessor_date_of_death","required_beginning_date","transfer_deadline"],"type":"object"},"InheritedRMDReview":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"base_minor":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"final_distribution_year":{"format":"int64","type":"integer"},"id":{"type":"string"},"method":{"type":"string"},"position_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"position_fmv_minor":{"format":"int64","type":"integer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/InheritedRMDReviewRequest"},"requirement":{"$ref":"#/components/schemas/InheritedRequirement"},"source_residual_minor":{"format":"int64","type":"integer"},"status":{"type":"string"},"transfer_command_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["account_id","base_minor","customer_id","due_date","id","method","position_account_id","position_fmv_minor","proposed_at","proposed_by","request","requirement","status","transfer_command_id","version"],"type":"object"},"InheritedRMDReviewRequest":{"properties":{"annual_position_id":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"inheritance_id":{"type":"string"},"policy_id":{"type":"string"},"reason":{"type":"string"},"source_position_id":{"description":"SourcePositionID is the decedent's IRA's December 31 position when that IRA still\nheld residual cash for this interest at the prior year end.","type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["evidence_ref","evidence_sha256","expected_version","inheritance_id","policy_id","reason","tax_year"],"type":"object"},"InheritedRMDStatus":{"properties":{"balance_minor":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"command_ids":{"items":{"type":"string"},"type":"array"},"missed_deadline":{"type":"boolean"},"paid_minor":{"format":"int64","type":"integer"},"remaining_minor":{"format":"int64","type":"integer"},"review":{"$ref":"#/components/schemas/InheritedRMDReview"}},"required":["command_ids","missed_deadline","paid_minor","remaining_minor","review"],"type":"object"},"InheritedRequirement":{"properties":{"annual_required":{"type":"boolean"},"divisor_tenths":{"format":"int64","type":"integer"},"entire_balance":{"type":"boolean"},"required_minor":{"format":"int64","type":"integer"}},"required":["annual_required","entire_balance","required_minor"],"type":"object"},"Input":{"properties":{"first_payment":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"items":{"items":{"$ref":"#/components/schemas/Item"},"type":"array"},"policy":{"$ref":"#/components/schemas/EscrowPolicy"}},"required":["first_payment","items","policy"],"type":"object"},"InsidersAuthorization":{"properties":{"additional_conflicted_director_ids":{"items":{"type":"string"},"type":"array"},"board_minutes_and_conflicts_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"classification_revision_id":{"type":"string"},"comparable_terms_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"credit_terms_sha256":{"type":"string"},"executive_financial_statement_evidence":{"oneOf":[{"$ref":"#/components/schemas/MonitoringEvidence"},{"type":"null"}]},"executive_written_demand_clause_evidence":{"oneOf":[{"$ref":"#/components/schemas/MonitoringEvidence"},{"type":"null"}]},"expires":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"maximum_minor":{"format":"int64","type":"integer"},"meeting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"normal_risk_and_equivalent_underwriting_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"policy_revision_id":{"type":"string"},"target_id":{"type":"string"},"target_kind":{"type":"string"},"votes":{"items":{"$ref":"#/components/schemas/Vote"},"type":"array"}},"required":["additional_conflicted_director_ids","board_minutes_and_conflicts_evidence","classification_revision_id","comparable_terms_evidence","credit_terms_sha256","expires","maximum_minor","meeting_date","normal_risk_and_equivalent_underwriting_evidence","policy_revision_id","target_id","target_kind","votes"],"type":"object"},"InsidersClassification":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"relationships":{"items":{"$ref":"#/components/schemas/Relationship"},"type":"array"},"review_by":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"not_insider, insider, related_interest","type":"string"}},"required":["customer_id","effective_date","evidence","relationships","review_by","status"],"type":"object"},"InsidersExposure":{"properties":{"aggregate_minor":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"classification_revision_ids":{"items":{"type":"string"},"type":"array"},"credits":{"items":{"$ref":"#/components/schemas/CreditExposure"},"type":"array"},"groups":{"items":{"$ref":"#/components/schemas/GroupExposure"},"type":"array"},"policy_revision_id":{"type":"string"},"unclassified_customer_ids":{"items":{"type":"string"},"type":"array"}},"required":["aggregate_minor","business_date","classification_revision_ids","credits","groups","policy_revision_id","unclassified_customer_ids"],"type":"object"},"InsidersPolicy":{"properties":{"aggregate_limit_minor":{"format":"int64","type":"integer"},"capital_policy_and_roster_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"complete_exposure_inventory_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entire_board":{"items":{"$ref":"#/components/schemas/Director"},"type":"array"},"external_exposure":{"items":{"$ref":"#/components/schemas/ExternalExposure"},"type":"array"},"individual_limit_minor":{"format":"int64","type":"integer"},"review_by":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"unimpaired_capital_and_surplus_minor":{"format":"int64","type":"integer"}},"required":["aggregate_limit_minor","capital_policy_and_roster_evidence","complete_exposure_inventory_evidence","effective_date","entire_board","external_exposure","individual_limit_minor","review_by","unimpaired_capital_and_surplus_minor"],"type":"object"},"InsidersProposal":{"properties":{"authorization":{"oneOf":[{"$ref":"#/components/schemas/InsidersAuthorization"},{"type":"null"}]},"classification":{"oneOf":[{"$ref":"#/components/schemas/InsidersClassification"},{"type":"null"}]},"policy":{"oneOf":[{"$ref":"#/components/schemas/InsidersPolicy"},{"type":"null"}]},"previous_id":{"type":"string"},"reason":{"type":"string"}},"required":["reason"],"type":"object"},"InsidersRecord":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/MonitoringDecision"},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string"},"proposal":{"$ref":"#/components/schemas/InsidersProposal"},"subject":{"type":"string"}},"required":["actor","content_sha256","created_at","id","kind","proposal","subject"],"type":"object"},"Installment":{"properties":{"due_date":{"type":"string"},"escrow_due_amount":{"format":"int64","type":"integer"},"escrow_paid_amount":{"format":"int64","type":"integer"},"installment":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"paid_amount":{"format":"int64","type":"integer"},"payment_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["due_date","escrow_due_amount","escrow_paid_amount","installment","interest_amount","paid_amount","payment_amount","principal_amount","status"],"type":"object"},"Instance":{"properties":{"content_sha256":{"type":"string"},"engine_version":{"type":"string"},"facts":{"items":{"$ref":"#/components/schemas/InstanceFact"},"type":"array"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"request":{"$ref":"#/components/schemas/InstanceRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/InstanceReview"},{"type":"null"}]},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"},"taxonomy":{"$ref":"#/components/schemas/TaxonomyManifest"},"workpaper_review_sha256":{"type":"string"},"workpaper_sha256":{"type":"string"},"xml_sha256":{"type":"string"}},"required":["content_sha256","engine_version","facts","id","proposed_at","proposed_by","report_date","request","submission_blockers","submission_ready","taxonomy","workpaper_review_sha256","workpaper_sha256","xml_sha256"],"type":"object"},"InstanceControls":{"properties":{"actor":{"type":"string"},"completed_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"instance_id":{"type":"string"},"instance_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/InstanceControlsRequest"},"result":{"$ref":"#/components/schemas/InstanceControlsResult"},"taxonomy_sha256":{"type":"string"},"xml_sha256":{"type":"string"}},"required":["actor","completed_at","content_sha256","id","instance_id","instance_sha256","request","result","taxonomy_sha256","xml_sha256"],"type":"object"},"InstanceControlsRequest":{"properties":{"history_source":{"description":"HistorySource \"accepted_filings\" reads the quarters' current accepted filings, which the\nservice resolves; it cannot be combined with candidate workpapers. Empty keeps the\nworkpaper candidates (or no history).","type":"string"},"history_workpaper_ids":{"items":{"type":"string"},"type":"array"},"scope":{"type":"string"}},"required":["scope"],"type":"object"},"InstanceControlsResult":{"properties":{"applicability_issues":{"items":{"type":"string"},"type":"array"},"catalog_sha256":{"type":"string"},"completeness":{"$ref":"#/components/schemas/CompletenessResult"},"continuity":{"oneOf":[{"$ref":"#/components/schemas/FilingContinuity"},{"type":"null"}]},"edits":{"items":{"$ref":"#/components/schemas/EditCheck"},"type":"array"},"engine_version":{"type":"string"},"failed":{"format":"int64","type":"integer"},"historical_comparisons":{"format":"int64","type":"integer"},"history_source":{"type":"string"},"passed":{"format":"int64","type":"integer"},"schedule_matrices":{"description":"omitted when empty so earlier retained results keep their digest","items":{"$ref":"#/components/schemas/CompletenessResult"},"type":"array"},"scope":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/ControlSource"},"type":"array"},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"},"total":{"format":"int64","type":"integer"},"unresolved":{"format":"int64","type":"integer"},"unsupported":{"format":"int64","type":"integer"}},"required":["applicability_issues","catalog_sha256","completeness","edits","engine_version","failed","historical_comparisons","passed","scope","sources","submission_blockers","submission_ready","total","unresolved","unsupported"],"type":"object"},"InstanceControlsSummary":{"description":"The list projection is small even for a full page of 3,615-edit executions. ContentSHA256 binds the full record returned by the individual evidence route.","properties":{"completed_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"engine_version":{"type":"string"},"failed":{"format":"int64","type":"integer"},"id":{"type":"string"},"instance_id":{"type":"string"},"missing_items":{"format":"int64","type":"integer"},"passed":{"format":"int64","type":"integer"},"required_items":{"format":"int64","type":"integer"},"submission_ready":{"type":"boolean"},"unresolved":{"format":"int64","type":"integer"},"unresolved_items":{"format":"int64","type":"integer"},"unsupported":{"format":"int64","type":"integer"}},"required":["completed_at","content_sha256","engine_version","failed","id","instance_id","missing_items","passed","required_items","submission_ready","unresolved","unresolved_items","unsupported"],"type":"object"},"InstanceDerivation":{"properties":{"calculation_role":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"rationale":{"type":"string"}},"required":["calculation_role","evidence_ref","evidence_sha256","rationale"],"type":"object"},"InstanceFact":{"properties":{"decimals":{"type":"string"},"derived_role":{"type":"string"},"figure_code":{"type":"string"},"mdrm":{"type":"string"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"raw_unit":{"type":"string"},"raw_value":{"type":"string"},"reference":{"$ref":"#/components/schemas/TaxonomyReference"},"unit":{"type":"string"},"value":{"type":"string"}},"required":["figure_code","mdrm","raw_unit","raw_value","reference","value"],"type":"object"},"InstanceFactRequest":{"properties":{"figure_code":{"type":"string"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"reference":{"$ref":"#/components/schemas/TaxonomyReference"}},"required":["figure_code","reference"],"type":"object"},"InstanceRequest":{"properties":{"derivations":{"items":{"$ref":"#/components/schemas/InstanceDerivation"},"type":"array"},"entity":{"$ref":"#/components/schemas/ReportingEntity"},"facts":{"items":{"$ref":"#/components/schemas/InstanceFactRequest"},"type":"array"},"rounding":{"type":"string"},"taxonomy_sha256":{"type":"string"},"workpaper_id":{"type":"string"}},"required":["entity","facts","rounding","taxonomy_sha256","workpaper_id"],"type":"object"},"InstanceReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"scope":{"type":"string"},"validation_id":{"type":"string"},"xml_sha256":{"type":"string"}},"required":["actor","content_sha256","decision","evidence_ref","rationale","reviewed_at","scope","validation_id","xml_sha256"],"type":"object"},"InstanceReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"scope":{"type":"string"},"validation_id":{"type":"string"},"xml_sha256":{"type":"string"}},"required":["content_sha256","decision","evidence_ref","rationale","scope","validation_id","xml_sha256"],"type":"object"},"InstanceValidation":{"properties":{"actor":{"type":"string"},"completed_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"instance_id":{"type":"string"},"request":{"$ref":"#/components/schemas/ValidationRequest"},"result":{"$ref":"#/components/schemas/ValidationResult"},"started_at":{"format":"date-time","type":"string"},"taxonomy_sha256":{"type":"string"},"xml_sha256":{"type":"string"}},"required":["actor","completed_at","content_sha256","id","instance_id","request","result","started_at","taxonomy_sha256","xml_sha256"],"type":"object"},"InstanceValidationSummary":{"description":"InstanceValidationSummary keeps list pages bounded; full logs remain available by ID.","properties":{"actor":{"type":"string"},"completed_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"instance_id":{"type":"string"},"scope":{"type":"string"},"status":{"type":"string"}},"required":["actor","completed_at","content_sha256","id","instance_id","scope","status"],"type":"object"},"InstantPayment":{"description":"InstantPayment is a FedNow or RTP payment: a customer credit transfer, a liquidity management transfer, or the return of one.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"cycle_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"direction":{"type":"string"},"end_to_end_id":{"type":"string"},"gl_code":{"description":"a liquidity transfer's GL account, or the transit account a held payment waits on","type":"string"},"id":{"example":"rttr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"customer, liquidity or return","type":"string"},"msg_id":{"type":"string"},"operator":{"type":"string"},"original_id":{"description":"on a return: the payment returned","type":"string"},"rail":{"type":"string"},"reason_code":{"type":"string"},"reason_info":{"type":"string"},"remittance":{"type":"string"},"request_id":{"description":"the request for payment this payment settles","example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"return_reason":{"type":"string"},"return_reason_code":{"type":"string"},"screening_result":{"type":"string"},"status":{"description":"pending, held_for_review, rejected, sent, accepted, accepted_without_posting, posted, blocked, rejected_by_rail, received, returned","type":"string"},"uetr":{"type":"string"}},"required":["account_id","amount","counterparty","direction","end_to_end_id","gl_code","id","journal_id","kind","msg_id","operator","original_id","rail","reason_code","reason_info","remittance","request_id","return_reason","return_reason_code","screening_result","status","uetr"],"type":"object"},"InstantRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"currency_code":{"description":"ISO 4217 code","type":"string"},"rail":{"type":"string"},"remittance":{"type":"string"},"request_id":{"description":"the request for payment this payment settles","example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount","counterparty","currency_code","rail"],"type":"object"},"InstantReturnRequest":{"description":"InstantReturnRequest is a request to return an instant payment, sent or received.","properties":{"created_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"direction":{"type":"string"},"id":{"type":"string"},"msg_id":{"type":"string"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"requested_by":{"type":"string"},"response_msg_id":{"type":"string"},"response_reason":{"type":"string"},"response_reason_code":{"type":"string"},"return_payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"description":"requested, acknowledged, accepted, pending, rejected, returned (outbound); received, honoured, refused (inbound); failed","type":"string"}},"required":["created_at","decided_by","direction","id","msg_id","payment_id","rail","reason","reason_code","requested_by","response_msg_id","response_reason","response_reason_code","return_payment_id","status"],"type":"object"},"Instruction":{"properties":{"broker_reference":{"type":"string"},"cash_limit_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"custody_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"custody_account_sha256":{"type":"string"},"dealer_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"dealer_reference":{"type":"string"},"external_account_reference":{"type":"string"},"id":{"type":"string"},"instrument_id":{"type":"string"},"instrument_sha256":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"legal_entity":{"type":"string"},"limit_price":{"format":"int64","type":"integer"},"lot_id":{"description":"allocated BUY lot or exclusively reserved SELL lot","type":"string"},"lot_revision":{"format":"int64","type":"integer"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_fee_amount":{"format":"int64","type":"integer"},"order_id":{"type":"string"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"request_sha256":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"sha256":{"type":"string"},"side":{"type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","cash_limit_amount","currency_code","cusip","custodian_reference","custody_account_id","custody_account_sha256","dealer_customer_id","dealer_reference","external_account_reference","id","instrument_id","instrument_sha256","issued_at","legal_entity","limit_price","lot_id","master_cash_external_account_reference","master_cash_ledger_account_id","max_fee_amount","order_id","program_id","program_sha256","request_sha256","settlement_date","sha256","side","trade_date","units","version"],"type":"object"},"InstructionRequest":{"description":"InstructionRequest is a currency or coin order or deposit the staff prepare for review.","properties":{"endpoint":{"type":"string"},"evidence":{"type":"string"},"kind":{"description":"order, deposit","type":"string"},"office_code":{"type":"string"},"packages":{"items":{"$ref":"#/components/schemas/FedcashPackage"},"type":"array"},"ship_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"unit_id":{"type":"string"}},"required":["endpoint","evidence","kind","office_code","packages","ship_date","unit_id"],"type":"object"},"Instrument":{"properties":{"currency_code":{"type":"string"},"cusip":{"type":"string"},"eligibility":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"enabled":{"type":"boolean"},"face_value_amount":{"description":"cents per whole unit","format":"int64","type":"integer"},"issue_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"kind":{"description":"treasury_bill","type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"name":{"type":"string"},"price_scale":{"format":"int64","type":"integer"},"program_id":{"type":"string"},"terms":{"$ref":"#/components/schemas/Document"},"unit_basis":{"description":"face_100_usd","type":"string"},"unit_increment":{"format":"int64","type":"integer"},"unit_scale":{"format":"int64","type":"integer"},"zero_coupon":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["currency_code","cusip","eligibility","enabled","face_value_amount","issue_date","kind","maturity_date","name","price_scale","program_id","terms","unit_basis","unit_increment","unit_scale"],"type":"object"},"InsuranceAccount":{"description":"InsuranceAccount is a retained core account/title plus its original version-one dated posted balance. A changing/current title is not assumed historically true.","properties":{"beneficiaries_complete":{"type":"boolean"},"beneficiary_ids":{"items":{"type":"string"},"type":"array"},"currency_code":{"type":"string"},"exception":{"type":"string"},"id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership_recorded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"ownership_revision":{"format":"int64","type":"integer"},"ownership_type":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"snapshot_version":{"format":"int64","type":"integer"},"title":{"additionalProperties":true,"type":"object"},"title_sha256":{"type":"string"},"trust_name":{"type":"string"}},"required":["beneficiaries_complete","beneficiary_ids","currency_code","id","ledger_account_id","owners","ownership_revision","ownership_type","principal_amount","product_code","snapshot_version","title","title_sha256"],"type":"object"},"InsuranceException":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"code":{"type":"string"},"detail":{"type":"string"}},"required":["code","detail"],"type":"object"},"InsuranceGroup":{"properties":{"bank_certificate":{"type":"string"},"beneficiary_ids":{"items":{"type":"string"},"type":"array"},"capacity":{"type":"string"},"estimated_insured_amount":{"format":"int64","type":"integer"},"estimated_uninsured_amount":{"format":"int64","type":"integer"},"interests":{"items":{"$ref":"#/components/schemas/InsuranceInterest"},"type":"array"},"limit_amount":{"format":"int64","type":"integer"},"owner_id":{"type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["bank_certificate","beneficiary_ids","capacity","estimated_insured_amount","estimated_uninsured_amount","interests","limit_amount","owner_id","total_amount"],"type":"object"},"InsuranceInterest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"}},"required":["account_id","amount"],"type":"object"},"InsuranceOwner":{"description":"Owner shares and capacity qualifications come from independently reviewed bank records. Joint shares need not be equal but must reflect those records. Formal trust owners are grantors, which must never be inferred from account trustees.","properties":{"beneficiary_ids":{"items":{"type":"string"},"type":"array"},"identity_id":{"type":"string"},"share_bps":{"format":"int64","type":"integer"}},"required":["beneficiary_ids","identity_id","share_bps"],"type":"object"},"InsurancePolicy":{"properties":{"bank_certificate":{"type":"string"},"bank_insurance_confirmed":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"legal_entity":{"type":"string"},"methodology":{"type":"string"},"name":{"type":"string"},"part370_applicability":{"description":"covered, not_covered, undetermined; never inferred from this run","type":"string"},"rule_version":{"type":"string"}},"required":["bank_certificate","effective_from","effective_through","evidence","legal_entity","methodology","name","part370_applicability","rule_version"],"type":"object"},"InsuranceResults":{"properties":{"captured_principal_amount":{"format":"int64","type":"integer"},"classified_amount":{"format":"int64","type":"integer"},"engine_version":{"type":"string"},"estimated_insured_amount":{"format":"int64","type":"integer"},"estimated_uninsured_amount":{"format":"int64","type":"integer"},"exceptions":{"items":{"$ref":"#/components/schemas/InsuranceException"},"type":"array"},"groups":{"items":{"$ref":"#/components/schemas/InsuranceGroup"},"type":"array"},"limitations":{"items":{"type":"string"},"type":"array"},"status":{"type":"string"}},"required":["captured_principal_amount","classified_amount","engine_version","estimated_insured_amount","estimated_uninsured_amount","exceptions","groups","limitations","status"],"type":"object"},"InsuranceRun":{"properties":{"policy":{"$ref":"#/components/schemas/InsurancePolicy"},"policy_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/InsuranceRunRequest"},"results":{"$ref":"#/components/schemas/InsuranceResults"},"source":{"$ref":"#/components/schemas/InsuranceSource"}},"required":["policy","policy_sha256","request","results","source"],"type":"object"},"InsuranceRunRequest":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"coverage_evidence":{"$ref":"#/components/schemas/AlmEvidence"},"policy_id":{"type":"string"},"rationale":{"type":"string"},"titles":{"items":{"$ref":"#/components/schemas/InsuranceTitle"},"type":"array"}},"required":["as_of","coverage_evidence","policy_id","rationale","titles"],"type":"object"},"InsuranceSource":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/InsuranceAccount"},"type":"array"},"captured_at":{"format":"date-time","type":"string"},"expected_accrued_interest_amount":{"format":"int64","type":"integer"},"expected_principal_amount":{"format":"int64","type":"integer"},"gl":{"$ref":"#/components/schemas/AlmSource"},"sha256":{"type":"string"}},"required":["accounts","captured_at","expected_accrued_interest_amount","expected_principal_amount","gl","sha256"],"type":"object"},"InsuranceTitle":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"accrued_interest_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"eligible_primary_beneficiaries":{"description":"EligiblePrimaryBeneficiaries is the exhaustive set of currently qualifying\nliving natural persons / IRS-recognized charity/nonprofit primary beneficiaries.","items":{"type":"string"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"joint_equal_withdrawal":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"joint_signature_requirement_met":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"owners":{"items":{"$ref":"#/components/schemas/InsuranceOwner"},"type":"array"},"owners_natural_persons":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"retirement_eligible":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"special_circumstances":{"description":"death, merger grace, disputed identity, contingent titling etc require exception review","oneOf":[{"type":"boolean"},{"type":"null"}]},"title_sha256":{"type":"string"},"treatment":{"type":"string"},"trust_qualifies":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["account_id","eligible_primary_beneficiaries","evidence","owners","title_sha256","treatment"],"type":"object"},"Intent":{"properties":{"at":{"format":"date-time","type":"string"},"evidence_sha256":{"type":"string"},"party":{"type":"string"}},"required":["at","evidence_sha256","party"],"type":"object"},"InterEntityRequest":{"description":"InterEntityRequest moves money between two legal entities of one multi-entity group.","properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"description":{"type":"string"},"from_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"initiated_by":{"description":"the member entity acting; the paying entity by default","type":"string"},"purpose":{"description":"loan, repayment, capital, dividend, management_fee, settlement or other","type":"string"},"requested_by":{"type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","currency_code","description","from_account_id","purpose","requested_by","to_account_id"],"type":"object"},"InterEntityTransfer":{"description":"InterEntityTransfer is money moved between two entities of a group.","properties":{"amount":{"format":"int64","type":"integer"},"book_transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"description":{"type":"string"},"from_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"from_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"group_id":{"type":"string"},"id":{"type":"string"},"initiated_by":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"purpose":{"type":"string"},"requested_by":{"type":"string"},"status":{"type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"to_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","book_transfer_id","created_at","currency_code","description","from_account_id","from_customer_id","group_id","id","initiated_by","journal_id","purpose","requested_by","status","to_account_id","to_customer_id"],"type":"object"},"Interest":{"description":"Interest terms of a deposit product.","properties":{"accrual":{"type":"string"},"annual_rate_bps":{"format":"int64","type":"integer"},"day_count":{"type":"string"},"posting":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]},"variable":{"type":"boolean"}},"required":["accrual","annual_rate_bps","day_count","posting","variable"],"type":"object"},"InterestPeriod":{"description":"InterestPeriod is a nostro account's interest for a month: the exact accrual of its days, the whole minor units recognised, and the settlement the correspondent booked.","properties":{"accrual_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"days":{"format":"int64","type":"integer"},"expense_accrued":{"description":"exact minor units, rounded to twelve decimal places for display","type":"string"},"expense_amount":{"description":"recognised: Dr 5205 / Cr 2393","format":"int64","type":"integer"},"id":{"type":"string"},"income_accrued":{"description":"exact minor units, rounded to twelve decimal places for display","type":"string"},"income_amount":{"description":"recognised: Dr 1475 / Cr 4025 (a negative rate reverses it)","format":"int64","type":"integer"},"net_amount":{"description":"what the correspondent should credit (positive) or debit (negative)","format":"int64","type":"integer"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period":{"type":"string"},"run_by":{"type":"string"},"settled_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"settled_at":{"format":"date-time","type":"string"},"settlement_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"statement_item_ref":{"type":"string"},"status":{"description":"accrued or settled","type":"string"},"variance_amount":{"description":"settled less net, once settled","format":"int64","type":"integer"}},"required":["created_at","currency_code","days","expense_accrued","expense_amount","id","income_accrued","income_amount","net_amount","nostro_account_id","period","run_by","status","variance_amount"],"type":"object"},"InterestSchedule":{"properties":{"day_count":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"rate_bps":{"format":"int64","type":"integer"},"rounding":{"type":"string"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["day_count","maturity_date","principal_amount","rate_bps","rounding","start_date"],"type":"object"},"InterestScheduleCancellation":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["created_at","reason"],"type":"object"},"InterestScheduleRequest":{"description":"InterestScheduleRequest is a dated instruction from the owning servicing workflow. The ledger preserves its source; customer disclosure and approval belong upstream.","properties":{"actor":{"type":"string"},"annual_rate_bps":{"format":"int64","type":"integer"},"day_count":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source_ref":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]}},"required":["annual_rate_bps","day_count","effective_date","source_ref"],"type":"object"},"InterestTerms":{"description":"InterestTerms are the rates the correspondent pays on a credit balance (a negative rate is a charge on it) and charges on an overdrawn one.","properties":{"credit_rate_bps":{"format":"int64","type":"integer"},"day_count":{"type":"string"},"debit_rate_bps":{"format":"int64","type":"integer"}},"required":["credit_rate_bps","day_count","debit_rate_bps"],"type":"object"},"InvestmentsAccountingPlan":{"properties":{"correction_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence_sha256":{"type":"string"},"journal":{"$ref":"#/components/schemas/Journal"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"supersedes_sha256":{"type":"string"}},"required":["created_at","evidence_sha256","journal","journal_key","journal_sha256"],"type":"object"},"InvestmentsControl":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"custody_account":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsCustodyAccount"},{"type":"null"}]},"decision":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsDecision"},{"type":"null"}]},"id":{"type":"string"},"instrument":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsInstrument"},{"type":"null"}]},"kind":{"type":"string"},"program":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsProgram"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","kind"],"type":"object"},"InvestmentsCreateOrderRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cash_limit_amount":{"description":"BUY maximum total debit; SELL minimum net credit","format":"int64","type":"integer"},"currency_code":{"type":"string"},"custody_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disclosure_sha256":{"type":"string"},"instrument_id":{"type":"string"},"investment_consent":{"type":"boolean"},"limit_price":{"format":"int64","type":"integer"},"lot_id":{"type":"string"},"max_fee_amount":{"format":"int64","type":"integer"},"owner_id":{"type":"string"},"program_id":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"side":{"description":"BUY or SELL","type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"}},"required":["account_id","cash_limit_amount","currency_code","custody_account_id","disclosure_sha256","instrument_id","investment_consent","limit_price","max_fee_amount","owner_id","program_id","settlement_date","side","trade_date","units"],"type":"object"},"InvestmentsCustodyAccount":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"custodian_reference":{"type":"string"},"enabled":{"type":"boolean"},"exclusive_core_instructions":{"type":"boolean"},"external_account_reference":{"type":"string"},"key_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"onboarding":{"$ref":"#/components/schemas/InvestmentsDocument"},"opening_inventory_empty":{"description":"original onboarding, never a claim that today's tracked lot book is empty","type":"boolean"},"owner_id":{"type":"string"},"ownership":{"$ref":"#/components/schemas/InvestmentsEvidence"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"signature":{"type":"string"},"valid_until":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["account_id","custodian_reference","enabled","exclusive_core_instructions","external_account_reference","key_id","observed_at","onboarding","opening_inventory_empty","owner_id","ownership","program_id","program_sha256","signature","valid_until","version"],"type":"object"},"InvestmentsDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["actor","at","content_sha256","decision","note"],"type":"object"},"InvestmentsDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["content_sha256","decision","note"],"type":"object"},"InvestmentsDisclosure":{"properties":{"bank_remuneration":{"type":"string"},"broker_name":{"type":"string"},"confirmation_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"},"confirmation_provider":{"type":"string"},"custodian_name":{"type":"string"},"instrument":{"$ref":"#/components/schemas/InvestmentsInstrument"},"instrument_id":{"type":"string"},"instrument_sha256":{"type":"string"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"risk_disclosure":{"$ref":"#/components/schemas/InvestmentsEvidence"},"risk_notice":{"type":"string"},"sha256":{"type":"string"},"tax_reporter":{"type":"string"},"tax_reporting_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"}},"required":["bank_remuneration","broker_name","confirmation_agreement","confirmation_provider","custodian_name","instrument","instrument_id","instrument_sha256","program_id","program_sha256","risk_disclosure","risk_notice","sha256","tax_reporter","tax_reporting_agreement"],"type":"object"},"InvestmentsDocument":{"description":"Document retains the actual external bytes, not a mutable reference alone.","properties":{"data":{"format":"byte","type":"string"},"format":{"type":"string"},"sha256":{"type":"string"}},"required":["data","format","sha256"],"type":"object"},"InvestmentsEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"InvestmentsExecution":{"properties":{"broker_reference":{"type":"string"},"confirmation":{"$ref":"#/components/schemas/InvestmentsDocument"},"confirmation_delivery":{"$ref":"#/components/schemas/InvestmentsDocument"},"confirmation_received_at":{"format":"date-time","type":"string"},"counterparty":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"delivery_method":{"type":"string"},"delivery_recipient_id":{"type":"string"},"executed_at":{"format":"date-time","type":"string"},"execution_reference":{"type":"string"},"external_account_reference":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"owner_id":{"type":"string"},"price":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"side":{"type":"string"},"signature":{"type":"string"},"status":{"description":"executed, cancelled, rejected; full fill only","type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","confirmation","confirmation_delivery","confirmation_received_at","counterparty","currency_code","cusip","custodian_reference","delivered_at","delivery_method","delivery_recipient_id","executed_at","execution_reference","external_account_reference","fee_amount","instruction_sha256","key_id","net_cash_amount","observed_at","order_id","owner_id","price","principal_amount","side","signature","status","trade_date","units","version"],"type":"object"},"InvestmentsInstruction":{"description":"Instruction is the bank's immutable, independently reviewed command. Signed execution and settlement evidence attest its exact digest; an ACK is no fill.","properties":{"broker_reference":{"type":"string"},"cash_limit_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"custody_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"custody_account_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"id":{"type":"string"},"instrument_id":{"type":"string"},"instrument_sha256":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"limit_price":{"format":"int64","type":"integer"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"max_fee_amount":{"format":"int64","type":"integer"},"order_id":{"type":"string"},"owner_id":{"type":"string"},"price_scale":{"format":"int64","type":"integer"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"request_sha256":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"sha256":{"type":"string"},"side":{"type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"unit_basis":{"type":"string"},"unit_scale":{"format":"int64","type":"integer"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","cash_limit_amount","currency_code","cusip","custodian_reference","custody_account_id","custody_account_sha256","external_account_reference","id","instrument_id","instrument_sha256","issued_at","limit_price","max_fee_amount","order_id","owner_id","price_scale","program_id","program_sha256","request_sha256","settlement_date","sha256","side","trade_date","unit_basis","unit_scale","units","version"],"type":"object"},"InvestmentsInstrument":{"properties":{"currency_code":{"type":"string"},"cusip":{"type":"string"},"eligibility":{"$ref":"#/components/schemas/InvestmentsEvidence"},"enabled":{"type":"boolean"},"face_value_amount":{"description":"cents per whole bill unit; zero for shares","format":"int64","type":"integer"},"government_only":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"issue_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"kind":{"description":"treasury_bill or government_mmf","type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"name":{"type":"string"},"no_load":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"price_scale":{"format":"int64","type":"integer"},"program_id":{"type":"string"},"prospectus":{"$ref":"#/components/schemas/InvestmentsEvidence"},"unit_basis":{"description":"face_100_usd or share","type":"string"},"unit_increment":{"format":"int64","type":"integer"},"unit_scale":{"format":"int64","type":"integer"},"zero_coupon":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["currency_code","cusip","eligibility","enabled","face_value_amount","kind","name","price_scale","program_id","prospectus","unit_basis","unit_increment","unit_scale"],"type":"object"},"InvestmentsLot":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"acquired_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"actual_proceeds_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"disposal_distribution_id":{"type":"string"},"disposal_order_id":{"type":"string"},"exceptions":{"items":{"type":"string"},"type":"array"},"external_account_reference":{"type":"string"},"id":{"type":"string"},"instrument":{"$ref":"#/components/schemas/InvestmentsControl"},"instrument_id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"latest_observation":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsObservation"},{"type":"null"}]},"original_cost_amount":{"description":"actual BUY net cash, including fees","format":"int64","type":"integer"},"owner_id":{"type":"string"},"program":{"$ref":"#/components/schemas/InvestmentsControl"},"purchase_order_id":{"type":"string"},"reservation_revision":{"format":"int64","type":"integer"},"reserved_distribution_id":{"type":"string"},"reserved_order_id":{"type":"string"},"revision":{"format":"int64","type":"integer"},"settlement_sha256":{"type":"string"},"status":{"description":"active, selling, maturing, sold, matured, exception","type":"string"},"tax_basis_amount":{"description":"unknown unless actual custody source supplies it","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"units":{"description":"original whole-lot quantity; never mutated by a sale","format":"int64","type":"integer"}},"required":["account_id","acquired_date","exceptions","external_account_reference","id","instrument","instrument_id","journal_id","original_cost_amount","owner_id","program","purchase_order_id","revision","settlement_sha256","status","units"],"type":"object"},"InvestmentsObservation":{"properties":{"accrued_income_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"close_out_complete":{"type":"boolean"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"external_account_reference":{"type":"string"},"key_id":{"type":"string"},"lot_id":{"type":"string"},"market_value_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"observed_at":{"format":"date-time","type":"string"},"original_settlement_sha256":{"type":"string"},"owner_id":{"type":"string"},"price":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"signature":{"type":"string"},"tax_basis_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["as_of","close_out_complete","currency_code","cusip","custodian_reference","evidence","external_account_reference","key_id","lot_id","observed_at","original_settlement_sha256","owner_id","signature","units","version"],"type":"object"},"InvestmentsOrder":{"properties":{"accounting_plan_sha256":{"type":"string"},"accounting_plans":{"items":{"$ref":"#/components/schemas/InvestmentsAccountingPlan"},"type":"array"},"actor":{"type":"string"},"cash_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"custody_account":{"$ref":"#/components/schemas/InvestmentsControl"},"customer_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsDecision"},{"type":"null"}]},"exceptions":{"items":{"type":"string"},"type":"array"},"execution":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsExecution"},{"type":"null"}]},"id":{"type":"string"},"instruction":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsInstruction"},{"type":"null"}]},"instrument":{"$ref":"#/components/schemas/InvestmentsControl"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"program":{"$ref":"#/components/schemas/InvestmentsControl"},"request":{"$ref":"#/components/schemas/InvestmentsCreateOrderRequest"},"request_sha256":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/InvestmentsDecision"},"type":"array"},"screening_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"screening_ids":{"items":{"type":"string"},"type":"array"},"settlement":{"oneOf":[{"$ref":"#/components/schemas/InvestmentsSettlement"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/InvestmentsSource"},"status":{"type":"string"}},"required":["actor","created_at","custody_account","exceptions","id","instrument","program","request","request_sha256","source","status"],"type":"object"},"InvestmentsProgram":{"properties":{"agency_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"},"authority":{"$ref":"#/components/schemas/InvestmentsEvidence"},"bank_remuneration":{"description":"none; bank fee collection is a separate unsupported workflow","type":"string"},"bridge_subject":{"type":"string"},"broker_name":{"type":"string"},"broker_reference":{"type":"string"},"cash_rounding":{"description":"half_up_cent only","type":"string"},"confirmation_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"},"confirmation_provider":{"description":"broker_custodian only","type":"string"},"custodian_name":{"type":"string"},"custodian_reference":{"type":"string"},"custody_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"},"enabled":{"type":"boolean"},"evidence_keys":{"additionalProperties":{"type":"string"},"type":"object"},"legal_entity":{"type":"string"},"max_order_amount":{"format":"int64","type":"integer"},"provider":{"type":"string"},"risk_disclosure":{"$ref":"#/components/schemas/InvestmentsEvidence"},"tax_reporter":{"description":"broker_custodian only","type":"string"},"tax_reporting_agreement":{"$ref":"#/components/schemas/InvestmentsEvidence"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["agency_agreement","authority","bank_remuneration","bridge_subject","broker_name","broker_reference","cash_rounding","confirmation_agreement","confirmation_provider","custodian_name","custodian_reference","custody_agreement","enabled","evidence_keys","legal_entity","max_order_amount","provider","risk_disclosure","tax_reporter","tax_reporting_agreement","valid_from","valid_through"],"type":"object"},"InvestmentsSettlement":{"properties":{"broker_reference":{"type":"string"},"cash_evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"cash_reference":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"delivery_evidence":{"$ref":"#/components/schemas/InvestmentsDocument"},"delivery_reference":{"type":"string"},"execution_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"owner_id":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"settled_at":{"format":"date-time","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"settlement_reference":{"type":"string"},"side":{"type":"string"},"signature":{"type":"string"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","cash_evidence","cash_reference","currency_code","cusip","custodian_reference","delivery_evidence","delivery_reference","execution_sha256","external_account_reference","fee_amount","instruction_sha256","key_id","net_cash_amount","observed_at","order_id","owner_id","principal_amount","settled_at","settlement_date","settlement_reference","side","signature","units","version"],"type":"object"},"InvestmentsSnapshot":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"captured_at":{"format":"date-time","type":"string"},"distributions":{"items":{"$ref":"#/components/schemas/DistributionObservation"},"type":"array"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"observation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"orders":{"items":{"$ref":"#/components/schemas/OrderObservation"},"type":"array"},"positions":{"items":{"$ref":"#/components/schemas/PositionObservation"},"type":"array"},"ready":{"type":"boolean"},"source_sha256":{"type":"string"}},"required":["blockers","captured_at","distributions","master_cash_ledger_account_id","observation_date","orders","positions","ready","source_sha256"],"type":"object"},"InvestmentsSource":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"captured_at":{"format":"date-time","type":"string"},"custody_ownership":{"$ref":"#/components/schemas/InvestmentsEvidence"},"external_account_reference":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owner_id":{"type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"ownership_sha256":{"type":"string"}},"required":["account_id","captured_at","custody_ownership","external_account_reference","ledger_account_id","owner_id","ownership_revision","ownership_sha256"],"type":"object"},"Invoice":{"description":"Invoice is one invoice a remittance pays.","properties":{"amount":{"format":"int64","type":"integer"},"number":{"type":"string"}},"required":["amount","number"],"type":"object"},"InvoiceLine":{"description":"InvoiceLine is one billed charge: a payment charge naming its UETR, or a monthly fee code.","properties":{"amount":{"format":"int64","type":"integer"},"code":{"type":"string"},"description":{"type":"string"},"uetr":{"type":"string"}},"required":["amount","code"],"type":"object"},"InvoiceLineMatch":{"description":"InvoiceLineMatch is the matching of one line.","properties":{"amount":{"format":"int64","type":"integer"},"charge_id":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"expected_amount":{"format":"int64","type":"integer"},"outcome":{"type":"string"},"uetr":{"type":"string"},"variance_amount":{"description":"billed less expected","format":"int64","type":"integer"}},"required":["amount","code","expected_amount","outcome","variance_amount"],"type":"object"},"InvoiceRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"carrier_id":{"type":"string"},"contract_id":{"type":"string"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"period_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_until":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"stops":{"format":"int64","type":"integer"}},"required":["amount","carrier_id","contract_id","evidence","evidence_sha256","period_from","period_until","reference","stops"],"type":"object"},"Iso20022StatementEntry":{"description":"StatementEntry is one entry read at its currency's scale: the account servicer's references, the direction, the dates, the ISO bank transaction code, the references of the first transaction behind it, the charges it says are already included in its amount and the interest periods an interest entry covers.","properties":{"additional_info":{"type":"string"},"amount":{"format":"int64","type":"integer"},"booking_date":{"description":"YYYY-MM-DD, the date part of a date-time","type":"string"},"charge_bearer":{"type":"string"},"currency_code":{"type":"string"},"direction":{"description":"credit or debit","type":"string"},"domain":{"type":"string"},"end_to_end_id":{"type":"string"},"entry_reference":{"type":"string"},"family":{"type":"string"},"included_charges_amount":{"description":"charges records marked included in the amount","format":"int64","type":"integer"},"index":{"description":"zero-based position of the entry on its page","format":"int64","type":"integer"},"instruction_id":{"type":"string"},"interest_from":{"type":"string"},"interest_to":{"type":"string"},"message_id":{"type":"string"},"owner_transaction_id":{"type":"string"},"proprietary_code":{"type":"string"},"proprietary_issuer":{"type":"string"},"remittance":{"type":"string"},"reversal":{"type":"boolean"},"servicer_reference":{"type":"string"},"status":{"description":"BOOK, PDNG or INFO","type":"string"},"sub_family":{"type":"string"},"transaction_id":{"type":"string"},"uetr":{"type":"string"},"value_date":{"type":"string"}},"required":["amount","currency_code","direction","index","status"],"type":"object"},"Issue":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"provider_list":{"oneOf":[{"$ref":"#/components/schemas/ProviderListDocument"},{"type":"null"}]},"retain_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"revision_id":{"type":"string"},"sha256":{"type":"string"},"template":{"type":"string"}},"required":["actor","at","retain_through","revision_id","sha256","template"],"type":"object"},"IssueInput":{"description":"IssueInput is one check the customer wrote.","properties":{"amount":{"format":"int64","type":"integer"},"check_number":{"type":"string"},"issued_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"payee":{"type":"string"},"void":{"type":"boolean"}},"required":["amount","check_number"],"type":"object"},"IssueOfficialCheckRequest":{"description":"IssueOfficialCheckRequest buys a cashier's check.","properties":{"account_id":{"description":"the remitter's account, debited","example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"gl_code":{"description":"or the bank's own GL account","type":"string"},"memo":{"type":"string"},"payee":{"type":"string"},"payee_address":{"description":"where a check bought to pay a bill is mailed","oneOf":[{"$ref":"#/components/schemas/PostalAddress"},{"type":"null"}]},"remitter":{"type":"string"},"requested_by":{"type":"string"}},"required":["amount","currency_code","payee","requested_by"],"type":"object"},"IssueRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cardholder_authority_id":{"example":"chra_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cardholder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"facility_id":{"type":"string"},"form":{"type":"string"},"kind":{"type":"string"},"network":{"type":"string"}},"required":["network"],"type":"object"},"IssuedAPIKey":{"description":"IssuedAPIKey returns its secret once. Subsequent reads contain metadata only.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"last_used_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"name":{"type":"string"},"revoked_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"scopes":{"items":{"type":"string"},"type":"array"},"secret":{"type":"string"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_ids","created_at","expires_at","id","name","scopes","secret","user_id"],"type":"object"},"Item":{"properties":{"amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"payee":{"type":"string"},"purpose":{"type":"string"}},"required":["amount","date","evidence","payee","purpose"],"type":"object"},"ItemDecision":{"description":"ItemDecision is the lender's decision on one collateral item.","properties":{"item_reference":{"type":"string"},"kind":{"description":"loan or security","type":"string"},"operator_reference":{"description":"the Fedwire Securities transfer of a pledge or a release","type":"string"},"par_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"reference":{"description":"the loan id or the CUSIP","type":"string"},"status":{"description":"accepted, refused, withdrawn or released","type":"string"}},"required":["kind","reference","status"],"type":"object"},"ItemReview":{"description":"ItemReview records one reviewer decision: a withholding basis, or `cleared` for an item the reviewer has read and found producible. Every collected item takes exactly one. A flagged item (bsa_indicator, binary_content_unscanned, attachments_incomplete) is decided on its own; ThroughOrdinal clears a page of at most 200 consecutive unflagged, undecided items in one attested decision and is refused if the range holds anything else.","properties":{"basis":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"ordinal":{"format":"int64","type":"integer"},"reason":{"type":"string"},"through_ordinal":{"format":"int64","type":"integer"}},"required":["basis","evidence_ref","evidence_sha256","ordinal","reason"],"type":"object"},"Job":{"properties":{"actor":{"type":"string"},"attachments_failed":{"format":"int64","type":"integer"},"attachments_pending":{"format":"int64","type":"integer"},"category":{"type":"string"},"chain_sha256":{"type":"string"},"complete":{"description":"Complete is true once every source page is archived and every attachment those pages\ndeclared is captured or recorded as a failure; SourceComplete covers the pages alone.","type":"boolean"},"created_at":{"format":"date-time","type":"string"},"cursor":{"format":"int64","type":"integer"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/IngestRequest"},"snapshot":{"oneOf":[{"$ref":"#/components/schemas/RecordsourceSnapshot"},{"type":"null"}]},"source_complete":{"type":"boolean"},"target":{"$ref":"#/components/schemas/Target"}},"required":["actor","category","chain_sha256","complete","created_at","cursor","id","request","target"],"type":"object"},"JoinEvidence":{"properties":{"key":{"type":"string"},"relationship":{"type":"string"},"table":{"type":"string"}},"required":["key","relationship","table"],"type":"object"},"Journal":{"description":"Journal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.","properties":{"adjusts_period":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entries":{"items":{"$ref":"#/components/schemas/Entry"},"type":"array"},"kind":{"type":"string"},"protected_command_id":{"type":"string"},"reason":{"type":"string"},"release_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"require_available":{"type":"boolean"},"reversal_of":{"type":"string"},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["effective_date","entries","kind","protected_command_id","source_ref","source_service"],"type":"object"},"JournalEvidenceClaim":{"properties":{"actor":{"type":"string"},"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"execution_sha256":{"type":"string"},"instruction_sha256":{"type":"string"},"investment_distribution_id":{"type":"string"},"investment_order_id":{"type":"string"},"journal_sha256":{"type":"string"},"journals":{"items":{"$ref":"#/components/schemas/JournalEvidenceReference"},"type":"array"},"placement_id":{"type":"string"},"proposed_by":{"type":"string"},"receipt_sha256":{"type":"string"},"reconciliation_id":{"type":"string"},"redemption_id":{"type":"string"},"redemption_request_sha256":{"type":"string"},"redemption_requested_by":{"type":"string"},"reviewed_by":{"type":"string"},"scheme_action_id":{"type":"string"},"scheme_amount_minor":{"description":"signed network/cash movement; positive loss/allocation","format":"int64","type":"integer"},"scheme_case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"scheme_claim_kind":{"description":"network, cash, loss or allocation","type":"string"},"scheme_dispute_id":{"type":"string"},"scheme_loss_action_id":{"type":"string"}},"required":["actor","content_sha256","created_at","journals","proposed_by","reviewed_by"],"type":"object"},"JournalEvidenceClaimRequest":{"description":"The owning service attests identities it authenticated and retained independently.","properties":{"assessment_id":{"example":"cpas_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"complaint_id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"execution_sha256":{"type":"string"},"instruction_sha256":{"type":"string"},"investment_distribution_id":{"type":"string"},"investment_order_id":{"type":"string"},"journal_sha256":{"type":"string"},"journals":{"items":{"$ref":"#/components/schemas/JournalEvidenceReference"},"type":"array"},"placement_id":{"type":"string"},"proposed_by":{"type":"string"},"receipt_sha256":{"type":"string"},"reconciliation_id":{"type":"string"},"redemption_id":{"type":"string"},"redemption_request_sha256":{"type":"string"},"redemption_requested_by":{"type":"string"},"reviewed_by":{"type":"string"},"scheme_action_id":{"type":"string"},"scheme_amount_minor":{"description":"signed network/cash movement; positive loss/allocation","format":"int64","type":"integer"},"scheme_case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"scheme_claim_kind":{"description":"network, cash, loss or allocation","type":"string"},"scheme_dispute_id":{"type":"string"},"scheme_loss_action_id":{"type":"string"}},"required":["content_sha256","journals","proposed_by","reviewed_by"],"type":"object"},"JournalEvidenceReference":{"properties":{"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"key":{"type":"string"}},"required":["journal_id","key"],"type":"object"},"JournalResult":{"description":"JournalResult is the reconciliation of one journal transaction.","properties":{"journal_amount":{"format":"int64","type":"integer"},"result":{"description":"matched, completed_from_journal, mismatch, unknown_to_switch, missing_from_journal","type":"string"},"serial":{"type":"string"},"switch_amount":{"format":"int64","type":"integer"},"transaction_id":{"type":"string"}},"required":["journal_amount","result","serial","switch_amount"],"type":"object"},"JournalSourcePin":{"properties":{"actor":{"type":"string"},"amount_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"debit_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal":{"$ref":"#/components/schemas/JournalEvidenceReference"},"journal_sha256":{"type":"string"},"proposed_by":{"type":"string"},"purpose":{"type":"string"},"reference_id":{"type":"string"},"reviewed_by":{"type":"string"},"source_id":{"type":"string"},"source_ref":{"type":"string"}},"required":["actor","amount_minor","content_sha256","created_at","debit_ledger_account_id","journal","journal_sha256","proposed_by","purpose","reference_id","reviewed_by","source_id","source_ref"],"type":"object"},"JournalSourcePinRequest":{"description":"JournalSourcePin retains nonexclusive reliance on an original posting. It prevents reversal without consuming another workflow's exclusive claim.","properties":{"amount_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"debit_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal":{"$ref":"#/components/schemas/JournalEvidenceReference"},"journal_sha256":{"type":"string"},"proposed_by":{"type":"string"},"purpose":{"type":"string"},"reference_id":{"type":"string"},"reviewed_by":{"type":"string"},"source_id":{"type":"string"},"source_ref":{"type":"string"}},"required":["amount_minor","content_sha256","debit_ledger_account_id","journal","journal_sha256","proposed_by","purpose","reference_id","reviewed_by","source_id","source_ref"],"type":"object"},"JournalUpload":{"description":"JournalUpload is a retained electronic journal range and its reconciliation.","properties":{"completed":{"description":"suspect transactions the journal completed","items":{"type":"string"},"type":"array"},"content_sha256":{"type":"string"},"exceptions":{"items":{"type":"string"},"type":"array"},"first_sequence":{"format":"int64","type":"integer"},"id":{"type":"string"},"last_sequence":{"format":"int64","type":"integer"},"matched":{"description":"transactions the journal agrees with","items":{"type":"string"},"type":"array"},"outcomes":{"items":{"$ref":"#/components/schemas/JournalResult"},"type":"array"},"received_at":{"format":"date-time","type":"string"},"records":{"format":"int64","type":"integer"},"terminal_ref":{"type":"string"}},"required":["completed","content_sha256","exceptions","first_sequence","id","last_sequence","matched","outcomes","received_at","records","terminal_ref"],"type":"object"},"JurisdictionChange":{"description":"JurisdictionChange is a recorded change to the sanctioned-jurisdiction list: a seed row or a proposal with its decision.","properties":{"action":{"description":"add or remove","type":"string"},"country":{"type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision":{"description":"seed, pending, approved, rejected, withdrawn","type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"description":"0 for a seed row","format":"int64","type":"integer"},"note":{"type":"string"},"postal_prefix":{"description":"a postal-code prefix within the country; empty for the whole country","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"reason":{"type":"string"},"region":{"description":"an ISO 3166-2 subdivision of the country; empty for the whole country","type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["action","country","decision","effective_from","proposed_at","proposed_by","reason"],"type":"object"},"JurisdictionList":{"description":"JurisdictionList is the sanctioned jurisdictions and areas in force on a date, and every change.","properties":{"areas":{"items":{"$ref":"#/components/schemas/SanctionedArea"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"countries":{"items":{"type":"string"},"type":"array"},"history":{"items":{"$ref":"#/components/schemas/JurisdictionChange"},"type":"array"}},"required":["areas","business_date","countries","history"],"type":"object"},"JurisdictionProposal":{"description":"JurisdictionProposal adds or removes a jurisdiction, or a region or postal prefix of one, from a later date; it is in force once a second staff member approves it.","properties":{"action":{"description":"add or remove","type":"string"},"country":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"postal_prefix":{"type":"string"},"reason":{"type":"string"},"region":{"type":"string"}},"required":["action","country","effective_from","reason"],"type":"object"},"KYCCheck":{"properties":{"business_parties_version":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"type":"string"},"evidence":{"description":"the vendor evaluation the decision rests on; absent for the simulator","oneOf":[{"$ref":"#/components/schemas/KYCEvidence"},{"type":"null"}]},"id":{"example":"kycc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"provider":{"type":"string"},"provider_ref":{"type":"string"},"reasons":{"items":{"type":"string"},"type":"array"},"risk_rating":{"type":"string"}},"required":["customer_id","decision","id","provider","provider_ref","reasons","risk_rating"],"type":"object"},"KYCDecision":{"properties":{"business_parties_version":{"format":"int64","type":"integer"},"provider_ref":{"type":"string"},"reason":{"type":"string"},"risk_rating":{"type":"string"},"status":{"type":"string"}},"required":["provider_ref","status"],"type":"object"},"KYCEvidence":{"description":"KYCEvidence identifies a vendor evaluation: the SHA-256 of the vendor's response, its status, outcome and reason codes, and the tokens that find it at the vendor. Never a document image or a tax id.","properties":{"entity_tokens":{"items":{"type":"string"},"type":"array"},"evaluation_tokens":{"items":{"type":"string"},"type":"array"},"journey_application_token":{"type":"string"},"journey_token":{"type":"string"},"outcome":{"type":"string"},"provider":{"type":"string"},"reason_codes":{"items":{"type":"string"},"type":"array"},"recorded_at":{"format":"date-time","type":"string"},"response_digest":{"type":"string"},"status":{"type":"string"}},"required":["entity_tokens","evaluation_tokens","journey_application_token","journey_token","outcome","provider","reason_codes","recorded_at","response_digest","status"],"type":"object"},"KeyCeremony":{"description":"KeyCeremony is one dual-control ceremony.","properties":{"components":{"items":{"$ref":"#/components/schemas/CeremonyComponent"},"type":"array"},"components_required":{"format":"int64","type":"integer"},"decimalization":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CeremonyDecision"},{"type":"null"}]},"document_sha256":{"type":"string"},"id":{"type":"string"},"kek_key_id":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"network":{"type":"string"},"opened_at":{"format":"date-time","type":"string"},"opened_by":{"type":"string"},"pvki":{"format":"int64","type":"integer"},"reason":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"result_key_id":{"type":"string"},"status":{"type":"string"},"template":{"$ref":"#/components/schemas/KeyTemplate"},"updated_at":{"format":"date-time","type":"string"},"zone_key_index":{"type":"string"}},"required":["components","components_required","document_sha256","id","kind","label","network","opened_at","opened_by","pvki","reason","status","template","updated_at"],"type":"object"},"KeyTemplate":{"description":"KeyTemplate names the attributes of a key the HSM creates or imports.","properties":{"algorithm":{"description":"T (TDEA), A (AES) or H (HMAC)","type":"string"},"exportability":{"description":"E or N","type":"string"},"key_version":{"description":"two characters; \"00\" when unversioned","type":"string"},"length":{"description":"key length in bytes","format":"int64","type":"integer"},"mode_of_use":{"description":"one character, for example B","type":"string"},"usage":{"description":"ANSI X9.143 key usage, for example P0","type":"string"}},"required":["algorithm","exportability","key_version","length","mode_of_use","usage"],"type":"object"},"Kind":{"description":"Kind is a source the reporting service computes for one schedule from retained core data. Each kind accounts for every declared position of its schedule: a capture either supplies a position from retained data or explains why it cannot, and a zero is never a substitute.","properties":{"data":{"type":"string"},"description":{"type":"string"},"kind":{"type":"string"},"period":{"type":"string"},"positions":{"items":{"$ref":"#/components/schemas/Fry9spPosition"},"type":"array"},"schedule":{"type":"string"}},"required":["data","description","kind","period","positions","schedule"],"type":"object"},"LedgerAccount":{"properties":{"address":{"$ref":"#/components/schemas/LedgerAddress"},"allow_negative":{"type":"boolean"},"gl_code":{"type":"string"},"id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"normal_balance":{"type":"string"},"protected_purpose":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"}},"required":["address","allow_negative","gl_code","id","normal_balance","status","type"],"type":"object"},"LedgerAccrual":{"properties":{"accrued":{"type":"string"},"basis_amount":{"description":"final day; daily_balances contains every dated principal","format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cumulative":{"type":"string"},"daily_balances":{"items":{"$ref":"#/components/schemas/LedgerDailyInterestBalance"},"type":"array"},"day_count":{"type":"string"},"days":{"format":"int64","type":"integer"},"posted_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rate":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]}},"required":["accrued","basis_amount","business_date","cumulative","days","posted_journal_id","rate"],"type":"object"},"LedgerActivity":{"properties":{"closing_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"entries":{"items":{"$ref":"#/components/schemas/LedgerEntryLine"},"type":"array"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opening_amount":{"format":"int64","type":"integer"}},"required":["closing_amount","currency_code","entries","ledger_account_id","opening_amount"],"type":"object"},"LedgerAddress":{"description":"Address of a ledger account.","properties":{"currency_code":{"type":"string"},"legal_entity":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"owner":{"type":"string"}},"required":["currency_code","legal_entity","name","namespace","owner"],"type":"object"},"LedgerAvailabilityRequest":{"properties":{"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"release_ids":{"items":{"type":"string"},"type":"array"},"tranches":{"items":{"$ref":"#/components/schemas/LedgerAvailabilityTranche"},"type":"array"}},"required":["ledger_account_id","release_ids","tranches"],"type":"object"},"LedgerAvailabilityTranche":{"properties":{"amount":{"format":"int64","type":"integer"},"expires_at":{"format":"date-time","type":"string"}},"required":["amount","expires_at"],"type":"object"},"LedgerBalances":{"description":"Balance reads a named balance definition. Balances are the posted and available balances with active holds by kind.","properties":{"available_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"holds":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"holds_amount":{"format":"int64","type":"integer"},"last_activity_at":{"description":"the last journal the customer initiated (not interest, fees or corrections)","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"last_activity_date":{"description":"its effective date; dormancy counts from here","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posted_amount":{"format":"int64","type":"integer"}},"required":["available_amount","currency_code","holds","holds_amount","ledger_account_id","posted_amount"],"type":"object"},"LedgerBorrowing":{"description":"Borrowing is money the bank borrowed: a Federal Home Loan Bank or discount window advance from a reviewed lender in the collateral register.","properties":{"accrued_interest_amount":{"description":"accrued since the last month-end, owed on top of outstanding","format":"int64","type":"integer"},"annual_rate_bps":{"format":"int64","type":"integer"},"approved_by":{"type":"string"},"collateral_pledged_amount":{"description":"the register's lendable value for the lender when the advance was drawn","format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender":{"type":"string"},"lender_id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"},"repaid_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"}},"required":["accrued_interest_amount","annual_rate_bps","collateral_pledged_amount","created_at","id","journal_id","kind","ledger_account_id","lender","maturity_date","outstanding_amount","principal_amount","status"],"type":"object"},"LedgerBorrowingOption":{"description":"BorrowingOption is one option or embedded derivative an advance's agreement contains: call (the lender may call it), conversion (the lender may convert it to floating), put (the bank may prepay without penalty), cap, floor or other_embedded_derivative.","properties":{"description":{"type":"string"},"exercised_date":{"description":"call or put exercised: the date it repays the advance","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"first_exercise_date":{"description":"call, conversion and put","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"kind":{"type":"string"}},"required":["description","kind"],"type":"object"},"LedgerBorrowingProposal":{"description":"BorrowingProposal is a draw waiting for a second treasury approver.","properties":{"borrowing_id":{"type":"string"},"id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/LedgerBorrowingRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["id","maker","recorded_at","request","status"],"type":"object"},"LedgerBorrowingRequest":{"description":"BorrowingRequest draws an advance from a reviewed lender; kind must match the lender's kind.","properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"kind":{"type":"string"},"lender_id":{"format":"int64","type":"integer"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"}},"required":["annual_rate_bps","kind","lender_id","maturity_date","principal_amount"],"type":"object"},"LedgerBorrowingStructureTerms":{"description":"BorrowingStructureTerms is a retained version of an advance's terms and its review.","properties":{"borrowing_id":{"type":"string"},"content_sha256":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"maker":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/LedgerBorrowingOption"},"type":"array"},"rate_type":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"source_sha256":{"type":"string"},"status":{"description":"pending_review, approved or rejected","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["borrowing_id","content_sha256","effective_date","maker","options","rate_type","recorded_at","source_ref","source_sha256","status","version"],"type":"object"},"LedgerBorrowingStructureTermsRequest":{"description":"BorrowingStructureTermsRequest records an advance's fixed-rate terms from an effective date, pending independent review; an empty options list attests the agreement contains none.","properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"options":{"items":{"$ref":"#/components/schemas/LedgerBorrowingOption"},"type":"array"},"rate_type":{"description":"fixed; floating is refused","type":"string"},"source_ref":{"type":"string"},"source_sha256":{"type":"string"}},"required":["effective_date","options","rate_type","source_ref","source_sha256"],"type":"object"},"LedgerChartLine":{"description":"ChartLine is one row of the chart of accounts.","properties":{"call_report_line":{"type":"string"},"gl_code":{"type":"string"},"is_control":{"type":"boolean"},"name":{"type":"string"},"normal_balance":{"type":"string"},"type":{"type":"string"}},"required":["call_report_line","gl_code","is_control","name","normal_balance","type"],"type":"object"},"LedgerCheckConsumptionRequest":{"properties":{"journal":{"$ref":"#/components/schemas/LedgerjournalRequest"},"sources":{"items":{"$ref":"#/components/schemas/JournalEvidenceReference"},"type":"array"}},"required":["journal","sources"],"type":"object"},"LedgerCheckSourceReservation":{"properties":{"key":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/JournalEvidenceReference"},"type":"array"}},"required":["key","sources"],"type":"object"},"LedgerCheckSourceReservationRequest":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/JournalEvidenceReference"},"type":"array"}},"required":["sources"],"type":"object"},"LedgerClosingFee":{"properties":{"amount":{"format":"int64","type":"integer"},"kind":{"type":"string"},"waiver_min_balance":{"format":"int64","type":"integer"}},"required":["amount","kind","waiver_min_balance"],"type":"object"},"LedgerClosure":{"properties":{"closing_fee_amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"interest_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"key":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_amount":{"format":"int64","type":"integer"},"payout_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payout_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"remittance_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"remitted_amount":{"format":"int64","type":"integer"},"rounding_adjustment":{"type":"string"},"withheld_amount":{"format":"int64","type":"integer"},"withholding_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["closing_fee_amount","date","interest_amount","key","ledger_account_id","payout_amount","payout_ledger_account_id","principal_amount","remitted_amount","rounding_adjustment","withheld_amount"],"type":"object"},"LedgerClosureRequest":{"properties":{"actor":{"type":"string"},"fees":{"items":{"$ref":"#/components/schemas/LedgerClosingFee"},"type":"array"},"payout_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"remit_interest":{"type":"boolean"},"withholding_bps":{"format":"int64","type":"integer"}},"required":["actor","payout_ledger_account_id","reason","remit_interest","withholding_bps"],"type":"object"},"LedgerCollateralAsset":{"description":"CollateralAsset is one bank-owned asset the register values.","properties":{"asset_class":{"type":"string"},"id":{"format":"int64","type":"integer"},"kind":{"description":"securities_lot or loan","type":"string"},"loan":{"oneOf":[{"$ref":"#/components/schemas/LedgerLoanCollateralFacts"},{"type":"null"}]},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"maturity_unresolved":{"type":"boolean"},"reference":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"valuation_as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valuation_basis":{"type":"string"},"valuation_sha256":{"type":"string"},"value_amount":{"format":"int64","type":"integer"}},"required":["asset_class","id","kind","maturity_unresolved","reference","updated_at","valuation_as_of","valuation_basis","value_amount"],"type":"object"},"LedgerCollateralBreak":{"description":"CollateralBreak is one difference between a lender's statement and the register, or a lender-acknowledged pledge whose asset ended (no statement, the pledge named instead).","properties":{"id":{"format":"int64","type":"integer"},"kind":{"description":"missing_at_lender, missing_in_register, value_difference, capacity_difference or pledged_asset_ended","type":"string"},"lender_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"opened_at":{"format":"date-time","type":"string"},"pledge_id":{"description":"the pledge a pledged_asset_ended break names","format":"int64","type":"integer"},"reference":{"type":"string"},"register_amount":{"format":"int64","type":"integer"},"resolution":{"type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"resolved_by":{"type":"string"},"statement_id":{"description":"zero for a pledged_asset_ended break","format":"int64","type":"integer"}},"required":["id","kind","lender_amount","lender_id","opened_at","register_amount","statement_id"],"type":"object"},"LedgerCollateralBreakResolution":{"description":"CollateralBreakResolution closes a break with a reason.","properties":{"resolution":{"type":"string"}},"required":["resolution"],"type":"object"},"LedgerCollateralClass":{"description":"CollateralClass is one asset class on a lender's schedule.","properties":{"asset_class":{"description":"us_treasury, agency_mbs, residential_mortgage_1_4, commercial_real_estate, commercial_and_industrial, consumer, other","type":"string"},"eligible":{"type":"boolean"},"haircut_bps":{"format":"int64","type":"integer"},"max_days_past_due":{"format":"int64","type":"integer"},"valuation_basis":{"description":"market_value for securities, unpaid_principal for loans","type":"string"}},"required":["asset_class","eligible","haircut_bps"],"type":"object"},"LedgerCollateralCloseReadiness":{"description":"CollateralCloseReadiness is whether the register lets the bank close the business date: no break or lender statement awaiting review or reconciliation beyond the reviewed tolerance (any age without approved parameters), no reserved or acknowledged pledge on a matured or ineligible asset, and no lender whose advances exceed its lendable value.","properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ineligible_pledges":{"format":"int64","type":"integer"},"lenders":{"items":{"$ref":"#/components/schemas/LedgerCollateralLenderPosition"},"type":"array"},"lenders_short":{"format":"int64","type":"integer"},"matured_pledges":{"format":"int64","type":"integer"},"max_break_age_days":{"format":"int64","type":"integer"},"oldest_break_days":{"format":"int64","type":"integer"},"open_breaks":{"format":"int64","type":"integer"},"parameters_approved":{"type":"boolean"},"ready":{"type":"boolean"},"statements_awaiting_reconciliation":{"format":"int64","type":"integer"},"statements_awaiting_review":{"format":"int64","type":"integer"}},"required":["blockers","business_date","ineligible_pledges","lenders","lenders_short","matured_pledges","max_break_age_days","oldest_break_days","open_breaks","parameters_approved","ready","statements_awaiting_reconciliation","statements_awaiting_review"],"type":"object"},"LedgerCollateralLender":{"description":"CollateralLender is a retained lender record and its review.","properties":{"evidence_keys":{"additionalProperties":{"type":"string"},"type":"object"},"gl_code":{"description":"the liability control the lender's advances post under: 2410, 2420 or 2430","type":"string"},"id":{"format":"int64","type":"integer"},"identifiers":{"additionalProperties":{"type":"string"},"type":"object"},"kind":{"type":"string"},"legal_name":{"type":"string"},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["evidence_keys","gl_code","id","identifiers","kind","legal_name","maker","recorded_at","status"],"type":"object"},"LedgerCollateralLenderPosition":{"description":"CollateralLenderPosition is one approved lender's position as the close saw it.","properties":{"capacity_amount":{"format":"int64","type":"integer"},"latest_statement_id":{"format":"int64","type":"integer"},"latest_statement_status":{"type":"string"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"live_pledges":{"format":"int64","type":"integer"},"outstanding_amount":{"format":"int64","type":"integer"},"schedule_id":{"format":"int64","type":"integer"},"shortfall_amount":{"format":"int64","type":"integer"}},"required":["capacity_amount","lendable_amount","lender_id","lender_kind","live_pledges","outstanding_amount","shortfall_amount"],"type":"object"},"LedgerCollateralLenderRequest":{"description":"CollateralLenderRequest records a lender the bank borrows from.","properties":{"evidence_keys":{"additionalProperties":{"type":"string"},"description":"key id to base64 ed25519 public key the lender signs statements with","type":"object"},"identifiers":{"additionalProperties":{"type":"string"},"type":"object"},"kind":{"description":"fhlb, federal_reserve_discount_window or repo_counterparty","type":"string"},"legal_name":{"type":"string"}},"required":["evidence_keys","kind","legal_name"],"type":"object"},"LedgerCollateralParameterRequest":{"description":"CollateralParameterRequest records the register's parameters from an effective date.","properties":{"break_block_age_days":{"description":"an open reconciliation break older than this blocks the bank's close","format":"int64","type":"integer"},"draw_approval_threshold_amount":{"description":"a draw above it needs a second treasury approver","format":"int64","type":"integer"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source_ref":{"type":"string"}},"required":["break_block_age_days","draw_approval_threshold_amount","effective_date","source_ref"],"type":"object"},"LedgerCollateralParameters":{"description":"CollateralParameters is a retained parameter instruction and its review.","properties":{"break_block_age_days":{"format":"int64","type":"integer"},"draw_approval_threshold_amount":{"format":"int64","type":"integer"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"status":{"type":"string"}},"required":["break_block_age_days","draw_approval_threshold_amount","effective_date","id","maker","recorded_at","source_ref","status"],"type":"object"},"LedgerCollateralPledge":{"description":"CollateralPledge is one asset's pledge to a lender with its latest evaluation.","properties":{"asset":{"$ref":"#/components/schemas/LedgerCollateralAsset"},"created_at":{"format":"date-time","type":"string"},"eligible":{"type":"boolean"},"haircut_bps":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"ineligibility":{"items":{"type":"string"},"type":"array"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"pledge_reference":{"type":"string"},"state":{"description":"reserved, pledged, releasing or released","type":"string"},"updated_at":{"format":"date-time","type":"string"},"value_amount":{"format":"int64","type":"integer"}},"required":["asset","created_at","eligible","haircut_bps","id","ineligibility","lendable_amount","lender_id","maker","state","updated_at","value_amount"],"type":"object"},"LedgerCollateralPledgePosition":{"description":"CollateralPledgePosition is one pledge as it stood at the close of a business date.","properties":{"asset_class":{"type":"string"},"asset_kind":{"type":"string"},"event_sequence":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"pledge_id":{"format":"int64","type":"integer"},"pledge_reference":{"type":"string"},"reference":{"type":"string"},"since":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"state":{"description":"reserved, pledged or releasing","type":"string"}},"required":["asset_class","asset_kind","event_sequence","lender_id","lender_kind","pledge_id","reference","since","state"],"type":"object"},"LedgerCollateralPledgePositions":{"description":"CollateralPledgePositions are the pledges live at the close of a business date that has ended, replayed from the register's retained events; UndatedPledges cannot be placed at the date.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"positions":{"items":{"$ref":"#/components/schemas/LedgerCollateralPledgePosition"},"type":"array"},"undated_pledges":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["as_of","business_date","positions","undated_pledges"],"type":"object"},"LedgerCollateralPledgeRequest":{"description":"CollateralPledgeRequest reserves an asset for a lender.","properties":{"asset_kind":{"description":"securities_lot or loan","type":"string"},"lender_id":{"format":"int64","type":"integer"},"reference":{"description":"the lot or loan id","type":"string"}},"required":["asset_kind","lender_id","reference"],"type":"object"},"LedgerCollateralPledgeTransition":{"description":"CollateralPledgeTransition moves a pledge to pledged (with the lender's reference), releasing or released.","properties":{"reference":{"type":"string"},"state":{"type":"string"}},"required":["state"],"type":"object"},"LedgerCollateralReconciliation":{"description":"CollateralReconciliation is a lender's latest statement, the register's position and the open breaks.","properties":{"capacity":{"$ref":"#/components/schemas/LedgerLenderCapacity"},"lender_id":{"format":"int64","type":"integer"},"open_breaks":{"items":{"$ref":"#/components/schemas/LedgerCollateralBreak"},"type":"array"},"statement":{"oneOf":[{"$ref":"#/components/schemas/LedgerCollateralStatementRecord"},{"type":"null"}]}},"required":["capacity","lender_id","open_breaks"],"type":"object"},"LedgerCollateralSchedule":{"description":"CollateralSchedule is a retained schedule and its review.","properties":{"classes":{"items":{"$ref":"#/components/schemas/LedgerCollateralClass"},"type":"array"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"excludes_charged_off":{"type":"boolean"},"excludes_nonaccrual":{"type":"boolean"},"excludes_sold_portion":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"maturity_beyond_advance":{"type":"boolean"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"status":{"type":"string"}},"required":["classes","effective_date","excludes_charged_off","excludes_nonaccrual","excludes_sold_portion","id","lender_id","maker","maturity_beyond_advance","recorded_at","source_ref","status"],"type":"object"},"LedgerCollateralScheduleRequest":{"description":"CollateralScheduleRequest records a lender's collateral schedule from an effective date.","properties":{"classes":{"items":{"$ref":"#/components/schemas/LedgerCollateralClass"},"type":"array"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"lender_id":{"format":"int64","type":"integer"},"maturity_beyond_advance":{"description":"an asset maturing inside the advance term is ineligible","type":"boolean"},"source_ref":{"type":"string"}},"required":["classes","effective_date","lender_id","maturity_beyond_advance","source_ref"],"type":"object"},"LedgerCollateralStatement":{"description":"CollateralStatement is a lender's signed collateral statement.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"assets":{"items":{"$ref":"#/components/schemas/LedgerStatementAsset"},"type":"array"},"capacity_amount":{"format":"int64","type":"integer"},"key_id":{"type":"string"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"signature":{"description":"base64 ed25519 over the version, a NUL byte and the statement without its signature","type":"string"},"source":{"description":"the lender's own signed statement, on a statement imported through its connection (version ledger.collateral.statement.lender-report.v1)","oneOf":[{"$ref":"#/components/schemas/SecuredlendingDocument"},{"type":"null"}]},"version":{"description":"ledger.collateral.statement.v1","type":"string"}},"required":["as_of","assets","capacity_amount","key_id","lendable_amount","lender_id","observed_at","signature","version"],"type":"object"},"LedgerCollateralStatementRecord":{"description":"CollateralStatementRecord is a retained statement with the breaks it opened and the independent review of its reconciliation.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"breaks":{"items":{"$ref":"#/components/schemas/LedgerCollateralBreak"},"type":"array"},"content_sha256":{"type":"string"},"id":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"statement":{"$ref":"#/components/schemas/LedgerCollateralStatement"},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["as_of","breaks","content_sha256","id","lender_id","recorded_at","recorded_by","statement","status"],"type":"object"},"LedgerDailyInterestBalance":{"description":"DailyInterestBalance is the dated principal before negative balances are clipped to zero.","properties":{"amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["amount","date"],"type":"object"},"LedgerDepositPosting":{"properties":{"hold_ids":{"items":{"type":"string"},"type":"array"},"journal":{"$ref":"#/components/schemas/LedgerJournal"}},"required":["hold_ids","journal"],"type":"object"},"LedgerEODReport":{"properties":{"accrual_journals":{"description":"Deposit interest recognised on GL 2150, and any disagreement with its evidence or the GL.","format":"int64","type":"integer"},"accrual_posted_amount":{"format":"int64","type":"integer"},"accrual_variances":{"format":"int64","type":"integer"},"bank_investment_accrued_books":{"format":"int64","type":"integer"},"bank_source_hashes":{"additionalProperties":{"type":"string"},"type":"object"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"hold_variances":{"description":"accounts whose held amount is not the sum of their active holds","format":"int64","type":"integer"},"holds_expired":{"format":"int64","type":"integer"},"interest_accruals":{"format":"int64","type":"integer"},"interest_journals":{"format":"int64","type":"integer"},"interest_posted_amount":{"format":"int64","type":"integer"},"reserve_interest_amount":{"format":"int64","type":"integer"},"reserve_interest_days":{"description":"Interest on reserve balances accrued at the close and recognised on GL 1470 / 4020.","format":"int64","type":"integer"},"reserve_interest_variances":{"format":"int64","type":"integer"},"snapshots":{"format":"int64","type":"integer"},"steps":{"items":{"type":"string"},"type":"array"},"total_credits":{"format":"int64","type":"integer"},"total_debits":{"format":"int64","type":"integer"},"trial_balance_ties":{"type":"boolean"},"variances":{"format":"int64","type":"integer"}},"required":["accrual_journals","accrual_posted_amount","accrual_variances","bank_investment_accrued_books","bank_source_hashes","business_date","hold_variances","holds_expired","interest_accruals","interest_journals","interest_posted_amount","reserve_interest_amount","reserve_interest_days","reserve_interest_variances","snapshots","steps","total_credits","total_debits","trial_balance_ties","variances"],"type":"object"},"LedgerEntry":{"properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"direction":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","currency_code","direction","ledger_account_id"],"type":"object"},"LedgerEntryLine":{"properties":{"amount":{"format":"int64","type":"integer"},"committed_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"running_amount":{"format":"int64","type":"integer"},"source_ref":{"type":"string"}},"required":["amount","committed_at","currency_code","direction","effective_date","journal_id","kind","running_amount","source_ref"],"type":"object"},"LedgerFedSecuritiesAdvice":{"description":"FedSecuritiesAdvice is an operator advice the ledger retained, how it was matched and what came of it.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"disposition":{"description":"order_settlement, collateral_return, collateral_pledge or unmatched","type":"string"},"id":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"message":{"$ref":"#/components/schemas/Message"},"operator_reference":{"type":"string"},"order_id":{"type":"string"},"outcome":{"description":"settled, recorded, exception or reversed","type":"string"},"reason":{"type":"string"},"received_by":{"type":"string"},"received_via":{"description":"delivery or sync","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["business_date","content_sha256","disposition","id","message","operator_reference","outcome","received_by","received_via","recorded_at","updated_at"],"type":"object"},"LedgerFedSecuritiesAdviceSync":{"description":"FedSecuritiesAdviceSync reads a business day's advices from the operator again.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["business_date"],"type":"object"},"LedgerFedSecuritiesDelivery":{"description":"FedSecuritiesDelivery is a transfer the bank sends, its review and the operator's answer.","properties":{"answer":{"oneOf":[{"$ref":"#/components/schemas/Message"},{"type":"null"}]},"id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"purpose":{"description":"sale_delivery or advice_reversal","type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/LedgerFedSecuritiesDeliveryRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"status":{"description":"pending_review, rejected, sending, settled or refused","type":"string"},"transfer":{"$ref":"#/components/schemas/FedsecuritiesTransfer"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","maker","purpose","recorded_at","request","status","transfer","updated_at"],"type":"object"},"LedgerFedSecuritiesDeliveryRequest":{"description":"FedSecuritiesDeliveryRequest proposes a transfer the bank sends: exactly one of order_id (a sold lot delivered against payment to receiver_aba/receiver_account) or advice_id (an exception advice reversed to its sender).","properties":{"advice_id":{"format":"int64","type":"integer"},"order_id":{"type":"string"},"reason":{"type":"string"},"receiver_aba":{"type":"string"},"receiver_account":{"type":"string"}},"required":["reason"],"type":"object"},"LedgerGLLine":{"properties":{"credits_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"debits_amount":{"format":"int64","type":"integer"},"gl_code":{"type":"string"},"gl_name":{"type":"string"},"journals":{"format":"int64","type":"integer"},"net_amount":{"format":"int64","type":"integer"}},"required":["credits_amount","currency_code","date","debits_amount","gl_code","gl_name","journals","net_amount"],"type":"object"},"LedgerHold":{"properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"require_available":{"type":"boolean"},"source_ref":{"type":"string"},"source_service":{"description":"the service that placed it; only its journals and releases touch it","type":"string"},"status":{"type":"string"}},"required":["amount","currency_code","id","kind","ledger_account_id","source_ref","status"],"type":"object"},"LedgerHoldRequest":{"properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"kind":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"require_available":{"type":"boolean"},"source_ref":{"type":"string"}},"required":["amount","currency_code","kind","ledger_account_id","source_ref"],"type":"object"},"LedgerHoldingsBreak":{"description":"HoldingsBreak is a line whose par differs, until a securities checker resolves it.","properties":{"account":{"type":"string"},"cusip":{"type":"string"},"expected_par_amount":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"opened_at":{"format":"date-time","type":"string"},"operator_par_amount":{"format":"int64","type":"integer"},"reconciliation_id":{"format":"int64","type":"integer"},"resolution":{"type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"resolved_by":{"type":"string"}},"required":["account","cusip","expected_par_amount","id","opened_at","operator_par_amount","reconciliation_id"],"type":"object"},"LedgerHoldingsBreakResolution":{"description":"HoldingsBreakResolution closes a holdings break with a reason.","properties":{"resolution":{"type":"string"}},"required":["resolution"],"type":"object"},"LedgerHoldingsLine":{"description":"HoldingsLine is one security in one account: the par the book expects and the operator reports.","properties":{"account":{"description":"ABA/NAME","type":"string"},"cusip":{"type":"string"},"expected_par_amount":{"format":"int64","type":"integer"},"operator_par_amount":{"format":"int64","type":"integer"}},"required":["account","cusip","expected_par_amount","operator_par_amount"],"type":"object"},"LedgerHoldingsReconciliation":{"description":"HoldingsReconciliation is the operator's holdings statements compared with the book.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"breaks":{"items":{"$ref":"#/components/schemas/LedgerHoldingsBreak"},"type":"array"},"content_sha256":{"type":"string"},"id":{"format":"int64","type":"integer"},"lines":{"items":{"$ref":"#/components/schemas/LedgerHoldingsLine"},"type":"array"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"statements":{"items":{"$ref":"#/components/schemas/HoldingsStatement"},"type":"array"},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["as_of","breaks","content_sha256","id","lines","recorded_at","recorded_by","statements","status"],"type":"object"},"LedgerHoldingsReconciliationRequest":{"description":"HoldingsReconciliationRequest reconciles the bank's securities accounts at the close of as_of.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["as_of"],"type":"object"},"LedgerInterestAdjustment":{"description":"InterestAdjustment is the interest a backdated journal added to or took from the accruals.","properties":{"accrued":{"description":"decimal string, major units","type":"string"},"created_at":{"format":"date-time","type":"string"},"delta_amount":{"description":"the backdated change to the balance, in the account's normal direction","format":"int64","type":"integer"},"from_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accrued","created_at","delta_amount","from_date","journal_id","ledger_account_id","posting_date","to_date"],"type":"object"},"LedgerInterestExpense":{"properties":{"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","business_date","currency_code","gl_code","ledger_account_id"],"type":"object"},"LedgerInterestPlan":{"properties":{"accrued_liability_amount":{"description":"the whole cents of Cumulative recognised on GL 2150","format":"int64","type":"integer"},"annual_rate_bps":{"format":"int64","type":"integer"},"cumulative":{"type":"string"},"day_count":{"type":"string"},"expense_gl_code":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_cycle":{"type":"string"},"source_ref":{"type":"string"},"status":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]}},"required":["accrued_liability_amount","annual_rate_bps","cumulative","day_count","expense_gl_code","ledger_account_id","posting_cycle","source_ref","status"],"type":"object"},"LedgerInterestPlanRequest":{"properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"day_count":{"type":"string"},"expense_gl_code":{"type":"string"},"source_ref":{"type":"string"},"tiering":{"oneOf":[{"$ref":"#/components/schemas/Tiering"},{"type":"null"}]}},"required":["annual_rate_bps","day_count","expense_gl_code","source_ref"],"type":"object"},"LedgerInterestRecognitionLine":{"description":"InterestRecognitionLine is one advance's interest recognised from a lender statement.","properties":{"advance_number":{"type":"string"},"borrowing_id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_accrued_amount":{"format":"int64","type":"integer"},"previously_recognized_amount":{"format":"int64","type":"integer"}},"required":["advance_number","borrowing_id","lender_accrued_amount","previously_recognized_amount"],"type":"object"},"LedgerJournal":{"properties":{"adjusts_period":{"description":"a sealed period this journal corrects, YYYY-MM","type":"string"},"approved_by":{"type":"string"},"backdated":{"description":"effective_date is before posting_date (read only)","type":"boolean"},"committed_at":{"format":"date-time","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entries":{"items":{"$ref":"#/components/schemas/LedgerEntry"},"type":"array"},"fx_legs":{"description":"FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and\nclose commands posted. A caller's posting never carries them.","items":{"$ref":"#/components/schemas/FXLeg"},"type":"array"},"id":{"type":"string"},"kind":{"type":"string"},"posted_by":{"type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"protected_command_id":{"type":"string"},"reason":{"description":"required on a backdated journal","type":"string"},"release_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"require_available":{"type":"boolean"},"reversal_of":{"type":"string"},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["effective_date","entries","kind","source_ref","source_service"],"type":"object"},"LedgerJournalEvidence":{"properties":{"claim_key":{"type":"string"},"consumption_key":{"type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_sha256":{"type":"string"},"reversal_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["journal","journal_sha256"],"type":"object"},"LedgerLenderAdvance":{"description":"LenderAdvance is an advance asked of a lender, its review, confirmation and booking.","properties":{"advance_number":{"type":"string"},"borrowing_id":{"type":"string"},"confirmation":{"oneOf":[{"$ref":"#/components/schemas/SecuredlendingDocument"},{"type":"null"}]},"id":{"format":"int64","type":"integer"},"interest_recognized_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"maker":{"type":"string"},"principal_outstanding_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/LedgerLenderAdvanceRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/LedgerReviewRecord"},{"type":"null"}]},"sent":{"oneOf":[{"$ref":"#/components/schemas/AdvanceRequest"},{"type":"null"}]},"status":{"description":"pending_review, rejected, requesting, declined or booked","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","interest_recognized_amount","lender_id","maker","principal_outstanding_amount","recorded_at","request","status","updated_at"],"type":"object"},"LedgerLenderAdvanceRequest":{"description":"LenderAdvanceRequest asks a lender for an advance through its connection.","properties":{"lender_id":{"format":"int64","type":"integer"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"program":{"description":"primary_credit or secondary_credit (discount window); overnight or fixed_rate (FHLB simulator)","type":"string"}},"required":["lender_id","maturity_date","principal_amount","program"],"type":"object"},"LedgerLenderCapacity":{"description":"LenderCapacity is a lender's position: lendable value of acknowledged eligible pledges, advances outstanding and what may still be drawn.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"capacity_amount":{"format":"int64","type":"integer"},"gl_code":{"type":"string"},"horizon":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ineligible_pledges":{"format":"int64","type":"integer"},"legal_name":{"type":"string"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"outstanding_amount":{"format":"int64","type":"integer"},"pledged_value_amount":{"format":"int64","type":"integer"},"pledges":{"items":{"$ref":"#/components/schemas/LedgerCollateralPledge"},"type":"array"},"schedule_id":{"format":"int64","type":"integer"},"shortfall_amount":{"format":"int64","type":"integer"}},"required":["as_of","capacity_amount","gl_code","horizon","ineligible_pledges","legal_name","lendable_amount","lender_id","lender_kind","outstanding_amount","pledged_value_amount","pledges","shortfall_amount"],"type":"object"},"LedgerLenderCollateralSubmission":{"description":"LenderCollateralSubmission is one delivery of a pledge to its lender or one release.","properties":{"actor":{"type":"string"},"channel":{"description":"loan_schedule, restricted_account or safekeeping_delivery","type":"string"},"created_at":{"format":"date-time","type":"string"},"cusip":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/SecuredlendingDocument"},{"type":"null"}]},"id":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lot_id":{"type":"string"},"par_amount":{"format":"int64","type":"integer"},"pledge_id":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"reason":{"type":"string"},"reference":{"type":"string"},"status":{"description":"sending, transfer_settled, acknowledged or refused","type":"string"},"submission":{"$ref":"#/components/schemas/CollateralSubmission"},"transfer":{"oneOf":[{"$ref":"#/components/schemas/FedsecuritiesTransfer"},{"type":"null"}]},"transfer_answer":{"oneOf":[{"$ref":"#/components/schemas/Message"},{"type":"null"}]},"updated_at":{"format":"date-time","type":"string"}},"required":["actor","channel","created_at","id","lender_id","par_amount","pledge_id","purpose","reference","status","submission","updated_at"],"type":"object"},"LedgerLenderDocumentImport":{"description":"LenderDocumentImport is a lender statement or schedule taken into the register.","properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"document":{"$ref":"#/components/schemas/SecuredlendingDocument"},"id":{"format":"int64","type":"integer"},"interest_recognized":{"items":{"$ref":"#/components/schemas/LedgerInterestRecognitionLine"},"type":"array"},"kind":{"description":"collateral_statement or collateral_schedule","type":"string"},"lender_id":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"schedule_id":{"format":"int64","type":"integer"},"statement_id":{"format":"int64","type":"integer"}},"required":["actor","content_sha256","document","id","interest_recognized","kind","lender_id","recorded_at"],"type":"object"},"LedgerLenderDocumentImportRequest":{"description":"LenderDocumentImportRequest imports a lender's statement for as_of, or its collateral schedule.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"type":"object"},"LedgerLenderRepayment":{"description":"LenderRepayment is a repayment asked of a lender and its booking.","properties":{"actor":{"type":"string"},"borrowing_id":{"type":"string"},"confirmation":{"oneOf":[{"$ref":"#/components/schemas/SecuredlendingDocument"},{"type":"null"}]},"id":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_advance_id":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"sent":{"$ref":"#/components/schemas/RepaymentRequest"},"status":{"description":"requesting, refused or booked","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["actor","borrowing_id","id","interest_amount","lender_advance_id","principal_amount","recorded_at","sent","status","updated_at"],"type":"object"},"LedgerLenderRepaymentRequest":{"description":"LenderRepaymentRequest repays principal of an advance drawn through its lender.","properties":{"principal_amount":{"format":"int64","type":"integer"}},"required":["principal_amount"],"type":"object"},"LedgerLenderSubmissionRequest":{"description":"LenderSubmissionRequest delivers a reserved pledge to its lender or releases an acknowledged one.","properties":{"purpose":{"description":"pledge or release","type":"string"}},"required":["purpose"],"type":"object"},"LedgerLoanCollateralFacts":{"description":"LoanCollateralFacts are the lending service's facts about a loan as of a date.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"asset_class":{"type":"string"},"charged_off":{"type":"boolean"},"days_past_due":{"format":"int64","type":"integer"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"maturity_unresolved":{"type":"boolean"},"nonaccrual":{"type":"boolean"},"participations_sold_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"status":{"type":"string"},"unpaid_principal_amount":{"format":"int64","type":"integer"}},"required":["as_of","asset_class","charged_off","days_past_due","loan_id","maturity_unresolved","nonaccrual","participations_sold_amount","product_code","status","unpaid_principal_amount"],"type":"object"},"LedgerOpenAccountRequest":{"properties":{"address":{"$ref":"#/components/schemas/LedgerAddress"},"allow_negative":{"type":"boolean"},"gl_code":{"type":"string"},"protected_purpose":{"type":"string"}},"required":["address","allow_negative","gl_code"],"type":"object"},"LedgerPeriodReport":{"properties":{"already_closed":{"type":"boolean"},"checksum":{"type":"string"},"closed_by":{"type":"string"},"interest_journals":{"format":"int64","type":"integer"},"interest_posted_amount":{"format":"int64","type":"integer"},"journal_count":{"format":"int64","type":"integer"},"period":{"type":"string"},"ties":{"type":"boolean"},"total_credits":{"format":"int64","type":"integer"},"total_debits":{"format":"int64","type":"integer"}},"required":["already_closed","checksum","closed_by","interest_journals","interest_posted_amount","journal_count","period","ties","total_credits","total_debits"],"type":"object"},"LedgerPledgedTotalLine":{"description":"PledgedTotalLine is one lender's acknowledged pledges of one asset kind and class.","properties":{"asset_class":{"type":"string"},"asset_kind":{"type":"string"},"count":{"format":"int64","type":"integer"},"lendable_amount":{"format":"int64","type":"integer"},"lender_id":{"format":"int64","type":"integer"},"lender_kind":{"type":"string"},"value_amount":{"format":"int64","type":"integer"}},"required":["asset_class","asset_kind","count","lendable_amount","lender_id","lender_kind","value_amount"],"type":"object"},"LedgerPledgedTotals":{"description":"PledgedTotals are the acknowledged pledges by lender, asset kind and class: the Call Report's pledged securities (RC-B memoranda) and pledged loans (RC-C).","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/LedgerPledgedTotalLine"},"type":"array"}},"required":["as_of","lines"],"type":"object"},"LedgerReverseRepo":{"description":"ReverseRepo is a retained reverse repurchase agreement and its live position. The carrying value is the resale asset account's balance: principal plus interest earned and accrued into the asset.","properties":{"accrued_interest_amount":{"description":"interest earned and posted to income so far","format":"int64","type":"integer"},"accrued_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"adjusted_collateral_amount":{"description":"after the haircut","format":"int64","type":"integer"},"annual_rate_bps":{"format":"int64","type":"integer"},"carrying_amount":{"description":"the resale asset account balance","format":"int64","type":"integer"},"closed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"collateral":{"items":{"$ref":"#/components/schemas/LedgerReverseRepoCollateral"},"type":"array"},"collateral_value_amount":{"description":"sum of delivered market values","format":"int64","type":"integer"},"counterparty":{"type":"string"},"counterparty_id":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"day_count":{"type":"string"},"haircut_bps":{"format":"int64","type":"integer"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"reverse_repo, tri_party_reverse_repo or buy_sell_back","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maker":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"},"repurchase_amount":{"description":"principal plus full-term interest","format":"int64","type":"integer"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"open or closed","type":"string"},"tri_party_agent":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["accrued_interest_amount","accrued_through","adjusted_collateral_amount","annual_rate_bps","carrying_amount","collateral","collateral_value_amount","counterparty","counterparty_id","created_at","day_count","haircut_bps","id","journal_id","kind","ledger_account_id","maturity_date","principal_amount","repurchase_amount","start_date","status","updated_at"],"type":"object"},"LedgerReverseRepoAccrualRequest":{"description":"ReverseRepoAccrualRequest recognises interest earned through a boundary date (today by default).","properties":{"through":{"description":"YYYY-MM-DD; omitted means today, never past maturity","type":"string"}},"type":"object"},"LedgerReverseRepoCollateral":{"description":"ReverseRepoCollateral is one security the counterparty delivered, at its signed market value.","properties":{"cusip":{"type":"string"},"description":{"type":"string"},"market_value_amount":{"format":"int64","type":"integer"}},"required":["cusip","market_value_amount"],"type":"object"},"LedgerReverseRepoRequest":{"description":"ReverseRepoRequest opens a reverse repo, tri-party reverse repo or buy-sell-back from a reviewed repo counterparty. The bank is the cash lender.","properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"collateral":{"items":{"$ref":"#/components/schemas/LedgerReverseRepoCollateral"},"type":"array"},"counterparty_id":{"format":"int64","type":"integer"},"day_count":{"description":"actual_360 or actual_365","type":"string"},"haircut_bps":{"format":"int64","type":"integer"},"kind":{"description":"reverse_repo, tri_party_reverse_repo or buy_sell_back","type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"tri_party_agent":{"type":"string"}},"required":["annual_rate_bps","collateral","counterparty_id","day_count","haircut_bps","kind","maturity_date","principal_amount","start_date"],"type":"object"},"LedgerReview":{"description":"Review is an independent decision on a register record or a proposed draw.","properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"LedgerReviewRecord":{"description":"ReviewRecord is a retained review.","properties":{"approve":{"type":"boolean"},"checker":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["approve","checker","reason","recorded_at"],"type":"object"},"LedgerSnapshot":{"properties":{"available_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entry_count":{"format":"int64","type":"integer"},"holds_amount":{"format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posted_amount":{"format":"int64","type":"integer"},"restated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"restated_by":{"description":"the backdated journal that produced this version","type":"string"},"version":{"description":"1 at end of day; each backdated journal that reaches the day adds one","format":"int64","type":"integer"}},"required":["available_amount","business_date","entry_count","holds_amount","ledger_account_id","posted_amount","version"],"type":"object"},"LedgerStatementAsset":{"description":"StatementAsset is one asset as a lender's statement lists it.","properties":{"lendable_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"}},"required":["lendable_amount","reference"],"type":"object"},"LedgerTrialBalance":{"properties":{"by_currency":{"additionalProperties":{"properties":{"credits":{"format":"int64","type":"integer"},"debits":{"format":"int64","type":"integer"},"ties":{"type":"boolean"}},"required":["credits","debits","ties"],"type":"object"},"type":"object"},"lines":{"items":{"$ref":"#/components/schemas/LedgerTrialBalanceLine"},"type":"array"},"ties":{"type":"boolean"},"total_credits":{"format":"int64","type":"integer"},"total_debits":{"format":"int64","type":"integer"}},"required":["by_currency","lines","ties","total_credits","total_debits"],"type":"object"},"LedgerTrialBalanceLine":{"properties":{"accounts":{"format":"int64","type":"integer"},"balance_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"name":{"type":"string"},"normal_balance":{"type":"string"}},"required":["accounts","balance_amount","currency_code","gl_code","name","normal_balance"],"type":"object"},"LedgerjournalRequest":{"description":"journalRequest is the write shape: only the fields the ledger accepts on POST /v1/journals.","properties":{"adjusts_period":{"type":"string"},"approved_by":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entries":{"items":{"$ref":"#/components/schemas/LedgerEntry"},"type":"array"},"fx_legs":{"description":"FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and\nclose commands posted. A caller's posting never carries them.","items":{"$ref":"#/components/schemas/FXLeg"},"type":"array"},"kind":{"type":"string"},"posted_by":{"type":"string"},"protected_command_id":{"type":"string"},"reason":{"type":"string"},"release_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"require_available":{"type":"boolean"},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["effective_date","entries","kind","source_ref","source_service"],"type":"object"},"LegacyCashRequest":{"properties":{"authorization_ids":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["authorization_ids","business_date","journal_id"],"type":"object"},"LegacyCashRow":{"properties":{"amount":{"format":"int64","type":"integer"},"count":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","count","journal_id"],"type":"object"},"LegalBasis":{"description":"LegalBasis is the retained evidence of the process itself. The code decides no legal question: validity, privilege, confidentiality and Right to Financial Privacy Act determinations are the bank's, evidenced here.","properties":{"citation":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["citation","evidence_ref","evidence_sha256","reason"],"type":"object"},"LegalRequest":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"productions":{"items":{"$ref":"#/components/schemas/Production"},"type":"array"},"request":{"$ref":"#/components/schemas/LegalRequestInput"}},"required":["actor","created_at","id","productions","request"],"type":"object"},"LegalRequestInput":{"properties":{"basis":{"$ref":"#/components/schemas/LegalBasis"},"counsel":{"type":"string"},"issuing_authority":{"type":"string"},"kind":{"description":"subpoena, court_order or regulator_request","type":"string"},"matter_ref":{"type":"string"},"production_prefix":{"type":"string"},"purpose":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"requester_type":{"description":"private_party, court, government_authority or bank_regulator","type":"string"},"response_due_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rfpa":{"oneOf":[{"$ref":"#/components/schemas/RFPADetermination"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/LegalScope"}},"required":["basis","counsel","issuing_authority","kind","matter_ref","production_prefix","purpose","received_at","requester_type","scope"],"type":"object"},"LegalScope":{"description":"LegalScope selects what a production collects. Every named dimension must match; within a dimension any listed value matches. Families name registered sources, RetainedRecords or ExternalDocuments; no families means every archive family, which the request must acknowledge with BankWide and its reason, because that places a bank-wide hold: every registered connector starts retaining superseded rows in its own database until the hold is released.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"bank_wide":{"type":"boolean"},"bank_wide_reason":{"type":"string"},"custodians":{"items":{"type":"string"},"type":"array"},"customer_ids":{"items":{"type":"string"},"type":"array"},"families":{"items":{"$ref":"#/components/schemas/Target"},"type":"array"},"from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"through":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["account_ids","custodians","customer_ids","families"],"type":"object"},"Lending":{"description":"Lending terms of a loan product.","properties":{"allowance":{"description":"the CECL loss-rate table","oneOf":[{"$ref":"#/components/schemas/Allowance"},{"type":"null"}]},"charge_off_days":{"description":"days past due at which the balance is charged off against the allowance (120 for closed-end consumer credit)","format":"int64","type":"integer"},"escrow":{"description":"the instalment carries an escrow for taxes and insurance (mortgages)","type":"boolean"},"facility":{"description":"a credit facility rather than an instalment loan","oneOf":[{"$ref":"#/components/schemas/Facility"},{"type":"null"}]},"grace_days":{"format":"int64","type":"integer"},"guarantee":{"description":"a government guarantee on the loan (SBA 7(a), 504, USDA)","oneOf":[{"$ref":"#/components/schemas/Guarantee"},{"type":"null"}]},"late_fee_minor":{"format":"int64","type":"integer"},"max_dti_bps":{"format":"int64","type":"integer"},"max_principal_minor":{"format":"int64","type":"integer"},"max_term_months":{"format":"int64","type":"integer"},"min_credit_score":{"format":"int64","type":"integer"},"min_principal_minor":{"format":"int64","type":"integer"},"min_term_months":{"format":"int64","type":"integer"},"nonaccrual_days":{"description":"days past due at which accrual stops and uncollected interest is reversed (90 is the general trigger)","format":"int64","type":"integer"},"origination_fee_bps":{"format":"int64","type":"integer"}},"required":["charge_off_days","grace_days","late_fee_minor","max_dti_bps","max_principal_minor","max_term_months","min_credit_score","min_principal_minor","min_term_months","nonaccrual_days","origination_fee_bps"],"type":"object"},"LendingCloseBlocker":{"properties":{"reason":{"type":"string"},"target_id":{"type":"string"},"target_kind":{"type":"string"}},"required":["reason","target_id","target_kind"],"type":"object"},"LendingCloseReadiness":{"properties":{"blockers":{"items":{"$ref":"#/components/schemas/LendingCloseBlocker"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ready":{"type":"boolean"}},"required":["blockers","business_date","ready"],"type":"object"},"LendingDispute":{"description":"Dispute is an FCRA dispute/correction record for a furnished tradeline.","properties":{"account_number":{"type":"string"},"id":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opened_at":{"format":"date-time","type":"string"},"reason":{"type":"string"},"resolution":{"type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"}},"required":["account_number","id","loan_id","opened_at","reason","status"],"type":"object"},"LendingDisputeRequest":{"description":"DisputeRequest opens an FCRA dispute.","properties":{"detail":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"}},"required":["detail","loan_id","reason"],"type":"object"},"LendingFacility":{"description":"Facility is a credit facility and its state.","properties":{"accrued_interest":{"type":"string"},"accrued_posted_amount":{"format":"int64","type":"integer"},"activated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"annual_rate_bps":{"format":"int64","type":"integer"},"available_amount":{"description":"net of active reservations","format":"int64","type":"integer"},"beneficiary":{"type":"string"},"borrowing_base":{"oneOf":[{"$ref":"#/components/schemas/BorrowingBase"},{"type":"null"}]},"bucket":{"type":"string"},"charged_off_amount":{"format":"int64","type":"integer"},"charged_off_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"converted_to_loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"days_past_due":{"format":"int64","type":"integer"},"decision":{"$ref":"#/components/schemas/Decision"},"draw_period_ends":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"drawn_amount":{"format":"int64","type":"integer"},"due_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"expiry":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"fees_due_amount":{"format":"int64","type":"integer"},"guarantee":{"oneOf":[{"$ref":"#/components/schemas/LendingGuarantee"},{"type":"null"}]},"id":{"type":"string"},"kind":{"description":"revolving, construction, letter_of_credit, factoring, floor_plan, merchant_cash_advance, warehouse","type":"string"},"last_statement":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"limit_amount":{"format":"int64","type":"integer"},"minimum_due_amount":{"format":"int64","type":"integer"},"nonaccrual_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"owed_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"purchased_amount":{"format":"int64","type":"integer"},"repayment_starts":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"reserved_amount":{"description":"active, unexpired reservations holding room on the line","format":"int64","type":"integer"},"settlement_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"},"terms":{"$ref":"#/components/schemas/FacilityTerms"},"updated_at":{"format":"date-time","type":"string"}},"required":["accrued_interest","accrued_posted_amount","annual_rate_bps","available_amount","bucket","charged_off_amount","created_at","currency_code","customer_id","days_past_due","decision","drawn_amount","fees_due_amount","id","kind","limit_amount","minimum_due_amount","product_code","product_version","settlement_account_id","status","terms","updated_at"],"type":"object"},"LendingFacilityPayment":{"description":"FacilityPayment is money applied to a facility.","properties":{"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"facility_id":{"type":"string"},"fees_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"income_amount":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"}},"required":["amount","created_at","facility_id","fees_amount","id","income_amount","interest_amount","journal_id","kind","principal_amount"],"type":"object"},"LendingFacilityStatement":{"description":"FacilityStatement is a billing cycle.","properties":{"closing_amount":{"format":"int64","type":"integer"},"collectible_minimum_due":{"format":"int64","type":"integer"},"collection_due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"facility_id":{"type":"string"},"fees_amount":{"format":"int64","type":"integer"},"generated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"interest_amount":{"format":"int64","type":"integer"},"minimum_due_amount":{"format":"int64","type":"integer"},"paid_amount":{"format":"int64","type":"integer"},"period":{"type":"string"},"protected_amount":{"format":"int64","type":"integer"},"statement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"type":"string"}},"required":["closing_amount","collectible_minimum_due","collection_due_date","due_date","facility_id","fees_amount","interest_amount","minimum_due_amount","paid_amount","period","protected_amount","statement_date","status"],"type":"object"},"LendingGuarantee":{"description":"Guarantee is a government guarantee on a loan or facility.","properties":{"guaranteed_bps":{"format":"int64","type":"integer"},"number":{"type":"string"},"program":{"description":"sba_7a, sba_504, usda","type":"string"}},"required":["guaranteed_bps","program"],"type":"object"},"LendingPayment":{"properties":{"amount":{"format":"int64","type":"integer"},"effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"escrow_amount":{"format":"int64","type":"integer"},"fees_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"interest_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"participants_amount":{"format":"int64","type":"integer"},"participants_interest_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"}},"required":["amount","escrow_amount","fees_amount","id","interest_amount","journal_id","principal_amount"],"type":"object"},"LendingStatementRun":{"description":"StatementRun is one billing of every open facility.","properties":{"billed":{"format":"int64","type":"integer"},"facilities":{"format":"int64","type":"integer"},"period":{"type":"string"},"replayed":{"format":"int64","type":"integer"}},"required":["billed","facilities","period","replayed"],"type":"object"},"LendingclosingAction":{"properties":{"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_sha256","reason"],"type":"object"},"LendingclosingCase":{"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"day_count":{"type":"string"},"escrow_monthly_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"maker":{"type":"string"},"plan":{"$ref":"#/components/schemas/LendingclosingPlan"},"principal_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"rate_bps":{"format":"int64","type":"integer"},"rescission_required":{"type":"boolean"},"target_id":{"type":"string"},"target_kind":{"type":"string"},"term_months":{"format":"int64","type":"integer"}},"required":["created_at","customer_id","escrow_monthly_amount","id","maker","plan","principal_amount","product_code","product_version","rate_bps","rescission_required","target_id","target_kind","term_months"],"type":"object"},"LendingclosingDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","approve","at","reason"],"type":"object"},"LendingclosingDocument":{"properties":{"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"code":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"maker":{"type":"string"},"receipts":{"items":{"$ref":"#/components/schemas/LendingclosingReceipt"},"type":"array"},"reference":{"type":"string"},"sha256":{"type":"string"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["case_id","code","created_at","id","maker","receipts","reference","sha256","signatures"],"type":"object"},"LendingclosingEvent":{"properties":{"action":{"oneOf":[{"$ref":"#/components/schemas/LendingclosingAction"},{"type":"null"}]},"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"consummation":{"oneOf":[{"$ref":"#/components/schemas/Consummation"},{"type":"null"}]},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"}},"required":["actor","at","kind"],"type":"object"},"LendingclosingPlan":{"properties":{"consummation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"escrow_analysis_id":{"type":"string"},"escrow_waiver_sha256":{"type":"string"},"first_payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"flood_insurance_required":{"type":"boolean"},"funding_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"operating_calendar":{"$ref":"#/components/schemas/Calendar"},"parties":{"description":"borrower/signers","items":{"type":"string"},"type":"array"},"policy_sha256":{"type":"string"},"principal_dwelling":{"type":"boolean"},"purpose":{"type":"string"},"real_estate":{"type":"boolean"},"requirements":{"items":{"$ref":"#/components/schemas/Requirement"},"type":"array"},"rescission_owners":{"items":{"type":"string"},"type":"array"},"state":{"type":"string"}},"required":["consummation_date","first_payment_date","flood_insurance_required","funding_date","operating_calendar","parties","policy_sha256","principal_dwelling","purpose","real_estate","requirements","rescission_owners","state"],"type":"object"},"LendingclosingReceipt":{"properties":{"at":{"format":"date-time","type":"string"},"consent_sha256":{"type":"string"},"copies":{"format":"int64","type":"integer"},"method":{"description":"paper or electronic","type":"string"},"party":{"type":"string"}},"required":["at","copies","method","party"],"type":"object"},"LendingclosingReview":{"properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"LendingclosingUpload":{"properties":{"code":{"type":"string"},"pdf":{"format":"byte","type":"string"},"receipts":{"items":{"$ref":"#/components/schemas/LendingclosingReceipt"},"type":"array"},"reference":{"type":"string"},"signatures":{"items":{"$ref":"#/components/schemas/Signature"},"type":"array"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["code","pdf","receipts","reference","signatures"],"type":"object"},"LendingclosingView":{"properties":{"case":{"$ref":"#/components/schemas/LendingclosingCase"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingclosingDecision"},{"type":"null"}]},"documents":{"items":{"$ref":"#/components/schemas/File"},"type":"array"},"events":{"items":{"$ref":"#/components/schemas/LendingclosingEvent"},"type":"array"},"rescission_deadline":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"status":{"type":"string"}},"required":["case","documents","events","status"],"type":"object"},"LendingdisclosuresApplication":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"operating_calendar":{"$ref":"#/components/schemas/Calendar"},"policy_sha256":{"type":"string"},"product_code":{"type":"string"}},"required":["customer_id","operating_calendar","policy_sha256","product_code"],"type":"object"},"LendingdisclosuresChange":{"properties":{"affected_cost_ids":{"items":{"type":"string"},"type":"array"},"evidence_sha256":{"type":"string"},"kind":{"type":"string"},"known_at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["affected_cost_ids","evidence_sha256","kind","known_at","reason"],"type":"object"},"LendingdisclosuresDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","approve","at","reason"],"type":"object"},"LendingdisclosuresDelivery":{"properties":{"consent_sha256":{"type":"string"},"evidence_sha256":{"type":"string"},"method":{"description":"in_person, mail, electronic","type":"string"},"party":{"type":"string"},"provider_list":{"oneOf":[{"$ref":"#/components/schemas/ProviderListReference"},{"type":"null"}]},"received_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"sent_at":{"format":"date-time","type":"string"}},"required":["evidence_sha256","method","party","sent_at"],"type":"object"},"LendingdisclosuresItem":{"properties":{"amount":{"format":"int64","type":"integer"},"evidence_sha256":{"type":"string"},"kind":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"text":{"type":"string"}},"required":["evidence_sha256","kind","received_at"],"type":"object"},"LendingdisclosuresPayment":{"properties":{"amount":{"format":"int64","type":"integer"},"balance_amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"}},"required":["amount","balance_amount","date","interest_amount","principal_amount"],"type":"object"},"LendingdisclosuresProposal":{"properties":{"change":{"oneOf":[{"$ref":"#/components/schemas/LendingdisclosuresChange"},{"type":"null"}]},"costs":{"items":{"$ref":"#/components/schemas/Cost"},"type":"array"},"kind":{"type":"string"},"previous_id":{"type":"string"},"provider_list":{"oneOf":[{"$ref":"#/components/schemas/ProviderList"},{"type":"null"}]},"provider_selections":{"items":{"$ref":"#/components/schemas/ProviderSelection"},"type":"array"},"terms":{"$ref":"#/components/schemas/LendingdisclosuresTerms"}},"required":["costs","kind","terms"],"type":"object"},"LendingdisclosuresProvider":{"properties":{"address":{"type":"string"},"affiliated":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"in_business":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"name":{"type":"string"},"phone":{"type":"string"},"serves_property":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"verified_at":{"format":"date-time","type":"string"}},"required":["address","evidence_sha256","id","name","phone","verified_at"],"type":"object"},"LendingdisclosuresReview":{"properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"LendingdisclosuresRevision":{"properties":{"calculation":{"$ref":"#/components/schemas/Calculation"},"change":{"oneOf":[{"$ref":"#/components/schemas/LendingdisclosuresChange"},{"type":"null"}]},"costs":{"items":{"$ref":"#/components/schemas/Cost"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"maker":{"type":"string"},"number":{"format":"int64","type":"integer"},"origination_id":{"type":"string"},"previous_id":{"type":"string"},"provider_list":{"oneOf":[{"$ref":"#/components/schemas/ProviderList"},{"type":"null"}]},"provider_selections":{"items":{"$ref":"#/components/schemas/ProviderSelection"},"type":"array"},"terms":{"$ref":"#/components/schemas/LendingdisclosuresTerms"}},"required":["calculation","costs","created_at","id","kind","maker","number","origination_id","terms"],"type":"object"},"LendingdisclosuresTerms":{"properties":{"annual_home_insurance_amount":{"format":"int64","type":"integer"},"annual_other_property_cost_amount":{"format":"int64","type":"integer"},"annual_property_tax_amount":{"format":"int64","type":"integer"},"assumable":{"description":"These facts require independent confirmation against the note and applicable state law.","oneOf":[{"type":"boolean"},{"type":"null"}]},"borrower_mailing_address":{"type":"string"},"buyer_broker":{"oneOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"consummation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"contract_sha256":{"type":"string"},"deficiency_protection":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"deposit_amount":{"format":"int64","type":"integer"},"deposit_holder":{"type":"string"},"escrow_adjustment_amount":{"format":"int64","type":"integer"},"escrow_declined":{"type":"boolean"},"escrow_lines":{"items":{"$ref":"#/components/schemas/EscrowLine"},"type":"array"},"escrow_monthly_amount":{"format":"int64","type":"integer"},"escrow_waiver_fee_amount":{"format":"int64","type":"integer"},"estimate_expires_at":{"format":"date-time","type":"string"},"features":{"items":{"type":"string"},"type":"array"},"first_payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"funding_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"grace_days":{"format":"int64","type":"integer"},"initial_escrow_amount":{"format":"int64","type":"integer"},"insurance_escrowed":{"type":"boolean"},"late_fee_amount":{"format":"int64","type":"integer"},"lender_contact":{"$ref":"#/components/schemas/Contact"},"lender_credit_amount":{"format":"int64","type":"integer"},"mortgage_broker":{"oneOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"other_escrowed":{"type":"boolean"},"other_property_cost_label":{"type":"string"},"partial_payments":{"type":"string"},"parties":{"items":{"type":"string"},"type":"array"},"principal_amount":{"format":"int64","type":"integer"},"profile":{"type":"string"},"property_address":{"type":"string"},"property_value_amount":{"format":"int64","type":"integer"},"property_value_basis":{"type":"string"},"purpose":{"type":"string"},"rate_bps":{"format":"int64","type":"integer"},"rate_lock_expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rate_locked":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"sale_price_amount":{"format":"int64","type":"integer"},"seller_address":{"type":"string"},"seller_broker":{"oneOf":[{"$ref":"#/components/schemas/Contact"},{"type":"null"}]},"seller_credit_amount":{"format":"int64","type":"integer"},"seller_name":{"type":"string"},"servicing":{"type":"string"},"settlement_agent":{"$ref":"#/components/schemas/Contact"},"settlement_file_number":{"type":"string"},"state":{"type":"string"},"tax_escrowed":{"type":"boolean"},"term_months":{"format":"int64","type":"integer"}},"required":["annual_home_insurance_amount","annual_other_property_cost_amount","annual_property_tax_amount","borrower_mailing_address","consummation_date","contract_sha256","deposit_amount","deposit_holder","escrow_adjustment_amount","escrow_declined","escrow_lines","escrow_monthly_amount","escrow_waiver_fee_amount","estimate_expires_at","features","first_payment_date","funding_date","grace_days","initial_escrow_amount","insurance_escrowed","late_fee_amount","lender_contact","lender_credit_amount","other_escrowed","other_property_cost_label","partial_payments","parties","principal_amount","profile","property_address","property_value_amount","property_value_basis","purpose","rate_bps","sale_price_amount","seller_address","seller_credit_amount","seller_name","servicing","settlement_agent","settlement_file_number","state","tax_escrowed","term_months"],"type":"object"},"LendingdisclosuresView":{"properties":{"complete_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"disclosures":{"items":{"$ref":"#/components/schemas/Disclosed"},"type":"array"},"estimate_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"intent":{"oneOf":[{"$ref":"#/components/schemas/Intent"},{"type":"null"}]},"items":{"items":{"$ref":"#/components/schemas/LendingdisclosuresItem"},"type":"array"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"origination":{"$ref":"#/components/schemas/Origin"}},"required":["disclosures","items","origination"],"type":"object"},"LendingratesCancellation":{"description":"Cancellation supersedes a notice only after independent approval; archived evidence remains.","properties":{"id":{"type":"string"},"reason":{"type":"string"},"reset_id":{"type":"string"}},"required":["id","reason","reset_id"],"type":"object"},"LendingratesContract":{"properties":{"id":{"type":"string"},"initial_rate_bps":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"target_id":{"type":"string"},"target_kind":{"type":"string"},"terms":{"$ref":"#/components/schemas/LendingratesTerms"}},"required":["id","initial_rate_bps","product_code","product_version","target_id","target_kind","terms"],"type":"object"},"LendingratesDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","approve","at","reason"],"type":"object"},"LendingratesObservation":{"description":"Observation rates are billionths of an annual fraction: 53,300,000 means 5.33%.","properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"index":{"type":"string"},"published_at":{"format":"date-time","type":"string"},"rate_nanos":{"format":"int64","type":"integer"},"source":{"type":"string"},"supersedes":{"type":"string"}},"required":["effective_date","evidence_sha256","id","index","published_at","rate_nanos","source"],"type":"object"},"LendingratesReview":{"properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"LendingratesTerms":{"properties":{"ceiling_bps":{"format":"int64","type":"integer"},"evidence_sha256":{"type":"string"},"first_reset":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"floor_bps":{"format":"int64","type":"integer"},"frequency_days":{"format":"int64","type":"integer"},"frequency_months":{"format":"int64","type":"integer"},"index":{"type":"string"},"lifetime_cap_bps":{"format":"int64","type":"integer"},"lookback_days":{"format":"int64","type":"integer"},"margin_bps":{"format":"int64","type":"integer"},"max_age_days":{"format":"int64","type":"integer"},"notice_days":{"format":"int64","type":"integer"},"notice_rule":{"type":"string"},"periodic_cap_bps":{"format":"int64","type":"integer"},"rounding":{"type":"string"},"rounding_bps":{"description":"whole basis points; superseded by RoundingNanos when set","format":"int64","type":"integer"},"rounding_nanos":{"description":"the rounding step in nanos: 1,250,000 is an eighth of a percent (12.5 bp)","format":"int64","type":"integer"}},"required":["ceiling_bps","evidence_sha256","first_reset","floor_bps","frequency_days","frequency_months","index","lifetime_cap_bps","lookback_days","margin_bps","max_age_days","notice_days","notice_rule","periodic_cap_bps","rounding","rounding_bps"],"type":"object"},"LendingratesWork":{"properties":{"reset_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reset_id":{"type":"string"},"status":{"type":"string"},"target_id":{"type":"string"}},"required":["reset_date","status","target_id"],"type":"object"},"LevyNotice":{"description":"LevyNotice is what the bank copies from the served notice. The taxpayer's identifying number is held sealed by the caller; only its last four digits are part of this record.","properties":{"form_number":{"type":"string"},"identifier_last4":{"type":"string"},"irs_office_contact":{"type":"string"},"notice_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"periods":{"items":{"$ref":"#/components/schemas/LevyPeriod"},"type":"array"},"reply_to":{"$ref":"#/components/schemas/AgencyAddress"},"served_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"taxpayer_name":{"type":"string"},"total_due_minor":{"format":"int64","type":"integer"}},"required":["form_number","identifier_last4","irs_office_contact","notice_date","periods","reply_to","served_date","taxpayer_name","total_due_minor"],"type":"object"},"LevyPeriod":{"description":"LevyPeriod is one row of the notice: kind of tax, tax period ended and the amounts shown.","properties":{"kind_of_tax":{"type":"string"},"statutory_additions_minor":{"format":"int64","type":"integer"},"tax_period_ended":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"unpaid_assessment_minor":{"format":"int64","type":"integer"}},"required":["kind_of_tax","statutory_additions_minor","tax_period_ended","unpaid_assessment_minor"],"type":"object"},"LevyTerms":{"description":"LevyTerms bind one served Form 668-A notice.","properties":{"notice":{"$ref":"#/components/schemas/LevyNotice"},"notice_evidence_reference":{"type":"string"},"notice_evidence_sha256":{"type":"string"},"taxpayer_identifier_id":{"type":"string"}},"required":["notice","notice_evidence_reference","notice_evidence_sha256","taxpayer_identifier_id"],"type":"object"},"LifecycleRequest":{"description":"LifecycleRequest is an issuer-initiated suspension, resumption or deletion.","properties":{"action":{"description":"suspend, resume or delete","type":"string"},"expected_sequence":{"format":"int64","type":"integer"},"reason":{"type":"string"}},"required":["action","expected_sequence","reason"],"type":"object"},"LifecycleStatus":{"properties":{"ProductStatusType":{"type":"string"}},"required":["ProductStatusType"],"type":"object"},"Limits":{"description":"Limits on money movement for the product.","properties":{"daily_minor":{"format":"int64","type":"integer"},"per_transaction_minor":{"format":"int64","type":"integer"}},"required":["daily_minor","per_transaction_minor"],"type":"object"},"Line":{"properties":{"amount":{"format":"int64","type":"integer"},"direction":{"description":"debit reduces bank cash; credit increases it","type":"string"},"id":{"type":"string"},"reference":{"type":"string"}},"required":["amount","direction","id","reference"],"type":"object"},"LiquidityAlert":{"description":"LiquidityAlert is a retained alert.","properties":{"acknowledged_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"acknowledged_by":{"type":"string"},"acknowledgement_note":{"type":"string"},"currency_code":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"observed_at":{"format":"date-time","type":"string"},"observed_balance":{"format":"int64","type":"integer"},"raised_at":{"format":"date-time","type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"source":{"type":"string"},"status":{"type":"string"},"suggested_amount":{"format":"int64","type":"integer"},"threshold":{"format":"int64","type":"integer"}},"required":["currency_code","id","kind","nostro_account_id","observed_at","observed_balance","raised_at","source","status","suggested_amount","threshold"],"type":"object"},"LiquidityBreach":{"description":"LiquidityBreach is a limit a balance reading is beyond.","properties":{"kind":{"type":"string"},"observation":{"$ref":"#/components/schemas/LiquidityObservation"},"suggested_amount":{"description":"SuggestedMinor is the funding that brings the balance back to the target (below minimum,\noverdrawn) or the excess above the target to bring home (above maximum).","format":"int64","type":"integer"},"threshold":{"format":"int64","type":"integer"}},"required":["kind","observation","suggested_amount","threshold"],"type":"object"},"LiquidityEvaluation":{"description":"LiquidityEvaluation is what one evaluation read and changed.","properties":{"breaches":{"items":{"$ref":"#/components/schemas/LiquidityBreach"},"type":"array"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"open":{"items":{"$ref":"#/components/schemas/LiquidityAlert"},"type":"array"},"raised":{"items":{"$ref":"#/components/schemas/LiquidityAlert"},"type":"array"},"readings":{"items":{"$ref":"#/components/schemas/LiquidityObservation"},"type":"array"},"resolved":{"items":{"$ref":"#/components/schemas/LiquidityAlert"},"type":"array"}},"required":["breaches","nostro_account_id","open","raised","readings","resolved"],"type":"object"},"LiquidityObservation":{"description":"LiquidityObservation is one reading of a nostro balance: the ledger's posted balance, the correspondent's intraday available or booked balance (camt.052) or its closing balance (camt.053).","properties":{"balance":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"source":{"description":"ledger, intraday_report or statement","type":"string"}},"required":["balance","observed_at","source"],"type":"object"},"LiquidityTerms":{"description":"LiquidityTerms are the bank's own limits for the account: the least it keeps to settle the day's payments, what a funding brings it back to, and the most it leaves at the correspondent, the internal exposure limit its correspondent policy sets under Regulation F (12 CFR 206.3).","properties":{"maximum_balance":{"format":"int64","type":"integer"},"minimum_balance":{"format":"int64","type":"integer"},"target_balance":{"format":"int64","type":"integer"}},"required":["maximum_balance","minimum_balance","target_balance"],"type":"object"},"LiquidityTransferRequest":{"description":"LiquidityTransferRequest moves the bank's own funds over FedNow: to another participant, or into the RTP joint account (purpose rtp_funding) to fund the bank's RTP position.","properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"gl_code":{"type":"string"},"operator":{"type":"string"},"purpose":{"type":"string"},"rail":{"type":"string"},"receiver_routing_number":{"type":"string"},"remittance":{"type":"string"},"rtp_participant_id":{"type":"string"}},"required":["amount","currency_code","operator","rail"],"type":"object"},"ListVersion":{"description":"ListVersion names the list content a screening ran against.","properties":{"age_days":{"description":"days since publication","format":"int64","type":"integer"},"entries":{"format":"int64","type":"integer"},"fetch_age_days":{"description":"days since the list's files were last downloaded","format":"int64","type":"integer"},"hash":{"type":"string"},"id":{"type":"string"},"published_on":{"type":"string"},"version":{"type":"string"}},"required":["age_days","entries","fetch_age_days","hash","id","version"],"type":"object"},"List_04a25272ac3a":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RetentionView"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"List_2a54db6c980c":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InformationView"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"List_3070f9f5a4f7":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RetentionHold"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"List_36d9366bbf96":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObligationView"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"List_3f0c64ab2dd9":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CorrectionView"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"List_a42b895f9713":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContinuingCandidateView"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"Loan":{"properties":{"accrued_interest":{"description":"decimal, major units, accrued and not yet collected","type":"string"},"accrued_posted_amount":{"description":"the whole cents of that recognised in the ledger's receivable","format":"int64","type":"integer"},"annual_rate_bps":{"format":"int64","type":"integer"},"annual_rate_nanos":{"format":"int64","type":"integer"},"bucket":{"description":"current, 1-29, 30-59, 60-89, 90+","type":"string"},"charged_off_amount":{"description":"principal written off against the allowance","format":"int64","type":"integer"},"charged_off_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"day_count":{"type":"string"},"days_past_due":{"description":"as of the last delinquency sweep","format":"int64","type":"integer"},"decision":{"$ref":"#/components/schemas/Decision"},"escrow_balance_amount":{"format":"int64","type":"integer"},"escrow_monthly_amount":{"format":"int64","type":"integer"},"fees_due_amount":{"format":"int64","type":"integer"},"first_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"guarantee":{"oneOf":[{"$ref":"#/components/schemas/LendingGuarantee"},{"type":"null"}]},"id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lead_bank":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"nonaccrual_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"outstanding_amount":{"format":"int64","type":"integer"},"participations_sold_amount":{"format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"recovered_amount":{"format":"int64","type":"integer"},"restored_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"description":"approved, declined, review, active, delinquent, nonaccrual, paid_off, charged_off","type":"string"},"syndicate":{"oneOf":[{"$ref":"#/components/schemas/Syndicate"},{"type":"null"}]},"term_months":{"format":"int64","type":"integer"}},"required":["accrued_interest","accrued_posted_amount","annual_rate_bps","annual_rate_nanos","bucket","charged_off_amount","customer_id","days_past_due","decision","fees_due_amount","id","ledger_account_id","outstanding_amount","participations_sold_amount","principal_amount","product_code","product_version","recovered_amount","status","term_months"],"type":"object"},"LoanEncumbrance":{"description":"LoanEncumbrance is the register's live pledge of a loan: while set, the loan cannot be sold or participated out.","properties":{"at":{"format":"date-time","type":"string"},"lender_id":{"format":"int64","type":"integer"},"lender_name":{"type":"string"},"pledge_id":{"format":"int64","type":"integer"},"state":{"description":"reserved, pledged or releasing","type":"string"}},"required":["at","lender_id","lender_name","pledge_id","state"],"type":"object"},"LoanItem":{"description":"LoanItem is one loan as the bank lists it on a collateral schedule: the lender's requirements name the outstanding principal, delinquency and status.","properties":{"asset_class":{"type":"string"},"charged_off":{"type":"boolean"},"days_past_due":{"format":"int64","type":"integer"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"nonaccrual":{"type":"boolean"},"outstanding_principal_amount":{"format":"int64","type":"integer"}},"required":["asset_class","charged_off","days_past_due","loan_id","nonaccrual","outstanding_principal_amount"],"type":"object"},"LoanVersion":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"pending_commands":{"type":"boolean"},"source_sha256":{"type":"string"},"source_updated_at":{"format":"date-time","type":"string"}},"required":["as_of","loan_id","pending_commands","source_sha256","source_updated_at"],"type":"object"},"LocalSourceKind":{"description":"LocalSourceKind is a workpaper source the reporting service computes from retained service data. The declared targets bound what a capture may supply; every declared target a capture cannot supply is listed with its reason, never filled with zero. A CompleteSchedule kind declares every position the retained FFIEC051 2026-09-30 reference linkbase binds for its schedule, so its capture accounts for the whole schedule.","properties":{"complete_schedule":{"type":"boolean"},"data":{"type":"string"},"description":{"type":"string"},"kind":{"type":"string"},"period":{"description":"instant, or calendar_year for sources carrying January 1 duration facts","type":"string"},"schedule":{"type":"string"},"targets":{"items":{"$ref":"#/components/schemas/SourceTarget"},"type":"array"}},"required":["complete_schedule","data","description","kind","period","schedule","targets"],"type":"object"},"Lockbox":{"description":"Lockbox is a remittance address the bank opens for a customer.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"address":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"status":{"type":"string"}},"required":["account_id","created_at","id","name","number","status"],"type":"object"},"LockboxItem":{"description":"LockboxItem is one check in a remittance with the invoices it pays.","properties":{"amount":{"format":"int64","type":"integer"},"batch_number":{"format":"int64","type":"integer"},"check_deposit_id":{"type":"string"},"id":{"type":"string"},"invoices":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"item_number":{"format":"int64","type":"integer"},"micr":{"$ref":"#/components/schemas/MICR"},"remitter":{"type":"string"}},"required":["amount","batch_number","id","item_number","micr"],"type":"object"},"LockboxRemittance":{"description":"LockboxRemittance is one day's mail for a lockbox.","properties":{"batch_count":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"item_count":{"format":"int64","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/LockboxItem"},"type":"array"},"lockbox_id":{"type":"string"},"status":{"type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["batch_count","business_date","created_at","id","item_count","lockbox_id","status","total_amount"],"type":"object"},"LockboxRequest":{"description":"LockboxRequest opens a lockbox for an account.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"address":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"}},"required":["account_id","name","number"],"type":"object"},"LoginRequest":{"description":"LoginRequest is a password login.","properties":{"device":{"$ref":"#/components/schemas/DeviceSignals"},"email":{"type":"string"},"password":{"type":"string"}},"required":["device","email","password"],"type":"object"},"Lot":{"properties":{"accrued_to_date":{"description":"exclusive start boundary; closing D requires D+1","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"actual_proceeds_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"cash_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disposal_cash_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disposal_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"disposal_execution_sha256":{"type":"string"},"disposal_order_id":{"type":"string"},"disposal_settlement_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"disposal_settlement_sha256":{"type":"string"},"disposal_trade_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"exceptions":{"items":{"type":"string"},"type":"array"},"execution_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"id":{"type":"string"},"instrument":{"$ref":"#/components/schemas/Control"},"latest_observation":{"oneOf":[{"$ref":"#/components/schemas/Observation"},{"type":"null"}]},"latest_valuation":{"oneOf":[{"$ref":"#/components/schemas/ValuationRecord"},{"type":"null"}]},"legal_entity":{"type":"string"},"original_cost_amount":{"format":"int64","type":"integer"},"program":{"$ref":"#/components/schemas/Control"},"purchase_order_id":{"type":"string"},"redemption_id":{"type":"string"},"reservation_revision":{"format":"int64","type":"integer"},"reserved_order_id":{"type":"string"},"reserved_redemption_id":{"type":"string"},"revision":{"format":"int64","type":"integer"},"schedule":{"$ref":"#/components/schemas/AccrualSchedule"},"settlement_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"settlement_sha256":{"type":"string"},"status":{"description":"unsettled, active, selling, sold_unsettled, sold, redeeming, redeemed, exception","type":"string"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"trade_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"units":{"description":"original full quantity; disposition never rewrites it","format":"int64","type":"integer"}},"required":["exceptions","execution_sha256","external_account_reference","id","instrument","legal_entity","original_cost_amount","program","purchase_order_id","revision","schedule","status","trade_date","trade_journal_id","units"],"type":"object"},"MICR":{"description":"MICR is a check's magnetic line.","properties":{"aux_on_us":{"type":"string"},"check_number":{"type":"string"},"on_us":{"description":"account number, \"/\" and serial as printed","type":"string"},"payor_routing_number":{"type":"string"}},"required":["on_us","payor_routing_number"],"type":"object"},"Manifest":{"description":"Manifest is the package's own description. It names only produced items and privilege-log entries: material withheld for BSA confidentiality appears nowhere in it.","properties":{"component_format":{"additionalProperties":{"type":"string"},"type":"object"},"counsel":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"custody_log":{"items":{"$ref":"#/components/schemas/CustodyEntry"},"type":"array"},"encryption":{"type":"string"},"format":{"type":"string"},"legal_request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"matter_ref":{"type":"string"},"package_root_sha256":{"type":"string"},"privilege_log":{"items":{"$ref":"#/components/schemas/PrivilegeEntry"},"type":"array"},"produced":{"items":{"$ref":"#/components/schemas/ManifestItem"},"type":"array"},"production_id":{"type":"string"},"sequence":{"format":"int64","type":"integer"}},"required":["component_format","counsel","created_at","custody_log","encryption","format","legal_request_id","matter_ref","package_root_sha256","privilege_log","produced","production_id","sequence"],"type":"object"},"ManifestComponent":{"properties":{"bytes":{"format":"int64","type":"integer"},"name":{"type":"string"},"parts":{"format":"int64","type":"integer"},"sha256":{"type":"string"}},"required":["bytes","name","parts","sha256"],"type":"object"},"ManifestItem":{"properties":{"components":{"items":{"$ref":"#/components/schemas/ManifestComponent"},"type":"array"},"custodian":{"type":"string"},"family":{"$ref":"#/components/schemas/Target"},"production_number":{"type":"string"},"record_date":{"format":"date-time","type":"string"},"record_date_basis":{"type":"string"},"source_key":{"type":"string"}},"required":["components","custodian","family","production_number","record_date","record_date_basis","source_key"],"type":"object"},"ManifestRequest":{"properties":{"evidence":{"type":"string"},"seal_numbers":{"items":{"type":"string"},"type":"array"}},"required":["evidence","seal_numbers"],"type":"object"},"Mapping":{"description":"Mapping is every live product and GL code with the schedule items it reports on.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"balance_decided_ri_items":{"description":"BalanceDecidedRIItems counts the products whose ri_item the filing decides by each\naccount's balance; ri_item_basis on the line says so.","format":"int64","type":"integer"},"lines":{"items":{"$ref":"#/components/schemas/MappingLine"},"type":"array"},"note":{"type":"string"},"unmapped":{"format":"int64","type":"integer"}},"required":["as_of","balance_decided_ri_items","lines","note","unmapped"],"type":"object"},"MappingLine":{"description":"MappingLine is one product or GL code and where it reports.","properties":{"call_report_line":{"type":"string"},"code":{"type":"string"},"demand":{"description":"a deposit GL the chart marks noninterest-bearing","type":"boolean"},"fr2900_class":{"type":"string"},"gl_code":{"type":"string"},"kind":{"description":"product or gl_code","type":"string"},"mapped":{"type":"boolean"},"name":{"type":"string"},"rc_c_item":{"type":"string"},"rc_e_column":{"type":"string"},"ri_item":{"type":"string"},"ri_item_basis":{"description":"set when the filed line is not the product's to decide","type":"string"}},"required":["code","kind","mapped","name"],"type":"object"},"Match":{"properties":{"alias_type":{"description":"primary, strong or weak","type":"string"},"dob_match":{"type":"boolean"},"list_id":{"type":"string"},"matched_name":{"type":"string"},"score":{"type":"number"}},"required":["alias_type","list_id","matched_name","score"],"type":"object"},"MatchRequest":{"properties":{"journal_ids":{"items":{"type":"string"},"type":"array"},"line_id":{"type":"string"},"reason":{"type":"string"},"statement_id":{"type":"string"},"statement_sha256":{"type":"string"}},"required":["journal_ids","line_id","reason","statement_id","statement_sha256"],"type":"object"},"MaturityAction":{"description":"MaturityAction is what happened to one certificate at the maturity run.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action":{"description":"renewed, matured or in_grace","type":"string"},"grace_ends":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"new_maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"notice_id":{"description":"the Reg DD 1030.5(b) maturity notice that preceded the renewal","type":"string"},"notice_missing":{"type":"boolean"},"rate_bps":{"format":"int64","type":"integer"}},"required":["account_id","action","maturity_date","notice_missing"],"type":"object"},"MaturityReport":{"description":"MaturityReport is one run of the certificate maturities.","properties":{"actions":{"items":{"$ref":"#/components/schemas/MaturityAction"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"in_grace":{"format":"int64","type":"integer"},"matured":{"format":"int64","type":"integer"},"notices_missing":{"format":"int64","type":"integer"},"operator":{"type":"string"},"renewed":{"format":"int64","type":"integer"},"replayed":{"type":"boolean"},"reviewed":{"format":"int64","type":"integer"}},"required":["actions","business_date","in_grace","matured","notices_missing","operator","renewed","replayed","reviewed"],"type":"object"},"MerchantBlock":{"description":"MerchantBlock is a merchant identity blocked after its screening at clearing was not clear.","properties":{"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"clear_note":{"type":"string"},"clearance":{"description":"the pending or latest clearance request","oneOf":[{"$ref":"#/components/schemas/BlockClearance"},{"type":"null"}]},"cleared_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"cleared_by":{"type":"string"},"country":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"merchant_id":{"type":"string"},"merchant_name":{"type":"string"},"name_key":{"type":"string"},"result":{"description":"hit or potential_match","type":"string"},"screening_id":{"example":"scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"description":"active or cleared","type":"string"}},"required":["authorization_id","country","created_at","id","merchant_name","name_key","result","screening_id","status"],"type":"object"},"MerchantScreenRetry":{"description":"MerchantScreenRetry is one pass over unscreened clearings and unraised block alerts.","properties":{"alerts_pending":{"description":"block alerts still not raised","format":"int64","type":"integer"},"alerts_raised":{"description":"block alerts raised this pass","format":"int64","type":"integer"},"screened":{"description":"clearings screened (clear or not) this pass","format":"int64","type":"integer"},"unscreened":{"description":"clearings still unscreened after this pass","format":"int64","type":"integer"}},"required":["alerts_pending","alerts_raised","screened","unscreened"],"type":"object"},"MerchantScreening":{"description":"MerchantScreening is an authorisation's merchant-screening flag from clearing and every attempt.","properties":{"attempts":{"items":{"$ref":"#/components/schemas/MerchantScreeningAttempt"},"type":"array"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"block_id":{"type":"string"},"detail":{"type":"string"},"outcome":{"type":"string"},"screening_id":{"example":"scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["attempts","authorization_id","outcome"],"type":"object"},"MerchantScreeningAttempt":{"description":"MerchantScreeningAttempt is one screening of a clearing's merchant.","properties":{"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"block_id":{"type":"string"},"detail":{"type":"string"},"id":{"format":"int64","type":"integer"},"outcome":{"description":"unscreened, clear, potential_match, hit","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"screening_id":{"example":"scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["authorization_id","id","outcome","recorded_at"],"type":"object"},"Message":{"description":"Message is the operator's answer to a transfer: an acknowledgment to the Sender, an advice to the Receiver, or a rejection to the Sender. The operator reference is assigned when the service time-stamps the message (6.3.2); the settled time is when the debits and credits became final (9.2.1).","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"operator_reference":{"type":"string"},"processed_at":{"format":"date-time","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"signature":{"type":"string"},"status":{"description":"settled or rejected","type":"string"},"transfer":{"$ref":"#/components/schemas/FedsecuritiesTransfer"},"version":{"type":"string"}},"required":["business_date","key_id","kind","operator_reference","processed_at","signature","status","transfer","version"],"type":"object"},"MessageDelivery":{"description":"MessageDelivery is one cash management message handed to the ledger: the bare camt.052, camt.053 or camt.054 Document, who sent it and the channel's reference.","properties":{"document":{"description":"base64 in JSON","format":"byte","type":"string"},"network_ref":{"type":"string"},"possible_duplicate":{"type":"boolean"},"sender_bic":{"type":"string"}},"required":["document"],"type":"object"},"MessageReceipt":{"description":"MessageReceipt is the outcome of one delivered cash management message: accepted (its pages retained), replayed (retained before) or refused, with the reason.","properties":{"id":{"format":"int64","type":"integer"},"message_definition":{"type":"string"},"message_sha256":{"type":"string"},"network_ref":{"type":"string"},"outcome":{"type":"string"},"reason":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"received_by":{"type":"string"},"sender_bic":{"type":"string"},"source":{"type":"string"},"statement_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","message_sha256","outcome","received_at","received_by","source","statement_ids"],"type":"object"},"MessageResult":{"description":"MessageResult is what the ledger did with a message: its receipt, the pages it retained or replayed, and anything the reconciliation and liquidity passes that follow could not do (the message stays accepted; the next pass retries).","properties":{"follow_up_errors":{"items":{"type":"string"},"type":"array"},"receipt":{"$ref":"#/components/schemas/MessageReceipt"},"statements":{"items":{"$ref":"#/components/schemas/StatementSummary"},"type":"array"}},"required":["receipt","statements"],"type":"object"},"Method":{"description":"Method is one identification and verification method offered on the yellow path.","properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"MissingItem":{"description":"MissingItem is a declared target a capture could not supply from retained data.","properties":{"category":{"type":"string"},"key":{"type":"string"},"mdrm":{"type":"string"},"reason":{"type":"string"},"reference":{"$ref":"#/components/schemas/TaxonomyReference"}},"required":["category","key","reason","reference"],"type":"object"},"MissingLine":{"description":"MissingLine is a schedule item the service does not produce and the source it needs. The figure is neither invented nor left silently absent: supply it as an evidenced import.","properties":{"description":{"type":"string"},"item":{"type":"string"},"requires":{"type":"string"}},"required":["description","item","requires"],"type":"object"},"Model":{"properties":{"accrued_interest_policy":{"type":"string"},"board_policy_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"engine":{"type":"string"},"forecast_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"groups":{"items":{"$ref":"#/components/schemas/CeclGroup"},"type":"array"},"historical_loss_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"independent_validation_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"interest_write_off_policy":{"$ref":"#/components/schemas/MonitoringEvidence"},"max_risk_grade_age_days":{"format":"int64","type":"integer"},"name":{"type":"string"},"previous_id":{"type":"string"},"reason":{"type":"string"},"reversion_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"type":"string"}},"required":["accrued_interest_policy","board_policy_evidence","engine","forecast_evidence","groups","historical_loss_evidence","independent_validation_evidence","interest_write_off_policy","max_risk_grade_age_days","name","previous_id","reason","reversion_evidence","valid_from","valid_through","version"],"type":"object"},"MonitorBlocker":{"properties":{"reason":{"type":"string"},"transaction_ref":{"type":"string"}},"required":["reason","transaction_ref"],"type":"object"},"MonitorItem":{"properties":{"accrued_interest_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"actual_cash_collateral_amount":{"format":"int64","type":"integer"},"blockers":{"items":{"type":"string"},"type":"array"},"collateral":{"items":{"$ref":"#/components/schemas/CollateralSnapshot"},"type":"array"},"lending_source":{"additionalProperties":true,"type":"object"},"lending_source_sha256":{"type":"string"},"lending_version":{"additionalProperties":true,"type":"object"},"plan":{"$ref":"#/components/schemas/Record"},"principal_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"registry_records":{"items":{"$ref":"#/components/schemas/Record"},"type":"array"},"required_covered_amount":{"format":"int64","type":"integer"},"reservation":{"$ref":"#/components/schemas/RegwReservation"},"undrawn_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"unpaid_fees_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]}},"required":["actual_cash_collateral_amount","blockers","collateral","plan","registry_records","required_covered_amount","reservation"],"type":"object"},"MonitorRequest":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["business_date"],"type":"object"},"MonitorRun":{"description":"MonitorRun is a dated, immutable observation of the active commitment book, authoritative lending source, current classifications and actual cash holds. It is a point-in-time exception control, not a claim of uninterrupted legal compliance.","properties":{"actor":{"type":"string"},"all_affiliate_exposure":{"format":"int64","type":"integer"},"blockers":{"items":{"$ref":"#/components/schemas/MonitorBlocker"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"capital_stock_and_surplus":{"format":"int64","type":"integer"},"capture_started_at":{"format":"date-time","type":"string"},"captured_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/MonitorItem"},"type":"array"},"observation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"policy":{"$ref":"#/components/schemas/Record"},"ready":{"type":"boolean"},"single_affiliate_exposures":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"}},"required":["actor","all_affiliate_exposure","blockers","business_date","capital_stock_and_surplus","capture_started_at","captured_at","content_sha256","id","items","observation_date","policy","ready","single_affiliate_exposures"],"type":"object"},"MonitoringDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"reason":{"type":"string"}},"required":["actor","approve","at","evidence","reason"],"type":"object"},"MonitoringEvent":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"business_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"channel":{"type":"string"},"counterparty":{"type":"string"},"currency_code":{"type":"string"},"direction":{"type":"string"},"event_id":{"type":"string"},"kind":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"subject":{"type":"string"}},"required":["amount","currency_code","direction","event_id","kind","occurred_at","subject"],"type":"object"},"MonitoringEvidence":{"description":"Evidence identifies the actual reviewed input, never an inferred geocode or identity.","properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"MonitoringExport":{"properties":{"actor":{"type":"string"},"category":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"limitations":{"items":{"type":"string"},"type":"array"},"purpose":{"type":"string"},"schema_id":{"type":"string"},"sha256":{"type":"string"},"source_ids":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"}},"required":["actor","category","created_at","data","id","limitations","purpose","schema_id","sha256","source_ids","submission_ready"],"type":"object"},"MonitoringExportRequest":{"properties":{"purpose":{"type":"string"},"reporting_year":{"format":"int64","type":"integer"}},"required":["purpose","reporting_year"],"type":"object"},"MonitoringProposal":{"properties":{"monitoring":{"oneOf":[{"$ref":"#/components/schemas/Capture"},{"type":"null"}]},"previous_id":{"type":"string"},"reason":{"type":"string"},"risk_grade":{"oneOf":[{"$ref":"#/components/schemas/RiskGrade"},{"type":"null"}]}},"required":["previous_id","reason"],"type":"object"},"MonitoringResult":{"description":"MonitoringResult is what reporting a movement produced.","properties":{"alerts":{"description":"the rules that fired, upserted per rule, subject and day","items":{"$ref":"#/components/schemas/Alert"},"type":"array"},"replayed":{"description":"the event id was seen before, so nothing was evaluated again","type":"boolean"}},"required":["alerts","replayed"],"type":"object"},"MonitoringReview":{"properties":{"approve":{"type":"boolean"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"reason":{"type":"string"}},"required":["approve","evidence","reason"],"type":"object"},"Month":{"properties":{"balance":{"format":"int64","type":"integer"},"disbursements":{"format":"int64","type":"integer"},"payment":{"format":"int64","type":"integer"},"payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"target_limit":{"format":"int64","type":"integer"}},"required":["balance","disbursements","payment","payment_date","target_limit"],"type":"object"},"MonthlyFee":{"description":"MonthlyFee is a periodic account charge, debited or invoiced.","properties":{"amount":{"format":"int64","type":"integer"},"billing":{"description":"item_debit or invoice","type":"string"},"code":{"type":"string"}},"required":["amount","billing","code"],"type":"object"},"MonthlyFeeRun":{"description":"MonthlyFeeRun is the charges one monthly fee run expects or accrued.","properties":{"charges":{"items":{"$ref":"#/components/schemas/ExpectedCharge"},"type":"array"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period":{"type":"string"},"terms_id":{"format":"int64","type":"integer"}},"required":["charges","nostro_account_id","period","terms_id"],"type":"object"},"Movement":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"agent_of":{"description":"owner the conductor acts for as an agent","type":"string"},"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"conductor_customer_id":{"description":"identified natural-person customer physically conducting the movement for a different owner","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"conductor_non_customer_id":{"description":"natural person without a customer record; exclusive of conductor_customer_id","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"count_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"description":"identified owner conducting a customer cash movement, or the owner for whom the conductor acts","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"delivery_method":{"description":"armored_car, mail, night_deposit, shared_branch","type":"string"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"execution":{"oneOf":[{"$ref":"#/components/schemas/CashExecution"},{"type":"null"}]},"foreign_amount_minor":{"format":"int64","type":"integer"},"foreign_country":{"type":"string"},"foreign_currency":{"description":"ISO 4217 of counted foreign cash; AmountMinor is the USD equivalent","type":"string"},"from_unit_id":{"type":"string"},"id":{"type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"kind":{"description":"shipment_in, shipment_out, transfer, deposit, withdrawal, adjustment","type":"string"},"reference":{"type":"string"},"to_unit_id":{"type":"string"}},"required":["actor","amount","business_date","created_at","evidence","evidence_sha256","id","journal","kind","reference"],"type":"object"},"MovementEvidence":{"properties":{"authority_ref":{"type":"string"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"ordinary_owner_cash_only":{"type":"boolean"},"outside_inventory_as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"outside_inventory_complete":{"type":"boolean"},"outside_original":{"oneOf":[{"$ref":"#/components/schemas/OutsideDistribution"},{"type":"null"}]},"outside_rollovers":{"items":{"$ref":"#/components/schemas/OutsideRollover"},"type":"array"},"policy_sha256":{"type":"string"},"rmd_policy_id":{"type":"string"}},"required":["authority_ref","instruction_ref","instruction_sha256","ordinary_owner_cash_only","outside_inventory_complete","policy_sha256"],"type":"object"},"MovementRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"agent_of":{"description":"owner the conductor acts for as an agent","type":"string"},"amount":{"format":"int64","type":"integer"},"conductor_customer_id":{"description":"identified natural-person customer physically conducting the movement for a different owner","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"conductor_non_customer_id":{"description":"natural person without a customer record; exclusive of conductor_customer_id","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"count_id":{"type":"string"},"customer_id":{"description":"identified owner conducting a customer cash movement, or the owner for whom the conductor acts","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"delivery_method":{"description":"armored_car, mail, night_deposit, shared_branch","type":"string"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"foreign_amount_minor":{"format":"int64","type":"integer"},"foreign_country":{"type":"string"},"foreign_currency":{"description":"ISO 4217 of counted foreign cash; AmountMinor is the USD equivalent","type":"string"},"from_unit_id":{"type":"string"},"kind":{"description":"shipment_in, shipment_out, transfer, deposit, withdrawal, adjustment","type":"string"},"reference":{"type":"string"},"to_unit_id":{"type":"string"}},"required":["amount","evidence","evidence_sha256","kind","reference"],"type":"object"},"NAUPAContact":{"description":"NAUPAContact is a HOLDER-CONTACT group.","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"extension":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["address1","city","country","name","phone","state","zip"],"type":"object"},"NAUPAHolder":{"description":"NAUPAHolder is the HOLDER record.","properties":{"city":{"type":"string"},"claims_contact":{"oneOf":[{"$ref":"#/components/schemas/NAUPAContact"},{"type":"null"}]},"contact":{"$ref":"#/components/schemas/NAUPAContact"},"county":{"type":"string"},"fax":{"type":"string"},"incorporated_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"incorporated_state":{"type":"string"},"naics":{"type":"string"},"name":{"type":"string"},"report_number":{"format":"int64","type":"integer"},"report_type":{"type":"string"},"report_year":{"format":"int64","type":"integer"},"sic":{"type":"string"},"state":{"type":"string"},"tax_id":{"type":"string"},"tax_id_ext":{"type":"string"}},"required":["city","contact","county","incorporated_date","naics","name","report_number","report_type","report_year","state","tax_id","tax_id_ext"],"type":"object"},"NAUPAOwner":{"description":"NAUPAOwner is a PROPADD additional owner.","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"business_name":{"type":"boolean"},"city":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"date_of_birth":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"owner_type_code":{"type":"string"},"prefix":{"type":"string"},"relationship_code":{"type":"string"},"state":{"type":"string"},"suffix":{"type":"string"},"tax_id_ext":{"type":"string"},"title":{"type":"string"},"zip":{"type":"string"}},"required":["date_of_birth","last_name","owner_type_code","relationship_code"],"type":"object"},"NAUPASummary":{"description":"NAUPASummary is the SUMINFO record.","properties":{"addition_minor":{"format":"int64","type":"integer"},"advertised_minor":{"format":"int64","type":"integer"},"creator":{"type":"string"},"creator_contact":{"type":"string"},"deduction_minor":{"format":"int64","type":"integer"},"deletion_minor":{"format":"int64","type":"integer"},"negative":{"type":"boolean"},"properties":{"format":"int64","type":"integer"},"records":{"format":"int64","type":"integer"},"remitted_minor":{"format":"int64","type":"integer"},"reported_minor":{"format":"int64","type":"integer"},"software_version":{"type":"string"}},"required":["addition_minor","advertised_minor","creator","creator_contact","deduction_minor","deletion_minor","negative","properties","records","remitted_minor","reported_minor","software_version"],"type":"object"},"Name":{"properties":{"Name":{"type":"string"}},"required":["Name"],"type":"object"},"NativeProvenance":{"description":"NativeProvenance distinguishes an actual source-generated, locally validated form from imported XML and independently authenticated bridge reports.","properties":{"guide_sha256":{"type":"string"},"input_sha256":{"type":"string"},"rules_id":{"type":"string"},"source_sha256":{"type":"string"},"validation_sha256":{"type":"string"},"version":{"type":"string"}},"required":["guide_sha256","input_sha256","rules_id","source_sha256","validation_sha256","version"],"type":"object"},"NativeTime":{"description":"NativeTime is the row's own timestamp column an inventory connector observed. It dates the row for discovery and production scope; it is not a retention trigger, because a mutable row's current version can be younger than its creation column.","properties":{"at":{"format":"date-time","type":"string"},"column":{"type":"string"}},"required":["at","column"],"type":"object"},"NativeValidation":{"description":"NativeValidation retains the complete deterministic engine reports without pretending the bank's local validator signed as an independent bridge. Maps marshal canonically across PostgreSQL JSONB key-order normalization.","properties":{"batch_sha256":{"type":"string"},"business":{"additionalProperties":true,"type":"object"},"form":{"type":"string"},"guide_sha256":{"type":"string"},"input_sha256":{"type":"string"},"rules_id":{"type":"string"},"schema":{"additionalProperties":true,"type":"object"},"schema_bundle_sha256":{"type":"string"},"source_sha256":{"type":"string"},"validated_at":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["batch_sha256","business","form","guide_sha256","input_sha256","rules_id","schema","schema_bundle_sha256","source_sha256","validated_at","version"],"type":"object"},"NetworkSettlement":{"description":"NetworkSettlement is a proposed, reviewed and posted network settlement.","properties":{"computed":{"allOf":[{"$ref":"#/components/schemas/AtmSettlementReport"}],"description":"the same figures from the switch's own transactions"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"the transactions it settles","items":{"type":"string"},"type":"array"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maker":{"type":"string"},"posted_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"posted_by":{"type":"string"},"report":{"$ref":"#/components/schemas/AtmSettlementReport"},"request":{"$ref":"#/components/schemas/SettlementRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/AtmReview"},{"type":"null"}]}},"required":["computed","created_at","id","items","maker","report","request"],"type":"object"},"NetworkTokenDeliveryRun":{"description":"NetworkTokenDeliveryRun is one pass over pending token service commands.","properties":{"attempts":{"items":{"$ref":"#/components/schemas/CommandAttempt"},"type":"array"},"waiting":{"format":"int64","type":"integer"}},"required":["attempts","waiting"],"type":"object"},"NetworkfinanceApplyRequest":{"properties":{"content_sha256":{"type":"string"}},"required":["content_sha256"],"type":"object"},"NetworkfinanceEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"NetworkfinanceLine":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"interchange or scheme_fee; reversal requires ReversesReference.","type":"string"},"reference":{"type":"string"},"reverses_reference":{"type":"string"}},"required":["amount_minor","authorization_id","kind","reference"],"type":"object"},"NetworkfinancePosting":{"properties":{"actor":{"type":"string"},"committed_journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]},"completed":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"}},"required":["actor","completed","created_at","journal","journal_key"],"type":"object"},"NetworkfinanceRecord":{"properties":{"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"interchange_minor":{"format":"int64","type":"integer"},"kind":{"type":"string"},"network":{"type":"string"},"posting":{"oneOf":[{"$ref":"#/components/schemas/NetworkfinancePosting"},{"type":"null"}]},"principal_settlement_minor":{"format":"int64","type":"integer"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/NetworkfinanceRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/NetworkfinanceReview"},{"type":"null"}]},"scheme_fee_minor":{"format":"int64","type":"integer"},"sources":{"items":{"$ref":"#/components/schemas/NetworkfinanceSource"},"type":"array"}},"required":["content_sha256","created_at","id","interchange_minor","kind","network","principal_settlement_minor","proposed_by","request","scheme_fee_minor","sources"],"type":"object"},"NetworkfinanceRequest":{"properties":{"cash":{"oneOf":[{"$ref":"#/components/schemas/CashRequest"},{"type":"null"}]},"statement":{"oneOf":[{"$ref":"#/components/schemas/StatementRequest"},{"type":"null"}]}},"type":"object"},"NetworkfinanceReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","content_sha256","created_at","decision","reason"],"type":"object"},"NetworkfinanceReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","decision","reason"],"type":"object"},"NetworkfinanceSource":{"properties":{"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_key":{"type":"string"},"record_sha256":{"type":"string"},"reference":{"type":"string"}},"required":["journal","journal_key","reference"],"type":"object"},"NetworktokensAcknowledgment":{"description":"Acknowledgment is the token service's answer to a command. Simulated is true whenever the simulator answered: a simulated acknowledgment is never evidence a network acted.","properties":{"accepted":{"type":"boolean"},"command_id":{"type":"string"},"detail":{"type":"string"},"network_reference":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"simulated":{"type":"boolean"}},"required":["accepted","command_id","received_at","simulated"],"type":"object"},"NetworktokensAuthorizationRequest":{"description":"AuthorizationRequest is the token service's token authorization request, bank-defined.","properties":{"card_verification":{"$ref":"#/components/schemas/CardVerification"},"device_sha256":{"description":"wallet: opaque device binding digest","type":"string"},"merchant_id":{"description":"merchant: the exact processor merchant identity","type":"string"},"network":{"type":"string"},"pan_source":{"description":"issuer_app, manual or on_file","type":"string"},"pan_token":{"description":"the issuer processor's surrogate of the funding PAN","type":"string"},"request_reference":{"type":"string"},"risk":{"$ref":"#/components/schemas/Risk"},"token_expiry_month":{"format":"int64","type":"integer"},"token_expiry_year":{"format":"int64","type":"integer"},"token_last4":{"type":"string"},"token_reference":{"description":"the token service's unique token reference, never the token number","type":"string"},"token_requestor_id":{"description":"11 digits","type":"string"},"token_requestor_name":{"type":"string"},"token_type":{"description":"secure_element, cloud or card_on_file","type":"string"},"use_case":{"type":"string"},"wallet_consent_id":{"description":"push provisioning: the holder's recorded wallet consent","type":"string"}},"required":["card_verification","network","pan_source","pan_token","request_reference","risk","token_expiry_month","token_expiry_year","token_last4","token_reference","token_requestor_id","token_requestor_name","token_type","use_case"],"type":"object"},"NetworktokensCommand":{"description":"Command is an issuer instruction to the token service.","properties":{"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"kind":{"description":"suspend, resume, delete or pan_update","type":"string"},"network":{"type":"string"},"pan_update":{"oneOf":[{"$ref":"#/components/schemas/PANUpdate"},{"type":"null"}]},"reason":{"type":"string"},"source_sequence":{"format":"int64","type":"integer"},"token_id":{"type":"string"},"token_reference":{"type":"string"}},"required":["created_at","id","kind","network","reason","source_sequence","token_id","token_reference"],"type":"object"},"NetworktokensControls":{"description":"Controls are per-token spending controls. They only ever restrict further than the card's own controls, which still apply to every token authorization.","properties":{"blocked_mccs":{"items":{"type":"string"},"type":"array"},"channels":{"description":"empty means every channel of the token's domain","items":{"type":"string"},"type":"array"},"daily_limit_amount":{"format":"int64","type":"integer"},"per_transaction_limit_amount":{"format":"int64","type":"integer"},"valid_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"type":"object"},"NetworktokensDecision":{"description":"Decision is the issuer's answer to a token authorization request.","properties":{"assurance":{"type":"string"},"decision":{"type":"string"},"reasons":{"items":{"type":"string"},"type":"array"},"verification_methods":{"items":{"$ref":"#/components/schemas/Method"},"type":"array"}},"required":["assurance","decision","reasons"],"type":"object"},"NetworktokensEvent":{"description":"Event is one immutable entry in a token's history with the token state after it.","properties":{"actor":{"type":"string"},"actor_kind":{"description":"token_service, holder, staff or issuer","type":"string"},"at":{"format":"date-time","type":"string"},"challenge":{"oneOf":[{"$ref":"#/components/schemas/Challenge"},{"type":"null"}]},"code_attempt":{"description":"the attempt without its code","oneOf":[{"$ref":"#/components/schemas/CodeAttemptRequest"},{"type":"null"}]},"code_request":{"oneOf":[{"$ref":"#/components/schemas/CodeRequest"},{"type":"null"}]},"command_id":{"type":"string"},"controls_request":{"oneOf":[{"$ref":"#/components/schemas/ControlsRequest"},{"type":"null"}]},"kind":{"type":"string"},"lifecycle":{"oneOf":[{"$ref":"#/components/schemas/LifecycleRequest"},{"type":"null"}]},"notification":{"oneOf":[{"$ref":"#/components/schemas/NetworktokensNotification"},{"type":"null"}]},"outcome":{"type":"string"},"pan_update":{"oneOf":[{"$ref":"#/components/schemas/PANUpdate"},{"type":"null"}]},"proposal_id":{"type":"string"},"reason":{"type":"string"},"request":{"oneOf":[{"$ref":"#/components/schemas/NetworktokensAuthorizationRequest"},{"type":"null"}]},"request_sha256":{"type":"string"},"result":{"$ref":"#/components/schemas/Token"},"sequence":{"format":"int64","type":"integer"},"token_id":{"type":"string"}},"required":["actor","actor_kind","at","kind","outcome","request_sha256","result","sequence","token_id"],"type":"object"},"NetworktokensHistory":{"description":"History is a page of a token's events in sequence order.","properties":{"events":{"items":{"$ref":"#/components/schemas/NetworktokensEvent"},"type":"array"},"more":{"type":"boolean"},"token":{"$ref":"#/components/schemas/Token"}},"required":["events","more","token"],"type":"object"},"NetworktokensNotification":{"description":"Notification is a token lifecycle notification from the token service.","properties":{"event":{"description":"activated, suspended, resumed or deleted","type":"string"},"initiated_by":{"description":"token_requestor, cardholder, network or issuer","type":"string"},"network":{"type":"string"},"notification_reference":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"reason":{"type":"string"},"token_reference":{"type":"string"}},"required":["event","initiated_by","network","notification_reference","occurred_at","token_reference"],"type":"object"},"NetworktokensReview":{"description":"Review is the independent decision on a proposal and what its approval changed.","properties":{"actor":{"type":"string"},"applied_token_ids":{"items":{"type":"string"},"type":"array"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["actor","applied_token_ids","approve","at","content_sha256","reason"],"type":"object"},"NetworktokensReviewRequest":{"description":"ReviewRequest approves or rejects a proposal against its exact content digest.","properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["approve","content_sha256","reason"],"type":"object"},"NewCustomer":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"date_of_birth":{"type":"string"},"email":{"type":"string"},"formation_date":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"},"tax_id":{"type":"string"},"type":{"type":"string"}},"required":["address","email","legal_name","tax_id","type"],"type":"object"},"NewGroup":{"description":"NewGroup opens a group.","properties":{"members":{"items":{"$ref":"#/components/schemas/GroupMemberRequest"},"type":"array"},"name":{"type":"string"},"parent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"transfer_policy":{"description":"any_member (default) or parent_only","type":"string"}},"required":["name","parent_customer_id"],"type":"object"},"NormalizedStatement":{"description":"NormalizedStatement is a report, statement or notification page read at its currency's scale.","properties":{"account_identifier":{"type":"string"},"account_is_iban":{"type":"boolean"},"closing_available_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"closing_booked_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"closing_booked_date":{"type":"string"},"created_at":{"type":"string"},"currency_code":{"type":"string"},"cycle":{"type":"string"},"electronic_sequence":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"entries":{"items":{"$ref":"#/components/schemas/Iso20022StatementEntry"},"type":"array"},"from_date":{"description":"YYYY-MM-DD","type":"string"},"interim_at":{"type":"string"},"interim_available_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"interim_booked_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"last_page":{"type":"boolean"},"legal_sequence":{"type":"string"},"message_created_at":{"type":"string"},"message_definition":{"type":"string"},"message_id":{"type":"string"},"opening_booked_amount":{"description":"signed: a debit balance is negative","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"opening_booked_date":{"type":"string"},"page_number":{"format":"int64","type":"integer"},"servicer_bic":{"type":"string"},"statement_id":{"type":"string"},"to_date":{"type":"string"}},"required":["account_identifier","currency_code","entries","last_page","message_created_at","message_definition","message_id","page_number","statement_id"],"type":"object"},"NostroAccount":{"description":"NostroAccount is a retained nostro account record, its review and its ledger account.","properties":{"account_identifier":{"type":"string"},"control_status":{"description":"open, suspended or closed once approved","type":"string"},"correspondent_bic":{"type":"string"},"correspondent_id":{"type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"id":{"type":"string"},"interest_bearing":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maker":{"type":"string"},"primary_route":{"type":"boolean"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"status":{"description":"pending_review, approved or rejected","type":"string"}},"required":["account_identifier","correspondent_bic","correspondent_id","currency_code","gl_code","id","interest_bearing","maker","primary_route","recorded_at","source_ref","status"],"type":"object"},"NostroAccountRequest":{"description":"NostroAccountRequest proposes a nostro account at an approved correspondent.","properties":{"account_identifier":{"description":"AccountIdentifier is how the correspondent identifies the account on its statements: an\nIBAN where the market uses them, the correspondent's account number otherwise.","type":"string"},"correspondent_id":{"type":"string"},"currency_code":{"type":"string"},"interest_bearing":{"type":"boolean"},"primary_route":{"description":"PrimaryRoute marks the account the SWIFT gateway settles the currency through. At most one\nprimary account per currency is not closed.","type":"boolean"},"source_ref":{"type":"string"}},"required":["account_identifier","correspondent_id","currency_code","interest_bearing","primary_route","source_ref"],"type":"object"},"Note":{"description":"Note is one entry on a case.","properties":{"at":{"format":"date-time","type":"string"},"by":{"type":"string"},"text":{"type":"string"}},"required":["at","by","text"],"type":"object"},"Notice":{"properties":{"channel":{"type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"sent_at":{"format":"date-time","type":"string"}},"required":["channel","evidence","sent_at"],"type":"object"},"NoticeRecipient":{"properties":{"address":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"name":{"type":"string"}},"required":["address","customer_id","name"],"type":"object"},"Notification":{"properties":{"attempts":{"format":"int64","type":"integer"},"body":{"type":"string"},"channel":{"type":"string"},"content_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"delivery_status":{"type":"string"},"error":{"description":"why the last attempt did not send","type":"string"},"id":{"example":"ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"next_attempt_at":{"format":"date-time","type":"string"},"provider_ref":{"type":"string"},"recipient_address":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string"},"template":{"type":"string"},"template_version":{"type":"string"}},"required":["attempts","body","channel","content_sha256","customer_id","id","next_attempt_at","status","subject","template","template_version"],"type":"object"},"NotificationEvidence":{"properties":{"action":{"type":"string"},"actor":{"type":"string"},"attempt":{"format":"int64","type":"integer"},"channel":{"description":"set when the attempt used another channel than the message's","type":"string"},"created_at":{"format":"date-time","type":"string"},"detail":{"type":"string"},"id":{"type":"string"},"notification_id":{"example":"ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"provider_ref":{"type":"string"},"recipient_address":{"type":"string"}},"required":["action","attempt","created_at","id","notification_id"],"type":"object"},"NotificationsDeliveryEvidence":{"properties":{"action":{"type":"string"},"actor":{"type":"string"},"attempt":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"delivery_id":{"example":"whdl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"detail":{"type":"string"},"id":{"type":"string"},"response_status":{"format":"int64","type":"integer"}},"required":["action","attempt","created_at","delivery_id","id"],"type":"object"},"NotificationsReceipt":{"properties":{"actor":{"type":"string"},"bounce_type":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"event_id":{"type":"string"},"id":{"type":"string"},"notification_id":{"example":"ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"provider_at":{"description":"the provider's own time for the outcome","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"provider_ref":{"type":"string"},"reason":{"type":"string"},"recipient_address":{"type":"string"},"status":{"type":"string"}},"required":["actor","created_at","event_id","id","notification_id","provider_ref","recipient_address","status"],"type":"object"},"NotificationsReceiptRequest":{"properties":{"bounce_type":{"type":"string"},"event_id":{"type":"string"},"provider_at":{"description":"the provider's own time for the outcome","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"provider_ref":{"type":"string"},"reason":{"type":"string"},"recipient_address":{"type":"string"},"status":{"type":"string"}},"required":["event_id","provider_ref","recipient_address","status"],"type":"object"},"NowDecision":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"evidence":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","approve","evidence","recorded_at"],"type":"object"},"NowDecisionRequest":{"properties":{"approve":{"type":"boolean"},"evidence":{"type":"string"}},"required":["approve","evidence"],"type":"object"},"NowRequest":{"properties":{"classification":{"type":"string"},"domestic_government":{"type":"boolean"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entire_beneficial_interest_eligible":{"type":"boolean"},"evidence":{"type":"string"},"expires_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"government_level":{"type":"string"},"nonprofit_purpose":{"type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"additionalProperties":true,"type":"object"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"revision":{"format":"int64","type":"integer"}},"required":["classification","effective_date","entire_beneficial_interest_eligible","evidence","expires_date","owners","ownership","product_code","product_version","revision"],"type":"object"},"NowReview":{"properties":{"actor":{"type":"string"},"binding_sha256":{"type":"string"},"classification":{"type":"string"},"customer_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/NowDecision"},{"type":"null"}]},"domestic_government":{"type":"boolean"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entire_beneficial_interest_eligible":{"type":"boolean"},"evidence":{"type":"string"},"expires_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"government_level":{"type":"string"},"id":{"type":"string"},"nonprofit_purpose":{"type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"additionalProperties":true,"type":"object"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"revision":{"format":"int64","type":"integer"}},"required":["actor","binding_sha256","classification","customer_sha256","effective_date","entire_beneficial_interest_eligible","evidence","expires_date","id","owners","ownership","product_code","product_version","recorded_at","revision"],"type":"object"},"Obligation":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_reference":{"type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"issuer":{"type":"string"},"jurisdiction":{"type":"string"},"kind":{"type":"string"},"legal_entity":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payee_reference":{"type":"string"},"source":{"$ref":"#/components/schemas/SourceCredit"},"source_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source_date_basis":{"type":"string"},"source_id":{"type":"string"},"source_sha256":{"type":"string"},"tax_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"tax_period":{"type":"string"}},"required":["amount_minor","content_sha256","created_at","currency","customer_id","evidence_reference","hold_id","id","issuer","kind","legal_entity","source","source_date","source_id","source_sha256"],"type":"object"},"ObligationDetermination":{"description":"A continuing determination names the continuing-activity candidate whose clock applies; its fields are absent from initial determinations so retained version hashes never change.","properties":{"continuing_activity_sequence":{"format":"int64","type":"integer"},"continuing_packet_id":{"type":"string"},"disposition":{"description":"required or not_required","type":"string"},"identification_extension":{"type":"boolean"},"initially_unknown_suspect":{"type":"boolean"},"trigger_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["disposition","identification_extension","initially_unknown_suspect","trigger_date"],"type":"object"},"ObligationDocumentRequest":{"properties":{"content_sha256":{"type":"string"},"reason":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["content_sha256","reason","version"],"type":"object"},"ObligationLink":{"properties":{"acknowledgment_sha256":{"type":"string"},"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"packet_content_sha256":{"type":"string"},"packet_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["actor","at","content_sha256","packet_content_sha256","packet_id","version"],"type":"object"},"ObligationLinkRequest":{"properties":{"content_sha256":{"type":"string"},"packet_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["content_sha256","packet_id","version"],"type":"object"},"ObligationProposalRequest":{"properties":{"base_version":{"format":"int64","type":"integer"},"basis":{"type":"string"},"determination":{"$ref":"#/components/schemas/ObligationDetermination"},"evidence":{"format":"byte","type":"string"},"evidence_reference":{"type":"string"},"source_sha256":{"type":"string"}},"required":["base_version","basis","determination","evidence","evidence_reference","source_sha256"],"type":"object"},"ObligationReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"}},"required":["actor","approve","at","content_sha256"],"type":"object"},"ObligationReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"}},"required":["approve","content_sha256"],"type":"object"},"ObligationStatus":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"cash_ready":{"type":"boolean"},"obligation":{"$ref":"#/components/schemas/Obligation"},"paid_minor":{"format":"int64","type":"integer"},"refunded_minor":{"format":"int64","type":"integer"},"remittance_ids":{"items":{"type":"string"},"type":"array"},"reserved_minor":{"format":"int64","type":"integer"},"returned_minor":{"format":"int64","type":"integer"},"unallocated_minor":{"format":"int64","type":"integer"},"unpaid_minor":{"format":"int64","type":"integer"}},"required":["cash_ready","obligation","paid_minor","refunded_minor","remittance_ids","reserved_minor","returned_minor","unallocated_minor","unpaid_minor"],"type":"object"},"ObligationVersion":{"properties":{"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"base_version":{"format":"int64","type":"integer"},"basis_sha256":{"type":"string"},"content_sha256":{"type":"string"},"determination":{"$ref":"#/components/schemas/ObligationDetermination"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"form":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ObligationReview"},{"type":"null"}]},"rules_id":{"type":"string"},"source_sha256":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["alert_id","base_version","basis_sha256","content_sha256","determination","due_date","form","proposed_at","proposed_by","rules_id","source_sha256","version"],"type":"object"},"ObligationView":{"properties":{"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"corrections":{"items":{"$ref":"#/components/schemas/CorrectionSummary"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"current_source_sha256":{"type":"string"},"current_version":{"format":"int64","type":"integer"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"filing_timing":{"description":"unproven,on_time,late","type":"string"},"form":{"type":"string"},"links":{"items":{"$ref":"#/components/schemas/ObligationLink"},"type":"array"},"overdue":{"type":"boolean"},"packet_id":{"type":"string"},"source_changed":{"type":"boolean"},"source_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"stage":{"type":"string"},"versions":{"items":{"$ref":"#/components/schemas/ObligationVersion"},"type":"array"}},"required":["alert_id","created_at","current_source_sha256","current_version","due_date","filing_date","filing_timing","form","links","overdue","source_changed","source_date","stage","versions"],"type":"object"},"Observation":{"properties":{"accrued_income_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"close_out_complete":{"type":"boolean"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"encumbered_units":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/Document"},"external_account_reference":{"type":"string"},"fair_value_amount":{"description":"actual custody units at supplied price","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"lot_id":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"observed_at":{"format":"date-time","type":"string"},"original_execution_sha256":{"type":"string"},"original_settlement_sha256":{"type":"string"},"price":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"price_basis":{"description":"optional actual bid/ask/mid/last source; repo requires bid","type":"string"},"signature":{"type":"string"},"units":{"description":"actual custodian quantity, distinct from trade-date book quantity","format":"int64","type":"integer"},"valuation_basis":{"description":"intraday uses start of AsOf; day_close uses start of AsOf+1","type":"string"},"version":{"type":"string"}},"required":["as_of","close_out_complete","currency_code","cusip","custodian_reference","encumbered_units","evidence","external_account_reference","key_id","legal_entity","lot_id","master_cash_ledger_account_id","observed_at","original_execution_sha256","signature","units","version"],"type":"object"},"Office":{"description":"Office is one Federal Reserve cash office or cash depot from the public FedCash order and deposit-notification deadline page. OrderDeadlineHour is noon local at every office.","properties":{"aba":{"description":"9-digit office routing used on FedCash files","type":"string"},"code":{"type":"string"},"deposit_notify_hour":{"description":"0 means no separate electronic notification deadline","format":"int64","type":"integer"},"district":{"type":"string"},"location":{"description":"IANA timezone of the office","type":"string"},"name":{"type":"string"}},"required":["aba","code","deposit_notify_hour","district","location","name"],"type":"object"},"OfficialCheck":{"description":"OfficialCheck is a cashier's check the bank issued.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"gl_code":{"type":"string"},"id":{"type":"string"},"inclearing_item_id":{"type":"string"},"issued_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"memo":{"type":"string"},"paid_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payee":{"type":"string"},"payee_address":{"oneOf":[{"$ref":"#/components/schemas/PostalAddress"},{"type":"null"}]},"remitter":{"type":"string"},"requested_by":{"type":"string"},"serial":{"type":"string"},"status":{"description":"issued, paid, voided, stopped","type":"string"}},"required":["amount","created_at","currency_code","id","issued_on","payee","serial","status"],"type":"object"},"OpenCase":{"description":"Case tracks actual servicing work. A loss-mitigation request protects against foreclosure from capture, without waiting for staff approval of the request.","properties":{"assigned_to":{"type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"kind":{"description":"collections, loss_mitigation","type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"received_at":{"format":"date-time","type":"string"}},"required":["assigned_to","evidence","kind","loan_id","reason","received_at"],"type":"object"},"OpenRequest":{"properties":{"acknowledgement":{"description":"Acknowledgement is required for a consumer (person) product: the deposit agreement and\ndisclosures served by OpeningDocuments, and the E-SIGN consent for electronic delivery.","oneOf":[{"$ref":"#/components/schemas/OpeningAcknowledgement"},{"type":"null"}]},"description":{"type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"description":"individual (or joint for several owners) by default","oneOf":[{"$ref":"#/components/schemas/Ownership"},{"type":"null"}]},"product_code":{"type":"string"},"screening":{"description":"Screening is an optional ChexSystems inquiry at opening (SSN, first, last). Decline and\nrefer refuse the opening when the accounts service is configured with a ChexSystems URL.","oneOf":[{"$ref":"#/components/schemas/ScreeningIdentity"},{"type":"null"}]}},"required":["owners","product_code"],"type":"object"},"OpenbankingAccessDecision":{"properties":{"access_id":{"type":"string"},"allowed":{"type":"boolean"},"consent":{"$ref":"#/components/schemas/Consent"},"reason":{"type":"string"}},"required":["access_id","allowed","consent","reason"],"type":"object"},"OpenbankingAccessRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"purpose":{"type":"string"},"through":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["fields","purpose"],"type":"object"},"OpenbankingConsentRequest":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"confirmed":{"type":"boolean"},"disclosure_sha256":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"provider_id":{"type":"string"},"provider_version":{"format":"int64","type":"integer"},"purpose":{"type":"string"}},"required":["account_ids","confirmed","disclosure_sha256","expires_at","fields","provider_id","provider_version","purpose"],"type":"object"},"OpenbankingRevocation":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"},"OpeningAcknowledgement":{"description":"OpeningAcknowledgement echoes the agreement version and hash the owners acknowledged, how (electronic through the digital channel, or in_person_signature recorded by branch staff) and the delivery (electronic or paper); electronic needs the E-SIGN consent.","properties":{"agreement_sha256":{"type":"string"},"agreement_version":{"type":"string"},"delivery":{"type":"string"},"e_sign":{"oneOf":[{"$ref":"#/components/schemas/ESignConsent"},{"type":"null"}]},"method":{"type":"string"}},"required":["agreement_sha256","agreement_version","delivery","method"],"type":"object"},"OpeningDocuments":{"description":"OpeningDocuments are the live product version's deposit agreement and E-SIGN consumer disclosure, each with its version and the SHA-256 of its exact text.","properties":{"agreement":{"type":"string"},"agreement_sha256":{"type":"string"},"agreement_version":{"type":"string"},"apy":{"oneOf":[{"$ref":"#/components/schemas/Disclosure"},{"type":"null"}]},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"e_sign_disclosure":{"type":"string"},"e_sign_sha256":{"type":"string"},"e_sign_version":{"type":"string"},"policy_id":{"type":"string"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"}},"required":["agreement","agreement_sha256","agreement_version","e_sign_disclosure","e_sign_sha256","e_sign_version","product_code","product_version"],"type":"object"},"OpeningEvidence":{"description":"OpeningEvidence is the immutable record a consumer account opened on.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"actor_kind":{"type":"string"},"agreement_sha256":{"type":"string"},"agreement_version":{"type":"string"},"delivery":{"type":"string"},"documents":{"oneOf":[{"$ref":"#/components/schemas/OpeningDocuments"},{"type":"null"}]},"e_sign_method":{"type":"string"},"e_sign_sha256":{"type":"string"},"e_sign_version":{"type":"string"},"method":{"type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"}},"required":["account_id","actor","actor_kind","agreement_sha256","agreement_version","delivery","method","owners","product_code","product_version","recorded_at"],"type":"object"},"Option":{"properties":{"due_days":{"format":"int64","type":"integer"},"method":{"type":"string"},"minimum_months":{"format":"int64","type":"integer"}},"required":["method"],"type":"object"},"Order":{"properties":{"accounting_plans":{"items":{"$ref":"#/components/schemas/AccountingPlan"},"type":"array"},"actor":{"type":"string"},"cash_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cash_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cash_posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"custody_account":{"$ref":"#/components/schemas/Control"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"exceptions":{"items":{"type":"string"},"type":"array"},"execution":{"oneOf":[{"$ref":"#/components/schemas/Execution"},{"type":"null"}]},"id":{"type":"string"},"instruction":{"oneOf":[{"$ref":"#/components/schemas/Instruction"},{"type":"null"}]},"instrument":{"$ref":"#/components/schemas/Control"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"program":{"$ref":"#/components/schemas/Control"},"request":{"$ref":"#/components/schemas/CreateOrderRequest"},"request_sha256":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/BanksecuritiesDecision"},"type":"array"},"settlement":{"oneOf":[{"$ref":"#/components/schemas/Settlement"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/Source"},"status":{"type":"string"},"trade_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"trade_posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["actor","created_at","custody_account","exceptions","id","instrument","lot_id","program","request","request_sha256","source","status"],"type":"object"},"OrderObservation":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"cash":{"oneOf":[{"$ref":"#/components/schemas/CashObservation"},{"type":"null"}]},"order":{"$ref":"#/components/schemas/InvestmentsOrder"},"reserved_cash_amount":{"format":"int64","type":"integer"}},"required":["blockers","order","reserved_cash_amount"],"type":"object"},"OrderRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"atm_order_id":{"type":"string"},"cadence":{"description":"ad_hoc, scheduled","type":"string"},"carrier_id":{"type":"string"},"contract_id":{"type":"string"},"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"description":"USD face value in cents -> number of pieces","type":"object"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"fedcash_order_id":{"type":"string"},"from_unit_id":{"type":"string"},"kind":{"description":"delivery, pickup","type":"string"},"needed_by":{"format":"date-time","type":"string"},"reference":{"type":"string"},"service":{"description":"branch, vault, atm, fedcash","type":"string"},"to_unit_id":{"type":"string"}},"required":["amount","cadence","carrier_id","contract_id","denominations","evidence","evidence_sha256","kind","needed_by","reference","service"],"type":"object"},"Origin":{"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"maker":{"type":"string"},"operating_calendar":{"$ref":"#/components/schemas/Calendar"},"policy_sha256":{"type":"string"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"}},"required":["created_at","customer_id","id","maker","operating_calendar","policy_sha256","product_code","product_version"],"type":"object"},"Originator":{"description":"Originator is the ODFI's record of a customer that originates entries, with the exposure limits the Nacha Operating Rules have the ODFI set, enforce and review.","properties":{"company_id":{"type":"string"},"company_name":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"credit_limit_amount":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"debit_limit_amount":{"format":"int64","type":"integer"},"exposure_days":{"format":"int64","type":"integer"},"exposure_limit_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"note":{"type":"string"},"prenote_required":{"type":"boolean"},"review_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reviewed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"reviewed_by":{"type":"string"},"sec_codes":{"items":{"type":"string"},"type":"array"},"status":{"description":"active or suspended","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["company_id","company_name","created_at","credit_limit_amount","customer_id","debit_limit_amount","exposure_days","exposure_limit_amount","id","prenote_required","review_due","sec_codes","status","updated_at"],"type":"object"},"OriginatorRequest":{"description":"OriginatorRequest creates or replaces an Originator. Limits are minor units; zero is no limit.","properties":{"company_id":{"type":"string"},"company_name":{"type":"string"},"credit_limit_amount":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"debit_limit_amount":{"format":"int64","type":"integer"},"exposure_days":{"format":"int64","type":"integer"},"exposure_limit_amount":{"format":"int64","type":"integer"},"note":{"type":"string"},"operator":{"description":"the reviewer; recorded as the periodic review","type":"string"},"prenote_required":{"type":"boolean"},"review_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"sec_codes":{"items":{"type":"string"},"type":"array"},"status":{"type":"string"}},"required":["credit_limit_amount","debit_limit_amount","exposure_limit_amount","prenote_required"],"type":"object"},"Outcome":{"description":"Outcome is what the terminal, its journal or the network said physically happened.","properties":{"check_kept":{"type":"boolean"},"deposit_notes":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"device":{"type":"string"},"presented":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"recorded_at":{"format":"date-time","type":"string"},"result":{"type":"string"},"retracted":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"source":{"description":"solicited_status, journal, network_reversal, exception_resolution","type":"string"}},"required":["recorded_at","result","source"],"type":"object"},"Output":{"properties":{"credits":{"items":{"$ref":"#/components/schemas/CreditResult"},"type":"array"},"engine":{"type":"string"},"funded_required":{"format":"int64","type":"integer"},"model_sha256":{"type":"string"},"source_sha256":{"type":"string"},"unfunded_required":{"format":"int64","type":"integer"}},"required":["credits","engine","funded_required","model_sha256","source_sha256","unfunded_required"],"type":"object"},"OutsideDistribution":{"description":"OutsideDistribution is another custodian's actual distribution that the owner received and is redepositing here, evidenced by that custodian's own statement.","properties":{"custodian":{"type":"string"},"distribution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"gross_minor":{"format":"int64","type":"integer"},"ira_type":{"type":"string"},"reference":{"type":"string"},"statement_ref":{"type":"string"},"statement_sha256":{"type":"string"},"wrapper":{"type":"string"}},"required":["custodian","distribution_date","gross_minor","reference","statement_ref","statement_sha256","wrapper"],"type":"object"},"OutsideRollover":{"description":"OutsideRollover retains reviewed customer/custodian evidence. Both statutory one-year restrictions follow original distribution receipt, not redeposit.","properties":{"amount_minor":{"format":"int64","type":"integer"},"contribution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"distribution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"original_bank_command_id":{"type":"string"},"reference":{"type":"string"},"wrapper":{"type":"string"}},"required":["amount_minor","contribution_date","distribution_date","reference","wrapper"],"type":"object"},"OverdraftConfirmation":{"properties":{"actor":{"type":"string"},"consent_id":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"evidence":{"type":"string"},"method":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","consent_id","delivered_at","method","recorded_at"],"type":"object"},"OverdraftConfirmationRequest":{"properties":{"code":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"evidence":{"type":"string"},"method":{"description":"electronic_receipt, mailed, delivered","type":"string"}},"required":["method"],"type":"object"},"OverdraftConsent":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action":{"type":"string"},"active":{"type":"boolean"},"actor":{"type":"string"},"confirmation":{"oneOf":[{"$ref":"#/components/schemas/OverdraftConfirmation"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disclosure":{"type":"string"},"electronic":{"type":"boolean"},"id":{"type":"string"},"offer_id":{"type":"string"},"terms_hash":{"type":"string"}},"required":["account_id","action","active","actor","created_at","customer_id","electronic","id"],"type":"object"},"OverdraftConsentRequest":{"properties":{"accepted":{"type":"boolean"},"action":{"description":"grant or revoke","type":"string"},"code":{"type":"string"},"electronic":{"type":"boolean"},"offer_id":{"type":"string"}},"required":["accepted","action","electronic"],"type":"object"},"OverdraftDecision":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"company_id":{"type":"string"},"consent_id":{"type":"string"},"covered_amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"description":"not_needed, line_advance, sweep, paid_into_overdraft or returned","type":"string"},"deferred_fee_amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"individual_id":{"type":"string"},"item_kind":{"description":"ach_debit, check, card, book_transfer, other","type":"string"},"reason":{"type":"string"},"reference":{"type":"string"},"represented":{"description":"the same item was presented within the last 30 days: no second fee","type":"boolean"},"shortfall_amount":{"format":"int64","type":"integer"},"source_id":{"description":"the draw, sweep journal or advance that covered it","type":"string"}},"required":["account_id","amount","business_date","covered_amount","created_at","decision","deferred_fee_amount","fee_amount","id","item_kind","reference","represented","shortfall_amount"],"type":"object"},"OverdraftOffer":{"description":"OverdraftOffer captures the terms actually shown before an affirmative choice.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disclosure":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"terms_hash":{"type":"string"},"version":{"type":"string"}},"required":["account_id","customer_id","disclosure","expires_at","id","terms_hash","version"],"type":"object"},"OverdraftProtection":{"description":"OverdraftProtection is how an account's items are covered when they would overdraw it: an advance on a line of credit, a sweep from a linked account, or paying into overdraft up to a limit with the fee the account agreement discloses.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"daily_fee_cap":{"description":"fees charged on one day at most","format":"int64","type":"integer"},"de_minimis_amount":{"description":"no fee when the overdraft is this small or smaller","format":"int64","type":"integer"},"draw_increment_amount":{"format":"int64","type":"integer"},"facility_id":{"type":"string"},"fee_amount":{"description":"per item paid into overdraft","format":"int64","type":"integer"},"limit_amount":{"description":"the most the account may be overdrawn by","format":"int64","type":"integer"},"linked_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"pay_into_overdraft":{"type":"boolean"},"source":{"description":"none, line or linked_account","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","daily_fee_cap","de_minimis_amount","draw_increment_amount","fee_amount","limit_amount","pay_into_overdraft","source","updated_at"],"type":"object"},"OverdraftRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"authorized_positive":{"type":"boolean"},"company_id":{"description":"ACH: the originator's company identification; checks: the constant \"check\"","type":"string"},"description":{"type":"string"},"individual_id":{"description":"ACH: the entry's individual identification; checks: the serial","type":"string"},"item_kind":{"description":"ach_debit, check, card, atm, book_transfer, scheduled_transfer, deposit_return","type":"string"},"reference":{"type":"string"},"represented":{"description":"ignored by the service: re-presentment is established from company_id, individual_id and amount","type":"boolean"}},"required":["amount","item_kind","reference"],"type":"object"},"Ownership":{"description":"Ownership is how an account is titled, apart from who its owners are.","properties":{"beneficiaries":{"items":{"$ref":"#/components/schemas/Beneficiary"},"type":"array"},"custodian":{"type":"string"},"decedent":{"type":"string"},"fiduciary":{"type":"string"},"firm":{"type":"string"},"ira_type":{"type":"string"},"survivorship":{"type":"boolean"},"tax_reporting":{"description":"derived: how the interest is reported","type":"string"},"trust_name":{"type":"string"},"trustees":{"items":{"type":"string"},"type":"array"},"type":{"description":"individual, joint, pod, trust, estate, utma, iolta, hsa, ira, custodial","type":"string"}},"required":["type"],"type":"object"},"OwnershipProof":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"verified_at":{"format":"date-time","type":"string"}},"required":["account_ids","customer_id","verified_at"],"type":"object"},"OwnershipRequest":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_ids","customer_id"],"type":"object"},"PANUpdate":{"description":"PANUpdate carries a replacement card to the token service. The pan_token is the issuer processor's surrogate; the certified connector resolves it to the PAN inside its boundary.","properties":{"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expiry_month":{"format":"int64","type":"integer"},"expiry_year":{"format":"int64","type":"integer"},"last4":{"type":"string"},"pan_token":{"type":"string"}},"required":["card_id","expiry_month","expiry_year","last4","pan_token"],"type":"object"},"PINRequest":{"description":"PINRequest sets or changes a card's PIN from a PIN-pad block.","properties":{"current_pin_block":{"type":"string"},"method":{"type":"string"},"pin_block":{"type":"string"},"pin_block_format":{"type":"string"},"zone_key_index":{"type":"string"}},"required":["pin_block","pin_block_format","zone_key_index"],"type":"object"},"PINUnlockRequest":{"description":"PINUnlockRequest gives the reason a locked PIN is reset.","properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"},"Package":{"properties":{"complete":{"type":"boolean"},"manifest":{"$ref":"#/components/schemas/Manifest"},"next_cursor":{"format":"int64","type":"integer"},"parts":{"items":{"$ref":"#/components/schemas/PackagePart"},"type":"array"},"production":{"$ref":"#/components/schemas/Production"}},"required":["complete","manifest","next_cursor","parts","production"],"type":"object"},"PackagePart":{"properties":{"bytes":{"format":"int64","type":"integer"},"chain_sha256":{"type":"string"},"ciphertext":{"type":"string"},"ciphertext_sha256":{"type":"string"},"component":{"type":"string"},"part":{"format":"int64","type":"integer"},"plain_sha256":{"type":"string"},"production_number":{"type":"string"},"sequence":{"format":"int64","type":"integer"}},"required":["bytes","chain_sha256","ciphertext","ciphertext_sha256","component","part","plain_sha256","production_number","sequence"],"type":"object"},"PackageSummary":{"properties":{"first_number":{"type":"string"},"last_number":{"type":"string"},"manifest_sha256":{"type":"string"},"package_sha256":{"type":"string"},"packaged_at":{"format":"date-time","type":"string"},"packaged_by":{"type":"string"},"parts":{"format":"int64","type":"integer"}},"required":["manifest_sha256","package_sha256","packaged_at","packaged_by","parts"],"type":"object"},"Packet":{"properties":{"acknowledgment":{"oneOf":[{"$ref":"#/components/schemas/FilingsAcknowledgment"},{"type":"null"}]},"cancellation":{"oneOf":[{"$ref":"#/components/schemas/FilingsCancellation"},{"type":"null"}]},"content_sha256":{"type":"string"},"continues":{"oneOf":[{"$ref":"#/components/schemas/ContinuingReference"},{"type":"null"}]},"decision":{"oneOf":[{"$ref":"#/components/schemas/FilingsDecision"},{"type":"null"}]},"disposal":{"oneOf":[{"$ref":"#/components/schemas/PacketDisposal"},{"type":"null"}]},"id":{"type":"string"},"manifest":{"$ref":"#/components/schemas/FilingsManifest"},"native":{"oneOf":[{"$ref":"#/components/schemas/NativeProvenance"},{"type":"null"}]},"native_validation":{"oneOf":[{"$ref":"#/components/schemas/NativeValidation"},{"type":"null"}]},"prepared_at":{"format":"date-time","type":"string"},"prepared_by":{"type":"string"},"prior_packet_id":{"type":"string"},"reason":{"type":"string"},"released_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"response":{"oneOf":[{"$ref":"#/components/schemas/Artifact"},{"type":"null"}]},"source_document_sha256":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/FilingsSource"},"type":"array"},"status":{"type":"string"},"support_document":{"oneOf":[{"$ref":"#/components/schemas/SupportDocument"},{"type":"null"}]},"transmission":{"oneOf":[{"$ref":"#/components/schemas/Artifact"},{"type":"null"}]},"validation":{"oneOf":[{"$ref":"#/components/schemas/ValidationReport"},{"type":"null"}]},"validation_profile":{"$ref":"#/components/schemas/Profile"}},"required":["content_sha256","id","manifest","prepared_at","prepared_by","reason","source_document_sha256","sources","status","validation_profile"],"type":"object"},"PacketDisposal":{"description":"PacketDisposal marks a packet whose encrypted documents were destroyed.","properties":{"disposed_at":{"format":"date-time","type":"string"},"documents":{"items":{"type":"string"},"type":"array"},"version":{"format":"int64","type":"integer"}},"required":["disposed_at","documents","version"],"type":"object"},"Page":{"properties":{"expenses":{"items":{"$ref":"#/components/schemas/Expense"},"type":"array"},"more":{"type":"boolean"}},"required":["expenses","more"],"type":"object"},"PartContent":{"properties":{"attachment":{"$ref":"#/components/schemas/AttachmentContent"},"content":{"format":"byte","type":"string"},"part":{"format":"int64","type":"integer"},"record":{"$ref":"#/components/schemas/BankrecordsRecord"},"sha256":{"type":"string"}},"required":["attachment","content","part","record","sha256"],"type":"object"},"PartRequest":{"properties":{"content":{"description":"base64 in JSON; exactly PartBytes except the last part","format":"byte","type":"string"},"part":{"format":"int64","type":"integer"},"sha256":{"type":"string"}},"required":["content","part","sha256"],"type":"object"},"Participation":{"description":"Participation is a share of a loan sold to another bank.","properties":{"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"participant":{"type":"string"},"recourse":{"description":"nil on a participation booked before the flag was recorded","oneOf":[{"type":"boolean"},{"type":"null"}]},"share_bps":{"format":"int64","type":"integer"}},"required":["amount","created_at","id","journal_id","loan_id","participant","share_bps"],"type":"object"},"ParticipationRequest":{"description":"ParticipationRequest sells a share. Recourse is required, and only false is booked: a participation with recourse is a secured borrowing, not a sale.","properties":{"participant":{"type":"string"},"recourse":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"share_bps":{"format":"int64","type":"integer"}},"required":["participant","share_bps"],"type":"object"},"Party":{"description":"Party is a debtor, creditor or ultimate party: a name and address, or a BIC, with an account and further identification. The Travel Rule (31 CFR 1010.410(f)) data of a transmittal of funds travels in these fields.","properties":{"account":{"description":"an IBAN when its check digits pass, another identifier otherwise","type":"string"},"address":{"$ref":"#/components/schemas/SwiftAddress"},"any_bic":{"type":"string"},"country_of_residence":{"type":"string"},"lei":{"type":"string"},"name":{"type":"string"},"other_id":{"type":"string"},"other_id_scheme":{"description":"ExternalOrganisationIdentification1Code or ExternalPersonIdentification1Code","type":"string"},"private":{"description":"the other identification is a person's (PrvtId), not an organisation's","type":"boolean"}},"required":["address"],"type":"object"},"Passkey":{"description":"Passkey is a registered WebAuthn credential.","properties":{"algorithm":{"description":"COSE algorithm, -7 for ES256","format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"id":{"example":"pkey_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"last_used_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"name":{"type":"string"},"sign_count":{},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["algorithm","created_at","id","name","sign_count","user_id"],"type":"object"},"PasskeyLoginOptionsRequest":{"description":"PasskeyLoginOptionsRequest starts a passkey login; the email narrows the allowed credentials.","properties":{"email":{"type":"string"}},"type":"object"},"PasskeyLoginRequest":{"description":"PasskeyLoginRequest completes a passkey login.","properties":{"device":{"$ref":"#/components/schemas/DeviceSignals"},"email":{"type":"string"},"response":{"$ref":"#/components/schemas/PasskeyResponse"}},"required":["device","response"],"type":"object"},"PasskeyResponse":{"description":"PasskeyResponse is what the authenticator returned, base64url encoded as WebAuthn does.","properties":{"attestationObject":{"type":"string"},"authenticatorData":{"type":"string"},"clientDataJSON":{"description":"base64url","type":"string"},"id":{"description":"the credential id","type":"string"},"name":{"description":"a name for a registration","type":"string"},"signature":{"type":"string"}},"required":["clientDataJSON","id"],"type":"object"},"PayablesCashReceipt":{"description":"CashReceipt records one actual external cash event, never an acceptance, cancellation request or simulator status. AmountMinor is payable principal; FeeMinor is a separately stated actual fee. Only zero fees are bookable in the current supported accounting scope. A trusted nonzero fee remains authentic.","properties":{"allocations":{"items":{"$ref":"#/components/schemas/Allocation"},"type":"array"},"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"destination":{"$ref":"#/components/schemas/Destination"},"environment":{"type":"string"},"event_id":{"type":"string"},"evidence":{"format":"byte","type":"string"},"evidence_format":{"type":"string"},"evidence_sha256":{"type":"string"},"fee_minor":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_statement_line_reference":{"type":"string"},"master_cash_statement_reference":{"type":"string"},"network_reference":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"original_network_reference":{"type":"string"},"original_settlement_sha256":{"type":"string"},"payee_sha256":{"type":"string"},"provider":{"type":"string"},"rail":{"type":"string"},"remittance_id":{"type":"string"},"settled_at":{"format":"date-time","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"signature":{"type":"string"},"version":{"type":"string"}},"required":["allocations","amount_minor","currency","destination","environment","event_id","evidence","evidence_format","evidence_sha256","fee_minor","instruction_sha256","key_id","kind","legal_entity","master_cash_external_account_reference","master_cash_ledger_account_id","master_cash_statement_line_reference","master_cash_statement_reference","network_reference","observed_at","payee_sha256","provider","rail","remittance_id","settled_at","settlement_date","signature","version"],"type":"object"},"PayablesDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","at","content_sha256","decision","reason"],"type":"object"},"PayablesDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","decision","reason"],"type":"object"},"PayablesInstruction":{"description":"Instruction is immutable before dispatch. Its retained source controls must independently establish provider/key trust, payee authority, actual master account ownership, source reservations and human approval. Validate is not a substitute for those service checks or for a bank connectivity adapter.","properties":{"allocations":{"items":{"$ref":"#/components/schemas/Allocation"},"type":"array"},"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"destination":{"$ref":"#/components/schemas/Destination"},"environment":{"type":"string"},"id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"network_reference":{"type":"string"},"outbound_message_sha256":{"type":"string"},"payee_control_id":{"type":"string"},"payee_sha256":{"type":"string"},"protocol":{"description":"empty for a beneficiary wire","type":"string"},"provider":{"type":"string"},"rail":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"type":"string"}},"required":["allocations","amount_minor","currency","destination","environment","id","issued_at","key_id","legal_entity","master_cash_external_account_reference","master_cash_ledger_account_id","network_reference","outbound_message_sha256","payee_control_id","payee_sha256","provider","rail","settlement_date","version"],"type":"object"},"Payload":{"properties":{"authority_id":{"type":"string"},"authority_sha256":{"type":"string"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"authorization_network_ref":{"type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"currency_code":{"type":"string"},"driver_reference":{"type":"string"},"effective_at":{"format":"date-time","type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"kind":{"description":"authorize or presentment","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/FuelLine"},"type":"array"},"network":{"type":"string"},"original_receipt_sha256":{"type":"string"},"product_code_system":{"type":"string"},"product_code_version":{"type":"string"},"receipt_reference":{"type":"string"},"source_evidence":{"$ref":"#/components/schemas/FleetEvidence"},"total_amount":{"format":"int64","type":"integer"},"transaction_sha256":{"type":"string"},"vehicle_reference":{"type":"string"},"verification":{"description":"driver_vehicle_verified or cleared_fuel_purchase","type":"string"},"version":{"type":"string"}},"required":["authority_id","authority_sha256","card_id","currency_code","driver_reference","effective_at","issued_at","key_id","kind","network","receipt_reference","source_evidence","total_amount","vehicle_reference","verification","version"],"type":"object"},"Payment":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"recipient":{"$ref":"#/components/schemas/EstateRecipient"}},"required":["amount_minor","ledger_account_id","ownership_revision","recipient"],"type":"object"},"PaymentApproval":{"description":"PaymentApproval is a payment waiting for the account's approvers.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decisions":{"items":{"$ref":"#/components/schemas/ApprovalDecision"},"type":"array"},"description":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"requested_by":{"type":"string"},"required":{"format":"int64","type":"integer"},"scheduled_transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"self_approval":{"type":"boolean"},"status":{"description":"pending, approved, rejected or expired","type":"string"}},"required":["account_id","amount","created_at","currency_code","decisions","description","expires_at","id","requested_by","required","scheduled_transfer_id","status"],"type":"object"},"PaymentChange":{"properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["effective_date"],"type":"object"},"PaymentCharge":{"description":"PaymentCharge is what the correspondent charges the bank for one payment of a direction and charge bearer, and how it collects it.","properties":{"amount":{"format":"int64","type":"integer"},"billing":{"description":"item_debit, invoice or deducted","type":"string"},"charge_bearer":{"type":"string"},"direction":{"description":"outbound or inbound","type":"string"}},"required":["amount","billing","charge_bearer","direction"],"type":"object"},"PaymentControlDecision":{"properties":{"actor":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["decision"],"type":"object"},"PaymentHistory":{"description":"PaymentHistory rebuilds an account's payment-and-fee sequence from retained journals and fee corrections, tied to the ledger's own running balance.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"closing_amount":{"format":"int64","type":"integer"},"corrections":{"items":{"$ref":"#/components/schemas/FeeCorrection"},"type":"array"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"events":{"items":{"$ref":"#/components/schemas/PaymentHistoryEvent"},"type":"array"},"fees_assessed_amount":{"format":"int64","type":"integer"},"fees_corrected_amount":{"format":"int64","type":"integer"},"from":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opening_amount":{"format":"int64","type":"integer"},"through":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"ties_to_ledger":{"type":"boolean"}},"required":["account_id","closing_amount","corrections","currency_code","events","fees_assessed_amount","fees_corrected_amount","ledger_account_id","opening_amount","ties_to_ledger"],"type":"object"},"PaymentHistoryEvent":{"description":"PaymentHistoryEvent is one retained ledger movement in a reconstructed history.","properties":{"amount":{"format":"int64","type":"integer"},"category":{"type":"string"},"committed_at":{"format":"date-time","type":"string"},"correction_id":{"type":"string"},"currency_code":{"type":"string"},"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"running_amount":{"format":"int64","type":"integer"},"source_ref":{"type":"string"}},"required":["amount","category","committed_at","currency_code","direction","effective_date","journal_id","kind","running_amount","source_ref"],"type":"object"},"PaymentLimit":{"description":"PaymentLimit caps gross initiation attempts, including retries with uncertain outcomes. An idempotency key is counted once, on the business date of its first accepted attempt.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"daily_amount":{"format":"int64","type":"integer"},"daily_user_amount":{"format":"int64","type":"integer"},"enabled":{"type":"boolean"},"per_payment_amount":{"format":"int64","type":"integer"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"type":"string"}},"required":["account_id","daily_amount","daily_user_amount","enabled","per_payment_amount","updated_at","updated_by"],"type":"object"},"PaymentLimitRequest":{"description":"PaymentLimitRequest sets the account's limits. Tightening them is the operations desk's to do; raising or disabling them is recorded as a control change and applied by a second operator.","properties":{"daily_amount":{"format":"int64","type":"integer"},"daily_user_amount":{"format":"int64","type":"integer"},"enabled":{"type":"boolean"},"operator":{"description":"names the operator only on the open local stack","type":"string"},"per_payment_amount":{"format":"int64","type":"integer"}},"required":["daily_amount","daily_user_amount","enabled","per_payment_amount"],"type":"object"},"PaymentRequest":{"description":"PaymentRequest is a request for payment sent (outbound) or received (inbound).","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"cancellation_reason_code":{"type":"string"},"cancellation_status":{"description":"requested, cancelled, refused, failed","type":"string"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"created_at":{"format":"date-time","type":"string"},"direction":{"type":"string"},"document_number":{"type":"string"},"expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"msg_id":{"type":"string"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"remittance":{"type":"string"},"requested_execution_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"sent, acknowledged, received, presented, accepted, paid, rejected, expired, cancelled, failed","type":"string"},"uetr":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","amount","cancellation_reason_code","cancellation_status","counterparty","created_at","direction","document_number","id","msg_id","payment_id","rail","reason","reason_code","remittance","requested_execution_date","status","uetr","updated_at"],"type":"object"},"PaymentRequestRequest":{"description":"PaymentRequestRequest asks a payer at another institution to pay the bank's customer (pain.013).","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"currency_code":{"description":"ISO 4217 code","type":"string"},"debtor":{"$ref":"#/components/schemas/Counterparty"},"document_number":{"type":"string"},"expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rail":{"type":"string"},"remittance":{"type":"string"},"requested_execution_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["account_id","amount","currency_code","debtor","rail"],"type":"object"},"PaymentResult":{"description":"PaymentResult is a payment and the facility after it.","properties":{"facility":{"$ref":"#/components/schemas/LendingFacility"},"payment":{"$ref":"#/components/schemas/LendingFacilityPayment"}},"required":["facility","payment"],"type":"object"},"PaymentReturn":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/MonitoringDecision"},{"type":"null"}]},"id":{"type":"string"},"received_payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request":{"$ref":"#/components/schemas/ReturnPayment"},"result":{"oneOf":[{"$ref":"#/components/schemas/Refund"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","received_payment_id","request"],"type":"object"},"PaymentUsage":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"total_amount":{"format":"int64","type":"integer"},"user_amount":{"format":"int64","type":"integer"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","business_date","total_amount","user_amount","user_id"],"type":"object"},"PaymentsFile":{"properties":{"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"entry_count":{"format":"int64","type":"integer"},"id":{"type":"string"},"rail_ref":{"type":"string"},"status":{"type":"string"},"total_credit_amount":{"format":"int64","type":"integer"},"total_debit_amount":{"format":"int64","type":"integer"}},"required":["direction","effective_date","entry_count","id","rail_ref","status","total_credit_amount","total_debit_amount"],"type":"object"},"PayoffQuote":{"properties":{"day_count":{"type":"string"},"escrow_refund_amount":{"format":"int64","type":"integer"},"fees_amount":{"format":"int64","type":"integer"},"good_through":{"type":"string"},"interest_amount":{"format":"int64","type":"integer"},"outstanding_amount":{"format":"int64","type":"integer"},"per_diem":{"type":"string"},"per_diem_amount":{"format":"int64","type":"integer"},"per_diem_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"per_diem_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["day_count","escrow_refund_amount","fees_amount","good_through","interest_amount","outstanding_amount","per_diem","per_diem_amount","per_diem_from","per_diem_through","total_amount"],"type":"object"},"PeriodCharge":{"description":"PeriodCharge is the two-week reserve maintenance period's bill with the $150 waiver applied.","properties":{"days":{"items":{"$ref":"#/components/schemas/DayCharge"},"type":"array"},"end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"gross_charge_amount":{"format":"int64","type":"integer"},"net_charge_amount":{"format":"int64","type":"integer"},"note":{"type":"string"},"start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"waiver_amount":{"format":"int64","type":"integer"}},"required":["days","end","gross_charge_amount","net_charge_amount","note","start","waiver_amount"],"type":"object"},"PeriodRequest":{"description":"PeriodRequest names a YYYY-MM period for monthly fees or interest.","properties":{"period":{"type":"string"}},"required":["period"],"type":"object"},"PeriodStatement":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"closing_amount":{"format":"int64","type":"integer"},"document":{"oneOf":[{"$ref":"#/components/schemas/StatementsDocument"},{"type":"null"}]},"id":{"example":"stmt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lines":{"additionalProperties":true,"type":"object"},"opening_amount":{"format":"int64","type":"integer"},"period":{"type":"string"}},"required":["account_id","closing_amount","id","lines","opening_amount","period"],"type":"object"},"PersonalizationRequest":{"description":"PersonalizationRequest binds a card to the keys its codes were made under.","properties":{"cvk_key_id":{"type":"string"},"imk_key_id":{"type":"string"},"pan_sequence":{"type":"string"}},"required":["cvk_key_id"],"type":"object"},"PersonalizationResult":{"description":"PersonalizationResult is the binding with the codes returned once.","properties":{"binding":{"$ref":"#/components/schemas/CardSecurityBinding"},"cvv":{"type":"string"},"cvv2":{"type":"string"},"icvv":{"type":"string"}},"required":["binding"],"type":"object"},"Placement":{"properties":{"accounting_plan_sha256":{"type":"string"},"accounting_plans":{"items":{"$ref":"#/components/schemas/PlacementsAccountingPlan"},"type":"array"},"actor":{"type":"string"},"capacity":{"$ref":"#/components/schemas/PlacementsControl"},"cash_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PlacementsDecision"},{"type":"null"}]},"exceptions":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"instruction":{"oneOf":[{"$ref":"#/components/schemas/PlacementsInstruction"},{"type":"null"}]},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"latest_statement":{"oneOf":[{"$ref":"#/components/schemas/PlacementsStatement"},{"type":"null"}]},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"prior_redemptions":{"items":{"$ref":"#/components/schemas/PlacementsRedemption"},"type":"array"},"program":{"$ref":"#/components/schemas/PlacementsControl"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/PlacementsReceipt"},{"type":"null"}]},"redemption":{"oneOf":[{"$ref":"#/components/schemas/PlacementsRedemption"},{"type":"null"}]},"request":{"$ref":"#/components/schemas/PlacementsCreateRequest"},"request_sha256":{"type":"string"},"screening_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"screening_ids":{"items":{"type":"string"},"type":"array"},"source":{"$ref":"#/components/schemas/PlacementsSource"},"status":{"type":"string"},"sweep_authorization":{"oneOf":[{"$ref":"#/components/schemas/SweepAuthorization"},{"type":"null"}]}},"required":["actor","capacity","created_at","exceptions","id","program","request","request_sha256","source","status"],"type":"object"},"PlacementsAccountingPlan":{"description":"AccountingPlan retains an exact ledger command before it is posted. A later plan may change the accounting date only after a definitive ledger refusal and a successful absent-journal lookup. Every plan shares one idempotency key.","properties":{"correction_reason":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"journal":{"$ref":"#/components/schemas/Journal"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"receipt_sha256":{"type":"string"},"supersedes_sha256":{"type":"string"}},"required":["created_at","journal","journal_key","journal_sha256","receipt_sha256"],"type":"object"},"PlacementsControl":{"properties":{"actor":{"type":"string"},"capacity":{"oneOf":[{"$ref":"#/components/schemas/Capacity"},{"type":"null"}]},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PlacementsDecision"},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string"},"program":{"oneOf":[{"$ref":"#/components/schemas/PlacementsProgram"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","kind"],"type":"object"},"PlacementsCreateRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"agency_consent":{"type":"boolean"},"amount":{"format":"int64","type":"integer"},"capacity_id":{"type":"string"},"currency_code":{"type":"string"},"disclosure_sha256":{"type":"string"},"program_id":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"standing_authorization_sha256":{"type":"string"}},"required":["account_id","agency_consent","amount","capacity_id","currency_code","disclosure_sha256","program_id","settlement_date"],"type":"object"},"PlacementsDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["actor","at","content_sha256","decision","note"],"type":"object"},"PlacementsDecisionRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"note":{"type":"string"}},"required":["content_sha256","decision","note"],"type":"object"},"PlacementsDisclosure":{"properties":{"agency_title":{"type":"string"},"annual_rate_bps":{"format":"int64","type":"integer"},"customer_disclosure":{"$ref":"#/components/schemas/PlacementsEvidence"},"fdic_certificate":{"type":"string"},"insurance_notice":{"type":"string"},"interest_basis":{"type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"product":{"type":"string"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"receiving_bank_name":{"type":"string"},"sha256":{"type":"string"},"tax_reporter":{"type":"string"},"tax_reporting_agreement":{"$ref":"#/components/schemas/PlacementsEvidence"}},"required":["agency_title","annual_rate_bps","customer_disclosure","fdic_certificate","insurance_notice","interest_basis","product","program_id","program_sha256","receiving_bank_name","sha256","tax_reporter","tax_reporting_agreement"],"type":"object"},"PlacementsEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"PlacementsInstruction":{"description":"Instruction is an immutable, authorized bridge command. Reading a draft is not dispatch.","properties":{"agency_title":{"type":"string"},"annual_rate_bps":{"format":"int64","type":"integer"},"capacity":{"type":"string"},"currency_code":{"type":"string"},"external_account_reference":{"type":"string"},"fdic_certificate":{"type":"string"},"id":{"type":"string"},"interest_basis":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"operation":{"type":"string"},"owner_id":{"type":"string"},"placement_id":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"product":{"type":"string"},"program_id":{"type":"string"},"program_sha256":{"type":"string"},"receiver_reference":{"type":"string"},"routing_number":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"sha256":{"type":"string"},"standing_authorization_sha256":{"type":"string"}},"required":["agency_title","annual_rate_bps","capacity","currency_code","fdic_certificate","id","interest_basis","issued_at","operation","owner_id","placement_id","principal_amount","product","program_id","program_sha256","receiver_reference","routing_number","settlement_date","sha256"],"type":"object"},"PlacementsPositionObservation":{"description":"PositionObservation separates customer-owned off-bank claims from both the originating bank's DDA liability and any bank-owned investment asset.","properties":{"blockers":{"items":{"type":"string"},"type":"array"},"interest_as_of":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"observed_accrued_interest_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"off_bank_principal_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"outbound_journal":{"additionalProperties":true,"type":"object"},"placement":{"$ref":"#/components/schemas/Placement"},"redemption_journal":{"additionalProperties":true,"type":"object"},"reserved_insurance_headroom":{"format":"int64","type":"integer"}},"required":["blockers","placement","reserved_insurance_headroom"],"type":"object"},"PlacementsProgram":{"properties":{"agency_agreement":{"$ref":"#/components/schemas/PlacementsEvidence"},"agency_title":{"type":"string"},"annual_rate_bps":{"description":"same actual and customer-facing terms","format":"int64","type":"integer"},"bank_eligibility":{"$ref":"#/components/schemas/PlacementsEvidence"},"bridge_subject":{"type":"string"},"capacity_rules":{"$ref":"#/components/schemas/PlacementsEvidence"},"customer_disclosure":{"$ref":"#/components/schemas/PlacementsEvidence"},"enabled":{"type":"boolean"},"fdic_certificate":{"type":"string"},"interest_basis":{"type":"string"},"interest_reserve_amount":{"format":"int64","type":"integer"},"legal_entity":{"type":"string"},"maturity_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"max_principal_amount":{"format":"int64","type":"integer"},"product":{"description":"demand or certificate","type":"string"},"provider":{"type":"string"},"receipt_keys":{"additionalProperties":{"type":"string"},"type":"object"},"receiver_reference":{"type":"string"},"receiving_bank_name":{"type":"string"},"routing_number":{"type":"string"},"tax_reporter":{"type":"string"},"tax_reporting_agreement":{"$ref":"#/components/schemas/PlacementsEvidence"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["agency_agreement","agency_title","annual_rate_bps","bank_eligibility","bridge_subject","capacity_rules","customer_disclosure","enabled","fdic_certificate","interest_basis","interest_reserve_amount","legal_entity","max_principal_amount","product","provider","receipt_keys","receiver_reference","receiving_bank_name","routing_number","tax_reporter","tax_reporting_agreement","valid_from","valid_through"],"type":"object"},"PlacementsReceipt":{"description":"Receipt is signed by a key in the independently approved retained program. Evidence retains the receiving-bank allocation and actual settlement confirmation, not an ACK.","properties":{"capacity":{"type":"string"},"currency_code":{"type":"string"},"evidence":{"format":"byte","type":"string"},"evidence_format":{"type":"string"},"evidence_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"fdic_certificate":{"type":"string"},"instruction_sha256":{"type":"string"},"interest_amount":{"format":"int64","type":"integer"},"key_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"operation":{"type":"string"},"owner_id":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"settlement_reference":{"type":"string"},"signature":{"type":"string"},"status":{"type":"string"},"version":{"type":"string"}},"required":["capacity","currency_code","evidence","evidence_format","evidence_sha256","external_account_reference","fdic_certificate","instruction_sha256","interest_amount","key_id","observed_at","operation","owner_id","principal_amount","settlement_date","settlement_reference","signature","status","version"],"type":"object"},"PlacementsRedemption":{"properties":{"accounting_plan_sha256":{"type":"string"},"accounting_plans":{"items":{"$ref":"#/components/schemas/PlacementsAccountingPlan"},"type":"array"},"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"instruction":{"$ref":"#/components/schemas/PlacementsInstruction"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"receipt":{"oneOf":[{"$ref":"#/components/schemas/PlacementsReceipt"},{"type":"null"}]},"request_sha256":{"type":"string"},"status":{"type":"string"},"sweep_authorization":{"oneOf":[{"$ref":"#/components/schemas/SweepAuthorization"},{"type":"null"}]}},"required":["actor","created_at","id","idempotency_key","instruction","request_sha256","status"],"type":"object"},"PlacementsSnapshot":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"captured_at":{"format":"date-time","type":"string"},"observation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"positions":{"items":{"$ref":"#/components/schemas/PlacementsPositionObservation"},"type":"array"},"ready":{"type":"boolean"},"source_sha256":{"type":"string"}},"required":["blockers","captured_at","observation_date","positions","ready","source_sha256"],"type":"object"},"PlacementsSnapshotRecord":{"properties":{"actor":{"type":"string"},"captured_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"snapshot":{"$ref":"#/components/schemas/PlacementsSnapshot"}},"required":["actor","captured_at","content_sha256","id","snapshot"],"type":"object"},"PlacementsSource":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"captured_at":{"format":"date-time","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"owner_id":{"type":"string"},"ownership_revision":{"format":"int64","type":"integer"},"ownership_sha256":{"type":"string"}},"required":["account_id","captured_at","ledger_account_id","owner_id","ownership_revision","ownership_sha256"],"type":"object"},"PlacementsStatement":{"description":"Statement is the receiving bank's signed principal and accrued-interest observation for an existing allocation. It is not a funds-transfer receipt.","properties":{"accrued_interest_amount":{"format":"int64","type":"integer"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"capacity":{"type":"string"},"evidence":{"format":"byte","type":"string"},"evidence_format":{"type":"string"},"evidence_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"fdic_certificate":{"type":"string"},"key_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"original_instruction_sha256":{"type":"string"},"owner_id":{"type":"string"},"placement_id":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"signature":{"type":"string"},"version":{"type":"string"}},"required":["accrued_interest_amount","as_of","capacity","evidence","evidence_format","evidence_sha256","external_account_reference","fdic_certificate","key_id","observed_at","original_instruction_sha256","owner_id","placement_id","principal_amount","signature","version"],"type":"object"},"Plan":{"properties":{"attribution_customer_ids":{"items":{"type":"string"},"type":"array"},"attribution_evidence":{"$ref":"#/components/schemas/Evidence"},"cash_collateral":{"oneOf":[{"$ref":"#/components/schemas/CashCollateral"},{"type":"null"}]},"credit":{"$ref":"#/components/schemas/CreditRequest"},"market_terms_evidence":{"$ref":"#/components/schemas/Evidence"},"rationale":{"type":"string"},"settlement_gl_code":{"description":"nonaffiliate facility only: reviewed card/rail settlement payable","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["attribution_customer_ids","attribution_evidence","credit","market_terms_evidence","rationale","valid_through"],"type":"object"},"Policy":{"properties":{"capital":{"$ref":"#/components/schemas/FiledCapital"},"coverage_evidence":{"$ref":"#/components/schemas/Evidence"},"existing_exposures":{"description":"external opening book, never duplicates locally reserved commitments","items":{"$ref":"#/components/schemas/ExistingExposure"},"type":"array"},"exposure_as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"legal_entity":{"type":"string"},"name":{"type":"string"},"rationale":{"type":"string"},"service_subjects":{"items":{"type":"string"},"type":"array"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["capital","coverage_evidence","existing_exposures","exposure_as_of","legal_entity","name","rationale","service_subjects","valid_from","valid_through"],"type":"object"},"Position":{"description":"Position is one lot as the original closing of a business date carries it. Missing names what is not known for the position at that close (a classification, completed accrual, a fair value); Exceptions name where the lot record and the closing disagree, which makes the set unfit to attribute the closing's securities balances.","properties":{"accrued_through_as_of":{"type":"boolean"},"amortized_cost_amount":{"format":"int64","type":"integer"},"carrying_amount":{"format":"int64","type":"integer"},"classification":{"oneOf":[{"$ref":"#/components/schemas/ClassificationRecord"},{"type":"null"}]},"closing":{"$ref":"#/components/schemas/ClosingBalances"},"cusip":{"type":"string"},"designation":{"type":"string"},"disposal_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"exceptions":{"items":{"type":"string"},"type":"array"},"fair_value_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"held":{"type":"boolean"},"instrument_id":{"type":"string"},"instrument_kind":{"type":"string"},"legal_entity":{"type":"string"},"lot_id":{"type":"string"},"lot_status":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"missing":{"items":{"type":"string"},"type":"array"},"next_repricing_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"scheduled_amortized_cost_amount":{"format":"int64","type":"integer"},"trade_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"units":{"format":"int64","type":"integer"},"valuation":{"oneOf":[{"$ref":"#/components/schemas/PositionValuation"},{"type":"null"}]}},"required":["accrued_through_as_of","amortized_cost_amount","carrying_amount","closing","cusip","designation","exceptions","held","instrument_id","instrument_kind","legal_entity","lot_id","lot_status","maturity_date","missing","scheduled_amortized_cost_amount","trade_date","units"],"type":"object"},"PositionObservation":{"properties":{"accrued_income_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"actual_units":{"format":"int64","type":"integer"},"blockers":{"items":{"type":"string"},"type":"array"},"lot":{"$ref":"#/components/schemas/InvestmentsLot"},"market_value_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"tax_basis_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"values_as_of":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["actual_units","blockers","lot"],"type":"object"},"PositionPair":{"description":"PositionPair is a foreign currency's pair of bank accounts at the FX position: the position account in the currency and its USD equivalent account. Every movement between currencies passes through a pair, and the close remeasures the pair.","properties":{"currency_code":{"type":"string"},"equivalent_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"position_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["currency_code","equivalent_ledger_account_id","position_ledger_account_id"],"type":"object"},"PositionSet":{"description":"PositionSet is every bank-owned lot the original closing of a business date carries or that was held on it, with the closing's managed securities totals: cost on GL 1200, the AFS fair-value adjustment on GL 1205 and the allowance on GL 1209.","properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_sha256":{"type":"string"},"content_sha256":{"type":"string"},"cost_amount":{"format":"int64","type":"integer"},"credit_allowance_amount":{"format":"int64","type":"integer"},"fair_value_adjustment_amount":{"format":"int64","type":"integer"},"positions":{"items":{"$ref":"#/components/schemas/Position"},"type":"array"},"version":{"type":"string"}},"required":["as_of","closing_sha256","content_sha256","cost_amount","credit_allowance_amount","fair_value_adjustment_amount","positions","version"],"type":"object"},"PositionValuation":{"description":"PositionValuation is the approved completed-day valuation a position's fair value comes from.","properties":{"amortized_cost_amount":{"format":"int64","type":"integer"},"approved_at":{"format":"date-time","type":"string"},"approved_by":{"type":"string"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"credit_allowance_amount":{"format":"int64","type":"integer"},"fair_value_adjustment_amount":{"format":"int64","type":"integer"},"fair_value_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"valuation_basis":{"type":"string"}},"required":["amortized_cost_amount","approved_at","approved_by","as_of","content_sha256","credit_allowance_amount","fair_value_adjustment_amount","fair_value_amount","id","valuation_basis"],"type":"object"},"PositivePayAccount":{"description":"PositivePayAccount is an account's positive pay terms.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decide_by_hour":{"format":"int64","type":"integer"},"default_decision":{"type":"string"},"enabled":{"type":"boolean"},"payee_match":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","decide_by_hour","default_decision","enabled","payee_match","updated_at"],"type":"object"},"PositivePayIssue":{"description":"PositivePayIssue is a check the customer told the bank it wrote.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"check_number":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"inclearing_item_id":{"type":"string"},"issued_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"payee":{"type":"string"},"status":{"description":"outstanding, paid, voided, stale","type":"string"}},"required":["account_id","amount","check_number","created_at","id","status"],"type":"object"},"PositivePayRequest":{"description":"PositivePayRequest enrols an account or replaces its terms.","properties":{"decide_by_hour":{"description":"Eastern, on the banking day after presentment","format":"int64","type":"integer"},"default_decision":{"description":"return (default) or pay, applied at the deadline","type":"string"},"enabled":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"payee_match":{"type":"boolean"}},"required":["payee_match"],"type":"object"},"PostalAddress":{"description":"PostalAddress is a counterparty's mailing address.","properties":{"city":{"type":"string"},"country_code":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country_code","line_1"],"type":"object"},"Posting":{"description":"Posting is a record's immutable disposition.","properties":{"amount_minor":{"format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"detail":{"$ref":"#/components/schemas/ClearingDetail"},"disposition":{"type":"string"},"exception_id":{"type":"string"},"original_record_id":{"type":"string"},"parent_authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"record_id":{"type":"string"}},"required":["amount_minor","created_at","detail","disposition","record_id"],"type":"object"},"PostingEntry":{"description":"PostingEntry is one counter entry of a movement's journal: the ledger account the gateway moves the money to or from, in the movement's currency. The nostro entry itself is written by the ledger from the movement's direction and amount, so no caller can misstate it.","properties":{"amount":{"format":"int64","type":"integer"},"direction":{"description":"debit or credit","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","direction","ledger_account_id"],"type":"object"},"PostingPolicy":{"description":"PostingPolicy describes the order the running ledger actually enforces. New ordering mechanisms require an engine change; arbitrary amount sorting is not a supported setting.","properties":{"order":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["order","version"],"type":"object"},"Preference":{"description":"Preference is a customer's setting for one channel.","properties":{"address":{"type":"string"},"channel":{"description":"email, sms or push","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"enabled":{"type":"boolean"}},"required":["channel","customer_id","enabled"],"type":"object"},"PrepareRequest":{"properties":{"attachment":{"description":"Attachment is the exact CSV named by imported SARX XML. Native requests\nretain bytes on SAR.Attachment instead; this field stays empty for them.","format":"byte","type":"string"},"ctr":{"oneOf":[{"$ref":"#/components/schemas/CTRRequest"},{"type":"null"}]},"prior_packet_id":{"type":"string"},"reason":{"type":"string"},"sar":{"oneOf":[{"$ref":"#/components/schemas/SARRequest"},{"type":"null"}]},"sources":{"items":{"$ref":"#/components/schemas/SourceRequest"},"type":"array"},"xml":{"format":"byte","type":"string"}},"required":["reason","sources","xml"],"type":"object"},"Presentment":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"authorization_use":{"$ref":"#/components/schemas/AuthorizationUse"},"captured_at":{"format":"date-time","type":"string"},"captured_by":{"type":"string"},"content_sha256":{"type":"string"},"receipt":{"$ref":"#/components/schemas/FleetReceipt"},"result":{"oneOf":[{"$ref":"#/components/schemas/FleetResult"},{"type":"null"}]},"review":{"oneOf":[{"$ref":"#/components/schemas/FleetReview"},{"type":"null"}]},"trust_config_sha256":{"type":"string"},"verification_key":{"$ref":"#/components/schemas/TrustedKey"},"violations":{"items":{"type":"string"},"type":"array"}},"required":["account_id","authorization_id","authorization_use","captured_at","captured_by","content_sha256","receipt","trust_config_sha256","verification_key","violations"],"type":"object"},"PresentmentItem":{"description":"PresentmentItem is one check drawn on the bank the sandbox operator presents.","properties":{"account_number":{"type":"string"},"amount":{"format":"int64","type":"integer"},"check_number":{"type":"string"},"payee":{"type":"string"}},"required":["account_number","amount","check_number"],"type":"object"},"Preservation":{"properties":{"enforcement":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/PreservationRequest"},"request_sha256":{"type":"string"},"service":{"type":"string"}},"required":["enforcement","recorded_at","request","request_sha256","service"],"type":"object"},"PreservationRequest":{"properties":{"command_id":{"type":"string"},"decision":{"type":"string"},"evidence_sha256":{"type":"string"},"matter_id":{"type":"string"},"on_behalf_of":{"type":"string"},"purpose":{"type":"string"},"source":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["command_id","decision","evidence_sha256","matter_id","on_behalf_of","purpose","source","version"],"type":"object"},"PrivacyDecision":{"properties":{"allowed":{"type":"boolean"},"export_id":{"type":"string"},"policy_id":{"type":"string"}},"required":["allowed","export_id","policy_id"],"type":"object"},"PrivacyDocument":{"properties":{"content":{"type":"string"},"content_ref":{"type":"string"},"content_sha256":{"type":"string"},"effective_at":{"format":"date-time","type":"string"},"opt_out_methods":{"items":{"type":"string"},"type":"array"},"policy_id":{"type":"string"},"policy_version":{"format":"int64","type":"integer"}},"required":["content","content_ref","content_sha256","effective_at","opt_out_methods","policy_id","policy_version"],"type":"object"},"PrivacyElection":{"properties":{"opt_out":{"type":"boolean"},"recorded_at":{"format":"date-time","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["opt_out","recorded_at","version"],"type":"object"},"PrivacyElectionRequest":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"opt_out":{"type":"boolean"}},"required":["evidence_ref","evidence_sha256","expected_version","opt_out"],"type":"object"},"PrivacyExport":{"properties":{"allowed":{"type":"boolean"},"basis":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"data":{"additionalProperties":true,"type":"object"},"data_sha256":{"type":"string"},"election_version":{"format":"int64","type":"integer"},"id":{"type":"string"},"notice_id":{"type":"string"},"policy_id":{"type":"string"},"policy_version":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"reasons":{"items":{"type":"string"},"type":"array"},"recipient_id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"rule_id":{"type":"string"}},"required":["allowed","basis","customer_id","election_version","id","policy_id","policy_version","purpose","reasons","recipient_id","recorded_at","rule_id"],"type":"object"},"PrivacyExportRequest":{"properties":{"election_version":{"format":"int64","type":"integer"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"policy_id":{"type":"string"},"purpose":{"type":"string"},"recipient_id":{"type":"string"},"rule_id":{"type":"string"}},"required":["election_version","evidence_ref","evidence_sha256","fields","policy_id","purpose","recipient_id","rule_id"],"type":"object"},"PrivacyNotice":{"properties":{"channel":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"document":{"$ref":"#/components/schemas/PrivacyDocument"},"id":{"type":"string"},"kind":{"type":"string"},"opportunity_ends_at":{"format":"date-time","type":"string"},"practices_sha256":{"type":"string"}},"required":["channel","delivered_at","document","id","kind","opportunity_ends_at","practices_sha256"],"type":"object"},"PrivacyNoticeRequest":{"properties":{"channel":{"description":"mail, hand_delivery, electronic","type":"string"},"content_sha256":{"type":"string"},"delivered_at":{"format":"date-time","type":"string"},"electronic_agreement_ref":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"kind":{"description":"initial, revised, annual","type":"string"},"policy_id":{"type":"string"}},"required":["channel","content_sha256","delivered_at","evidence_ref","evidence_sha256","kind","policy_id"],"type":"object"},"PrivacyPolicy":{"properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"practices_sha256":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/PrivacyPolicyRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","practices_sha256","proposed_at","proposed_by","request","status","version"],"type":"object"},"PrivacyPolicyDecision":{"properties":{"decision":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["decision","evidence_ref","evidence_sha256","reason"],"type":"object"},"PrivacyPolicyRequest":{"properties":{"change_kind":{"description":"initial, revised_notice, annual_100_day, no_disclosure_change","type":"string"},"content":{"type":"string"},"content_ref":{"type":"string"},"content_sha256":{"type":"string"},"disclosure_practices_sha256":{"type":"string"},"effective_at":{"format":"date-time","type":"string"},"expected_version":{"format":"int64","type":"integer"},"opt_out_methods":{"items":{"type":"string"},"type":"array"},"opt_out_opportunity_days":{"format":"int64","type":"integer"},"reason":{"type":"string"},"review_ref":{"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/PrivacySharingRule"},"type":"array"}},"required":["change_kind","content","content_ref","content_sha256","disclosure_practices_sha256","effective_at","expected_version","opt_out_methods","opt_out_opportunity_days","reason","review_ref","rules"],"type":"object"},"PrivacyRelationshipRequest":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"inventory_complete":{"type":"boolean"},"occurred_at":{"format":"date-time","type":"string"},"product_ref":{"type":"string"},"source_service":{"type":"string"},"status":{"description":"active/former consumer relationship; a customer master record alone is not a relationship","type":"string"}},"required":["evidence_ref","evidence_sha256","inventory_complete","occurred_at","product_ref","source_service","status"],"type":"object"},"PrivacyRelationshipRun":{"properties":{"delivered":{"format":"int64","type":"integer"},"failed":{"format":"int64","type":"integer"},"locked":{"type":"boolean"}},"required":["delivered","failed","locked"],"type":"object"},"PrivacyRelationshipRunRequest":{"properties":{"limit":{"format":"int64","type":"integer"}},"required":["limit"],"type":"object"},"PrivacySharingRule":{"properties":{"authority_ref":{"type":"string"},"authority_sha256":{"type":"string"},"basis":{"description":"nonaffiliate, service_provider, servicing, fraud_prevention, legal_process","type":"string"},"contract_ref":{"type":"string"},"contract_sha256":{"type":"string"},"data_kinds":{"items":{"type":"string"},"type":"array"},"fields":{"items":{"type":"string"},"type":"array"},"honor_opt_out":{"description":"a more restrictive bank/state policy may honor opt-outs under exceptions","type":"boolean"},"id":{"type":"string"},"purpose":{"type":"string"},"recipient_id":{"type":"string"},"service_subject":{"type":"string"}},"required":["authority_ref","authority_sha256","basis","fields","honor_opt_out","id","purpose","recipient_id","service_subject"],"type":"object"},"PrivacyStatus":{"properties":{"annual_exception":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"election":{"$ref":"#/components/schemas/PrivacyElection"},"initial_notice_required":{"type":"boolean"},"notice_due_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"notice_kind":{"type":"string"},"notice_overdue":{"type":"boolean"},"notices":{"items":{"$ref":"#/components/schemas/PrivacyNotice"},"type":"array"},"policy":{"oneOf":[{"$ref":"#/components/schemas/PrivacyDocument"},{"type":"null"}]},"reason":{"type":"string"},"relationship":{"type":"string"},"relationship_review_required":{"type":"boolean"}},"required":["annual_exception","customer_id","election","initial_notice_required","notice_overdue","notices","reason","relationship","relationship_review_required"],"type":"object"},"PrivilegeEntry":{"properties":{"basis":{"type":"string"},"custodian":{"type":"string"},"entry":{"format":"int64","type":"integer"},"family":{"$ref":"#/components/schemas/Target"},"reason":{"type":"string"}},"required":["basis","custodian","entry","family","reason"],"type":"object"},"Problem":{"properties":{"code":{"enum":["accounts.account_not_empty","accounts.account_not_open","accounts.certificate_locked","accounts.currency_unsupported","accounts.customer_not_eligible","accounts.cycle_not_ready","accounts.debit_blocked","accounts.deposit_screening_declined","accounts.export_not_configured","accounts.fx_quote_expired","accounts.garnishment_not_open","accounts.not_a_certificate","accounts.not_escheatable","accounts.product_not_live","accounts.reconciliation_required","accounts.rule_set_incomplete","accounts.transfer_limit_reached","accounts.withdrawal_restricted","cards.card_not_active","cards.control_declined","cards.dual_control","cards.hsm_not_configured","cards.hsm_refused","cards.pin_incorrect","cards.pin_tries_exceeded","conflict","customers.already_in_group","customers.group_closed","customers.group_parent","customers.not_a_business","dependency_failed","forbidden","idempotency_in_progress","idempotency_key_reused","identity.account_locked","identity.credential_invalid","identity.device_not_enrolled","identity.passkey_invalid","identity.token_expired","internal","ledger.account_closed","ledger.account_not_empty","ledger.account_unknown","ledger.backdate_reason_required","ledger.backdate_too_old","ledger.balance_definition_unknown","ledger.business_date_closed","ledger.correspondent_route_unavailable","ledger.cross_currency_requires_fx_position","ledger.currency_mismatch","ledger.currency_unsupported","ledger.fx_limit_exceeded","ledger.fx_quote_expired","ledger.fx_rate_unavailable","ledger.hold_not_active","ledger.insufficient_available","ledger.journal_already_reversed","ledger.journal_unbalanced","ledger.maker_checker_required","ledger.period_closed","ledger.period_not_ready","ledger.reconciliation_required","ledger.serialization_retry_exhausted","ledger.statement_refused","ledger.vostro_unsupported","lending.not_current","lending.not_nonaccrual","lending.reconciliation_required","malformed_request","not_found","operations.close_blocked","operations.not_pending","operations.reconciliation_required","operations.same_person","payments.already_cancelled","payments.approval_not_pending","payments.approval_required","payments.callback_required","payments.check_not_returnable","payments.control_approval_required","payments.counterparty_deleted","payments.cutoff_passed","payments.destination_currency_not_supported","payments.destination_not_supported","payments.duplicate_item","payments.duplicate_trace","payments.exposure_limit_exceeded","payments.file_not_sent","payments.fraud_review_open","payments.fx_quotes_unavailable","payments.group_policy","payments.imad_exhausted","payments.invalid_routing_number","payments.limit_exceeded","payments.no_pending_transfers","payments.not_cancellable","payments.not_in_group","payments.not_reviewable","payments.originator_limit_exceeded","payments.originator_suspended","payments.payment_not_returnable","payments.prenote_required","payments.rail_unavailable","payments.reconciliation_required","payments.request_not_open","payments.retirement_receipt_applied","payments.retirement_receipt_claimed","payments.retirement_receipt_not_claimable","payments.return_request_not_open","payments.return_window_closed","payments.same_account","payments.same_customer","payments.schedule_not_active","payments.screening_hit","payments.screening_review_required","payments.self_approval","payments.stop_payment_matched","payments.swift_not_cancellable","payments.swift_originator_incomplete","payments.swift_possible_duplicate","payments.swift_repair_not_open","payments.swift_repair_not_proposed","payments.swift_unroutable","payments.transfer_not_settled","payments.unknown_gl_code","payments.unsupported_country","payments.unsupported_deposit_channel","payments.unsupported_sec_code","payments.wire_not_applicable","payments.wire_not_returnable","precondition_failed","rate_limited","reporting.statement_missing","reporting.time_deposit_evidence_required","request_too_large","step_up_required","unauthenticated","unavailable","validation_failed"],"type":"string"},"detail":{"type":"string"},"errors":{"items":{"properties":{"field":{"type":"string"},"reason":{"type":"string"}},"type":"object"},"type":"array"},"instance":{"description":"the request id","type":"string"},"retryable":{"type":"boolean"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"format":"uri","type":"string"}},"required":["type","title","status","code","retryable"],"type":"object"},"ProcessResult":{"description":"ProcessResult summarises a processing run.","properties":{"file":{"$ref":"#/components/schemas/IngestedFile"},"processed":{"format":"int64","type":"integer"}},"required":["file","processed"],"type":"object"},"Product":{"description":"Product is one version of a product definition.","properties":{"allow_negative":{"type":"boolean"},"analysis":{"description":"business analysis checking: earnings credit against fees","oneOf":[{"$ref":"#/components/schemas/Analysis"},{"type":"null"}]},"code":{"type":"string"},"currency":{"type":"string"},"customer_type":{"type":"string"},"family":{"type":"string"},"fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array"},"gl_code":{"type":"string"},"interest":{"oneOf":[{"$ref":"#/components/schemas/Interest"},{"type":"null"}]},"kind":{"type":"string"},"ledger_namespace":{"type":"string"},"lending":{"oneOf":[{"$ref":"#/components/schemas/Lending"},{"type":"null"}]},"limits":{"$ref":"#/components/schemas/Limits"},"name":{"type":"string"},"now_notice_days":{"format":"int64","type":"integer"},"posting_policy":{"oneOf":[{"$ref":"#/components/schemas/PostingPolicy"},{"type":"null"}]},"regulatory":{"description":"where the product's balances report: Call Report items and the FR 2900 class","oneOf":[{"$ref":"#/components/schemas/Regulatory"},{"type":"null"}]},"source":{"type":"string"},"statement_cycle":{"type":"string"},"status":{"type":"string"},"term":{"description":"certificates of deposit: the term, penalty and what happens at maturity","oneOf":[{"$ref":"#/components/schemas/Term"},{"type":"null"}]},"transfer_limit":{"description":"money market and savings: the convenient-transfer limit, when the bank keeps one","oneOf":[{"$ref":"#/components/schemas/TransferLimit"},{"type":"null"}]},"type":{"description":"deposit products: checking, now, savings, money_market, certificate","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["allow_negative","code","currency","customer_type","family","fees","gl_code","kind","ledger_namespace","limits","name","source","statement_cycle","status","version"],"type":"object"},"ProductNotice":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actions":{"items":{"$ref":"#/components/schemas/ProductNoticeAction"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"document":{"$ref":"#/components/schemas/ProductNoticeDocument"},"from_version":{"format":"int64","type":"integer"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/ProductNoticeRequest"},"sha256":{"type":"string"},"status":{"type":"string"}},"required":["account_id","actions","created_at","document","from_version","id","request","sha256","status"],"type":"object"},"ProductNoticeAction":{"properties":{"actor":{"type":"string"},"channel":{"type":"string"},"consent_reference":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"kind":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"reference":{"type":"string"}},"required":["actor","date","kind","recorded_at","reference"],"type":"object"},"ProductNoticeDecision":{"properties":{"actor":{"type":"string"},"reference":{"type":"string"}},"required":["reference"],"type":"object"},"ProductNoticeDelivery":{"properties":{"actor":{"type":"string"},"channel":{"type":"string"},"consent_reference":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"}},"required":["channel","customer_id","date","reference"],"type":"object"},"ProductNoticeDocument":{"properties":{"bank":{"$ref":"#/components/schemas/Bank"},"changes":{"items":{"$ref":"#/components/schemas/ProductsChange"},"type":"array"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"explanation":{"type":"string"},"notice_days":{"format":"int64","type":"integer"},"number_last4":{"type":"string"},"product":{"type":"string"},"recipients":{"items":{"$ref":"#/components/schemas/NoticeRecipient"},"type":"array"}},"required":["bank","changes","effective_date","explanation","notice_days","number_last4","product","recipients"],"type":"object"},"ProductNoticeRequest":{"properties":{"actor":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"explanation":{"type":"string"},"policy_reference":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["effective_date","explanation","policy_reference","version"],"type":"object"},"ProductNoticeRun":{"properties":{"has_more":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/ProductNoticeWork"},"type":"array"},"next":{"type":"string"}},"required":["has_more","items"],"type":"object"},"ProductNoticeRunRequest":{"properties":{"activate":{"type":"boolean"},"after":{"type":"string"},"limit":{"format":"int64","type":"integer"}},"required":["activate"],"type":"object"},"ProductNoticeWork":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"changed":{"type":"boolean"},"deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"error_code":{"type":"string"},"notice_id":{"type":"string"},"state":{"type":"string"}},"required":["account_id","changed","deadline","notice_id","state"],"type":"object"},"Production":{"properties":{"actor":{"type":"string"},"approved_by":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"high_water":{"format":"int64","type":"integer"},"holds":{"items":{"$ref":"#/components/schemas/ProductionHold"},"type":"array"},"id":{"type":"string"},"items":{"format":"int64","type":"integer"},"legal_request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"package":{"oneOf":[{"$ref":"#/components/schemas/PackageSummary"},{"type":"null"}]},"released_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"required_determinations":{"items":{"type":"string"},"type":"array"},"review_required":{"format":"int64","type":"integer"},"root_sha256":{"type":"string"},"scope":{"$ref":"#/components/schemas/LegalScope"},"sequence":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["actor","created_at","holds","id","items","legal_request_id","required_determinations","review_required","scope","sequence","status"],"type":"object"},"ProductionDecision":{"properties":{"decision":{"description":"approve or reject","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["decision","evidence_ref","evidence_sha256","reason"],"type":"object"},"ProductionEvent":{"properties":{"actor":{"type":"string"},"detail":{"additionalProperties":true,"type":"object"},"event_sha256":{"type":"string"},"kind":{"type":"string"},"previous_sha256":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"sequence":{"format":"int64","type":"integer"}},"required":["actor","detail","event_sha256","kind","previous_sha256","recorded_at","sequence"],"type":"object"},"ProductionHold":{"properties":{"bank_wide":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"bank_archive or customer_archive","type":"string"},"target":{"$ref":"#/components/schemas/Target"}},"required":["hold_id","kind","target"],"type":"object"},"ProductionItem":{"description":"ProductionItem is one collected archive item as frozen at collection.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentContent"},"type":"array"},"chain_sha256":{"type":"string"},"custodian":{"type":"string"},"customer_ids":{"items":{"type":"string"},"type":"array"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BankrecordsItemDecision"},{"type":"null"}]},"document_sha256":{"type":"string"},"family":{"$ref":"#/components/schemas/Target"},"item_id":{"type":"string"},"kind":{"description":"bank_record or retained_record","type":"string"},"metadata_sha256":{"type":"string"},"ordinal":{"format":"int64","type":"integer"},"production_number":{"type":"string"},"record_date":{"format":"date-time","type":"string"},"record_date_basis":{"type":"string"},"review_required":{"items":{"type":"string"},"type":"array"},"source_key":{"type":"string"}},"required":["account_ids","attachments","chain_sha256","custodian","customer_ids","document_sha256","family","item_id","kind","metadata_sha256","ordinal","record_date","record_date_basis","review_required","source_key"],"type":"object"},"ProductionItemPage":{"properties":{"complete":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/ProductionItem"},"type":"array"},"next_cursor":{"format":"int64","type":"integer"},"production":{"$ref":"#/components/schemas/Production"}},"required":["complete","items","next_cursor","production"],"type":"object"},"ProductsChange":{"properties":{"after":{"type":"string"},"before":{"type":"string"},"term":{"type":"string"}},"required":["after","before","term"],"type":"object"},"Profile":{"properties":{"business_rules_id":{"type":"string"},"environment":{"description":"test or production, retained with every packet","type":"string"},"form":{"type":"string"},"schema_bundle_sha256":{"type":"string"}},"required":["business_rules_id","environment","form","schema_bundle_sha256"],"type":"object"},"Program":{"properties":{"authority":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"bridge_subject":{"type":"string"},"broker_name":{"type":"string"},"broker_reference":{"type":"string"},"custodian_name":{"type":"string"},"custodian_reference":{"type":"string"},"custody_agreement":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"dealers":{"items":{"$ref":"#/components/schemas/Dealer"},"type":"array"},"enabled":{"type":"boolean"},"evidence_keys":{"additionalProperties":{"type":"string"},"type":"object"},"legal_entity":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_identity":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_order_amount":{"format":"int64","type":"integer"},"policy":{"$ref":"#/components/schemas/AccountingPolicy"},"provider":{"type":"string"},"trading_agreement":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["authority","bridge_subject","broker_name","broker_reference","custodian_name","custodian_reference","custody_agreement","dealers","enabled","evidence_keys","legal_entity","master_cash_external_account_reference","master_cash_identity","master_cash_ledger_account_id","max_order_amount","policy","provider","trading_agreement","valid_from","valid_through"],"type":"object"},"ProgressRequest":{"properties":{"carrier_reference":{"type":"string"},"evidence":{"type":"string"},"status":{"description":"picked_up, in_transit, delivered, exception","type":"string"}},"required":["carrier_reference","evidence","status"],"type":"object"},"Projection":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/Bucket"},"type":"array"},"eve_amount":{"format":"int64","type":"integer"},"first_shortfall_month":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"minimum_liquidity_amount":{"format":"int64","type":"integer"},"nii_amount":{"format":"int64","type":"integer"},"triggered_actions":{"items":{"type":"string"},"type":"array"}},"required":["buckets","eve_amount","minimum_liquidity_amount","nii_amount","triggered_actions"],"type":"object"},"Proof":{"properties":{"journal":{"$ref":"#/components/schemas/CashJournal"},"line_key":{"type":"string"},"match_id":{"type":"string"},"ready":{"type":"boolean"},"statement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"statement_id":{"type":"string"},"statement_sha256":{"type":"string"}},"required":["journal","line_key","match_id","ready","statement_date","statement_id","statement_sha256"],"type":"object"},"ProofRequest":{"properties":{"command_id":{"type":"string"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"}},"required":["command_id","journal_key","journal_sha256"],"type":"object"},"Propagation":{"properties":{"decision":{"type":"string"},"last_attempt_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"receipt":{"oneOf":[{"$ref":"#/components/schemas/Preservation"},{"type":"null"}]},"status":{"type":"string"},"target":{"$ref":"#/components/schemas/Target"},"version":{"format":"int64","type":"integer"}},"required":["decision","status","target","version"],"type":"object"},"ProperRecipientNotice":{"description":"ProperRecipientNotice is actual retained notice evidence. Capturing it does not send a message or manufacture provider delivery confirmation.","properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"notice":{"$ref":"#/components/schemas/Notice"},"receiving_servicer_contact":{"type":"string"},"receiving_servicer_id":{"type":"string"},"receiving_servicer_name":{"type":"string"}},"required":["customer_id","notice","receiving_servicer_contact","receiving_servicer_id","receiving_servicer_name"],"type":"object"},"Proposal":{"description":"Proposal is a retained maker-checker change.","properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/ProposalRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/NetworktokensReview"},{"type":"null"}]}},"required":["actor","at","content_sha256","id","request"],"type":"object"},"ProposalRequest":{"description":"ProposalRequest is a staff change that needs a second person: resuming a staff suspension, changing a token's controls, or moving a card's tokens to its replacement card.","properties":{"controls":{"oneOf":[{"$ref":"#/components/schemas/NetworktokensControls"},{"type":"null"}]},"expected_sequence":{"format":"int64","type":"integer"},"kind":{"type":"string"},"new_card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"old_card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"token_id":{"type":"string"}},"required":["kind","reason"],"type":"object"},"Provenance":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"customer_ids":{"items":{"type":"string"},"type":"array"},"joins":{"items":{"$ref":"#/components/schemas/JoinEvidence"},"type":"array"},"ledger_account_ids":{"items":{"type":"string"},"type":"array"},"native_time":{"oneOf":[{"$ref":"#/components/schemas/NativeTime"},{"type":"null"}]},"source_recorded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["account_ids","customer_ids","joins","ledger_account_ids"],"type":"object"},"Provider":{"properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/ProviderRequest"},"revision_id":{"type":"string"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","proposed_at","proposed_by","request","revision_id","status","version"],"type":"object"},"ProviderList":{"properties":{"reuse":{"oneOf":[{"$ref":"#/components/schemas/ProviderListReference"},{"type":"null"}]},"services":{"items":{"$ref":"#/components/schemas/ProviderService"},"type":"array"}},"type":"object"},"ProviderListDocument":{"properties":{"revision_id":{"type":"string"},"sha256":{"type":"string"},"template":{"type":"string"}},"required":["revision_id","sha256","template"],"type":"object"},"ProviderListReference":{"properties":{"revision_id":{"type":"string"},"sha256":{"type":"string"}},"required":["revision_id","sha256"],"type":"object"},"ProviderRequest":{"properties":{"display_name":{"type":"string"},"enabled":{"type":"boolean"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"purposes":{"items":{"$ref":"#/components/schemas/PurposeGrant"},"type":"array"},"reason":{"type":"string"},"service_subject":{"type":"string"}},"required":["display_name","enabled","evidence_ref","evidence_sha256","expected_version","purposes","reason","service_subject"],"type":"object"},"ProviderSelection":{"properties":{"cost_id":{"type":"string"},"evidence_sha256":{"type":"string"},"list":{"$ref":"#/components/schemas/ProviderListReference"},"provider":{"$ref":"#/components/schemas/LendingdisclosuresProvider"},"selected_at":{"format":"date-time","type":"string"},"selected_by":{"type":"string"}},"required":["cost_id","evidence_sha256","list","provider","selected_at","selected_by"],"type":"object"},"ProviderService":{"properties":{"cost_id":{"type":"string"},"estimated_provider_id":{"type":"string"},"providers":{"items":{"$ref":"#/components/schemas/LendingdisclosuresProvider"},"type":"array"}},"required":["cost_id","estimated_provider_id","providers"],"type":"object"},"PublicComplaint":{"properties":{"created_at":{"format":"date-time","type":"string"},"id":{"example":"cmpl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"intake":{"$ref":"#/components/schemas/ComplaintIntake"},"response_ids":{"items":{"type":"string"},"type":"array"},"revision":{"format":"int64","type":"integer"},"round":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["created_at","id","intake","response_ids","revision","round","status"],"type":"object"},"PullResult":{"description":"PullResult is what one pull from the configured message source did.","properties":{"cursor":{"type":"string"},"follow_up_errors":{"items":{"type":"string"},"type":"array"},"processed":{"format":"int64","type":"integer"},"receipts":{"items":{"$ref":"#/components/schemas/MessageReceipt"},"type":"array"},"source":{"type":"string"}},"required":["cursor","processed","receipts","source"],"type":"object"},"PurchaseRequest":{"description":"PurchaseRequest books a share of another bank's loan.","properties":{"amount":{"format":"int64","type":"integer"},"annual_rate_bps":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lead_bank":{"type":"string"},"product_code":{"type":"string"},"reference":{"type":"string"},"settlement_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"term_months":{"format":"int64","type":"integer"}},"required":["amount","customer_id","lead_bank","product_code","reference","settlement_account_id","term_months"],"type":"object"},"PurposeGrant":{"properties":{"disclosure":{"type":"string"},"disclosure_sha256":{"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"history_days":{"format":"int64","type":"integer"},"max_consent_days":{"format":"int64","type":"integer"},"privacy_policy_id":{"type":"string"},"privacy_rule_id":{"type":"string"},"purpose":{"type":"string"}},"required":["disclosure","disclosure_sha256","fields","history_days","max_consent_days","privacy_policy_id","privacy_rule_id","purpose"],"type":"object"},"PurposeTotal":{"properties":{"amount":{"format":"int64","type":"integer"},"purpose":{"type":"string"}},"required":["amount","purpose"],"type":"object"},"Query":{"properties":{"accounts_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_ids":{"items":{"type":"string"},"type":"array"},"cutoff":{"format":"date-time","type":"string"},"manifest_sha256":{"type":"string"},"purpose":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"search_id":{"type":"string"},"source":{"description":"customers, accounts or payments","type":"string"},"subject":{"$ref":"#/components/schemas/Subject"},"subject_reference":{"type":"string"},"transactions_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accounts_from","cutoff","manifest_sha256","purpose","request_id","search_id","source","subject","subject_reference","transactions_from"],"type":"object"},"QueuePage":{"properties":{"has_more":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/ObligationStatus"},"type":"array"},"next_cursor":{"type":"string"}},"required":["has_more","items"],"type":"object"},"Quote":{"description":"Quote is a priced, short-lived offer on the current approved customer sheet.","properties":{"caller":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"daily_limit_usd_minor":{"format":"int64","type":"integer"},"daily_used_usd_minor":{"format":"int64","type":"integer"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"owner":{"type":"string"},"price":{"$ref":"#/components/schemas/ConversionPrice"},"rate_sheet_id":{"type":"string"},"source_amount":{"format":"int64","type":"integer"},"source_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_amount":{"format":"int64","type":"integer"},"target_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["caller","created_at","daily_limit_usd_minor","daily_used_usd_minor","expires_at","id","owner","price","rate_sheet_id","source_ledger_account_id","target_ledger_account_id"],"type":"object"},"QuoteRequest":{"description":"QuoteRequest asks for a price to convert between two ledger accounts of the same customer. Exactly one of the amounts is fixed.","properties":{"source_amount":{"format":"int64","type":"integer"},"source_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"target_amount":{"format":"int64","type":"integer"},"target_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["source_ledger_account_id","target_ledger_account_id"],"type":"object"},"RFPADetermination":{"description":"RFPADetermination records the bank's determination for a government authority's request: the written certificate of compliance 12 U.S.C. 3403(b) requires before customer financial records are released, or the evidenced determination that the certificate does not apply.","properties":{"determination":{"description":"certificate_received or not_applicable","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["determination","evidence_ref","evidence_sha256","reason"],"type":"object"},"RMDAccount":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"fmv_minor":{"format":"int64","type":"integer"},"position_id":{"type":"string"},"required_minor":{"format":"int64","type":"integer"}},"required":["account_id","fmv_minor","position_id","required_minor"],"type":"object"},"RMDAllocation":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"paid_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/RMDAllocationRequest"},"status":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["customer_id","id","journal_id","paid_on","proposed_at","proposed_by","request","status","tax_year"],"type":"object"},"RMDAllocationRequest":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"command_id":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"},"review_id":{"type":"string"}},"required":["amount_minor","command_id","evidence_ref","evidence_sha256","reason","review_id"],"type":"object"},"RMDCohort":{"properties":{"birth_year_from":{"format":"int64","type":"integer"},"birth_year_through":{"format":"int64","type":"integer"},"required_age":{"format":"int64","type":"integer"}},"required":["birth_year_from","birth_year_through","required_age"],"type":"object"},"RMDDivisor":{"properties":{"age":{"format":"int64","type":"integer"},"tenths":{"format":"int64","type":"integer"}},"required":["age","tenths"],"type":"object"},"RMDPolicy":{"properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/RMDPolicyRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","proposed_at","proposed_by","request","status","version"],"type":"object"},"RMDPolicyRequest":{"properties":{"annual_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"authority_ref":{"type":"string"},"cohorts":{"items":{"$ref":"#/components/schemas/RMDCohort"},"type":"array"},"effective_at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"first_year_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reason":{"type":"string"},"single_life":{"items":{"$ref":"#/components/schemas/RMDDivisor"},"type":"array"},"tax_year":{"format":"int64","type":"integer"},"uniform_lifetime":{"items":{"$ref":"#/components/schemas/RMDDivisor"},"type":"array"}},"required":["annual_deadline","authority_ref","cohorts","effective_at","evidence_ref","evidence_sha256","expected_version","first_year_deadline","reason","tax_year","uniform_lifetime"],"type":"object"},"RMDReview":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/RMDAccount"},"type":"array"},"bank_required_minor":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date_of_birth":{"type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"divisor_tenths":{"format":"int64","type":"integer"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"first_required_year":{"type":"boolean"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/RMDReviewRequest"},"status":{"type":"string"},"total_required_minor":{"format":"int64","type":"integer"},"version":{"format":"int64","type":"integer"}},"required":["accounts","bank_required_minor","customer_id","date_of_birth","divisor_tenths","due_date","first_required_year","id","proposed_at","proposed_by","request","status","total_required_minor","version"],"type":"object"},"RMDReviewRequest":{"properties":{"annual_position_ids":{"items":{"type":"string"},"type":"array"},"defer_first_year":{"type":"boolean"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"inherited":{"type":"boolean"},"outside_amounts_as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"outside_eligible_distributions_minor":{"format":"int64","type":"integer"},"outside_ira_required_minor":{"format":"int64","type":"integer"},"outside_timely_distributions_minor":{"format":"int64","type":"integer"},"outstanding_rollover":{"type":"boolean"},"policy_id":{"type":"string"},"reason":{"type":"string"},"spouse_more_than_ten_years_younger":{"type":"boolean"},"tax_year":{"format":"int64","type":"integer"}},"required":["annual_position_ids","defer_first_year","evidence_ref","evidence_sha256","expected_version","inherited","outside_amounts_as_of","outside_eligible_distributions_minor","outside_ira_required_minor","outside_timely_distributions_minor","outstanding_rollover","policy_id","reason","spouse_more_than_ten_years_younger","tax_year"],"type":"object"},"RMDStatus":{"properties":{"bank_command_ids":{"items":{"type":"string"},"type":"array"},"bank_paid_minor":{"format":"int64","type":"integer"},"late_bank_paid_minor":{"format":"int64","type":"integer"},"missed_deadline":{"type":"boolean"},"outside_paid_minor":{"format":"int64","type":"integer"},"past_due":{"type":"boolean"},"remaining_minor":{"format":"int64","type":"integer"},"review":{"$ref":"#/components/schemas/RMDReview"},"timely_bank_paid_minor":{"format":"int64","type":"integer"}},"required":["bank_command_ids","bank_paid_minor","late_bank_paid_minor","missed_deadline","outside_paid_minor","past_due","remaining_minor","review","timely_bank_paid_minor"],"type":"object"},"RailList":{"description":"RailList is the rails with their schedules and live status.","properties":{"data":{"items":{"$ref":"#/components/schemas/RailStatus"},"type":"array"}},"required":["data"],"type":"object"},"RailNotification":{"description":"RailNotification is one entry of an account debit/credit notification (camt.054).","properties":{"accepted_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"account":{"type":"string"},"amount":{"format":"int64","type":"integer"},"cycle_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"direction":{"type":"string"},"end_to_end_id":{"type":"string"},"id":{"type":"string"},"instructed_agent":{"type":"string"},"instructing_agent":{"type":"string"},"msg_def":{"type":"string"},"msg_id":{"type":"string"},"notification_id":{"example":"ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"respondent":{"type":"string"},"uetr":{"type":"string"}},"required":["account","amount","cycle_date","direction","end_to_end_id","id","instructed_agent","instructing_agent","msg_def","msg_id","notification_id","rail","respondent","uetr"],"type":"object"},"RailStatus":{"description":"RailStatus is one rail's published schedule and where it stands now: Fedwire's customer cutoff and cycle date, FedACH's Same Day windows and per-entry limit, and the 24x7 rails' accounting-day rollover.","properties":{"closes":{"type":"string"},"configured":{"type":"boolean"},"customer_cutoff":{"type":"string"},"cycle_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"liquidity_transfer_limit_amount":{"format":"int64","type":"integer"},"liquidity_transfers":{"description":"when liquidity management transfers are accepted","type":"string"},"liquidity_transfers_open":{"type":"boolean"},"next_opening":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rail":{"type":"string"},"rollover":{"type":"string"},"same_day_limit_amount":{"format":"int64","type":"integer"},"same_day_windows":{"items":{"$ref":"#/components/schemas/RailWindow"},"type":"array"},"schedule_confirmed":{"description":"false while a figure waits for the operator's confirmation at onboarding","type":"boolean"},"source":{"type":"string"},"standard_settles_at":{"type":"string"},"status":{"description":"open, closed or always_on","type":"string"},"transaction_limit_amount":{"description":"the network's per-payment limit","format":"int64","type":"integer"}},"required":["configured","cycle_date","rail","schedule_confirmed","source","status"],"type":"object"},"RailWindow":{"description":"RailWindow is a Same Day ACH window and whether it is still open now.","properties":{"name":{"type":"string"},"open":{"type":"boolean"},"settles_at":{"description":"ET","type":"string"},"submit_by":{"description":"ET","type":"string"}},"required":["name","open","settles_at","submit_by"],"type":"object"},"RaisedAlert":{"description":"RaisedAlert is an alert another service raises (cards raises card_merchant_sanctions).","properties":{"detail":{"type":"string"},"evidence":{"additionalProperties":true,"type":"object"},"rule":{"type":"string"},"severity":{"type":"string"},"subject":{"type":"string"}},"required":["detail","evidence","rule","severity","subject"],"type":"object"},"RaisedAlertID":{"description":"RaisedAlertID is the alert a raise opened or found (one per rule, subject and business date).","properties":{"id":{"type":"string"}},"required":["id"],"type":"object"},"RateLine":{"description":"RateLine is one currency's rate: USD per one major unit of the currency at mid, and for a customer sheet the spreads either side of mid and the largest conversion it may price.","properties":{"currency_code":{"type":"string"},"customer_buy_spread_bps":{"description":"the customer buys the currency: ask = mid × (1 + bps/10000)","format":"int64","type":"integer"},"customer_sell_spread_bps":{"description":"the customer sells the currency: bid = mid × (1 − bps/10000)","format":"int64","type":"integer"},"max_conversion_usd_minor":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["currency_code","usd_per_foreign_major"],"type":"object"},"RateSheet":{"description":"RateSheet is a retained proposal and, once decided, its independent decision.","properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"daily_customer_limit_usd_minor":{"format":"int64","type":"integer"},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"evidence":{"type":"string"},"id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/RateLine"},"type":"array"},"policy_reference":{"type":"string"},"purpose":{"type":"string"},"rate_snapshot_id":{"type":"string"},"rate_snapshot_sha256":{"type":"string"},"status":{"description":"proposed, approved or rejected","type":"string"},"valid_from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"valid_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["actor","at","business_date","content_sha256","evidence","id","lines","policy_reference","purpose","rate_snapshot_id","rate_snapshot_sha256","status"],"type":"object"},"RateSheetRequest":{"description":"RateSheetRequest is what treasury proposes. The rates must equal the retained reference snapshot the sheet names; the ledger checks that, the maker cannot type a rate.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"daily_customer_limit_usd_minor":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/RateLine"},"type":"array"},"policy_reference":{"type":"string"},"purpose":{"type":"string"},"rate_snapshot_id":{"type":"string"},"valid_from":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"valid_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"required":["business_date","evidence","lines","policy_reference","purpose","rate_snapshot_id"],"type":"object"},"RateSnapshot":{"description":"RateSnapshot is one retained reference-rate publication and the USD rates derived from it.","properties":{"document_sha256":{"type":"string"},"fetched_at":{"format":"date-time","type":"string"},"fetched_by":{"type":"string"},"id":{"type":"string"},"publication_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"$ref":"#/components/schemas/ReferenceRates"},"source":{"description":"simulator or provider","type":"string"},"usd_per_foreign_major":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["document_sha256","fetched_at","fetched_by","id","publication_date","reference","source","usd_per_foreign_major"],"type":"object"},"RateSnapshotRequest":{"description":"RateSnapshotRequest names the reference-rate publication date to fetch.","properties":{"publication_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["publication_date"],"type":"object"},"ReadRequest":{"properties":{"after":{"format":"int64","type":"integer"},"purpose":{"type":"string"}},"required":["after","purpose"],"type":"object"},"Readiness":{"properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ready":{"type":"boolean"},"units":{"format":"int64","type":"integer"}},"required":["blockers","business_date","ready","units"],"type":"object"},"RebuildRecord":{"description":"RebuildRecord is the immutable record of one read-model rebuild; CompletedAt is set once its consumer group has caught up.","properties":{"completed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"consumer_group":{"type":"string"},"from_offset":{"type":"string"},"id":{"format":"int64","type":"integer"},"reason":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"requested_by":{"type":"string"},"tables":{"items":{"type":"string"},"type":"array"}},"required":["consumer_group","from_offset","id","reason","requested_at","requested_by","tables"],"type":"object"},"RebuildRequest":{"description":"RebuildRequest asks for the event-derived facts to be emptied and replayed from the start of the topics under the consumer group <base>-rebuild-<suffix>.","properties":{"reason":{"type":"string"},"suffix":{"type":"string"},"tables":{"description":"a subset of the event-derived tables; all of them when empty","items":{"type":"string"},"type":"array"}},"required":["reason","suffix"],"type":"object"},"Receipt":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_number":{"type":"string"},"amount":{"format":"int64","type":"integer"},"company_id":{"type":"string"},"effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"hold_reason":{"type":"string"},"iat":{"oneOf":[{"$ref":"#/components/schemas/IATDetails"},{"type":"null"}]},"id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"individual_id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"name":{"type":"string"},"odfi":{"type":"string"},"originator_name":{"type":"string"},"outcome":{"description":"posted, returned, accepted (a prenotification), held (an international entry under review), blocked","type":"string"},"return_code":{"type":"string"},"return_reason":{"type":"string"},"reversal_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reviewed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"reviewed_by":{"type":"string"},"screening_ids":{"items":{"type":"string"},"type":"array"},"sec_code":{"type":"string"},"trace_number":{"type":"string"},"transaction_code":{"type":"string"}},"required":["account_id","account_number","amount","file_id","id","journal_id","outcome","return_code","return_reason","trace_number","transaction_code"],"type":"object"},"ReceiptCount":{"properties":{"actor":{"type":"string"},"counted_amount":{"format":"int64","type":"integer"},"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"role":{"description":"first, second","type":"string"},"shipment_id":{"type":"string"}},"required":["actor","counted_amount","denominations","evidence","evidence_sha256","id","recorded_at","role","shipment_id"],"type":"object"},"ReceiptCountRequest":{"properties":{"denominations":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"evidence":{"type":"string"},"evidence_sha256":{"type":"string"},"role":{"description":"first, second","type":"string"},"shipment_id":{"type":"string"}},"required":["denominations","evidence","evidence_sha256","role","shipment_id"],"type":"object"},"ReceiptObservation":{"properties":{"return_journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]},"return_journal_sha256":{"type":"string"},"return_reason":{"type":"string"},"returned":{"type":"boolean"},"source":{"$ref":"#/components/schemas/HoaSource"}},"required":["returned","source"],"type":"object"},"ReceiptRequest":{"properties":{"document":{"format":"byte","type":"string"},"receipt":{"$ref":"#/components/schemas/FilingsReceipt"}},"required":["document","receipt"],"type":"object"},"ReceiptResult":{"properties":{"actor":{"type":"string"},"blockers":{"items":{"type":"string"},"type":"array"},"cash_ready":{"type":"boolean"},"cash_statement_id":{"type":"string"},"cash_statement_sha256":{"type":"string"},"content_sha256":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"receipt":{"$ref":"#/components/schemas/PayablesCashReceipt"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","cash_ready","content_sha256","receipt","recorded_at"],"type":"object"},"ReceivePayment":{"description":"ReceivePayment is a fresh, voluntary instruction from the verified individual borrower. The account is resolved from the loan; no replacement destination or client-supplied received date is accepted.","properties":{"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"forwarding_consent":{"type":"boolean"},"receiving_servicer_id":{"type":"string"},"transfer_action_id":{"type":"string"}},"required":["amount_minor","currency","forwarding_consent","receiving_servicer_id","transfer_action_id"],"type":"object"},"ReceivedPayment":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"actor":{"type":"string"},"cancellation":{"oneOf":[{"$ref":"#/components/schemas/ForwardingCancellation"},{"type":"null"}]},"captured_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request":{"$ref":"#/components/schemas/ReceivePayment"},"result":{"oneOf":[{"$ref":"#/components/schemas/ForwardingResult"},{"type":"null"}]},"returns":{"items":{"$ref":"#/components/schemas/PaymentReturn"},"type":"array"},"source":{"$ref":"#/components/schemas/ForwardingSource"}},"required":["account_id","actor","captured_at","content_sha256","customer_id","id","loan_id","request","returns","source"],"type":"object"},"RecharacterizationEvidence":{"description":"RecharacterizationEvidence retains the owner's election and the reviewed net income attributable; the trustee does not calculate that income here.","properties":{"authority_ref":{"type":"string"},"earnings_ref":{"type":"string"},"earnings_sha256":{"type":"string"},"instruction_ref":{"type":"string"},"instruction_sha256":{"type":"string"},"policy_sha256":{"type":"string"}},"required":["authority_ref","earnings_ref","earnings_sha256","instruction_ref","instruction_sha256","policy_sha256"],"type":"object"},"Recipient":{"properties":{"actor":{"type":"string"},"agency":{"description":"Agency holds the reviewed terms of an agency protocol; omitted for a beneficiary wire so\nthe digests of recipients reviewed before agency protocols existed are unchanged.","oneOf":[{"$ref":"#/components/schemas/AgencyTerms"},{"type":"null"}]},"authority_evidence_reference":{"type":"string"},"authority_evidence_sha256":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PayablesDecision"},{"type":"null"}]},"destination":{"$ref":"#/components/schemas/Destination"},"environment":{"type":"string"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"legal_entity":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_external_account_reference":{"type":"string"},"payee_reference":{"type":"string"},"protocol":{"type":"string"},"provider":{"type":"string"},"public_key":{"type":"string"},"receiving_bank_name":{"type":"string"},"revocation":{"oneOf":[{"$ref":"#/components/schemas/Revocation"},{"type":"null"}]},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["actor","authority_evidence_reference","authority_evidence_sha256","content_sha256","created_at","destination","environment","id","jurisdiction","key_id","kind","legal_entity","master_cash_external_account_reference","payee_reference","protocol","provider","public_key","receiving_bank_name","valid_from","valid_through"],"type":"object"},"RecipientTerms":{"description":"RecipientTerms establishes a reviewed payment destination, signature trust and applicable source context. Evidence references point to actual retained bank authorization/enrollment records, not inferred tax deadlines or vendor setup.","properties":{"agency":{"description":"Agency holds the reviewed terms of an agency protocol; omitted for a beneficiary wire so\nthe digests of recipients reviewed before agency protocols existed are unchanged.","oneOf":[{"$ref":"#/components/schemas/AgencyTerms"},{"type":"null"}]},"authority_evidence_reference":{"type":"string"},"authority_evidence_sha256":{"type":"string"},"destination":{"$ref":"#/components/schemas/Destination"},"environment":{"type":"string"},"jurisdiction":{"type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"legal_entity":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_external_account_reference":{"type":"string"},"payee_reference":{"type":"string"},"protocol":{"type":"string"},"provider":{"type":"string"},"public_key":{"type":"string"},"receiving_bank_name":{"type":"string"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["authority_evidence_reference","authority_evidence_sha256","destination","environment","jurisdiction","key_id","kind","legal_entity","master_cash_external_account_reference","payee_reference","protocol","provider","public_key","receiving_bank_name","valid_from","valid_through"],"type":"object"},"Recon":{"properties":{"actor":{"type":"string"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"balanced":{"type":"boolean"},"blockers":{"items":{"type":"string"},"type":"array"},"claim_amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"delivered_amount":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"id":{"type":"string"},"in_transit_amount":{"format":"int64","type":"integer"},"posted_amount":{"format":"int64","type":"integer"},"unit_id":{"type":"string"}},"required":["actor","as_of","balanced","blockers","claim_amount","created_at","delivered_amount","evidence","id","in_transit_amount","posted_amount","unit_id"],"type":"object"},"ReconRequest":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"unit_id":{"type":"string"}},"required":["as_of","evidence","unit_id"],"type":"object"},"ReconciledSource":{"description":"ReconciledSource is one payable source of a remittance and what happened to its allocation.","properties":{"allocated_minor":{"format":"int64","type":"integer"},"obligation_id":{"type":"string"},"returned_minor":{"format":"int64","type":"integer"},"settled_minor":{"format":"int64","type":"integer"},"source_sha256":{"type":"string"}},"required":["allocated_minor","obligation_id","returned_minor","settled_minor","source_sha256"],"type":"object"},"Reconciliation":{"description":"Reconciliation is a proposed match awaiting independent review.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/CashDecision"},{"type":"null"}]},"evidence":{"type":"string"},"id":{"type":"string"},"journal_ids":{"items":{"type":"string"},"type":"array"},"line_id":{"type":"string"},"statement_id":{"type":"string"}},"required":["actor","created_at","evidence","id","journal_ids","line_id","statement_id"],"type":"object"},"ReconciliationBreak":{"description":"ReconciliationBreak is one unmatched or mismatched item, open until an analyst clears it.","properties":{"age_days":{"description":"calendar days since the business date","format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cleared_by_run_id":{"description":"the run whose match resolved an open break","type":"string"},"created_at":{"format":"date-time","type":"string"},"external_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"id":{"type":"string"},"internal_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"kind":{"type":"string"},"note":{"type":"string"},"reference":{"type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"resolved_by":{"type":"string"},"run_id":{"type":"string"},"side":{"description":"external (on the statement only), internal (in the bank only), amount (both, different), closing_balance","type":"string"},"source":{"type":"string"},"status":{"description":"open, explained, resolved","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["age_days","business_date","created_at","id","kind","note","reference","run_id","side","source","status","updated_at"],"type":"object"},"ReconciliationEvidence":{"description":"ReconciliationEvidence retains the versioned statement, exact internal items and GL position used by this run. Raw JSON preserves every integer exactly.","properties":{"captured_at":{"format":"date-time","type":"string"},"record":{"additionalProperties":true,"type":"object"},"run_id":{"type":"string"},"source_sha256":{"type":"string"},"statement_id":{"type":"string"}},"required":["captured_at","record","run_id","source_sha256","statement_id"],"type":"object"},"ReconciliationRequest":{"description":"ReconciliationRequest matches one statement line to journals.","properties":{"evidence":{"type":"string"},"journal_ids":{"items":{"type":"string"},"type":"array"},"line_id":{"type":"string"},"statement_id":{"type":"string"}},"required":["evidence","journal_ids","line_id","statement_id"],"type":"object"},"ReconciliationRun":{"description":"ReconciliationRun is one matching of a statement against the bank's own records.","properties":{"breaks_open":{"description":"open breaks for the source and date after the run","format":"int64","type":"integer"},"breaks_opened":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_amount":{"description":"the statement's closing balance","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"difference_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"external_count":{"description":"statement lines","format":"int64","type":"integer"},"external_total_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"internal_count":{"description":"the bank's items for the day","format":"int64","type":"integer"},"internal_total_amount":{"format":"int64","type":"integer"},"ledger_amount":{"description":"the ledger's master account position for the day","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"matched":{"format":"int64","type":"integer"},"run_at":{"format":"date-time","type":"string"},"source":{"type":"string"},"statement_id":{"type":"string"},"status":{"description":"clean or breaks","type":"string"}},"required":["breaks_open","breaks_opened","business_date","external_count","external_total_amount","id","internal_count","internal_total_amount","matched","run_at","source","statement_id","status"],"type":"object"},"ReconciliationTerms":{"description":"ReconciliationTerms are the tolerances of the automated reconciliation: how far apart a statement entry's value date and the ledger's effective date may be for a match, and how many days an unmatched item waits (a timing difference) before it opens a break.","properties":{"unmatched_age_days":{"format":"int64","type":"integer"},"value_date_window_days":{"format":"int64","type":"integer"}},"required":["unmatched_age_days","value_date_window_days"],"type":"object"},"ReconciliationTotals":{"description":"ReconciliationTotals tie the file.","properties":{"outstanding_amount":{"format":"int64","type":"integer"},"outstanding_count":{"format":"int64","type":"integer"},"paid_amount":{"format":"int64","type":"integer"},"paid_count":{"format":"int64","type":"integer"},"returned_amount":{"format":"int64","type":"integer"},"returned_count":{"format":"int64","type":"integer"}},"required":["outstanding_amount","outstanding_count","paid_amount","paid_count","returned_amount","returned_count"],"type":"object"},"Record":{"properties":{"collateral":{"oneOf":[{"$ref":"#/components/schemas/CollateralAdjustmentRequest"},{"type":"null"}]},"content_sha256":{"type":"string"},"customer_sha256":{"type":"string"},"customer_snapshot":{"additionalProperties":true,"type":"object"},"decision":{"oneOf":[{"$ref":"#/components/schemas/RegwDecision"},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string"},"plan":{"oneOf":[{"$ref":"#/components/schemas/Plan"},{"type":"null"}]},"policy":{"oneOf":[{"$ref":"#/components/schemas/Policy"},{"type":"null"}]},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"registry":{"oneOf":[{"$ref":"#/components/schemas/Registry"},{"type":"null"}]},"release":{"oneOf":[{"$ref":"#/components/schemas/ReleaseRequest"},{"type":"null"}]}},"required":["content_sha256","id","kind","proposed_at","proposed_by"],"type":"object"},"RecordView":{"description":"RecordView is a retained record with its disposition.","properties":{"content_sha256":{"type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"identity":{"type":"string"},"network":{"type":"string"},"posting":{"oneOf":[{"$ref":"#/components/schemas/Posting"},{"type":"null"}]},"record":{"$ref":"#/components/schemas/ClearingRecord"}},"required":["content_sha256","file_id","id","identity","network","record"],"type":"object"},"Record_046f45c32cb3":{"properties":{"cancelled":{"type":"boolean"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingratesDecision"},{"type":"null"}]},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/LendingratesObservation"}},"required":["maker","recorded_at","value"],"type":"object"},"Record_0f87d82e510e":{"properties":{"cancelled":{"type":"boolean"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingratesDecision"},{"type":"null"}]},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/LendingratesCancellation"}},"required":["maker","recorded_at","value"],"type":"object"},"Record_642039d9104b":{"properties":{"cancelled":{"type":"boolean"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingratesDecision"},{"type":"null"}]},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/Reset"}},"required":["maker","recorded_at","value"],"type":"object"},"Record_9e2345ba8bd4":{"properties":{"cancelled":{"type":"boolean"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingratesDecision"},{"type":"null"}]},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"value":{"$ref":"#/components/schemas/LendingratesContract"}},"required":["maker","recorded_at","value"],"type":"object"},"Record_de2ff211e763":{"properties":{"cancelled":{"type":"boolean"},"decision":{"oneOf":[{"$ref":"#/components/schemas/LendingratesDecision"},{"type":"null"}]},"maker":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"value":{"additionalProperties":true,"type":"object"}},"required":["maker","recorded_at","value"],"type":"object"},"RecordsAction":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/RecordsActionRequest"},"status":{"type":"string"}},"required":["customer_id","id","proposed_at","proposed_by","request","status"],"type":"object"},"RecordsActionRequest":{"properties":{"event_at":{"description":"independently evidenced trigger, e.g. relationship closure","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"hold_id":{"description":"release_hold only","example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"hold, release_hold, dispose, retention_event","type":"string"},"matter_ref":{"type":"string"},"reason":{"type":"string"},"record_id":{"description":"empty hold covers all current/future customer records","type":"string"}},"required":["evidence_ref","evidence_sha256","kind","matter_ref","reason"],"type":"object"},"RecordsContent":{"properties":{"content":{"format":"byte","type":"string"},"record":{"$ref":"#/components/schemas/RecordsRecord"}},"required":["content","record"],"type":"object"},"RecordsDecision":{"properties":{"decision":{"description":"approve/reject","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["decision","evidence_ref","evidence_sha256","reason"],"type":"object"},"RecordsEvidence":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"RecordsRecord":{"properties":{"active_holds":{"items":{"type":"string"},"type":"array"},"category":{"type":"string"},"content_bytes":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"content_type":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disposed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"type":"string"},"permanent":{"type":"boolean"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"retain_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"retention_starts_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"schedule_id":{"type":"string"},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["active_holds","category","content_bytes","content_sha256","content_type","created_at","customer_id","id","permanent","recorded_at","recorded_by","schedule_id","source_ref","source_service"],"type":"object"},"RecordsourceSnapshot":{"properties":{"database":{"type":"string"},"description":{"$ref":"#/components/schemas/Description"},"id":{"type":"string"},"mvcc_snapshot":{"type":"string"},"request":{"$ref":"#/components/schemas/SnapshotRequest"},"root_sha256":{"type":"string"},"rows":{"format":"int64","type":"integer"},"schema":{"type":"string"},"shape":{"oneOf":[{"$ref":"#/components/schemas/Shape"},{"type":"null"}]},"taken_at":{"format":"date-time","type":"string"}},"required":["database","description","id","mvcc_snapshot","request","root_sha256","rows","schema","taken_at"],"type":"object"},"RecoveryRequest":{"properties":{"by":{"type":"string"},"reason":{"type":"string"}},"required":["reason"],"type":"object"},"Redemption":{"properties":{"cash_evidence":{"$ref":"#/components/schemas/Document"},"cash_reference":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"custody_evidence":{"$ref":"#/components/schemas/Document"},"external_account_reference":{"type":"string"},"face_amount":{"format":"int64","type":"integer"},"fee_amount":{"format":"int64","type":"integer"},"id":{"type":"string"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_statement_line_reference":{"type":"string"},"master_cash_statement_reference":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"original_settlement_sha256":{"type":"string"},"payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"payment_reference":{"type":"string"},"signature":{"type":"string"},"tax_evidence":{"$ref":"#/components/schemas/Document"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"},"withholding_amount":{"format":"int64","type":"integer"}},"required":["cash_evidence","cash_reference","currency_code","cusip","custodian_reference","custody_evidence","external_account_reference","face_amount","fee_amount","id","key_id","legal_entity","lot_id","lot_revision","master_cash_external_account_reference","master_cash_ledger_account_id","master_cash_statement_line_reference","master_cash_statement_reference","net_cash_amount","observed_at","original_settlement_sha256","payment_date","payment_reference","signature","tax_evidence","units","version","withholding_amount"],"type":"object"},"RedemptionRecord":{"properties":{"accounting_plans":{"items":{"$ref":"#/components/schemas/AccountingPlan"},"type":"array"},"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"exceptions":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"receipt":{"$ref":"#/components/schemas/Redemption"},"request_sha256":{"type":"string"},"resolutions":{"items":{"$ref":"#/components/schemas/BanksecuritiesDecision"},"type":"array"},"status":{"type":"string"}},"required":["actor","created_at","exceptions","id","receipt","request_sha256","status"],"type":"object"},"RedemptionRequest":{"properties":{"consent":{"type":"boolean"},"placement_id":{"type":"string"},"standing_authorization_sha256":{"type":"string"}},"required":["consent","placement_id"],"type":"object"},"ReferenceRates":{"description":"ReferenceRates is one parsed reference-rate publication.","properties":{"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"per_eur":{"additionalProperties":{"type":"string"},"description":"units of the currency per one euro, as published","type":"object"},"sender":{"type":"string"},"subject":{"type":"string"}},"required":["date","per_eur","sender","subject"],"type":"object"},"RefreshRequest":{"description":"RefreshRequest rotates a refresh token.","properties":{"refresh_token":{"type":"string"}},"required":["refresh_token"],"type":"object"},"Refund":{"properties":{"actor":{"type":"string"},"amount_minor":{"format":"int64","type":"integer"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"destination_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_reference":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"obligation_id":{"type":"string"},"obligation_sha256":{"type":"string"},"reason":{"type":"string"},"requested_by":{"type":"string"},"source_id":{"type":"string"},"source_sha256":{"type":"string"}},"required":["actor","amount_minor","content_sha256","created_at","destination_ledger_account_id","evidence_reference","id","journal_id","journal_key","obligation_id","obligation_sha256","reason","requested_by","source_id","source_sha256"],"type":"object"},"RefundRequest":{"description":"RefundRequest can only return an unallocated loan-forwarding obligation to its actual original debit DDA. Destination and posting amounts are resolved from retained ledger evidence, never supplied by the caller. The exact eight-field JSON encoding is also verified by ledger migration0056; changes need a compatible proof migration preserving retained replay hashes.","properties":{"amount_minor":{"format":"int64","type":"integer"},"evidence_reference":{"type":"string"},"obligation_id":{"type":"string"},"obligation_sha256":{"type":"string"},"reason":{"type":"string"},"requested_by":{"type":"string"},"source_id":{"type":"string"},"source_sha256":{"type":"string"}},"required":["amount_minor","evidence_reference","obligation_id","obligation_sha256","reason","requested_by","source_id","source_sha256"],"type":"object"},"RefuseChangeBody":{"description":"RefuseChangeBody refuses a notification of change the bank received.","properties":{"operator":{"type":"string"},"refused_code":{"description":"C61 to C69","type":"string"}},"required":["operator","refused_code"],"type":"object"},"RegisterRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"evidence_reference":{"type":"string"},"jurisdiction":{"type":"string"},"kind":{"type":"string"},"legal_entity":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payee_reference":{"type":"string"},"source":{"$ref":"#/components/schemas/SourceCredit"},"source_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source_date_basis":{"type":"string"},"source_id":{"type":"string"},"source_sha256":{"type":"string"},"tax_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"tax_period":{"type":"string"}},"required":["amount_minor","currency","customer_id","evidence_reference","kind","legal_entity","source","source_date","source_id","source_sha256"],"type":"object"},"Registry":{"properties":{"affiliate_id":{"description":"canonical company identity, not a whole customer group","type":"string"},"classification":{"description":"affiliate or nonaffiliate; a miss never implies nonaffiliate","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ownership_evidence":{"$ref":"#/components/schemas/Evidence"},"rationale":{"type":"string"},"relationship":{"type":"string"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["classification","customer_id","ownership_evidence","rationale","relationship","valid_from","valid_through"],"type":"object"},"RegistryObservation":{"description":"RegistryObservation is a current read of the latest independently reviewed classification and the customer's unchanged authoritative identity source. It is an observation, not a distributed fence on later ownership changes.","properties":{"content_sha256":{"type":"string"},"customer_sha256":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"record":{"$ref":"#/components/schemas/Record"}},"required":["content_sha256","customer_sha256","observed_at","record"],"type":"object"},"Regulatory":{"description":"Regulatory is the product's place in the bank's reporting: the Call Report (FFIEC 041) items its balances and income roll up to and its FR 2900 deposit class. It is an attribute of the product, checked against the chart of accounts, so a schedule is never mapped by hand.","properties":{"fr2900_class":{"description":"deposits: transaction, savings (money market included) or time","type":"string"},"interest_bearing":{"description":"deposits: RC 13.a.(2) when true, 13.a.(1) when not","type":"boolean"},"rc_c_item":{"description":"loans: the Schedule RC-C loan category, 4.a commercial and industrial, 6.c other consumer","type":"string"},"rc_e_column":{"description":"deposits: transaction or nontransaction (Schedule RC-E columns)","type":"string"},"rc_e_item":{"description":"deposits: the RC-E depositor line, 1 for individuals, partnerships and corporations","type":"string"},"rc_n_category":{"description":"loans: the Schedule RC-N line, the same category as RC-C unless the schedule splits it","type":"string"},"ri_item":{"description":"the Schedule RI income or expense item the product's interest reports on","type":"string"}},"type":"object"},"RegwDecision":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence":{"$ref":"#/components/schemas/Evidence"},"rationale":{"type":"string"}},"required":["actor","at","content_sha256","decision","evidence","rationale"],"type":"object"},"RegwReservation":{"properties":{"actor":{"type":"string"},"affiliate_id":{"type":"string"},"all_exposure_after":{"format":"int64","type":"integer"},"capital_stock_and_surplus":{"format":"int64","type":"integer"},"cash_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"covered_amount":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"credit":{"$ref":"#/components/schemas/CreditRequest"},"id":{"type":"string"},"monitor_id":{"type":"string"},"plan_id":{"type":"string"},"plan_sha256":{"type":"string"},"policy_id":{"type":"string"},"policy_sha256":{"type":"string"},"registry_ids":{"items":{"type":"string"},"type":"array"},"single_exposure_after":{"format":"int64","type":"integer"},"status":{"description":"preparing, reserved, released; preparing still consumes capacity","type":"string"}},"required":["actor","all_exposure_after","capital_stock_and_surplus","covered_amount","created_at","credit","id","plan_id","plan_sha256","policy_id","policy_sha256","registry_ids","single_exposure_after","status"],"type":"object"},"Relationship":{"properties":{"basis":{"description":"self, controlled_company, political_committee, guarantee, tangible_benefit, majority_partnership","type":"string"},"insider_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"institution":{"description":"bank, affiliate","type":"string"},"role":{"description":"executive_officer, director, principal_shareholder","type":"string"}},"required":["basis","insider_customer_id","institution","role"],"type":"object"},"Release":{"description":"Release records the audited handoff of an approved package to the counsel named on the legal request. Nothing is transmitted: the releasing staff member retrieves the package and key. The key is returned at release and again on an exact replay by the same staff member under the same idempotency key; any other request for it is refused.","properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"handoff_method":{"type":"string"},"reason":{"type":"string"},"recipient":{"type":"string"}},"required":["evidence_ref","evidence_sha256","handoff_method","reason","recipient"],"type":"object"},"ReleaseReceipt":{"properties":{"handoff_method":{"type":"string"},"key_format":{"type":"string"},"package_key":{"format":"byte","type":"string"},"package_sha256":{"type":"string"},"production_id":{"type":"string"},"recipient":{"type":"string"},"released_at":{"format":"date-time","type":"string"},"released_by":{"type":"string"}},"required":["handoff_method","key_format","package_key","package_sha256","production_id","recipient","released_at","released_by"],"type":"object"},"ReleaseRequest":{"properties":{"evidence":{"$ref":"#/components/schemas/Evidence"},"obligation_terminated":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"rationale":{"type":"string"},"reservation_id":{"type":"string"}},"required":["evidence","rationale","reservation_id"],"type":"object"},"ReleasedSupportDocument":{"description":"ReleasedSupportDocument carries the exact retained bytes of a support document.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"bytes":{"format":"int64","type":"integer"},"content":{"format":"byte","type":"string"},"file_name":{"type":"string"},"sha256":{"type":"string"},"submission_file_name":{"type":"string"}},"required":["activity_sequence","bytes","content","file_name","sha256","submission_file_name"],"type":"object"},"Remittance":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PayablesDecision"},{"type":"null"}]},"id":{"type":"string"},"instruction":{"oneOf":[{"$ref":"#/components/schemas/PayablesInstruction"},{"type":"null"}]},"obligations":{"items":{"$ref":"#/components/schemas/Obligation"},"type":"array"},"outbound_message":{"type":"string"},"recipient":{"$ref":"#/components/schemas/Recipient"},"request":{"$ref":"#/components/schemas/RemittanceRequest"},"reservation":{"oneOf":[{"$ref":"#/components/schemas/Reservation"},{"type":"null"}]}},"required":["actor","content_sha256","created_at","id","obligations","recipient","request"],"type":"object"},"RemittanceBatch":{"description":"RemittanceBatch is one batch of a day's mail.","properties":{"items":{"items":{"$ref":"#/components/schemas/RemittanceItem"},"type":"array"},"number":{"format":"int64","type":"integer"}},"required":["items"],"type":"object"},"RemittanceItem":{"description":"RemittanceItem is one check in a lockbox batch.","properties":{"amount":{"format":"int64","type":"integer"},"back_image":{"format":"byte","type":"string"},"front_image":{"format":"byte","type":"string"},"invoices":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"micr":{"$ref":"#/components/schemas/MICR"},"remitter":{"type":"string"}},"required":["amount","micr"],"type":"object"},"RemittanceRequest":{"properties":{"agency_report_id":{"description":"AgencyReportID names the accepted unclaimed property holder report an unclaimed property\nremittance pays; omitted otherwise.","example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"allocations":{"items":{"$ref":"#/components/schemas/AllocationRequest"},"type":"array"},"recipient_id":{"type":"string"},"reference":{"type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["allocations","recipient_id","reference","settlement_date"],"type":"object"},"RemoteDeposit":{"description":"RemoteDeposit is one item a customer captured remotely.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"adjustment_amount":{"format":"int64","type":"integer"},"adjustment_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"adjustment_reason":{"type":"string"},"amount":{"format":"int64","type":"integer"},"channel":{"type":"string"},"check_deposit_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_by":{"type":"string"},"deposited_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"endorsement_present":{"type":"boolean"},"endorsement_restrictive":{"type":"boolean"},"has_images":{"type":"boolean"},"id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"micr":{"$ref":"#/components/schemas/MICR"},"payee":{"type":"string"},"pending_actor":{"type":"string"},"pending_decision":{"type":"string"},"product_code":{"type":"string"},"quality_codes":{"items":{"type":"string"},"type":"array"},"reject_reason":{"type":"string"},"review_reasons":{"items":{"type":"string"},"type":"array"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","amount","channel","created_at","currency_code","endorsement_present","endorsement_restrictive","has_images","id","ledger_account_id","micr","product_code","status","updated_at"],"type":"object"},"RemoteDepositLimit":{"description":"RemoteDepositLimit is the bank's per-customer, per-product cap on remotely captured items.","properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"daily_amount":{"format":"int64","type":"integer"},"daily_items":{"format":"int64","type":"integer"},"defaulted":{"type":"boolean"},"per_item_amount":{"format":"int64","type":"integer"},"product_code":{"type":"string"},"review_amount":{"format":"int64","type":"integer"},"updated_at":{"format":"date-time","type":"string"},"updated_by":{"type":"string"}},"required":["customer_id","daily_amount","daily_items","per_item_amount","product_code","review_amount"],"type":"object"},"Repayment":{"properties":{"cash_evidence":{"$ref":"#/components/schemas/Document"},"cash_reference":{"type":"string"},"confirmation":{"$ref":"#/components/schemas/Document"},"currency_code":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"interest_amount":{"format":"int64","type":"integer"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"lender_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_reference":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_statement_line_reference":{"type":"string"},"master_cash_statement_reference":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"repayment_instruction_sha256":{"type":"string"},"settled_at":{"format":"date-time","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"signature":{"type":"string"},"transaction_id":{"type":"string"},"version":{"type":"string"}},"required":["cash_evidence","cash_reference","confirmation","currency_code","fee_amount","instruction_sha256","interest_amount","key_id","legal_entity","lender_customer_id","lender_reference","master_cash_external_account_reference","master_cash_ledger_account_id","master_cash_statement_line_reference","master_cash_statement_reference","net_cash_amount","observed_at","principal_amount","settled_at","settlement_date","signature","transaction_id","version"],"type":"object"},"RepaymentConfirmation":{"description":"RepaymentConfirmation is the lender's answer to a repayment request: the principal repaid, the interest charged on the advance for the days since interest was last paid, any fee, and the total debited to the bank.","properties":{"advance_number":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"interest_amount":{"format":"int64","type":"integer"},"interest_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"principal_outstanding_amount":{"format":"int64","type":"integer"},"rate_bps":{"format":"int64","type":"integer"},"reason":{"type":"string"},"reference":{"type":"string"},"status":{"description":"repaid or refused","type":"string"},"total_amount":{"format":"int64","type":"integer"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["advance_number","fee_amount","interest_amount","interest_from","interest_through","principal_amount","principal_outstanding_amount","rate_bps","reference","status","total_amount","value_date"],"type":"object"},"RepaymentInstruction":{"properties":{"cash_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"due_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"funding_sha256":{"type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"issued_at":{"format":"date-time","type":"string"},"legal_entity":{"type":"string"},"lender_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"lender_reference":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_instruction_sha256":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"sha256":{"type":"string"},"transaction_id":{"type":"string"},"version":{"type":"string"}},"required":["cash_amount","currency_code","due_date","funding_sha256","hold_id","interest_amount","issued_at","legal_entity","lender_customer_id","lender_reference","master_cash_external_account_reference","master_cash_ledger_account_id","original_instruction_sha256","principal_amount","sha256","transaction_id","version"],"type":"object"},"RepaymentRequest":{"description":"RepaymentRequest repays principal of an advance, with the interest the lender charges on it.","properties":{"advance_number":{"type":"string"},"borrower":{"type":"string"},"lender":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"type":"string"}},"required":["advance_number","borrower","lender","principal_amount","reference","value_date","version"],"type":"object"},"Replenishment":{"description":"Replenishment is a replenishment order with its history.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"order":{"$ref":"#/components/schemas/ReplenishmentOrder"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/CarrierReceipt"},{"type":"null"}]},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"updates":{"items":{"$ref":"#/components/schemas/ReplenishmentUpdate"},"type":"array"}},"required":["actor","created_at","order","status","updated_at","updates"],"type":"object"},"ReplenishmentOrder":{"description":"ReplenishmentOrder is what the switch hands the armored carrier module: the narrow interface between ATM operations and cash logistics.","properties":{"amount":{"format":"int64","type":"integer"},"cash_unit_id":{"type":"string"},"id":{"type":"string"},"location":{"type":"string"},"needed_by":{"format":"date-time","type":"string"},"notes":{"additionalProperties":{"format":"int64","type":"integer"},"description":"requested notes by denomination in cents","type":"object"},"reason":{"description":"low_cash, out_of_cash, manual","type":"string"},"terminal_id":{"type":"string"},"terminal_ref":{"type":"string"}},"required":["amount","cash_unit_id","id","location","needed_by","notes","reason","terminal_id","terminal_ref"],"type":"object"},"ReplenishmentUpdate":{"description":"ReplenishmentUpdate reports the carrier's progress on an order.","properties":{"carrier_reference":{"type":"string"},"cash_movement_id":{"description":"completed: the accounts custody movement that loaded the unit","type":"string"},"evidence":{"type":"string"},"status":{"description":"scheduled, completed, cancelled","type":"string"}},"required":["carrier_reference","evidence","status"],"type":"object"},"ReportingCentralReceipt":{"description":"ReportingCentralReceipt is the retained answer from the Reporting Central simulator. It is not a filed Board report.","properties":{"form":{"type":"string"},"id":{"type":"string"},"note":{"type":"string"},"period_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"receipt":{"additionalProperties":true,"type":"object"},"receipt_sha256":{"type":"string"},"request":{"additionalProperties":true,"type":"object"},"request_sha256":{"type":"string"},"rssd_id":{"type":"string"},"simulator_id":{"type":"string"},"status":{"type":"string"},"submitted_at":{"format":"date-time","type":"string"},"submitted_by":{"type":"string"}},"required":["form","id","period_date","receipt","receipt_sha256","request","request_sha256","rssd_id","simulator_id","status","submitted_at","submitted_by"],"type":"object"},"ReportingCentralRequest":{"description":"ReportingCentralRequest is one FR 2900 or FR Y-9SP offered to the Reporting Central simulator.","properties":{"below_deposit_reporting_limit":{"type":"boolean"},"form":{"type":"string"},"payload":{"additionalProperties":true,"type":"object"},"report_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"rssd_id":{"type":"string"},"week_ending":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["form","payload","rssd_id"],"type":"object"},"ReportingEntity":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"identifier":{"type":"string"},"scheme":{"type":"string"},"synthetic":{"type":"boolean"}},"required":["evidence_ref","evidence_sha256","identifier","scheme","synthetic"],"type":"object"},"ReportingRunRequest":{"description":"RunRequest asks for a reconciliation of one source on one date.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"source":{"type":"string"}},"required":["business_date","source"],"type":"object"},"ReportingSchedule":{"description":"Schedule is one Call Report schedule as of a date (RC-E, RC-C, RC-N) or for a period (RI), assembled from the products' regulatory attributes and the chart of accounts.","properties":{"as_of":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"lines":{"items":{"$ref":"#/components/schemas/ScheduleLine"},"type":"array"},"missing":{"items":{"$ref":"#/components/schemas/MissingLine"},"type":"array"},"note":{"type":"string"},"period":{"type":"string"},"schedule":{"type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["lines","note","schedule","total_amount"],"type":"object"},"ReportingStatement":{"description":"Statement is one day's statement from a source: the Fed master account (Fedwire, FedACH and FedNow), the RTP network's prefunded position, or a card network's settlement report.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_amount":{"description":"the statement's closing balance, compared with the ledger","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"currency_code":{"type":"string"},"id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/ReportingStatementLine"},"type":"array"},"opening_amount":{"description":"the statement's opening balance, when the source reports one","oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"received_at":{"format":"date-time","type":"string"},"reserve_interest_credits":{"description":"ReserveInterestCredits answers the Federal Reserve account report that carried them, in\nthe order the report listed them; reads of a stored statement leave it empty.","items":{"$ref":"#/components/schemas/ReserveInterestCredit"},"type":"array"},"source":{"description":"fed_master, rtp or card_network","type":"string"},"superseded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"version":{"description":"versions of one source and date are retained; a later one supersedes","format":"int64","type":"integer"}},"required":["business_date","lines","source"],"type":"object"},"ReportingStatementLine":{"description":"StatementLine is one line of an external statement: what the operator or network says moved.","properties":{"amount":{"description":"minor units, always positive","format":"int64","type":"integer"},"description":{"description":"free text from the statement","type":"string"},"direction":{"description":"debit takes money out of the bank's account, credit brings it in","type":"string"},"kind":{"description":"wire, ach_file, instant, card_settlement, ...","type":"string"},"reference":{"description":"the rail's reference: IMAD, message id, operator file id, network:date","type":"string"}},"required":["amount","description","direction","kind","reference"],"type":"object"},"Request":{"description":"Request is a maker-checker request.","properties":{"applied_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"approver":{"type":"string"},"attempts":{"format":"int64","type":"integer"},"command_key":{"description":"operations:<id>, the idempotent key the owning service sees on apply and recovery","type":"string"},"created_at":{"format":"date-time","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decision_note":{"type":"string"},"effective_date":{"type":"string"},"expires_at":{"description":"a pending request lapses here and can no longer be decided","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"one of the request kinds","type":"string"},"lease_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"payload":{"additionalProperties":true,"type":"object"},"requested_by":{"type":"string"},"result":{"additionalProperties":true,"description":"what applying it produced","type":"object"},"status":{"description":"pending, approved, rejected, applied, failed","type":"string"}},"required":["attempts","command_key","created_at","id","kind","payload","requested_by","status"],"type":"object"},"RequestKind":{"description":"RequestKind is one kind the console supports.","properties":{"available":{"description":"false: no service applies it yet, and submitting it is refused","type":"boolean"},"description":{"type":"string"},"kind":{"type":"string"}},"required":["available","description","kind"],"type":"object"},"RequestReturnBody":{"description":"RequestReturnBody asks the receiver of a wire the bank sent to return it.","properties":{"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["operator","reason_code"],"type":"object"},"RequiredItem":{"properties":{"basis":{"type":"string"},"caption":{"type":"string"},"instruction_sha256":{"type":"string"},"mdrm":{"type":"string"},"missing_category":{"type":"string"},"reference":{"$ref":"#/components/schemas/TaxonomyReference"},"requirement":{"type":"string"},"source_key":{"type":"string"},"source_kind":{"type":"string"},"source_status":{"type":"string"},"status":{"type":"string"}},"required":["basis","mdrm","reference","requirement","status"],"type":"object"},"Requirement":{"properties":{"code":{"type":"string"},"stage":{"description":"consummation or funding","type":"string"}},"required":["code","stage"],"type":"object"},"Reservation":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"instruction":{"$ref":"#/components/schemas/PayablesInstruction"},"master_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"outbound_message":{"type":"string"},"proposed_by":{"type":"string"},"recipient":{"$ref":"#/components/schemas/Recipient"},"review_sha256":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"reviewed_by":{"type":"string"}},"required":["actor","content_sha256","created_at","instruction","master_hold_id","outbound_message","proposed_by","recipient","review_sha256","reviewed_at","reviewed_by"],"type":"object"},"ReserveAccrual":{"description":"ReserveAccrual is one calendar day's interest on the master account balance (GL 1470 / 4020).","properties":{"accrued":{"description":"dollars to eight decimal places","type":"string"},"balance_amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"currency_code":{"type":"string"},"day_count":{"description":"actual/360","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rate_bps":{"format":"int64","type":"integer"},"rate_id":{"format":"int64","type":"integer"}},"required":["accrued","balance_amount","business_date","currency_code","day_count","rate_bps","rate_id"],"type":"object"},"ReserveAccrualPage":{"description":"ReserveAccrualPage is a period's daily reserve interest.","properties":{"data":{"items":{"$ref":"#/components/schemas/ReserveAccrual"},"type":"array"},"has_more":{"type":"boolean"},"period":{"type":"string"}},"required":["data","has_more","period"],"type":"object"},"ReserveInterestCredit":{"description":"ReserveInterestCredit is what became of one interest-on-reserve-balances entry on the Federal Reserve's Statement of Account. It is a proposal (pending_review) until a treasury checker settles or rejects it, whether or not it equals the period's accrual; a debit is not_fed (a Reserve Bank correction treasury reverses by hand); refused names a credit the ledger would not take, and the statement line stays an open reconciliation break until it is settled.","properties":{"amount":{"format":"int64","type":"integer"},"detail":{"type":"string"},"direction":{"type":"string"},"expected_amount":{"description":"the period's accrual, to the cent","format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"settlement_id":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["amount","direction","period_end","period_start","reference","status"],"type":"object"},"ReserveRate":{"description":"ReserveRate is a retained rate instruction: pending_review, approved or rejected.","properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"format":"int64","type":"integer"},"maker":{"description":"the verified treasury officer who recorded it","type":"string"},"rate_bps":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReserveReviewRecord"},{"type":"null"}]},"source_ref":{"type":"string"},"status":{"type":"string"}},"required":["effective_date","id","maker","rate_bps","recorded_at","source_ref","status"],"type":"object"},"ReserveRateRequest":{"description":"ReserveRateRequest records the interest on reserve balances (IORB) rate from a date.","properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rate_bps":{"description":"the annual rate in basis points the Federal Reserve announced","format":"int64","type":"integer"},"source_ref":{"description":"where it was announced","type":"string"}},"required":["effective_date","rate_bps","source_ref"],"type":"object"},"ReserveRequest":{"properties":{"instruction":{"$ref":"#/components/schemas/PayablesInstruction"},"outbound_message":{"type":"string"},"proposed_by":{"type":"string"},"recipient":{"$ref":"#/components/schemas/Recipient"},"review_sha256":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"reviewed_by":{"type":"string"}},"required":["instruction","outbound_message","proposed_by","recipient","review_sha256","reviewed_at","reviewed_by"],"type":"object"},"ReserveReview":{"description":"ReserveReview is an independent decision on a rate, or on a credit that differs from the accrual.","properties":{"approve":{"type":"boolean"},"reason":{"type":"string"}},"required":["approve","reason"],"type":"object"},"ReserveReviewRecord":{"description":"ReserveReviewRecord is a retained review.","properties":{"approve":{"type":"boolean"},"checker":{"description":"the verified treasury checker, never the maker","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["approve","checker","reason","recorded_at"],"type":"object"},"ReserveSettlement":{"description":"ReserveSettlement is a retained credit: one fed from the Federal Reserve's account report settled at once when it matched the period's accrual rounded to the cent; a treasury hand entry and any credit that differs are pending_review until an independent review settles or rejects it.","properties":{"accrual_matched":{"description":"the credit equals the accrual rounded to the cent","type":"boolean"},"accrued":{"description":"the period's accrual, dollars to eight places","type":"string"},"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"difference_amount":{"description":"the credit less that accrual","format":"int64","type":"integer"},"expected_amount":{"description":"that accrual rounded to the cent","format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maker":{"type":"string"},"matched":{"description":"settled when recorded (statement credits before proposals were reviewed)","type":"boolean"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"reference":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/ReserveReviewRecord"},{"type":"null"}]},"source":{"description":"fed_statement (the Fed account statement) or treasury (entered by hand)","type":"string"},"statement_ref":{"type":"string"},"status":{"type":"string"}},"required":["accrual_matched","accrued","amount","currency_code","difference_amount","expected_amount","id","maker","matched","period_end","period_start","recorded_at","reference","source","status"],"type":"object"},"ReserveSettlementRequest":{"description":"ReserveSettlementRequest records the Federal Reserve's credit of interest for a contiguous accrued period, inclusive of both dates.","properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"}},"required":["amount","currency_code","period_end","period_start","reference"],"type":"object"},"ReserveStatementCredit":{"description":"ReserveStatementCredit is one interest credit the Federal Reserve's account report carried, keyed by the Reserve Bank's own reference for the entry.","properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"period_end":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"period_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"statement_ref":{"description":"the reporting service's retained Statement of Account the credit was read from","type":"string"}},"required":["amount","currency_code","period_end","period_start","reference"],"type":"object"},"Reset":{"properties":{"at_consummation":{"type":"boolean"},"closing_id":{"type":"string"},"consummation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"contract_id":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"earliest_delivery":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"escrow_payment_amount":{"format":"int64","type":"integer"},"estimated":{"type":"boolean"},"first_installment":{"format":"int64","type":"integer"},"id":{"type":"string"},"initial_notice":{"type":"boolean"},"latest_delivery":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"new_payment_amount":{"format":"int64","type":"integer"},"new_rate_bps":{"description":"rounded half up from NewRateNanos","format":"int64","type":"integer"},"new_rate_nanos":{"format":"int64","type":"integer"},"notice_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"notice_rule":{"type":"string"},"observation":{"$ref":"#/components/schemas/LendingratesObservation"},"old_payment_amount":{"format":"int64","type":"integer"},"old_rate_bps":{"description":"whole basis points, for readers of them","format":"int64","type":"integer"},"old_rate_nanos":{"description":"the contract rates, exact","format":"int64","type":"integer"},"operating_calendar":{"$ref":"#/components/schemas/Calendar"},"payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"remaining_months":{"format":"int64","type":"integer"},"target_id":{"type":"string"},"target_kind":{"type":"string"},"terms":{"$ref":"#/components/schemas/LendingratesTerms"}},"required":["consummation_date","contract_id","customer_id","earliest_delivery","effective_date","escrow_payment_amount","first_installment","id","initial_notice","latest_delivery","new_payment_amount","new_rate_bps","new_rate_nanos","notice_date","notice_rule","observation","old_payment_amount","old_rate_bps","old_rate_nanos","operating_calendar","payment_date","principal_amount","remaining_months","target_id","target_kind","terms"],"type":"object"},"ResetRequest":{"properties":{"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"initial_notice":{"type":"boolean"},"operating_calendar":{"oneOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"null"}]},"payment_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["effective_date","initial_notice","payment_date"],"type":"object"},"Resolution":{"description":"Resolution is a proposed, reviewed and applied exception resolution.","properties":{"amount_minor":{"format":"int64","type":"integer"},"card_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"direction":{"type":"string"},"exception_id":{"type":"string"},"exception_kind":{"type":"string"},"id":{"type":"string"},"ordinal":{"format":"int64","type":"integer"},"proposed_by":{"type":"string"},"record_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/ClearingResolutionRequest"},"result":{"oneOf":[{"$ref":"#/components/schemas/ClearingResolutionResult"},{"type":"null"}]},"review":{"oneOf":[{"$ref":"#/components/schemas/ClearingReview"},{"type":"null"}]},"settled_at_proposal":{"type":"boolean"}},"required":["amount_minor","content_sha256","created_at","direction","exception_id","exception_kind","id","ordinal","proposed_by","record_sha256","request","settled_at_proposal"],"type":"object"},"ResolutionRequest":{"description":"ResolutionRequest proposes how an exception ends.","properties":{"action":{"type":"string"},"amount":{"format":"int64","type":"integer"},"evidence":{"type":"string"},"reference":{"description":"for record_evidence: the accounts count or movement, or the network case, that settles it","type":"string"}},"required":["action","amount","evidence"],"type":"object"},"ResolutionResult":{"description":"ResolutionResult is what applying an approved resolution did.","properties":{"accounts_movement_id":{"type":"string"},"actor":{"type":"string"},"outcome":{"description":"applied","type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","outcome","recorded_at"],"type":"object"},"RespondBody":{"description":"RespondBody is the operator's decision on a return request another participant sent.","properties":{"decision":{"description":"honour or refuse","type":"string"},"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["decision","operator"],"type":"object"},"Response":{"description":"Response answers a token service call with the event it produced and the token after it.","properties":{"event":{"$ref":"#/components/schemas/NetworktokensEvent"},"replayed":{"type":"boolean"}},"required":["event","replayed"],"type":"object"},"RestoreAccrualRequest":{"description":"RestoreAccrualRequest returns a nonaccrual loan to accrual. Interest reversed at nonaccrual and accrued since is still owed: it is collected under CollectionKey or forgiven with a ConcessionReason; without either the restore is refused (lending.interest_uncollected).","properties":{"by":{"type":"string"},"collection_key":{"type":"string"},"concession_reason":{"type":"string"},"reason":{"type":"string"}},"required":["by","reason"],"type":"object"},"Restrictions":{"description":"Restrictions are the rules a payment or a card must respect before money leaves the account.","properties":{"certificate":{"oneOf":[{"$ref":"#/components/schemas/CertificateStatus"},{"type":"null"}]},"debit_blocked":{"type":"boolean"},"reason":{"type":"string"},"transfer_limit":{"oneOf":[{"$ref":"#/components/schemas/TransferLimitStatus"},{"type":"null"}]},"withdrawable":{"type":"boolean"}},"required":["debit_blocked","withdrawable"],"type":"object"},"Result":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/Information314Account"},"type":"array"},"accounts_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"algorithm":{"type":"string"},"candidates":{"items":{"$ref":"#/components/schemas/Candidate"},"type":"array"},"content_sha256":{"type":"string"},"cutoff":{"format":"date-time","type":"string"},"holes":{"items":{"type":"string"},"type":"array"},"manifest_sha256":{"type":"string"},"purpose":{"type":"string"},"query_sha256":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rows_examined":{"format":"int64","type":"integer"},"scan_complete":{"type":"boolean"},"search_id":{"type":"string"},"snapshot_at":{"format":"date-time","type":"string"},"source":{"type":"string"},"subject_reference":{"type":"string"},"transactions":{"items":{"$ref":"#/components/schemas/Information314Transaction"},"type":"array"},"transactions_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accounts","accounts_from","algorithm","candidates","content_sha256","cutoff","holes","manifest_sha256","purpose","query_sha256","request_id","rows_examined","scan_complete","search_id","snapshot_at","source","subject_reference","transactions","transactions_from"],"type":"object"},"Results":{"properties":{"base":{"$ref":"#/components/schemas/Projection"},"engine_version":{"type":"string"},"eve_delta_amount":{"format":"int64","type":"integer"},"initial_liquidity_amount":{"format":"int64","type":"integer"},"limitations":{"items":{"type":"string"},"type":"array"},"nii_delta_amount":{"format":"int64","type":"integer"},"scope":{"type":"string"},"stress":{"$ref":"#/components/schemas/Projection"}},"required":["base","engine_version","eve_delta_amount","initial_liquidity_amount","limitations","nii_delta_amount","scope","stress"],"type":"object"},"RetainedStatement":{"properties":{"content_sha256":{"type":"string"},"id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"signature":{"type":"string"},"statement":{"$ref":"#/components/schemas/Statement"},"verified_public_key":{"type":"string"}},"required":["content_sha256","id","recorded_at","signature","statement","verified_public_key"],"type":"object"},"RetentionDisposition":{"properties":{"basis":{"type":"string"},"content_sha256":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"packet_content_sha256":{"type":"string"},"packet_id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"retain_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/RetentionDispositionReview"},{"type":"null"}]},"rules_id":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["basis","content_sha256","evidence_reference","evidence_sha256","packet_content_sha256","packet_id","proposed_at","proposed_by","retain_through","rules_id","version"],"type":"object"},"RetentionDispositionRequest":{"properties":{"basis":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"packet_content_sha256":{"type":"string"}},"required":["basis","evidence_reference","evidence_sha256","packet_content_sha256"],"type":"object"},"RetentionDispositionReview":{"description":"RetentionDispositionReview is the independent decision. An approval retains the verified accepted status the destroyed acknowledgment established.","properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"packet_status":{"type":"string"}},"required":["actor","approve","at","content_sha256"],"type":"object"},"RetentionHold":{"properties":{"active":{"type":"boolean"},"basis":{"type":"string"},"content_sha256":{"type":"string"},"cursor":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"matter_reference":{"type":"string"},"number":{"format":"int64","type":"integer"},"packet_ids":{"items":{"type":"string"},"type":"array"},"placed_at":{"format":"date-time","type":"string"},"placed_by":{"type":"string"},"releases":{"items":{"$ref":"#/components/schemas/RetentionHoldRelease"},"type":"array"},"scope":{"description":"packets or all_filing_records","type":"string"}},"required":["active","basis","content_sha256","cursor","evidence_reference","evidence_sha256","matter_reference","number","placed_at","placed_by","releases","scope"],"type":"object"},"RetentionHoldRelease":{"properties":{"basis":{"type":"string"},"content_sha256":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"hold_content_sha256":{"type":"string"},"number":{"format":"int64","type":"integer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"review":{"oneOf":[{"$ref":"#/components/schemas/RetentionReview"},{"type":"null"}]},"version":{"format":"int64","type":"integer"}},"required":["basis","content_sha256","evidence_reference","evidence_sha256","hold_content_sha256","number","proposed_at","proposed_by","version"],"type":"object"},"RetentionHoldRequest":{"description":"RetentionHoldRequest preserves explicit packets or every filing record, present and future. A hold takes effect when recorded and never expires by itself.","properties":{"basis":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"matter_reference":{"type":"string"},"packet_ids":{"items":{"type":"string"},"type":"array"},"scope":{"description":"packets or all_filing_records","type":"string"}},"required":["basis","evidence_reference","evidence_sha256","matter_reference","scope"],"type":"object"},"RetentionReleaseRequest":{"properties":{"basis":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"hold_content_sha256":{"type":"string"}},"required":["basis","evidence_reference","evidence_sha256","hold_content_sha256"],"type":"object"},"RetentionReview":{"properties":{"actor":{"type":"string"},"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"}},"required":["actor","approve","at","content_sha256"],"type":"object"},"RetentionReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"}},"required":["approve","content_sha256"],"type":"object"},"RetentionSchedule":{"description":"RetentionSchedule exists only for an accepted production filing: drafts, cancelled, rejected, unreleased and test packets have none and are never disposed.","properties":{"created_at":{"format":"date-time","type":"string"},"filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"form":{"type":"string"},"packet_id":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"retain_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"retention_start":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rules_id":{"type":"string"}},"required":["created_at","filing_date","form","packet_id","report_date","retain_through","retention_start","rules_id"],"type":"object"},"RetentionView":{"description":"RetentionView is a packet's schedule, holds, dispositions and receipts. Stage is disposed, held, unscheduled, disposition_proposed, retained or eligible.","properties":{"active_holds":{"items":{"format":"int64","type":"integer"},"type":"array"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"dispositions":{"items":{"$ref":"#/components/schemas/RetentionDisposition"},"type":"array"},"environment":{"type":"string"},"form":{"type":"string"},"packet_id":{"type":"string"},"receipts":{"items":{"$ref":"#/components/schemas/DisposalReceipt"},"type":"array"},"schedule":{"oneOf":[{"$ref":"#/components/schemas/RetentionSchedule"},{"type":"null"}]},"stage":{"type":"string"}},"required":["active_holds","as_of","content_sha256","dispositions","environment","form","packet_id","receipts","stage"],"type":"object"},"RetirementClaimRequest":{"description":"RetirementClaimRequest names the command that takes a receipt.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"command_id":{"type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount_minor","command_id","transfer_id"],"type":"object"},"RetirementCommand":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cash_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"conversion_rmd":{"items":{"$ref":"#/components/schemas/ConversionRMDSource"},"type":"array"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decedent_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"distribution_code":{"type":"string"},"executed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"gross_minor":{"format":"int64","type":"integer"},"id":{"type":"string"},"inbound_receipt":{"oneOf":[{"$ref":"#/components/schemas/InboundReceipt"},{"type":"null"}]},"ira_type":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"origin_cash_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"other_ownership_revision":{"format":"int64","type":"integer"},"ownership_revision":{"format":"int64","type":"integer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"recipients":{"items":{"$ref":"#/components/schemas/CommandRecipient"},"type":"array"},"request":{"$ref":"#/components/schemas/CommandRequest"},"status":{"type":"string"},"taxable_minor":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"taxable_undetermined":{"type":"boolean"},"withheld_minor":{"format":"int64","type":"integer"},"wrapper":{"type":"string"}},"required":["account_id","customer_id","gross_minor","id","other_ownership_revision","ownership_revision","proposed_at","proposed_by","request","status","taxable_undetermined","withheld_minor","wrapper"],"type":"object"},"RetirementEligibility":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"date_of_birth":{"type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"limits":{"$ref":"#/components/schemas/RetirementLimits"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/EligibilityRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["customer_id","date_of_birth","id","limits","proposed_at","proposed_by","request","status","version"],"type":"object"},"RetirementExecutionRequest":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"RetirementLimits":{"properties":{"hsa_minor":{"format":"int64","type":"integer"},"ira_combined_minor":{"format":"int64","type":"integer"},"roth_minor":{"format":"int64","type":"integer"}},"required":["hsa_minor","ira_combined_minor","roth_minor"],"type":"object"},"RetirementProof":{"properties":{"allowed":{"type":"boolean"},"cash_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"command_id":{"type":"string"},"command_type":{"type":"string"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"ledger_account_ids":{"items":{"type":"string"},"type":"array"}},"required":["allowed","command_id","command_type","journal_key","journal_sha256","ledger_account_ids"],"type":"object"},"RetirementReceipt":{"description":"RetirementReceipt is a wire or ACH credit parked on transit for a protected IRA or HSA.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_number":{"type":"string"},"amount_minor":{"format":"int64","type":"integer"},"claim":{"oneOf":[{"$ref":"#/components/schemas/RetirementReceiptClaim"},{"type":"null"}]},"claimable":{"type":"boolean"},"currency":{"type":"string"},"funding_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"reason":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"received_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"sender_name":{"type":"string"},"sender_routing":{"type":"string"},"status":{"type":"string"}},"required":["account_number","amount_minor","claimable","currency","rail","receipt_id","received_on","reference","sender_name","sender_routing","status"],"type":"object"},"RetirementReceiptClaim":{"description":"RetirementReceiptClaim takes a receipt for one protected accounts command.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"claimed_at":{"format":"date-time","type":"string"},"claimed_by":{"type":"string"},"command_id":{"type":"string"},"currency":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"resolved_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount_minor","claimed_at","claimed_by","command_id","currency","id","journal_key","ledger_account_id","rail","receipt_id","status","transfer_id"],"type":"object"},"RetirementTaxForm":{"description":"TaxForm carries every applicable box for the supported cash-retirement case. Omitted optional boxes are blank, distinct from an explicitly reported zero.","properties":{"account_number":{"type":"string"},"amounts":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"checks":{"additionalProperties":{"type":"boolean"},"type":"object"},"codes":{"additionalProperties":{"type":"string"},"type":"object"},"form":{"type":"string"},"id":{"type":"string"},"source_command_ids":{"items":{"type":"string"},"type":"array"},"tax_year":{"format":"int64","type":"integer"}},"required":["account_number","amounts","checks","codes","form","id","source_command_ids","tax_year"],"type":"object"},"ReturnPayment":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"proper_recipient_notice":{"$ref":"#/components/schemas/ProperRecipientNotice"},"reason":{"type":"string"}},"required":["amount_minor","evidence","proper_recipient_notice","reason"],"type":"object"},"ReturnRateEvaluation":{"description":"ReturnRateEvaluation is the scheduler's evaluation of an Originator's return rates on one business date, with what it did: none, alerted (a breach, the Originator already suspended or reviewed since its last suspension) or suspended (origination stopped pending staff review).","properties":{"action":{"type":"string"},"administrative_rate_bps":{"format":"int64","type":"integer"},"administrative_returns":{"format":"int64","type":"integer"},"breached":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"debits_originated":{"format":"int64","type":"integer"},"evaluated_at":{"format":"date-time","type":"string"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"type":"string"},"originator_id":{"type":"string"},"overall_rate_bps":{"format":"int64","type":"integer"},"to":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"total_returns":{"format":"int64","type":"integer"},"unauthorized_rate_bps":{"format":"int64","type":"integer"},"unauthorized_returns":{"format":"int64","type":"integer"}},"required":["action","administrative_rate_bps","administrative_returns","breached","business_date","debits_originated","evaluated_at","from","id","originator_id","overall_rate_bps","to","total_returns","unauthorized_rate_bps","unauthorized_returns"],"type":"object"},"ReturnRates":{"description":"ReturnRates is an Originator's debit return activity over sixty days against the Nacha thresholds (0.5% unauthorized, 3% administrative, 15% overall).","properties":{"administrative_rate_bps":{"format":"int64","type":"integer"},"administrative_returns":{"format":"int64","type":"integer"},"breached":{"items":{"type":"string"},"type":"array"},"debits_originated":{"format":"int64","type":"integer"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"originator_id":{"type":"string"},"overall_rate_bps":{"format":"int64","type":"integer"},"to":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"total_returns":{"format":"int64","type":"integer"},"unauthorized_rate_bps":{"format":"int64","type":"integer"},"unauthorized_returns":{"format":"int64","type":"integer"}},"required":["administrative_rate_bps","administrative_returns","breached","debits_originated","from","originator_id","overall_rate_bps","to","total_returns","unauthorized_rate_bps","unauthorized_returns"],"type":"object"},"ReturnReceipt":{"description":"ReturnReceipt is the network's acknowledgement of a return instruction. An acknowledgement is not the money: the later return credit or debit in a clearing file is.","properties":{"accepted_at":{"format":"date-time","type":"string"},"reference":{"type":"string"},"source":{"type":"string"}},"required":["accepted_at","reference","source"],"type":"object"},"ReturnRequestBody":{"description":"ReturnRequestBody asks for an inbound wire to be returned.","properties":{"amount":{"format":"int64","type":"integer"},"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["operator","reason_code"],"type":"object"},"Review":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"}},"required":["actor","content_sha256","decision","evidence","rationale","reviewed_at"],"type":"object"},"ReviewReceiptBody":{"description":"ReviewReceiptBody decides an international entry held on the transit account.","properties":{"decision":{"description":"approve, block or return","type":"string"},"operator":{"type":"string"},"return_code":{"type":"string"}},"required":["decision","operator"],"type":"object"},"ReviewRecord":{"description":"ReviewRecord is a retained decision.","properties":{"approve":{"type":"boolean"},"checker":{"type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["approve","checker","reason","recorded_at"],"type":"object"},"ReviewRemoteDepositRequest":{"description":"ReviewRemoteDepositRequest is a maker's proposal or a checker's decision.","properties":{"actor":{"type":"string"},"decision":{"description":"accept or reject","type":"string"},"reason":{"type":"string"}},"required":["decision"],"type":"object"},"ReviewRequest":{"description":"ReviewRequest decides a proposal.","properties":{"approve":{"type":"boolean"},"evidence":{"type":"string"}},"required":["approve","evidence"],"type":"object"},"Revision":{"properties":{"actor":{"type":"string"},"category":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/MonitoringDecision"},{"type":"null"}]},"id":{"type":"string"},"proposal":{"$ref":"#/components/schemas/MonitoringProposal"},"reporting_year":{"format":"int64","type":"integer"},"sha256":{"type":"string"},"target_id":{"type":"string"},"target_kind":{"type":"string"}},"required":["actor","category","created_at","id","proposal","reporting_year","sha256","target_id","target_kind"],"type":"object"},"Revocation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"reason":{"type":"string"}},"required":["actor","at","reason"],"type":"object"},"RevocationRequest":{"properties":{"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/FleetEvidence"},"reason":{"type":"string"}},"required":["content_sha256","evidence","reason"],"type":"object"},"Risk":{"description":"Risk is the token service's and wallet provider's risk data, normalized by the connector. Scores are on the bank-defined scale 1 (highest risk) to 5 (lowest risk); 0 is not provided.","properties":{"account_score":{"format":"int64","type":"integer"},"device_country":{"type":"string"},"device_score":{"format":"int64","type":"integer"},"phone_number_score":{"format":"int64","type":"integer"},"reason_codes":{"items":{"type":"string"},"type":"array"},"recommended_decision":{"description":"approve, decline or require_idv","type":"string"}},"type":"object"},"RiskGrade":{"properties":{"classification":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"grade":{"type":"string"},"policy":{"$ref":"#/components/schemas/MonitoringEvidence"},"scale_id":{"type":"string"},"scale_version":{"type":"string"},"source":{"$ref":"#/components/schemas/MonitoringEvidence"}},"required":["classification","effective_date","grade","policy","scale_id","scale_version","source"],"type":"object"},"RotationBody":{"description":"RotationBody rotates a webhook endpoint's signing secret.","properties":{"force":{"description":"cut the retiring secret off when a rotation is already inside its overlap (otherwise 409)","type":"boolean"},"overlap_seconds":{"description":"how long the retiring secret keeps signing; zero is the default day, at most a week","format":"int64","type":"integer"}},"required":["force","overlap_seconds"],"type":"object"},"RothPhaseout":{"properties":{"end_minor":{"format":"int64","type":"integer"},"filing_status":{"type":"string"},"start_minor":{"format":"int64","type":"integer"}},"required":["end_minor","filing_status","start_minor"],"type":"object"},"Route":{"description":"Route is what the SWIFT gateway needs to send a payment in a currency: the correspondent and nostro account it settles through, the correspondent's same-day window, the charges the correspondent takes on the bank's outbound transfers and the account's liquidity.","properties":{"accepts_now":{"type":"boolean"},"account_identifier":{"type":"string"},"correspondent_bic":{"type":"string"},"correspondent_id":{"type":"string"},"correspondent_name":{"type":"string"},"currency_code":{"type":"string"},"cutoff":{"$ref":"#/components/schemas/CutoffWindow"},"destination_bic":{"description":"DestinationBIC is the beneficiary bank the route was chosen for, RoutedByPrefix the prefix\nin the account's terms that chose it (empty when the currency's primary route settled it),\nand Direct reports that the destination is the correspondent itself, so the payment reaches\nthe beneficiary's bank without another institution in the chain.","type":"string"},"direct":{"type":"boolean"},"headroom_amount":{"description":"posted balance above the minimum; negative when below it","format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"maximum_balance":{"format":"int64","type":"integer"},"minimum_balance":{"format":"int64","type":"integer"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"open_liquidity_alerts":{"items":{"type":"string"},"type":"array"},"outbound_charges":{"items":{"$ref":"#/components/schemas/PaymentCharge"},"type":"array"},"posted_balance":{"format":"int64","type":"integer"},"routed_by_prefix":{"type":"string"},"target_balance":{"format":"int64","type":"integer"},"terms_id":{"format":"int64","type":"integer"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accepts_now","account_identifier","correspondent_bic","correspondent_id","correspondent_name","currency_code","cutoff","direct","headroom_amount","ledger_account_id","maximum_balance","minimum_balance","nostro_account_id","open_liquidity_alerts","outbound_charges","posted_balance","target_balance","terms_id","value_date"],"type":"object"},"Rule":{"properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/RuleRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","proposed_at","proposed_by","request","status","version"],"type":"object"},"RuleRequest":{"properties":{"authority_ref":{"type":"string"},"contribution_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"excess_return_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"expected_version":{"format":"int64","type":"integer"},"hsa_catchup_age":{"format":"int64","type":"integer"},"hsa_catchup_minor":{"format":"int64","type":"integer"},"hsa_family_minor":{"format":"int64","type":"integer"},"hsa_self_minor":{"format":"int64","type":"integer"},"ira_annual_minor":{"format":"int64","type":"integer"},"ira_catchup_age":{"format":"int64","type":"integer"},"ira_catchup_minor":{"format":"int64","type":"integer"},"ira_default_withholding_bps":{"format":"int64","type":"integer"},"reason":{"type":"string"},"roth_phaseouts":{"items":{"$ref":"#/components/schemas/RothPhaseout"},"type":"array"},"tax_year":{"format":"int64","type":"integer"}},"required":["authority_ref","contribution_deadline","effective_at","evidence_ref","evidence_sha256","excess_return_deadline","expected_version","hsa_catchup_age","hsa_catchup_minor","hsa_family_minor","hsa_self_minor","ira_annual_minor","ira_catchup_age","ira_catchup_minor","ira_default_withholding_bps","reason","roth_phaseouts","tax_year"],"type":"object"},"Run":{"properties":{"request":{"$ref":"#/components/schemas/RunRequest"},"results":{"$ref":"#/components/schemas/Results"},"scenario":{"$ref":"#/components/schemas/Scenario"},"scenario_sha256":{"type":"string"},"source":{"$ref":"#/components/schemas/AlmSource"}},"required":["request","results","scenario","scenario_sha256","source"],"type":"object"},"RunReport":{"description":"RunReport is what one scheduler pass did.","properties":{"executed":{"format":"int64","type":"integer"},"expired_approvals":{"format":"int64","type":"integer"},"failed":{"format":"int64","type":"integer"}},"required":["executed","expired_approvals","failed"],"type":"object"},"RunRequest":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"contingent_flows":{"items":{"$ref":"#/components/schemas/ContingentFlow"},"type":"array"},"coverage_evidence":{"allOf":[{"$ref":"#/components/schemas/AlmEvidence"}],"description":"review of exclusions, off-balance exposures and assumed funding"},"exclusions":{"items":{"$ref":"#/components/schemas/Exclusion"},"type":"array"},"positions":{"items":{"$ref":"#/components/schemas/AlmPosition"},"type":"array"},"rationale":{"type":"string"},"scenario_id":{"type":"string"}},"required":["as_of","contingent_flows","coverage_evidence","exclusions","positions","rationale","scenario_id"],"type":"object"},"SARAddress":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"review_reference":{"description":"retained actual address review, including postal consistency","type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"required":["city","country","review_reference","state","street","zip"],"type":"object"},"SARAlertEvents":{"description":"SARAlertEvents names one selected alert and the complete retained event set that reproduces it: one event for a single-event alert, every window event for a structuring or velocity alert.","properties":{"alert_id":{"example":"alrt_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"event_ids":{"items":{"type":"string"},"type":"array"}},"required":["alert_id","event_ids"],"type":"object"},"SARAttachment":{"properties":{"csv":{"format":"byte","type":"string"},"file_name":{"type":"string"}},"required":["csv","file_name"],"type":"object"},"SARBranch":{"properties":{"address":{"$ref":"#/components/schemas/SARAddress"},"rssd":{"type":"string"}},"required":["address"],"type":"object"},"SARClassification":{"properties":{"other_text":{"description":"v2: required exactly when the subtype is the type's \"Other\" code","type":"string"},"subtype":{"type":"string"},"type":{"type":"string"}},"required":["subtype","type"],"type":"object"},"SARCyberEvent":{"description":"SARCyberEvent is one Part II cyber-event indicator. Type 11 classifications require at least one retained indicator whose value is the actual artifact.","properties":{"code":{"type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"other_text":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"type":"object"},"SARDirectedInstruction":{"description":"SARDirectedInstruction is the reviewed FinCEN instruction that requires this backfile. SAR XML has no directed-backfile association flag; the generator records the instruction in FilingInstitutionNotetoFinCEN and the narrative.","properties":{"document_sha256":{"type":"string"},"instruction_id":{"type":"string"},"issued_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"reference":{"type":"string"},"source_reference":{"type":"string"}},"required":["document_sha256","instruction_id","issued_on","reference","source_reference"],"type":"object"},"SARElectronicAddress":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"SARIPAddress":{"description":"SARIPAddress is one Activity IP address observed with the activity.","properties":{"address":{"type":"string"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["address"],"type":"object"},"SARInstitution":{"properties":{"address":{"$ref":"#/components/schemas/SARAddress"},"contact_extension":{"type":"string"},"contact_office":{"type":"string"},"contact_phone":{"type":"string"},"dba":{"type":"string"},"ein":{"type":"string"},"internal_control_number":{"type":"string"},"known_loss_minor":{"description":"investigator-reviewed known bank loss in USD cents; zero when no loss is known","format":"int64","type":"integer"},"legal_name":{"type":"string"},"metadata_evidence_reference":{"type":"string"},"primary_regulator":{"description":"1 Federal Reserve, 2 FDIC, 4 OCC","type":"string"},"rssd":{"type":"string"}},"required":["address","contact_office","contact_phone","ein","known_loss_minor","legal_name","metadata_evidence_reference","primary_regulator","rssd"],"type":"object"},"SARJointFiler":{"description":"SARJointFiler is another depository institution that jointly files this SAR. The transmitting bank remains Party type 30; each joint filer is an additional type-34 activity institution with retained reviewed metadata.","properties":{"address":{"$ref":"#/components/schemas/SARAddress"},"ein":{"type":"string"},"legal_name":{"type":"string"},"metadata_evidence_reference":{"type":"string"},"primary_regulator":{"type":"string"},"rssd":{"type":"string"}},"required":["address","ein","legal_name","metadata_evidence_reference","primary_regulator"],"type":"object"},"SARNarrative":{"description":"Narrative text is authored by the investigator. The generator adds an exact source-derived activity schedule; it never invents the reason for suspicion.","properties":{"actions_taken":{"type":"string"},"beneficiaries":{"type":"string"},"investigation":{"type":"string"},"language":{"description":"en; English narrative required","type":"string"},"losses_and_recoveries":{"type":"string"},"related_activity":{"type":"string"},"summary":{"type":"string"},"supporting_records_reference":{"type":"string"},"why_suspicious":{"type":"string"}},"required":["actions_taken","beneficiaries","investigation","language","losses_and_recoveries","related_activity","summary","supporting_records_reference","why_suspicious"],"type":"object"},"SARPhone":{"properties":{"extension":{"type":"string"},"number":{"type":"string"},"type":{"type":"string"}},"required":["number","type"],"type":"object"},"SARProduct":{"description":"SARProduct is one Part II product or instrument from the guide's asset enumerations; each admitted subtype needs a matching source mechanism.","properties":{"other_description":{"type":"string"},"subtype":{"type":"string"},"type":{"type":"string"}},"required":["subtype","type"],"type":"object"},"SARRequest":{"description":"SARRequest is confidential filing input supplied by verified filing staff. Personal and institution metadata are retained assertions for independent review, not identities inferred from an alert or a successful XSD check. Initial scope supports the actual large_transaction alert's exact event link. Other alert/window semantics and additional parties require another profile. SARProfileV2 uses AlertSources, Subjects, Products and the optional Branch, Attachment, SubjectUnknown, PriorPacketID and PriorActivitySequence fields; they are absent from v1 requests so retained v1 input digests never change. SARProfileV3 uses the v2 fields plus JointFilers, Directed, Branches, CyberEvents, IPAddresses and DisputeIDs; those are absent from v1/v2 requests.","properties":{"alert_ids":{"items":{"type":"string"},"type":"array"},"alert_sources":{"items":{"$ref":"#/components/schemas/SARAlertEvents"},"type":"array"},"attachment":{"oneOf":[{"$ref":"#/components/schemas/SARAttachment"},{"type":"null"}]},"branch":{"oneOf":[{"$ref":"#/components/schemas/SARBranch"},{"type":"null"}]},"branches":{"items":{"$ref":"#/components/schemas/SARBranch"},"type":"array"},"classifications":{"items":{"$ref":"#/components/schemas/SARClassification"},"type":"array"},"cyber_events":{"items":{"$ref":"#/components/schemas/SARCyberEvent"},"type":"array"},"directed":{"oneOf":[{"$ref":"#/components/schemas/SARDirectedInstruction"},{"type":"null"}]},"dispute_ids":{"description":"DisputeIDs name retained consumer-dispute cases whose error kinds source\nidentity-theft and payment-fraud classifications in v3.","items":{"type":"string"},"type":"array"},"event_ids":{"items":{"type":"string"},"type":"array"},"filing_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"institution":{"$ref":"#/components/schemas/SARInstitution"},"ip_addresses":{"items":{"$ref":"#/components/schemas/SARIPAddress"},"type":"array"},"joint_filers":{"items":{"$ref":"#/components/schemas/SARJointFiler"},"type":"array"},"narrative":{"$ref":"#/components/schemas/SARNarrative"},"prior_activity_sequence":{"description":"PriorActivitySequence names the accepted predecessor activity a continuing\nreport follows; a corrected report's single-activity predecessor needs none.","format":"int64","type":"integer"},"prior_packet_id":{"type":"string"},"products":{"items":{"$ref":"#/components/schemas/SARProduct"},"type":"array"},"profile":{"type":"string"},"scope":{"$ref":"#/components/schemas/SARScope"},"subject":{"$ref":"#/components/schemas/SARSubject"},"subject_unknown":{"oneOf":[{"$ref":"#/components/schemas/SARSubjectUnknown"},{"type":"null"}]},"subjects":{"items":{"$ref":"#/components/schemas/SARSubjectV2"},"type":"array"},"transmitter":{"$ref":"#/components/schemas/SARTransmitter"}},"required":["alert_ids","classifications","event_ids","filing_date","institution","narrative","profile","scope","subject","transmitter"],"type":"object"},"SARScope":{"properties":{"activity_location":{"description":"no_branch; v2 also branch","type":"string"},"all_known_information_included":{"type":"boolean"},"directed_backfile":{"description":"v1/v2 refuse; v3 requires Directed instruction evidence","type":"boolean"},"institution_roles":{"description":"filing_activity_account_bank","type":"string"},"joint_report":{"description":"v1/v2 refuse; v3 requires JointFilers","type":"boolean"},"report_kind":{"description":"initial; v2 also continuing or corrected","type":"string"},"subject_relationship":{"description":"customer_only; v2 per_subject","type":"string"},"unsupported_facts":{"items":{"type":"string"},"type":"array"}},"required":["activity_location","all_known_information_included","institution_roles","report_kind","subject_relationship"],"type":"object"},"SARSubject":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"address":{"$ref":"#/components/schemas/SARAddress"},"admission":{"description":"yes, no; blank when not applicable","type":"string"},"alternate_names":{"items":{"type":"string"},"type":"array"},"birth_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"electronic_addresses":{"items":{"$ref":"#/components/schemas/SARElectronicAddress"},"type":"array"},"first_name":{"type":"string"},"gender":{"description":"male, female, unknown; blank when not recorded","type":"string"},"identification":{"$ref":"#/components/schemas/SARSubjectIdentification"},"identity_evidence_reference":{"type":"string"},"last_name":{"type":"string"},"middle_name":{"type":"string"},"occupation":{"type":"string"},"phones":{"items":{"$ref":"#/components/schemas/SARPhone"},"type":"array"},"ssn":{"type":"string"},"suffix":{"type":"string"},"tin_country":{"description":"required with tin_type 9","type":"string"},"tin_type":{"description":"1 SSN (default); v3 also 9 foreign","type":"string"}},"required":["account_id","address","birth_date","customer_id","first_name","identification","identity_evidence_reference","last_name","occupation","ssn"],"type":"object"},"SARSubjectEntity":{"properties":{"address":{"$ref":"#/components/schemas/SARAddress"},"alternate_names":{"items":{"type":"string"},"type":"array"},"business_description":{"type":"string"},"ein":{"type":"string"},"electronic_addresses":{"items":{"$ref":"#/components/schemas/SARElectronicAddress"},"type":"array"},"identity_evidence_reference":{"type":"string"},"legal_name":{"type":"string"},"naics":{"type":"string"},"phones":{"items":{"$ref":"#/components/schemas/SARPhone"},"type":"array"}},"required":["address","business_description","ein","identity_evidence_reference","legal_name"],"type":"object"},"SARSubjectIdentification":{"properties":{"issuer_country":{"type":"string"},"issuer_state":{"type":"string"},"number":{"type":"string"},"other_type_text":{"description":"v3: required exactly for type 999","type":"string"},"type":{"description":"5 driver's license/state ID; v3 also 6 passport, 7 alien registration, 999 other","type":"string"}},"required":["issuer_country","issuer_state","number","type"],"type":"object"},"SARSubjectUnknown":{"properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"search_evidence_reference":{"type":"string"}},"required":["account_ids","search_evidence_reference"],"type":"object"},"SARSubjectV2":{"description":"SARSubjectV2 is one Part I subject. Individual identity reuses SARSubject (its CustomerID and AccountID stay empty); entities use SARSubjectEntity. Relationships and status are the guide's Part I institution-relationship indicators; Role is required only for a subject with no known account.","properties":{"account_ids":{"items":{"type":"string"},"type":"array"},"action_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"entity":{"oneOf":[{"$ref":"#/components/schemas/SARSubjectEntity"},{"type":"null"}]},"individual":{"oneOf":[{"$ref":"#/components/schemas/SARSubject"},{"type":"null"}]},"kind":{"description":"individual or entity","type":"string"},"no_known_account":{"type":"boolean"},"other_relationship":{"type":"string"},"relationship_status":{"description":"continues, resigned, suspended_barred, terminated","type":"string"},"relationships":{"items":{"type":"string"},"type":"array"},"role":{"description":"sender, receiver or both; derived from activity when accounts are known","type":"string"}},"required":["customer_id","kind","relationships"],"type":"object"},"SARTransmitter":{"properties":{"address":{"$ref":"#/components/schemas/SARAddress"},"contact_name":{"type":"string"},"control_code":{"description":"actual environment-specific TCC; no default","type":"string"},"legal_name":{"type":"string"},"metadata_evidence_reference":{"type":"string"},"phone":{"type":"string"},"tin":{"type":"string"}},"required":["address","contact_name","control_code","legal_name","metadata_evidence_reference","phone","tin"],"type":"object"},"SCIMError":{"properties":{"detail":{"type":"string"},"schemas":{"items":{"type":"string"},"type":"array"},"scimType":{"type":"string"},"status":{"type":"string"}},"required":["detail","schemas","status"],"type":"object"},"SanctionedArea":{"description":"SanctionedArea is a region or postal prefix of a country sanctioned on its own.","properties":{"country":{"type":"string"},"postal_prefix":{"type":"string"},"region":{"type":"string"}},"required":["country"],"type":"object"},"SanctionsList":{"description":"SanctionsList is one list loaded for screening and how old it is.","properties":{"entries":{"description":"names loaded","format":"int64","type":"integer"},"fetch_age_days":{"description":"calendar days since that download","format":"int64","type":"integer"},"fetched_at":{"description":"when the list's files were last downloaded (RFC 3339)","type":"string"},"hash":{"description":"SHA-256 of the list content","type":"string"},"id":{"description":"OFAC-SDN, OFAC-CONS, or SAMPLE for the local test list","type":"string"},"list_age_days":{"description":"calendar days since publication","format":"int64","type":"integer"},"published_on":{"description":"YYYY-MM-DD","type":"string"},"stale":{"description":"no download for longer than the staleness threshold; screening continues and says so","type":"boolean"},"version":{"description":"the list's publication or file date","type":"string"}},"required":["entries","fetch_age_days","hash","id","list_age_days","published_on","stale","version"],"type":"object"},"SavedCounterparty":{"description":"SavedCounterparty is a counterparty a customer saved to pay again.","properties":{"account_number":{"type":"string"},"account_type":{"type":"string"},"address":{"oneOf":[{"$ref":"#/components/schemas/PostalAddress"},{"type":"null"}]},"bank_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"bank_name":{"type":"string"},"bic":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"iban":{"type":"string"},"id":{"type":"string"},"is_bank_account":{"type":"boolean"},"legal_id":{"type":"string"},"legal_type":{"type":"string"},"name":{"type":"string"},"pay_by":{"type":"string"},"phone":{"type":"string"},"routing_number":{"type":"string"},"routing_number_type":{"type":"string"},"status":{"description":"active or deleted","type":"string"}},"required":["account_type","created_at","customer_id","id","is_bank_account","name","pay_by","routing_number_type","status"],"type":"object"},"Scenario":{"description":"Scenario fixes every monthly curve point and behavioral parameter before a run. Curves are annual nominal rates with monthly compounding for present values. Cash-flow accrual is Actual/365. Principal remaining at maturity (or the chosen behavioral truncation month) is paid in that month; no EVE terminal value is hidden.","properties":{"assumptions":{"items":{"$ref":"#/components/schemas/Assumption"},"type":"array"},"base_curve_bps":{"items":{"format":"int64","type":"integer"},"type":"array"},"base_index_bps":{"items":{"format":"int64","type":"integer"},"type":"array"},"contingency_actions":{"items":{"$ref":"#/components/schemas/ContingencyAction"},"type":"array"},"evidence":{"$ref":"#/components/schemas/AlmEvidence"},"horizon_months":{"format":"int64","type":"integer"},"liquidity_floor_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"methodology":{"type":"string"},"name":{"type":"string"},"nii_months":{"format":"int64","type":"integer"},"stress_curve_bps":{"items":{"format":"int64","type":"integer"},"type":"array"},"stress_index_bps":{"items":{"format":"int64","type":"integer"},"type":"array"}},"required":["assumptions","base_curve_bps","base_index_bps","contingency_actions","evidence","horizon_months","methodology","name","nii_months","stress_curve_bps","stress_index_bps"],"type":"object"},"Schedule":{"properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/ScheduleRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","proposed_at","proposed_by","request","status","version"],"type":"object"},"ScheduleActionBody":{"description":"ScheduleActionBody names who paused, resumed or cancelled a schedule.","properties":{"operator":{"type":"string"},"reason":{"type":"string"}},"required":["operator"],"type":"object"},"ScheduleClass":{"description":"ScheduleClass is how the lender treats one asset class.","properties":{"asset_class":{"type":"string"},"eligible":{"type":"boolean"},"margin_bps":{"description":"the share of the basis lent against","format":"int64","type":"integer"},"max_days_past_due":{"format":"int64","type":"integer"},"pledge_method":{"description":"restricted_account, borrower_in_custody, listing, delivery","type":"string"},"valuation_basis":{"description":"market_value or unpaid_principal","type":"string"}},"required":["asset_class","eligible","margin_bps"],"type":"object"},"ScheduleCoverage":{"description":"ScheduleCoverage is one schedule's completeness matrix: every declared position, counted once, and the figures bound to them.","properties":{"complete":{"type":"boolean"},"explained":{"format":"int64","type":"integer"},"figures":{"format":"int64","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/CoverageItem"},"type":"array"},"missing_categories":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"},"period":{"type":"string"},"positions":{"format":"int64","type":"integer"},"schedule":{"type":"string"},"supplied":{"format":"int64","type":"integer"},"uncovered":{"format":"int64","type":"integer"}},"required":["complete","explained","figures","items","missing_categories","period","positions","schedule","supplied","uncovered"],"type":"object"},"ScheduleLine":{"description":"ScheduleLine is one line of a Call Report schedule, in minor units.","properties":{"amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"item":{"description":"the schedule item, RC-E \"1 column A\", RC-C \"4.a\", RC-N \"4.a column C\", RI \"RI 1.a.(1) ...\"","type":"string"},"products":{"description":"the products or GL codes that roll up to the line","type":"string"}},"required":["amount","description","item"],"type":"object"},"ScheduleRequest":{"properties":{"authority_ref":{"type":"string"},"category":{"type":"string"},"effective_at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"permanent":{"type":"boolean"},"reason":{"type":"string"},"retention_days":{"format":"int64","type":"integer"},"trigger":{"description":"creation or evidenced_event","type":"string"}},"required":["authority_ref","category","effective_at","evidence_ref","evidence_sha256","expected_version","permanent","reason","retention_days","trigger"],"type":"object"},"ScheduleReview":{"properties":{"code":{"type":"string"},"disposition":{"description":"applicable or not_applicable for conditional detail","type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"}},"required":["code","disposition","evidence_ref","rationale"],"type":"object"},"ScheduledRun":{"description":"ScheduledRun is one execution of a schedule.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"description":{"type":"string"},"executed_at":{"format":"date-time","type":"string"},"failure_code":{"type":"string"},"failure_detail":{"type":"string"},"id":{"type":"string"},"nominal_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"occurrence":{"format":"int64","type":"integer"},"run_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"scheduled_transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"description":"executed or failed","type":"string"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"transfer_kind":{"type":"string"}},"required":["account_id","amount","currency_code","description","executed_at","id","nominal_date","occurrence","run_date","scheduled_transfer_id","status"],"type":"object"},"ScheduledTransfer":{"description":"ScheduledTransfer is a payment on a date or a recurrence.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"api_key_id":{"type":"string"},"approval_id":{"type":"string"},"consecutive_failures":{"format":"int64","type":"integer"},"counterparty_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"end_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"frequency":{"type":"string"},"id":{"type":"string"},"last_run_id":{"type":"string"},"last_transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"max_runs":{"format":"int64","type":"integer"},"next_occurrence":{"format":"int64","type":"integer"},"next_run_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"non_banking_day":{"type":"string"},"rail":{"type":"string"},"runs_completed":{"format":"int64","type":"integer"},"start_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"status":{"description":"pending_approval, active, paused, completed, cancelled or rejected","type":"string"},"status_reason":{"type":"string"},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount","consecutive_failures","created_at","created_by","currency_code","description","frequency","id","next_occurrence","non_banking_day","rail","runs_completed","start_date","status"],"type":"object"},"ScheduledTransferRequest":{"description":"ScheduledTransferRequest schedules a payment to a counterparty or between the customer's accounts.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"counterparty_id":{"type":"string"},"created_by":{"type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"description":{"type":"string"},"end_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"frequency":{"description":"once (default), weekly, biweekly, semimonthly, monthly, quarterly or annually","type":"string"},"max_runs":{"format":"int64","type":"integer"},"non_banking_day":{"description":"previous (default) or next","type":"string"},"rail":{"description":"defaults to the counterparty's pay_by","type":"string"},"start_date":{"description":"today by default","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"to_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount","created_by","currency_code","description"],"type":"object"},"Schema":{"properties":{"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array"},"id":{"type":"string"},"retrieved_at":{"type":"string"},"source_sha256":{"type":"string"},"source_url":{"type":"string"},"source_version":{"type":"string"},"validation_level":{"type":"string"},"year":{"format":"int64","type":"integer"}},"required":["fields","id","retrieved_at","source_sha256","source_url","source_version","validation_level","year"],"type":"object"},"SchemesAction":{"properties":{"after":{"$ref":"#/components/schemas/State"},"before":{"$ref":"#/components/schemas/State"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"loss":{"oneOf":[{"$ref":"#/components/schemas/FinalCardDisputeLoss"},{"type":"null"}]},"ordinal":{"format":"int64","type":"integer"},"posting":{"oneOf":[{"$ref":"#/components/schemas/SchemesPosting"},{"type":"null"}]},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/SchemesActionRequest"},"result":{"oneOf":[{"$ref":"#/components/schemas/SchemesResult"},{"type":"null"}]},"review":{"oneOf":[{"$ref":"#/components/schemas/SchemesReview"},{"type":"null"}]},"verified_receipt":{"oneOf":[{"$ref":"#/components/schemas/VerifiedReceipt"},{"type":"null"}]}},"required":["after","before","case_id","content_sha256","created_at","id","ordinal","proposed_by","request"],"type":"object"},"SchemesActionRequest":{"properties":{"amount_minor":{"format":"int64","type":"integer"},"dispute_action_id":{"type":"string"},"dispute_id":{"type":"string"},"evidence":{"items":{"$ref":"#/components/schemas/SchemesEvidence"},"type":"array"},"expected_sequence":{"format":"int64","type":"integer"},"kind":{"type":"string"},"operation":{"type":"string"},"receipt":{"oneOf":[{"$ref":"#/components/schemas/SchemesReceipt"},{"type":"null"}]}},"required":["expected_sequence","kind"],"type":"object"},"SchemesApplyRequest":{"properties":{"content_sha256":{"type":"string"}},"required":["content_sha256"],"type":"object"},"SchemesCase":{"properties":{"activation":{"oneOf":[{"$ref":"#/components/schemas/Activation"},{"type":"null"}]},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"eligibility":{"$ref":"#/components/schemas/VerifiedReceipt"},"id":{"type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/CaseRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/SchemesReview"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/SchemesSource"},"state":{"oneOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}]},"unclaimed_original_minor":{"format":"int64","type":"integer"}},"required":["content_sha256","created_at","eligibility","id","proposed_by","request","source","unclaimed_original_minor"],"type":"object"},"SchemesCloseReadiness":{"properties":{"blockers":{"items":{"$ref":"#/components/schemas/CloseBlocker"},"type":"array"},"business_date":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"ready":{"type":"boolean"},"truncated":{"type":"boolean"}},"required":["blockers","business_date","observed_at","ready","truncated"],"type":"object"},"SchemesEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"SchemesHistory":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/SchemesAction"},"type":"array"},"more":{"type":"boolean"}},"required":["actions","more"],"type":"object"},"SchemesPayload":{"description":"SigningBytes is normative. The processor signs actual facts from its network adapter; current issued_at attests an independently retained effective_at.","properties":{"acknowledged_instruction_id":{"type":"string"},"acknowledged_instruction_sha256":{"type":"string"},"allowed_actions":{"items":{"type":"string"},"type":"array"},"amount_minor":{"description":"eligibility amount or signed actual movement","format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"case_sha256":{"type":"string"},"currency":{"type":"string"},"effective_at":{"format":"date-time","type":"string"},"evidence":{"$ref":"#/components/schemas/SchemesEvidence"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"kind":{"description":"eligibility, network, cash","type":"string"},"network":{"type":"string"},"network_case_reference":{"type":"string"},"original_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"outcome":{"type":"string"},"reason_code":{"type":"string"},"receipt_reference":{"type":"string"},"respond_by":{"format":"date-time","type":"string"},"rules_evidence":{"$ref":"#/components/schemas/SchemesEvidence"},"rules_version":{"type":"string"},"sequence":{"format":"int64","type":"integer"},"settlement_reference":{"type":"string"},"stage":{"type":"string"},"submit_by":{"format":"date-time","type":"string"},"version":{"type":"string"}},"required":["amount_minor","authorization_id","currency","effective_at","evidence","issued_at","key_id","kind","network","original_journal_id","receipt_reference","rules_evidence","rules_version","sequence","version"],"type":"object"},"SchemesPosting":{"properties":{"created_at":{"format":"date-time","type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_sha256":{"type":"string"}},"required":["created_at","journal","journal_sha256"],"type":"object"},"SchemesReceipt":{"properties":{"payload":{"$ref":"#/components/schemas/SchemesPayload"},"signature":{"type":"string"}},"required":["payload","signature"],"type":"object"},"SchemesResult":{"properties":{"claim":{"oneOf":[{"$ref":"#/components/schemas/JournalEvidenceClaim"},{"type":"null"}]},"completed_at":{"format":"date-time","type":"string"},"disposition":{"type":"string"},"instruction_sha256":{"type":"string"},"journal":{"oneOf":[{"$ref":"#/components/schemas/LedgerJournal"},{"type":"null"}]},"journal_key":{"type":"string"},"state":{"$ref":"#/components/schemas/State"},"unallocated_loss_minor":{"format":"int64","type":"integer"}},"required":["completed_at","disposition","state"],"type":"object"},"SchemesReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","content_sha256","created_at","decision","reason"],"type":"object"},"SchemesReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","decision","reason"],"type":"object"},"SchemesSource":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"card_kind":{"type":"string"},"clearing_operation_key":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"debit_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"network":{"type":"string"},"network_ref":{"type":"string"}},"required":["account_id","amount_minor","card_id","card_kind","clearing_operation_key","customer_id","debit_ledger_account_id","journal","journal_key","journal_sha256","network","network_ref"],"type":"object"},"SchemesTrustedKey":{"properties":{"id":{"type":"string"},"network":{"type":"string"},"public_key":{"type":"string"},"valid_from":{"format":"date-time","type":"string"},"valid_through":{"format":"date-time","type":"string"}},"required":["id","network","public_key","valid_from","valid_through"],"type":"object"},"ScreenRequest":{"properties":{"country":{"type":"string"},"dob":{"description":"YYYY-MM-DD, a discriminator against the list's dates of birth","type":"string"},"name":{"type":"string"},"requested_by":{"type":"string"},"subject_id":{"description":"the customer id when screening a customer","type":"string"},"subject_type":{"type":"string"}},"required":["name","subject_type"],"type":"object"},"Screening":{"properties":{"id":{"example":"scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"list_age_days":{"description":"the oldest list's age on the day of the screening","format":"int64","type":"integer"},"list_stale":{"description":"a list had gone past the staleness threshold without a download; the screening still ran","type":"boolean"},"list_version":{"description":"the versions of the lists, in the order of Lists","type":"string"},"list_versions":{"items":{"$ref":"#/components/schemas/ListVersion"},"type":"array"},"lists":{"type":"string"},"matches":{"items":{"$ref":"#/components/schemas/Match"},"type":"array"},"name":{"type":"string"},"result":{"type":"string"},"unreadable_script":{"description":"UnreadableScript is set when the name has letters of a script the matcher cannot read; the\nresult is then a potential match for a person, never clear.","type":"boolean"}},"required":["id","list_age_days","list_stale","list_version","list_versions","lists","matches","name","result"],"type":"object"},"ScreeningIdentity":{"description":"ScreeningIdentity is the consumer identity presented to ChexSystems at account opening.","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"ssn":{"type":"string"}},"required":["first_name","last_name","ssn"],"type":"object"},"ScreeningItem":{"description":"ScreeningItem is one prior deposit-account abuse record.","properties":{"closed_date":{"format":"date-time","type":"string"},"institution":{"type":"string"},"item_id":{"type":"string"},"reason":{"type":"string"},"reported":{"format":"date-time","type":"string"},"suspected_fraud":{"type":"boolean"},"unpaid_amount":{"format":"int64","type":"integer"}},"required":["closed_date","institution","item_id","reason","reported","suspected_fraud","unpaid_amount"],"type":"object"},"SecuredlendingDocument":{"description":"Document is every signed answer the lender gives, one payload per kind.","properties":{"advance":{"oneOf":[{"$ref":"#/components/schemas/AdvanceConfirmation"},{"type":"null"}]},"borrower":{"description":"the bank as the lender names it","type":"string"},"collateral":{"oneOf":[{"$ref":"#/components/schemas/CollateralDecision"},{"type":"null"}]},"issued_at":{"format":"date-time","type":"string"},"issuer":{"description":"the Reserve Bank or the Federal Home Loan Bank","type":"string"},"key_id":{"type":"string"},"kind":{"type":"string"},"lender":{"type":"string"},"repayment":{"oneOf":[{"$ref":"#/components/schemas/RepaymentConfirmation"},{"type":"null"}]},"schedule":{"oneOf":[{"$ref":"#/components/schemas/CollateralSchedule"},{"type":"null"}]},"signature":{"type":"string"},"statement":{"oneOf":[{"$ref":"#/components/schemas/CollateralStatement"},{"type":"null"}]},"version":{"type":"string"}},"required":["borrower","issued_at","issuer","key_id","kind","lender","signature","version"],"type":"object"},"SecurityItem":{"description":"SecurityItem is a security the bank pledged or asks to have released: its CUSIP, par and the Fedwire Securities transfer that moved it.","properties":{"cusip":{"type":"string"},"operator_reference":{"type":"string"},"par_amount":{"format":"int64","type":"integer"}},"required":["cusip","par_amount"],"type":"object"},"SecurityKey":{"description":"SecurityKey is one key of the card cryptography hierarchy as the registry records it.","properties":{"activated_at":{"format":"date-time","type":"string"},"algorithm":{"type":"string"},"ceremony_id":{"type":"string"},"check_value":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decimalization":{"type":"string"},"exportability":{"type":"string"},"id":{"type":"string"},"key_version":{"type":"string"},"label":{"type":"string"},"length":{"format":"int64","type":"integer"},"mode_of_use":{"type":"string"},"network":{"type":"string"},"pvki":{"format":"int64","type":"integer"},"replaced_by_key_id":{"type":"string"},"replaces_key_id":{"type":"string"},"retired_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rotated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"usage":{"type":"string"},"zone_key_index":{"type":"string"}},"required":["activated_at","algorithm","ceremony_id","check_value","created_at","exportability","id","key_version","label","length","mode_of_use","network","pvki","status","updated_at","usage"],"type":"object"},"ServicingAction":{"properties":{"appeal_until":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"ends":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"kind":{"description":"contact, acknowledge, complete_application, forbearance, denial, withdrawal, foreclosure_referral, transfer_out","type":"string"},"notice":{"oneOf":[{"$ref":"#/components/schemas/Notice"},{"type":"null"}]},"previous_id":{"type":"string"},"reason":{"type":"string"},"related_action_id":{"type":"string"},"transfer":{"oneOf":[{"$ref":"#/components/schemas/ServicingTransfer"},{"type":"null"}]}},"required":["effective_date","evidence","kind","reason"],"type":"object"},"ServicingCase":{"properties":{"acknowledgment_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"actions":{"items":{"$ref":"#/components/schemas/ServicingRecord"},"type":"array"},"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evaluation_due":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"id":{"type":"string"},"request":{"$ref":"#/components/schemas/OpenCase"},"work_needed":{"items":{"type":"string"},"type":"array"}},"required":["acknowledgment_due","actions","actor","created_at","id","request","work_needed"],"type":"object"},"ServicingControls":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"collection_blocked":{"type":"boolean"},"external_servicer_id":{"type":"string"},"foreclosure_blocked":{"type":"boolean"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"open_loss_mitigation_case_ids":{"items":{"type":"string"},"type":"array"},"source_ids":{"items":{"type":"string"},"type":"array"}},"required":["business_date","collection_blocked","foreclosure_blocked","loan_id","open_loss_mitigation_case_ids","source_ids"],"type":"object"},"ServicingRecord":{"properties":{"action":{"$ref":"#/components/schemas/ServicingAction"},"actor":{"type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/MonitoringDecision"},{"type":"null"}]},"id":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["action","actor","case_id","content_sha256","created_at","id","loan_id"],"type":"object"},"ServicingSnapshot":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"data":{"additionalProperties":true,"type":"object"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["business_date","content_sha256","data","loan_id"],"type":"object"},"ServicingTransfer":{"properties":{"receiver_acknowledgment_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"receiving_servicer_contact":{"type":"string"},"receiving_servicer_id":{"type":"string"},"receiving_servicer_name":{"type":"string"},"servicing_contract_evidence":{"$ref":"#/components/schemas/MonitoringEvidence"},"snapshot_sha256":{"type":"string"}},"required":["receiver_acknowledgment_evidence","receiving_servicer_contact","receiving_servicer_id","receiving_servicer_name","servicing_contract_evidence","snapshot_sha256"],"type":"object"},"SetPINRequest":{"description":"SetPINRequest sets the transaction PIN.","properties":{"pin":{"description":"six digits","type":"string"}},"required":["pin"],"type":"object"},"Settlement":{"properties":{"broker_reference":{"type":"string"},"cash_evidence":{"$ref":"#/components/schemas/Document"},"cash_reference":{"type":"string"},"currency_code":{"type":"string"},"cusip":{"type":"string"},"custodian_reference":{"type":"string"},"delivery_evidence":{"$ref":"#/components/schemas/Document"},"delivery_reference":{"type":"string"},"execution_sha256":{"type":"string"},"external_account_reference":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"instruction_sha256":{"type":"string"},"key_id":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_external_account_reference":{"type":"string"},"master_cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"master_cash_statement_line_reference":{"type":"string"},"master_cash_statement_reference":{"type":"string"},"net_cash_amount":{"format":"int64","type":"integer"},"observed_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"principal_amount":{"format":"int64","type":"integer"},"settled_at":{"format":"date-time","type":"string"},"settlement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"settlement_reference":{"type":"string"},"side":{"type":"string"},"signature":{"type":"string"},"units":{"format":"int64","type":"integer"},"version":{"type":"string"}},"required":["broker_reference","cash_evidence","cash_reference","currency_code","cusip","custodian_reference","delivery_evidence","delivery_reference","execution_sha256","external_account_reference","fee_amount","instruction_sha256","key_id","legal_entity","master_cash_external_account_reference","master_cash_ledger_account_id","master_cash_statement_line_reference","master_cash_statement_reference","net_cash_amount","observed_at","order_id","principal_amount","settled_at","settlement_date","settlement_reference","side","signature","units","version"],"type":"object"},"SettlementAccountNet":{"description":"SettlementAccountNet is one account's figures over the window. The lines' net is what this report accounts for; the ledger movement is what the account actually moved, and the difference is every other posting on the account in the window, fees and interest among them. A report ties when the difference is explained: the lines are a subset of the movement and the remainder is named, never discarded.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"closing_minor":{"format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_movement_minor":{"format":"int64","type":"integer"},"ledger_read":{"type":"boolean"},"net_movement_minor":{"format":"int64","type":"integer"},"net_settlement_minor":{"format":"int64","type":"integer"},"opening_minor":{"format":"int64","type":"integer"},"other_postings_minor":{"format":"int64","type":"integer"}},"required":["account_id","closing_minor","ledger_movement_minor","ledger_read","net_movement_minor","net_settlement_minor","opening_minor","other_postings_minor"],"type":"object"},"SettlementChunk":{"description":"SettlementChunk is a principal batch with its network finance statement and cash, at most 250 presentments each so the batch and statement stay inside their bounds.","properties":{"authorization_ids":{"items":{"type":"string"},"type":"array"},"batch_key":{"type":"string"},"cash_minor":{"description":"interchange less fees less principal: the network finance cash reconciliation","format":"int64","type":"integer"},"index":{"format":"int64","type":"integer"},"interchange_minor":{"format":"int64","type":"integer"},"lines":{"items":{"$ref":"#/components/schemas/NetworkfinanceLine"},"type":"array"},"principal_minor":{"format":"int64","type":"integer"},"scheme_fee_minor":{"format":"int64","type":"integer"},"statement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["authorization_ids","batch_key","cash_minor","index","interchange_minor","lines","principal_minor","scheme_fee_minor","statement_date"],"type":"object"},"SettlementFigures":{"description":"SettlementFigures reconcile the file's net settlement to its categories.","properties":{"attributable_interchange_minor":{"format":"int64","type":"integer"},"attributable_scheme_fee_minor":{"format":"int64","type":"integer"},"credit_minor":{"format":"int64","type":"integer"},"direct_interchange_minor":{"format":"int64","type":"integer"},"direct_journal_cash_minor":{"description":"the master account leg of the direct journal","format":"int64","type":"integer"},"direct_scheme_fee_minor":{"format":"int64","type":"integer"},"external_cash_minor":{"format":"int64","type":"integer"},"net_minor":{"description":"the categories added up: what moves the master account","format":"int64","type":"integer"},"network_finance_cash_minor":{"description":"interchange less fees the network finance cash records move","format":"int64","type":"integer"},"principal_minor":{"format":"int64","type":"integer"},"principal_settlement_cash_minor":{"description":"negative: what the principal batches move","format":"int64","type":"integer"},"reported_net_minor":{"description":"the file trailer's net settlement","format":"int64","type":"integer"},"return_credit_minor":{"format":"int64","type":"integer"},"return_debit_minor":{"format":"int64","type":"integer"},"suspense_credit_minor":{"format":"int64","type":"integer"},"suspense_debit_minor":{"format":"int64","type":"integer"}},"required":["attributable_interchange_minor","attributable_scheme_fee_minor","credit_minor","direct_interchange_minor","direct_journal_cash_minor","direct_scheme_fee_minor","external_cash_minor","net_minor","network_finance_cash_minor","principal_minor","principal_settlement_cash_minor","reported_net_minor","return_credit_minor","return_debit_minor","suspense_credit_minor","suspense_debit_minor"],"type":"object"},"SettlementReconciliation":{"properties":{"application":{"oneOf":[{"$ref":"#/components/schemas/SettlementReconciliationApplication"},{"type":"null"}]},"cash":{"items":{"$ref":"#/components/schemas/HistoricalCash"},"type":"array"},"conflicts":{"items":{"type":"string"},"type":"array"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/SettlementReconciliationRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/SettlementReconciliationReview"},{"type":"null"}]},"sources":{"items":{"$ref":"#/components/schemas/HistoricalClearing"},"type":"array"}},"required":["cash","conflicts","content_sha256","created_at","id","proposed_by","request","sources"],"type":"object"},"SettlementReconciliationApplication":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"}},"required":["actor","content_sha256","created_at"],"type":"object"},"SettlementReconciliationApplicationRequest":{"properties":{"content_sha256":{"type":"string"}},"required":["content_sha256"],"type":"object"},"SettlementReconciliationRequest":{"properties":{"cash_groups":{"items":{"$ref":"#/components/schemas/LegacyCashRequest"},"type":"array"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"network":{"type":"string"},"reason":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/SettlementSourceRequest"},"type":"array"},"unsettled_authorization_ids":{"items":{"type":"string"},"type":"array"}},"required":["cash_groups","evidence_ref","evidence_sha256","network","reason","sources","unsettled_authorization_ids"],"type":"object"},"SettlementReconciliationReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","content_sha256","created_at","decision","reason"],"type":"object"},"SettlementReconciliationReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["content_sha256","decision","reason"],"type":"object"},"SettlementReport":{"description":"SettlementReport is one scheduled report: what was asked for, where it got to, and the documents it produced.","properties":{"completed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"documents":{"items":{"$ref":"#/components/schemas/SettlementReportDocument"},"type":"array"},"failure_reason":{"type":"string"},"from_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"type":"string"},"requested_by":{"type":"string"},"scheduled_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"scope":{"type":"string"},"status":{"type":"string"},"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"type":{"type":"string"}},"required":["created_at","documents","from_date","id","requested_by","scope","status","to_date","type"],"type":"object"},"SettlementReportContent":{"description":"SettlementReportContent is the document: the settled facts for the scope and window, grouped by business date and rail, every line carrying the ledger journal that posted it. Two nets are reported and they are not the same figure. The settlement net is what moved across the rails, which is the bank's position with the operators; the movement net is what the accounts moved, which is what the ledger shows. They differ by the book transfers, which settle at the bank and cross no rail.","properties":{"accounts":{"items":{"$ref":"#/components/schemas/SettlementAccountNet"},"type":"array"},"currency":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"days":{"items":{"$ref":"#/components/schemas/SettlementReportDay"},"type":"array"},"from_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"line_count":{"format":"int64","type":"integer"},"net_movement_minor":{"format":"int64","type":"integer"},"net_settlement_minor":{"format":"int64","type":"integer"},"notes":{"items":{"type":"string"},"type":"array"},"rail":{"type":"string"},"report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"scope":{"type":"string"},"ties":{"type":"boolean"},"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"type":{"type":"string"}},"required":["accounts","currency","days","from_date","line_count","net_movement_minor","net_settlement_minor","notes","report_id","scope","ties","to_date","type"],"type":"object"},"SettlementReportDay":{"description":"SettlementReportDay is one business date of settlement.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"net_movement_minor":{"format":"int64","type":"integer"},"net_settlement_minor":{"format":"int64","type":"integer"},"rails":{"items":{"$ref":"#/components/schemas/SettlementReportRail"},"type":"array"}},"required":["business_date","net_movement_minor","net_settlement_minor","rails"],"type":"object"},"SettlementReportDocument":{"description":"SettlementReportDocument is one rendering of a completed report. The content is served by the document route, not inlined in the report.","properties":{"built_at":{"format":"date-time","type":"string"},"format":{"type":"string"},"report_id":{"example":"strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sha256":{"type":"string"}},"required":["built_at","format","report_id","sha256"],"type":"object"},"SettlementReportLine":{"description":"SettlementReportLine is one settled transfer, return or reversal. The amounts are signed from the account holder's side: money into the account is positive, money out of it negative. SettlementMinor is the part of that movement which crossed a rail, so it is zero for a book transfer, and JournalID is the ledger journal that posted the movement, which is how a line ties to a posting.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount_minor":{"format":"int64","type":"integer"},"category":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"direction":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"settlement_minor":{"format":"int64","type":"integer"},"signed_minor":{"format":"int64","type":"integer"},"transfer_id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount_minor","category","direction","journal_id","settlement_minor","signed_minor","transfer_id"],"type":"object"},"SettlementReportRail":{"description":"SettlementReportRail is one rail's settlement on a business date. Window names the settlement window the rail settled through where it has more than one: the ACH Same Day window against the standard windows, and the cash letter a check settled in.","properties":{"lines":{"items":{"$ref":"#/components/schemas/SettlementReportLine"},"type":"array"},"net_movement_minor":{"format":"int64","type":"integer"},"net_settlement_minor":{"format":"int64","type":"integer"},"rail":{"type":"string"},"returned_minor":{"format":"int64","type":"integer"},"settled_minor":{"format":"int64","type":"integer"},"window":{"type":"string"}},"required":["lines","net_movement_minor","net_settlement_minor","rail","returned_minor","settled_minor","window"],"type":"object"},"SettlementReportRequest":{"description":"SettlementReportRequest is what a caller asks for.","properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"from_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"rail":{"type":"string"},"scope":{"type":"string"},"to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"type":{"type":"string"}},"required":["from_date","scope","to_date","type"],"type":"object"},"SettlementRequest":{"description":"SettlementRequest proposes a network settlement for a business date.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence":{"type":"string"},"network":{"type":"string"}},"required":["business_date","evidence","network"],"type":"object"},"SettlementResult":{"description":"SettlementResult is what applying a settlement posted.","properties":{"actor":{"type":"string"},"batch_journal_ids":{"items":{"type":"string"},"type":"array"},"completed_at":{"format":"date-time","type":"string"},"journal_effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"network_finance_cash_ids":{"items":{"type":"string"},"type":"array"},"network_finance_statement_ids":{"items":{"type":"string"},"type":"array"},"return_credited_exception_ids":{"items":{"type":"string"},"type":"array"}},"required":["actor","batch_journal_ids","completed_at","network_finance_cash_ids","network_finance_statement_ids","return_credited_exception_ids"],"type":"object"},"SettlementSource":{"description":"SettlementSource is one record's place in the settlement.","properties":{"amount_minor":{"format":"int64","type":"integer"},"attributable":{"description":"interchange and fees accrue through network finance against the clearing receipt","type":"boolean"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"category":{"type":"string"},"exception_id":{"type":"string"},"interchange_minor":{"format":"int64","type":"integer"},"record_id":{"type":"string"},"resolution_id":{"type":"string"},"scheme_fee_minor":{"format":"int64","type":"integer"},"sequence":{"format":"int64","type":"integer"}},"required":["amount_minor","attributable","category","interchange_minor","record_id","scheme_fee_minor","sequence"],"type":"object"},"SettlementSourceRequest":{"description":"Membership is an explicit staff assertion supported by retained network evidence.","properties":{"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"clearing_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["authorization_id","clearing_journal_id"],"type":"object"},"Shape":{"properties":{"attachments":{"items":{"type":"string"},"type":"array"},"columns":{"items":{"$ref":"#/components/schemas/Column"},"type":"array"},"excluded":{"items":{"type":"string"},"type":"array"},"key":{"items":{"type":"string"},"type":"array"},"redacted":{"items":{"type":"string"},"type":"array"},"sha256":{"type":"string"}},"required":["attachments","columns","excluded","key","redacted","sha256"],"type":"object"},"SheetWithdrawal":{"description":"SheetWithdrawal stops an approved rate sheet pricing.","properties":{"evidence":{"type":"string"}},"required":["evidence"],"type":"object"},"Shipment":{"properties":{"actor":{"type":"string"},"amount":{"format":"int64","type":"integer"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"carrier_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"exception":{"type":"string"},"from_unit_id":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"manifest":{"oneOf":[{"$ref":"#/components/schemas/CashManifest"},{"type":"null"}]},"movement_id":{"type":"string"},"order_id":{"type":"string"},"progress":{"items":{"$ref":"#/components/schemas/ShipmentProgress"},"type":"array"},"status":{"type":"string"},"to_unit_id":{"type":"string"}},"required":["actor","amount","business_date","carrier_id","created_at","id","kind","order_id","progress","status"],"type":"object"},"ShipmentProgress":{"properties":{"actor":{"type":"string"},"carrier_reference":{"type":"string"},"evidence":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"status":{"description":"scheduled, picked_up, in_transit, delivered, exception","type":"string"}},"required":["actor","carrier_reference","evidence","recorded_at","status"],"type":"object"},"Signature":{"properties":{"at":{"format":"date-time","type":"string"},"evidence_sha256":{"type":"string"},"party":{"type":"string"}},"required":["at","evidence_sha256","party"],"type":"object"},"SignedStatement":{"properties":{"document":{"format":"byte","type":"string"},"signature":{"type":"string"},"statement":{"$ref":"#/components/schemas/Statement"}},"required":["document","signature","statement"],"type":"object"},"SignupRequest":{"description":"SignupRequest creates a customer login.","properties":{"customer_id":{"description":"must be empty; a bank enrolment binds the login","example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"email":{"type":"string"},"password":{"description":"at least 12 characters","type":"string"}},"required":["email","password"],"type":"object"},"SimulateACHChange":{"description":"SimulateACHChange plays an RDFI sending a notification of change about an entry the bank originated.","properties":{"change_code":{"description":"C01 to C14","type":"string"},"corrected":{"$ref":"#/components/schemas/Corrected"},"trace_number":{"type":"string"}},"required":["change_code","corrected","trace_number"],"type":"object"},"SimulateACHReceive":{"description":"SimulateACHReceive delivers an ACH credit or debit to one of the bank's account numbers.","properties":{"account_number":{"type":"string"},"account_type":{"description":"the transaction code's account type: checking (default) or savings","type":"string"},"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"description":{"type":"string"},"direction":{"description":"credit (money arrives) or debit (a pull against the account)","type":"string"},"individual_id":{"type":"string"},"ofac_indicator":{"description":"on IAT: the Gateway Operator's indicator, 0 or 1","type":"string"},"originator_country":{"description":"on IAT: the foreign originator's country, CA by default","type":"string"},"originator_name":{"type":"string"},"originator_routing_number":{"type":"string"},"prenote":{"description":"a zero-dollar prenotification","type":"boolean"},"receiver_name":{"type":"string"},"sec_code":{"description":"PPD (default), CCD or IAT","type":"string"}},"required":["account_number","amount","currency_code","description","direction","individual_id","originator_name","originator_routing_number"],"type":"object"},"SimulateACHReturn":{"description":"SimulateACHReturn returns an originated entry with a NACHA return reason code.","properties":{"return_code":{"type":"string"},"trace_number":{"type":"string"}},"required":["return_code","trace_number"],"type":"object"},"SimulateACHSettle":{"description":"SimulateACHSettle settles a sent outbound file as the operator would.","properties":{"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["file_id"],"type":"object"},"SimulateBankTransferReceive":{"description":"SimulateBankTransferReceive delivers a bank transfer (pacs.009) from another institution; it parks on the transit account until operations apply or return it.","properties":{"amount":{"format":"int64","type":"integer"},"info":{"type":"string"},"reference":{"type":"string"},"sender_name":{"type":"string"},"sender_routing_number":{"type":"string"}},"required":["amount","reference","sender_name","sender_routing_number"],"type":"object"},"SimulateCheckReturn":{"description":"SimulateCheckReturn plays the payor bank returning a deposited check.","properties":{"deposit_id":{"type":"string"},"reason":{"description":"an X9 return reason: A NSF, C stop payment, D closed account, ...","type":"string"}},"required":["deposit_id","reason"],"type":"object"},"SimulateClearing":{"description":"SimulateClearing clears an authorization as the network would.","properties":{"amount":{"format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["amount","authorization_id"],"type":"object"},"SimulateInstantReturn":{"description":"SimulateInstantReturn plays the receiver returning a payment the bank sent.","properties":{"amount":{"format":"int64","type":"integer"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["payment_id","reason_code"],"type":"object"},"SimulateInstantReturnRequest":{"description":"SimulateInstantReturnRequest plays the sender asking for a payment the bank received back (camt.056).","properties":{"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["payment_id","reason_code"],"type":"object"},"SimulateLiquidityReceive":{"description":"SimulateLiquidityReceive plays a liquidity management transfer arriving (pacs.009).","properties":{"amount":{"format":"int64","type":"integer"},"remittance":{"type":"string"},"sender_routing_number":{"type":"string"}},"required":["amount","sender_routing_number"],"type":"object"},"SimulateNotification":{"description":"SimulateNotification plays the service notifying the bank, as a correspondent, of a respondent's settled message (camt.054).","properties":{"amount":{"format":"int64","type":"integer"},"direction":{"description":"credit or debit","type":"string"},"msg_def":{"type":"string"},"rail":{"type":"string"},"respondent":{"type":"string"}},"required":["amount","direction","rail","respondent"],"type":"object"},"SimulatePaymentRequest":{"description":"SimulatePaymentRequest plays another institution's customer asking the bank's customer to pay (pain.013).","properties":{"account_number":{"description":"the payer's account at the bank","type":"string"},"amount":{"format":"int64","type":"integer"},"creditor_account":{"type":"string"},"creditor_name":{"type":"string"},"creditor_routing_number":{"type":"string"},"document_number":{"type":"string"},"expires_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"rail":{"type":"string"},"remittance":{"type":"string"}},"required":["account_number","amount","creditor_account","creditor_name","creditor_routing_number","rail"],"type":"object"},"SimulatePurchase":{"description":"SimulatePurchase runs a merchant purchase on a card through the same authorization path the issuer-processor calls.","properties":{"amount":{"format":"int64","type":"integer"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"channel":{"description":"pos, ecommerce, atm, contactless","type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"mcc":{"type":"string"},"merchant_id":{"type":"string"},"merchant_name":{"type":"string"},"network_ref":{"type":"string"}},"required":["amount","card_id","channel","country","currency_code","mcc","merchant_name"],"type":"object"},"SimulateRealtimeReceive":{"description":"SimulateRealtimeReceive delivers a FedNow or RTP credit transfer to one of the bank's account numbers.","properties":{"account_number":{"type":"string"},"amount":{"format":"int64","type":"integer"},"creditor_name":{"type":"string"},"currency_code":{"type":"string"},"debtor_account":{"type":"string"},"debtor_name":{"type":"string"},"debtor_routing_number":{"type":"string"},"rail":{"description":"fednow or rtp","type":"string"},"remittance":{"type":"string"}},"required":["account_number","amount","creditor_name","currency_code","debtor_account","debtor_name","debtor_routing_number","rail","remittance"],"type":"object"},"SimulateRequestCancellation":{"description":"SimulateRequestCancellation plays the requester cancelling a request the bank's customer received (camt.055).","properties":{"reason_code":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["reason_code","request_id"],"type":"object"},"SimulateStatements":{"description":"SimulateStatements pulls the sandbox operators' statements for a date; omit drops references and extra_lines adds lines, to exercise breaks.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"extra_lines":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ReportingStatementLine"},"type":"array"},"description":"by source","type":"object"},"omit":{"items":{"type":"string"},"type":"array"}},"required":["business_date"],"type":"object"},"SimulateSwiftBankReceive":{"description":"SimulateSwiftBankReceive is a bank transfer or cover a simulated correspondent sends (sandbox).","properties":{"amount":{"format":"int64","type":"integer"},"cover_of":{"type":"string"},"currency_code":{"type":"string"},"remittance":{"type":"string"},"sender_bic":{"type":"string"}},"type":"object"},"SimulateSwiftCancellation":{"description":"SimulateSwiftCancellation is a cancellation request the sender of a received payment sends (sandbox).","properties":{"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["payment_id","reason_code"],"type":"object"},"SimulateSwiftReceive":{"description":"SimulateSwiftReceive is a customer transfer a simulated correspondent sends the bank (sandbox).","properties":{"account_number":{"type":"string"},"amount":{"format":"int64","type":"integer"},"charge_bearer":{"type":"string"},"cover":{"type":"boolean"},"creditor_agent_bic":{"type":"string"},"creditor_name":{"type":"string"},"currency_code":{"type":"string"},"debtor":{"oneOf":[{"$ref":"#/components/schemas/Party"},{"type":"null"}]},"debtor_agent_bic":{"type":"string"},"remittance":{"type":"string"},"sender_bic":{"type":"string"}},"required":["account_number","amount"],"type":"object"},"SimulateWireReceive":{"description":"SimulateWireReceive delivers a Fedwire to one of the bank's account numbers.","properties":{"account_number":{"type":"string"},"amount":{"format":"int64","type":"integer"},"beneficiary_name":{"type":"string"},"currency_code":{"type":"string"},"originator_account":{"type":"string"},"originator_name":{"type":"string"},"reference":{"type":"string"},"sender_name":{"type":"string"},"sender_routing_number":{"type":"string"}},"required":["account_number","amount","beneficiary_name","currency_code","originator_account","originator_name","reference","sender_name","sender_routing_number"],"type":"object"},"SimulateWireReturn":{"description":"SimulateWireReturn plays the receiver of a wire the bank sent returning it (pacs.004).","properties":{"amount":{"description":"up to the original; the whole amount when absent","format":"int64","type":"integer"},"original_imad":{"description":"to point the return at a wire the bank never sent","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"wire_id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["reason_code","wire_id"],"type":"object"},"SimulateWireReturnRequest":{"description":"SimulateWireReturnRequest plays the sender of a wire the bank received asking for it back (camt.056).","properties":{"reason":{"type":"string"},"reason_code":{"type":"string"},"wire_id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["reason_code","wire_id"],"type":"object"},"Snapshot":{"description":"Snapshot is a complete internal source digest, not a substitute for checking the signed external evidence and actual journals that every position retains.","properties":{"blockers":{"items":{"type":"string"},"type":"array"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"captured_at":{"format":"date-time","type":"string"},"cash_evidence":{"items":{"$ref":"#/components/schemas/SnapshotCashEvidence"},"type":"array"},"content_sha256":{"type":"string"},"dealer_checks":{"items":{"$ref":"#/components/schemas/DealerCheck"},"type":"array"},"encumbrances":{"items":{"$ref":"#/components/schemas/SnapshotEncumbrance"},"type":"array"},"id":{"type":"string"},"journals":{"items":{"$ref":"#/components/schemas/SnapshotJournal"},"type":"array"},"legal_entity":{"type":"string"},"lots":{"items":{"$ref":"#/components/schemas/Lot"},"type":"array"},"managed_accounts":{"items":{"$ref":"#/components/schemas/SnapshotAccount"},"type":"array"},"observation_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"orders":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"ready":{"type":"boolean"},"redemptions":{"items":{"$ref":"#/components/schemas/RedemptionRecord"},"type":"array"},"version":{"type":"string"}},"required":["blockers","business_date","captured_at","cash_evidence","content_sha256","dealer_checks","encumbrances","id","journals","legal_entity","lots","managed_accounts","observation_date","orders","ready","redemptions","version"],"type":"object"},"SnapshotAccount":{"properties":{"gl_code":{"type":"string"},"held_amount":{"format":"int64","type":"integer"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"normal_balance":{"type":"string"},"posted_amount":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"source_id":{"type":"string"}},"required":["gl_code","held_amount","ledger_account_id","normal_balance","posted_amount","purpose","source_id"],"type":"object"},"SnapshotAdmission":{"properties":{"admission":{"$ref":"#/components/schemas/Admission"},"stage":{"type":"string"},"transaction_id":{"type":"string"}},"required":["admission","stage","transaction_id"],"type":"object"},"SnapshotCashEvidence":{"description":"SnapshotCashEvidence binds a module's actual settlement to independent native statement reliance. A provider signature by itself never sets this ready.","properties":{"actual_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"proof":{"$ref":"#/components/schemas/Proof"},"ready":{"type":"boolean"},"receipt_sha256":{"type":"string"},"signed_delta_amount":{"format":"int64","type":"integer"},"source_id":{"type":"string"}},"required":["actual_date","journal_id","kind","proof","ready","receipt_sha256","signed_delta_amount","source_id"],"type":"object"},"SnapshotEncumbrance":{"description":"SnapshotEncumbrance retains the exact native reservation and managing command alongside a known lien. The opaque document avoids coupling this accounting package to the separate borrowing model that depends on its Treasury lots.","properties":{"content_sha256":{"type":"string"},"document":{"additionalProperties":true,"type":"object"},"kind":{"type":"string"},"lot_id":{"type":"string"},"source_id":{"type":"string"}},"required":["content_sha256","document","kind","lot_id","source_id"],"type":"object"},"SnapshotJournal":{"description":"SnapshotJournal retains assigned posting provenance separately from the exact immutable command fingerprint, including its hold-release binding.","properties":{"approved_by":{"type":"string"},"committed_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"idempotency_key":{"type":"string"},"journal":{"$ref":"#/components/schemas/Journal"},"journal_sha256":{"type":"string"},"posted_by":{"type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["approved_by","committed_at","id","idempotency_key","journal","journal_sha256","posted_by","posting_date"],"type":"object"},"SnapshotPosition":{"properties":{"coverage":{"oneOf":[{"$ref":"#/components/schemas/Coverage"},{"type":"null"}]},"current_lots":{"items":{"$ref":"#/components/schemas/Lot"},"type":"array"},"reservations":{"items":{"$ref":"#/components/schemas/SnapshotReservation"},"type":"array"},"transaction":{"$ref":"#/components/schemas/Transaction"}},"required":["current_lots","reservations","transaction"],"type":"object"},"SnapshotRecord":{"properties":{"actor":{"type":"string"},"captured_at":{"format":"date-time","type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"snapshot":{"$ref":"#/components/schemas/InvestmentsSnapshot"}},"required":["actor","captured_at","content_sha256","id","snapshot"],"type":"object"},"SnapshotRequest":{"properties":{"on_behalf_of":{"type":"string"},"purpose":{"type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source":{"type":"string"}},"required":["on_behalf_of","purpose","request_id","source"],"type":"object"},"SnapshotReservation":{"properties":{"active":{"type":"boolean"},"reservation":{"$ref":"#/components/schemas/BankrepoReservation"}},"required":["active","reservation"],"type":"object"},"Source":{"properties":{"captured_at":{"format":"date-time","type":"string"},"cash_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"external_account_reference":{"type":"string"},"legal_entity":{"type":"string"},"master_cash_external_account_reference":{"type":"string"}},"required":["captured_at","cash_ledger_account_id","external_account_reference","legal_entity","master_cash_external_account_reference"],"type":"object"},"SourceAddress":{"properties":{"currency_code":{"type":"string"},"legal_entity":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"owner":{"type":"string"}},"required":["currency_code","legal_entity","name","namespace","owner"],"type":"object"},"SourceCredit":{"properties":{"closure_component":{"type":"string"},"closure_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["journal_id","journal_key","journal_sha256","ledger_account_id"],"type":"object"},"SourceRequest":{"properties":{"activity_sequence":{"format":"int64","type":"integer"},"alert_ids":{"items":{"type":"string"},"type":"array"}},"required":["activity_sequence","alert_ids"],"type":"object"},"SourceSnapshot":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"captured_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":true,"type":"object"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"kind":{"description":"gl_positions, gl_income_ytd, imported, or a declared local source kind","type":"string"},"missing":{"items":{"$ref":"#/components/schemas/MissingItem"},"type":"array"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"sha256":{"type":"string"},"values":{"items":{"$ref":"#/components/schemas/SourceValue"},"type":"array"}},"required":["as_of","captured_at","data","id","kind","sha256"],"type":"object"},"SourceTarget":{"description":"SourceTarget is one exact retained form position a local source kind can supply, keyed as \"SCHEDULE:line:column\" in the source's captured values.","properties":{"description":{"type":"string"},"key":{"type":"string"},"mdrm":{"description":"MDRM disambiguates a position the retained reference linkbase binds to more than one\nconcept (Schedule RC-R Part II binds form columns K through T under the letters A through\nJ), keyed \"SCHEDULE:line:column:MDRM\". It is empty for every unambiguous position.","type":"string"},"reference":{"$ref":"#/components/schemas/TaxonomyReference"},"unit":{"type":"string"}},"required":["key","reference","unit"],"type":"object"},"SourceValue":{"properties":{"key":{"type":"string"},"unit":{"description":"usd_cents, integer, decimal, boolean, text","type":"string"},"value":{"type":"string"}},"required":["key","unit","value"],"type":"object"},"SpendAllocation":{"properties":{"amount":{"format":"int64","type":"integer"},"cost_center":{"type":"string"},"external_account_code":{"type":"string"},"memo":{"type":"string"}},"required":["amount","cost_center","external_account_code","memo"],"type":"object"},"SpendArtifact":{"description":"Artifact JSON is deterministic in this declaration order. Its hash binds exact reviewed records, actual source journals and the organization authority snapshot.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"entries":{"items":{"$ref":"#/components/schemas/SpendEntry"},"type":"array"},"expenses":{"items":{"$ref":"#/components/schemas/Expense"},"type":"array"},"export_id":{"type":"string"},"organization_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"version":{"type":"string"}},"required":["account_id","created_at","entries","expenses","export_id","organization_customer_id","version"],"type":"object"},"SpendAuthority":{"description":"Authority is the observed current organization membership and separately bank- verified person identity. Neither the request body nor a receipt supplies it.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"device_sha256":{"type":"string"},"membership_changed_by":{"type":"string"},"membership_updated_at":{"format":"date-time","type":"string"},"observed_at":{"format":"date-time","type":"string"},"organization_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"payment_limit_amount":{"format":"int64","type":"integer"},"person_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"role":{"type":"string"},"session_sha256":{"type":"string"},"step_up_at":{"format":"date-time","type":"string"},"user_id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","device_sha256","membership_changed_by","membership_updated_at","observed_at","organization_customer_id","payment_limit_amount","person_customer_id","role","session_sha256","step_up_at","user_id"],"type":"object"},"SpendEntry":{"properties":{"amount":{"format":"int64","type":"integer"},"cost_center":{"type":"string"},"currency_code":{"type":"string"},"direction":{"type":"string"},"expense_id":{"type":"string"},"external_account_code":{"type":"string"},"memo":{"type":"string"},"source_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"source_journal_sha256":{"type":"string"}},"required":["amount","currency_code","direction","expense_id","external_account_code","memo","source_journal_id","source_journal_sha256"],"type":"object"},"SpendEvidence":{"properties":{"reference":{"type":"string"},"sha256":{"type":"string"}},"required":["reference","sha256"],"type":"object"},"SpendReceipt":{"description":"Receipt identity is scoped to the organization and the exact processor merchant. A source document can support several partial bank payments, but only up to its declared total. Evidence is retained customer-supplied documentation, not OCR proof.","properties":{"currency_code":{"type":"string"},"evidence":{"$ref":"#/components/schemas/SpendEvidence"},"external_reference":{"type":"string"},"issued_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"merchant_id":{"type":"string"},"total_amount":{"format":"int64","type":"integer"}},"required":["currency_code","evidence","external_reference","issued_date","merchant_id","total_amount"],"type":"object"},"SpendRequest":{"properties":{"allocations":{"items":{"$ref":"#/components/schemas/SpendAllocation"},"type":"array"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"coding_evidence":{"$ref":"#/components/schemas/SpendEvidence"},"reason":{"type":"string"},"receipt":{"$ref":"#/components/schemas/SpendReceipt"},"replaces_expense_id":{"type":"string"},"settlement_account_code":{"type":"string"}},"required":["allocations","authorization_id","coding_evidence","reason","receipt","settlement_account_code"],"type":"object"},"SpendReview":{"properties":{"approve":{"type":"boolean"},"at":{"format":"date-time","type":"string"},"authority":{"$ref":"#/components/schemas/SpendAuthority"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/SpendEvidence"},"reason":{"type":"string"}},"required":["approve","at","authority","content_sha256","evidence","reason"],"type":"object"},"SpendReviewRequest":{"properties":{"approve":{"type":"boolean"},"content_sha256":{"type":"string"},"evidence":{"$ref":"#/components/schemas/SpendEvidence"},"reason":{"type":"string"}},"required":["approve","content_sha256","evidence","reason"],"type":"object"},"SpendSource":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"card_kind":{"type":"string"},"currency_code":{"type":"string"},"journal":{"$ref":"#/components/schemas/LedgerJournal"},"journal_key":{"type":"string"},"journal_sha256":{"type":"string"},"kind":{"description":"purchase or refund, derived from actual bank source","type":"string"},"merchant_id":{"type":"string"},"merchant_name":{"type":"string"},"network_reference":{"type":"string"},"organization_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"original_authorization_id":{"example":"auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["account_id","amount","authorization_id","card_id","card_kind","currency_code","journal","journal_key","journal_sha256","kind","merchant_id","merchant_name","network_reference","organization_customer_id"],"type":"object"},"StaffAuditChain":{"description":"StaffAuditChain is the verification of one of identity's hash-chained audit tables.","properties":{"anchor":{"description":"identity's signature over the verified head, to keep outside the database and present as ?anchor=","type":"string"},"anchor_sequence":{"format":"int64","type":"integer"},"detail":{"type":"string"},"first_break":{"format":"int64","type":"integer"},"intact":{"type":"boolean"},"pending":{"description":"rows committed moments ago the sequencer has not chained yet","format":"int64","type":"integer"},"rows":{"format":"int64","type":"integer"},"table":{"description":"security_audit or staff_audit","type":"string"},"verified_at":{"format":"date-time","type":"string"}},"required":["intact","pending","rows","table","verified_at"],"type":"object"},"StaffAuditVerification":{"description":"StaffAuditVerification is identity's answer: the security and staff audit chains.","properties":{"chains":{"items":{"$ref":"#/components/schemas/StaffAuditChain"},"type":"array"}},"required":["chains"],"type":"object"},"StaffAuthorization":{"properties":{"authorization_url":{"type":"string"},"binding":{"description":"retain in the initiating browser; never put in the redirect URL","type":"string"},"expires_at":{"format":"date-time","type":"string"}},"required":["authorization_url","binding","expires_at"],"type":"object"},"StaffList":{"properties":{"Resources":{"items":{"$ref":"#/components/schemas/StaffUser"},"type":"array"},"itemsPerPage":{"format":"int64","type":"integer"},"schemas":{"items":{"type":"string"},"type":"array"},"startIndex":{"format":"int64","type":"integer"},"totalResults":{"format":"int64","type":"integer"}},"required":["Resources","itemsPerPage","schemas","startIndex","totalResults"],"type":"object"},"StaffLoginRequest":{"properties":{"binding":{"type":"string"},"code":{"type":"string"},"state":{"type":"string"}},"required":["binding","code","state"],"type":"object"},"StaffMeta":{"properties":{"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"resourceType":{"type":"string"},"version":{"type":"string"}},"type":"object"},"StaffPatch":{"properties":{"Operations":{"items":{"properties":{"op":{"type":"string"},"path":{"type":"string"},"value":{"additionalProperties":true,"type":"object"}},"required":["op"],"type":"object"},"type":"array"},"schemas":{"items":{"type":"string"},"type":"array"}},"required":["Operations","schemas"],"type":"object"},"StaffRole":{"properties":{"value":{"type":"string"}},"required":["value"],"type":"object"},"StaffTokens":{"properties":{"access_token":{"type":"string"},"expires_in":{"format":"int64","type":"integer"},"refresh_token":{"type":"string"},"session_id":{"example":"sess_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"token_type":{"type":"string"},"user":{"$ref":"#/components/schemas/StaffUser"}},"required":["access_token","expires_in","refresh_token","session_id","token_type","user"],"type":"object"},"StaffUser":{"properties":{"active":{"type":"boolean"},"displayName":{"type":"string"},"externalId":{"description":"exact subject from the configured OIDC issuer","type":"string"},"id":{"example":"staff_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"meta":{"$ref":"#/components/schemas/StaffMeta"},"roles":{"items":{"$ref":"#/components/schemas/StaffRole"},"type":"array"},"schemas":{"items":{"type":"string"},"type":"array"},"userName":{"type":"string"}},"required":["active","externalId","roles","schemas","userName"],"type":"object"},"Standard":{"description":"Standard is one public packing unit: a strap, bundle or bag and its face value.","properties":{"aba_color":{"type":"string"},"denomination_amount":{"format":"int64","type":"integer"},"face_amount":{"format":"int64","type":"integer"},"form":{"type":"string"},"notes":{"type":"string"},"series":{"type":"string"},"unit":{"type":"string"}},"required":["aba_color","denomination_amount","face_amount","form","unit"],"type":"object"},"State":{"properties":{"allocated_minor":{"format":"int64","type":"integer"},"allowed_actions":{"items":{"type":"string"},"type":"array"},"net_recovery_minor":{"format":"int64","type":"integer"},"network_case_reference":{"type":"string"},"network_effective_at":{"format":"date-time","type":"string"},"network_sequence":{"format":"int64","type":"integer"},"outcome":{"type":"string"},"payable_minor":{"format":"int64","type":"integer"},"pending_instruction_id":{"type":"string"},"pending_instruction_sha256":{"type":"string"},"receivable_minor":{"format":"int64","type":"integer"},"respond_by":{"format":"date-time","type":"string"},"settled_cash_minor":{"format":"int64","type":"integer"},"stage":{"type":"string"},"unallocated_recovery_minor":{"format":"int64","type":"integer"}},"required":["allocated_minor","net_recovery_minor","network_sequence","payable_minor","receivable_minor","settled_cash_minor","stage","unallocated_recovery_minor"],"type":"object"},"Statement":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_amount":{"format":"int64","type":"integer"},"complete":{"type":"boolean"},"currency_code":{"type":"string"},"document_sha256":{"type":"string"},"environment":{"type":"string"},"external_account_reference":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"legal_entity":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/Line"},"type":"array"},"observed_at":{"format":"date-time","type":"string"},"opening_amount":{"format":"int64","type":"integer"},"previous_sha256":{"type":"string"},"receipt_id":{"example":"achr_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"revision":{"format":"int64","type":"integer"},"statement_reference":{"type":"string"},"version":{"type":"string"}},"required":["business_date","closing_amount","complete","currency_code","document_sha256","environment","external_account_reference","issued_at","key_id","ledger_account_id","legal_entity","lines","observed_at","opening_amount","receipt_id","revision","statement_reference","version"],"type":"object"},"StatementAdvance":{"description":"StatementAdvance is an advance outstanding at the statement date.","properties":{"accrued_interest_amount":{"format":"int64","type":"integer"},"advance_number":{"type":"string"},"maturity_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"principal_amount":{"format":"int64","type":"integer"},"program":{"type":"string"},"rate_bps":{"format":"int64","type":"integer"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["accrued_interest_amount","advance_number","maturity_date","principal_amount","program","rate_bps","value_date"],"type":"object"},"StatementArchive":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"document":{"$ref":"#/components/schemas/StatementsDocument"},"id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"issued_by":{"type":"string"},"period":{"type":"string"},"previous_id":{"type":"string"},"revision":{"format":"int64","type":"integer"},"sha256":{"type":"string"}},"required":["account_id","document","id","issued_at","issued_by","period","revision","sha256"],"type":"object"},"StatementConsent":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action":{"type":"string"},"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"disclosure":{"type":"string"},"disclosure_version":{"type":"string"},"id":{"type":"string"},"proof_id":{"type":"string"}},"required":["account_id","action","actor","created_at","customer_id","disclosure","disclosure_version","id"],"type":"object"},"StatementCorrection":{"properties":{"candidate":{"$ref":"#/components/schemas/StatementArchive"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/StatementCorrectionRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/StatementCorrectionReview"},{"type":"null"}]},"source_sha256":{"type":"string"}},"required":["candidate","id","proposed_at","proposed_by","request","source_sha256"],"type":"object"},"StatementCorrectionRequest":{"properties":{"base_id":{"type":"string"},"customer_summary":{"type":"string"},"reason":{"type":"string"}},"required":["base_id","customer_summary","reason"],"type":"object"},"StatementCorrectionReview":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"type":"string"},"reason":{"type":"string"}},"required":["actor","created_at","decision","reason"],"type":"object"},"StatementCorrectionReviewRequest":{"properties":{"decision":{"type":"string"},"reason":{"type":"string"}},"required":["decision","reason"],"type":"object"},"StatementDelivery":{"properties":{"attempts":{"format":"int64","type":"integer"},"channel":{"type":"string"},"provider_ref":{"type":"string"},"statement_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["attempts","channel","provider_ref","statement_id","status","updated_at"],"type":"object"},"StatementDeliveryJob":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"attempts":{"format":"int64","type":"integer"},"channel":{"type":"string"},"period":{"type":"string"},"provider_ref":{"type":"string"},"revision":{"format":"int64","type":"integer"},"statement_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","attempts","channel","period","provider_ref","revision","statement_id","status","updated_at"],"type":"object"},"StatementEntry":{"properties":{"amount":{"format":"int64","type":"integer"},"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"},"original_source_ref":{"type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"reversal_of":{"type":"string"},"running_amount":{"format":"int64","type":"integer"},"sequence":{"format":"int64","type":"integer"},"source_ref":{"type":"string"},"source_service":{"type":"string"}},"required":["amount","direction","effective_date","journal_id","kind","posting_date","recorded_at","running_amount","sequence","source_ref","source_service"],"type":"object"},"StatementIdentity":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"environment":{"type":"string"},"external_account_reference":{"type":"string"},"id":{"type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"legal_entity":{"type":"string"},"statement_reference":{"type":"string"}},"required":["business_date","content_sha256","environment","external_account_reference","id","ledger_account_id","legal_entity","statement_reference"],"type":"object"},"StatementInterestCredit":{"properties":{"earned_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"earned_period":{"type":"string"},"earned_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"gross_amount":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"source_kind":{"type":"string"}},"required":["earned_from","earned_period","earned_through","effective_date","gross_amount","journal_id","posting_date","recorded_at","source_kind"],"type":"object"},"StatementItem":{"description":"StatementItem is one collateral item as the lender values it: the valuation basis (a security's fair market value, a loan's estimated value or principal), the margin the lender lends at, and the lendable value that follows.","properties":{"asset_class":{"type":"string"},"basis_value_amount":{"format":"int64","type":"integer"},"eligible":{"type":"boolean"},"ineligible_reason":{"type":"string"},"kind":{"type":"string"},"lendable_amount":{"format":"int64","type":"integer"},"margin_bps":{"description":"the share of the basis value lent against","format":"int64","type":"integer"},"par_amount":{"format":"int64","type":"integer"},"price_micros":{"description":"per 100 of par, scaled by 1,000,000","format":"int64","type":"integer"},"principal_amount":{"format":"int64","type":"integer"},"reference":{"type":"string"}},"required":["asset_class","basis_value_amount","eligible","kind","lendable_amount","margin_bps","reference"],"type":"object"},"StatementLine":{"properties":{"balance_amount":{"format":"int64","type":"integer"},"credit_amount":{"format":"int64","type":"integer"},"date":{"type":"string"},"debit_amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"}},"required":["balance_amount","credit_amount","date","debit_amount","description","journal_id","kind"],"type":"object"},"StatementProof":{"properties":{"closure":{"oneOf":[{"$ref":"#/components/schemas/Closure"},{"type":"null"}]},"eod_proof_sha256":{"type":"string"},"history_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest_applicability":{"type":"string"},"kind":{"type":"string"},"monthly_completion_sha256":{"type":"string"},"monthly_result_sha256":{"type":"string"},"seals":{"items":{"$ref":"#/components/schemas/StatementSeal"},"type":"array"}},"required":["eod_proof_sha256","history_from","interest_applicability","kind","monthly_completion_sha256","monthly_result_sha256","seals"],"type":"object"},"StatementRequest":{"properties":{"evidence":{"$ref":"#/components/schemas/NetworkfinanceEvidence"},"external_reference":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/NetworkfinanceLine"},"type":"array"},"network":{"type":"string"},"statement_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["evidence","external_reference","lines","network","statement_date"],"type":"object"},"StatementRun":{"properties":{"has_more":{"type":"boolean"},"items":{"items":{"$ref":"#/components/schemas/StatementRunItem"},"type":"array"},"next":{"type":"string"}},"required":["has_more","items"],"type":"object"},"StatementRunItem":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"error":{"type":"string"},"status":{"type":"string"}},"required":["account_id","status"],"type":"object"},"StatementRunRequest":{"properties":{"after":{"type":"string"},"dispatch":{"type":"boolean"},"issue":{"type":"boolean"},"limit":{"format":"int64","type":"integer"},"period":{"type":"string"}},"required":["dispatch","issue","period"],"type":"object"},"StatementSeal":{"properties":{"period":{"type":"string"},"sha256":{"type":"string"}},"required":["period","sha256"],"type":"object"},"StatementSnapshot":{"description":"StatementSnapshot is a complete immutable financial cut, never a live preview.","properties":{"carry_after":{"type":"string"},"closing_amount":{"format":"int64","type":"integer"},"credits":{"items":{"$ref":"#/components/schemas/StatementInterestCredit"},"type":"array"},"currency_code":{"type":"string"},"cut_id":{"type":"string"},"earned_exact":{"type":"string"},"entries":{"items":{"$ref":"#/components/schemas/StatementEntry"},"type":"array"},"final":{"type":"boolean"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest_basis":{"items":{"$ref":"#/components/schemas/DailyInterestBalance"},"type":"array"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opening_amount":{"format":"int64","type":"integer"},"period":{"type":"string"},"proof":{"$ref":"#/components/schemas/StatementProof"},"through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"format":"int64","type":"integer"},"ytd_fees":{"items":{"$ref":"#/components/schemas/StatementEntry"},"type":"array"}},"required":["carry_after","closing_amount","credits","currency_code","cut_id","earned_exact","entries","final","from","interest_basis","ledger_account_id","opening_amount","period","proof","through","version","ytd_fees"],"type":"object"},"StatementStatus":{"properties":{"current":{"type":"boolean"},"current_source_sha256":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"statement_id":{"type":"string"}},"required":["current","current_source_sha256","observed_at","statement_id"],"type":"object"},"StatementSummary":{"description":"StatementSummary is a retained page's identity and balances without its entries.","properties":{"closing_booked_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"closing_booked_date":{"type":"string"},"currency_code":{"type":"string"},"electronic_sequence":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"entries":{"format":"int64","type":"integer"},"id":{"type":"string"},"last_page":{"type":"boolean"},"message_definition":{"type":"string"},"nostro_account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"opening_booked_amount":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"page_number":{"format":"int64","type":"integer"},"received_at":{"format":"date-time","type":"string"},"source":{"type":"string"},"statement_id":{"type":"string"}},"required":["currency_code","entries","id","last_page","message_definition","nostro_account_id","page_number","received_at","source","statement_id"],"type":"object"},"StatementsDocument":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"account_number_last4":{"type":"string"},"address":{"type":"string"},"apy_earned_percent":{"type":"string"},"average_daily_balance_amount":{"format":"int64","type":"integer"},"bank":{"$ref":"#/components/schemas/Bank"},"closing_amount":{"format":"int64","type":"integer"},"correction":{"oneOf":[{"$ref":"#/components/schemas/Correction"},{"type":"null"}]},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"customer_name":{"type":"string"},"days":{"format":"int64","type":"integer"},"fees":{"items":{"$ref":"#/components/schemas/StatementsFee"},"type":"array"},"final_statement":{"type":"boolean"},"from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"generated_at":{"format":"date-time","type":"string"},"interest_earned_amount":{"format":"int64","type":"integer"},"interest_paid_amount":{"format":"int64","type":"integer"},"lines":{"items":{"$ref":"#/components/schemas/StatementsLine"},"type":"array"},"opening_amount":{"format":"int64","type":"integer"},"period":{"type":"string"},"period_fees":{"$ref":"#/components/schemas/FeeTotals"},"product":{"type":"string"},"through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"version":{"format":"int64","type":"integer"},"year_fees":{"$ref":"#/components/schemas/FeeTotals"}},"required":["account_id","account_number_last4","address","apy_earned_percent","average_daily_balance_amount","bank","closing_amount","currency_code","customer_id","customer_name","days","fees","from","generated_at","interest_earned_amount","interest_paid_amount","lines","opening_amount","period","period_fees","product","through","version","year_fees"],"type":"object"},"StatementsFee":{"properties":{"amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"}},"required":["amount","date","journal_id","kind"],"type":"object"},"StatementsLine":{"properties":{"balance_amount":{"format":"int64","type":"integer"},"credit_amount":{"format":"int64","type":"integer"},"date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"debit_amount":{"format":"int64","type":"integer"},"description":{"type":"string"},"detail":{"oneOf":[{"$ref":"#/components/schemas/Detail"},{"type":"null"}]},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"type":"string"}},"required":["balance_amount","credit_amount","date","debit_amount","description","journal_id","kind"],"type":"object"},"StatusChange":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"book_id":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"enabled":{"type":"boolean"},"evidence":{"type":"string"},"expected_revision":{"format":"int64","type":"integer"},"id":{"type":"string"}},"required":["actor","at","book_id","content_sha256","enabled","evidence","expected_revision","id"],"type":"object"},"StatusRequest":{"properties":{"enabled":{"type":"boolean"},"evidence":{"type":"string"},"expected_revision":{"format":"int64","type":"integer"}},"required":["enabled","evidence","expected_revision"],"type":"object"},"StepUpRequest":{"description":"StepUpRequest proves presence by PIN or passkey.","properties":{"method":{"description":"pin or passkey","type":"string"},"pin":{"description":"six digits","type":"string"},"response":{"description":"the assertion for a passkey step-up","oneOf":[{"$ref":"#/components/schemas/PasskeyResponse"},{"type":"null"}]}},"required":["method"],"type":"object"},"StopPayment":{"description":"StopPayment is a stop payment order.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ach":{"oneOf":[{"$ref":"#/components/schemas/ACHStop"},{"type":"null"}]},"amount":{"format":"int64","type":"integer"},"check_number_high":{"type":"string"},"check_number_low":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expires_at":{"format":"date-time","type":"string"},"fee_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"matches":{"format":"int64","type":"integer"},"payee":{"type":"string"},"reason":{"type":"string"},"released_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"released_by":{"description":"the verified operator who lifted the order","type":"string"},"requested_by":{"type":"string"},"status":{"description":"active, released, expired","type":"string"},"written":{"type":"boolean"}},"required":["account_id","check_number_high","check_number_low","created_at","expires_at","id","matches","status","written"],"type":"object"},"StopPaymentRequest":{"description":"StopPaymentRequest orders the bank not to pay a check or a range of checks.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"ach":{"oneOf":[{"$ref":"#/components/schemas/ACHStop"},{"type":"null"}]},"amount":{"format":"int64","type":"integer"},"check_number":{"type":"string"},"check_number_high":{"type":"string"},"kind":{"type":"string"},"oral":{"description":"fourteen days unless confirmed in writing; written orders last six months","type":"boolean"},"payee":{"type":"string"},"reason":{"type":"string"},"requested_by":{"type":"string"}},"required":["account_id","check_number","requested_by"],"type":"object"},"Subject":{"properties":{"account_numbers":{"items":{"type":"string"},"type":"array"},"addresses":{"items":{"$ref":"#/components/schemas/Information314Address"},"type":"array"},"date_of_birth":{"type":"string"},"identification_numbers":{"items":{"$ref":"#/components/schemas/Identification"},"type":"array"},"names":{"items":{"type":"string"},"type":"array"},"phones":{"items":{"type":"string"},"type":"array"},"reference":{"type":"string"},"routing_numbers":{"items":{"type":"string"},"type":"array"},"tax_ids":{"items":{"type":"string"},"type":"array"}},"required":["names","reference"],"type":"object"},"Submission":{"description":"Submission is the Reserve Bank office's acknowledgement.","properties":{"actor":{"type":"string"},"fees":{"items":{"$ref":"#/components/schemas/FedcashFee"},"type":"array"},"operator_id":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"}},"required":["actor","fees","operator_id","recorded_at"],"type":"object"},"SubmissionReceipt":{"description":"SubmissionReceipt is the carrier's answer that it holds the submission. It is not an agency decision.","properties":{"agency":{"type":"string"},"content_sha256":{"type":"string"},"environment":{"type":"string"},"kind":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"reference":{"type":"string"}},"required":["agency","content_sha256","environment","kind","received_at","reference"],"type":"object"},"SupplementalInput":{"description":"SupplementalInput opens a further production under a legal request, for material captured since, or an amended scope evidenced by the request's parties.","properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"},"scope":{"oneOf":[{"$ref":"#/components/schemas/LegalScope"},{"type":"null"}]}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"SupportDocument":{"description":"SupportDocument is the one CSV attachment a SARX activity names, whether the batch was generated natively or imported with those exact bytes. The SAR XML User Guide 1.6 (section 4.5 and Attachment E) permits one MS Excel-compatible CSV of at most one megabyte per SAR, recorded by its full name in OriginalAttachmentFileName; batch filers place each CSV in the attachment zip file named <activity SeqNum>_<OriginalAttachmentFileName>. The exact bytes are a separate encrypted payload released only with the approved batch naming them.","properties":{"activity_sequence":{"format":"int64","type":"integer"},"bytes":{"format":"int64","type":"integer"},"file_name":{"type":"string"},"sha256":{"type":"string"},"submission_file_name":{"type":"string"}},"required":["activity_sequence","bytes","file_name","sha256","submission_file_name"],"type":"object"},"Suppression":{"properties":{"accepted":{"type":"boolean"},"action":{"type":"string"},"actor":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"evidence":{"type":"string"},"id":{"type":"string"},"reason":{"type":"string"}},"required":["accepted","action","actor","address","channel","created_at","evidence","id","reason"],"type":"object"},"SuppressionRequest":{"properties":{"accepted":{"type":"boolean"},"action":{"type":"string"},"address":{"type":"string"},"channel":{"type":"string"},"evidence":{"type":"string"},"reason":{"type":"string"}},"required":["accepted","action","address","channel","evidence","reason"],"type":"object"},"SweepAuthorization":{"description":"Generated Placement.Actor and Redemption.Actor retain Mandate.Consent.Actor, the real authorizing customer. Run.Actor and persistence events identify the actual executing bridge; callers must never synthesize customer claims or a fresh human approval to execute this retained standing authority.","properties":{"bridge_subject":{"type":"string"},"mandate":{"$ref":"#/components/schemas/SweepMandate"},"run":{"$ref":"#/components/schemas/SweepRunBinding"},"sha256":{"type":"string"},"version":{"type":"string"}},"required":["bridge_subject","mandate","run","sha256","version"],"type":"object"},"SweepConsent":{"properties":{"accepted_at":{"format":"date-time","type":"string"},"actor":{"type":"string"},"content_sha256":{"type":"string"},"id":{"type":"string"},"mandate_id":{"type":"string"},"request":{"$ref":"#/components/schemas/SweepConsentRequest"},"source":{"$ref":"#/components/schemas/PlacementsSource"}},"required":["accepted_at","actor","content_sha256","id","mandate_id","request","source"],"type":"object"},"SweepConsentRequest":{"properties":{"agency_consent":{"type":"boolean"},"disclosure_sha256":{"type":"string"},"full_position_redemption":{"type":"boolean"},"mandate_sha256":{"type":"string"},"standing_sweep_consent":{"type":"boolean"},"target_overshoot":{"type":"boolean"}},"required":["agency_consent","disclosure_sha256","full_position_redemption","mandate_sha256","standing_sweep_consent","target_overshoot"],"type":"object"},"SweepDueItem":{"properties":{"detail":{"type":"string"},"error_code":{"type":"string"},"mandate_id":{"type":"string"},"operation":{"type":"string"},"run_id":{"type":"string"}},"required":["mandate_id"],"type":"object"},"SweepDueRequest":{"description":"SweepDueRequest bounds a pass by the authenticated program bridge. The service derives eligible mandates; callers cannot supply another bridge.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"limit":{"format":"int64","type":"integer"},"starting_after":{"type":"string"}},"required":["business_date"],"type":"object"},"SweepDueResult":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"has_more":{"type":"boolean"},"next_cursor":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SweepDueItem"},"type":"array"}},"required":["business_date","has_more","results"],"type":"object"},"SweepMandate":{"properties":{"actor":{"type":"string"},"consent":{"oneOf":[{"$ref":"#/components/schemas/SweepConsent"},{"type":"null"}]},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PlacementsDecision"},{"type":"null"}]},"disclosure":{"$ref":"#/components/schemas/PlacementsDisclosure"},"id":{"type":"string"},"program":{"$ref":"#/components/schemas/PlacementsControl"},"source":{"$ref":"#/components/schemas/PlacementsSource"},"terms":{"$ref":"#/components/schemas/SweepTerms"}},"required":["actor","content_sha256","created_at","disclosure","id","program","source","terms"],"type":"object"},"SweepObservation":{"description":"InventoryComplete records the trusted application's complete source query. None of these scalar observations is itself proof of available future funds.","properties":{"available_amount":{"format":"int64","type":"integer"},"blockers":{"items":{"type":"string"},"type":"array"},"capacity":{"oneOf":[{"$ref":"#/components/schemas/PlacementsControl"},{"type":"null"}]},"inventory_complete":{"type":"boolean"},"observed_at":{"format":"date-time","type":"string"},"positions":{"items":{"$ref":"#/components/schemas/SweepPosition"},"type":"array"},"source":{"$ref":"#/components/schemas/PlacementsSource"}},"required":["available_amount","blockers","inventory_complete","observed_at","positions","source"],"type":"object"},"SweepPosition":{"description":"MandateID is derived by the application from the retained origin authority; it is never accepted as customer-supplied evidence of an eligible position.","properties":{"mandate_id":{"type":"string"},"placement":{"$ref":"#/components/schemas/Placement"}},"required":["placement"],"type":"object"},"SweepRecord":{"properties":{"mandate":{"$ref":"#/components/schemas/SweepMandate"},"state":{"$ref":"#/components/schemas/SweepState"}},"required":["mandate","state"],"type":"object"},"SweepRun":{"properties":{"actor":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"consent_sha256":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"mandate_id":{"type":"string"},"mandate_sha256":{"type":"string"},"observation":{"$ref":"#/components/schemas/SweepObservation"},"selection":{"$ref":"#/components/schemas/SweepSelection"}},"required":["actor","business_date","consent_sha256","content_sha256","created_at","id","mandate_id","mandate_sha256","observation","selection"],"type":"object"},"SweepRunBinding":{"description":"The full run is independently durable. Its exact source and deterministic selection must be reverified by the application before issuing or claiming.","properties":{"actor":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"observation_sha256":{"type":"string"},"selection":{"$ref":"#/components/schemas/SweepSelection"},"source":{"$ref":"#/components/schemas/PlacementsSource"}},"required":["actor","business_date","content_sha256","created_at","id","observation_sha256","selection","source"],"type":"object"},"SweepRunRecord":{"description":"The exact original accepted mandate remains with every immutable run even after the customer pauses, cancels or accepts the mandate again.","properties":{"mandate":{"$ref":"#/components/schemas/SweepMandate"},"run":{"$ref":"#/components/schemas/SweepRun"}},"required":["mandate","run"],"type":"object"},"SweepRunRequest":{"properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["business_date"],"type":"object"},"SweepRunResult":{"properties":{"placement":{"oneOf":[{"$ref":"#/components/schemas/Placement"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/SweepRunRecord"}},"required":["source"],"type":"object"},"SweepSelection":{"properties":{"amount":{"description":"principal; redemption interest remains actual receipt evidence","format":"int64","type":"integer"},"blockers":{"items":{"type":"string"},"type":"array"},"operation":{"description":"place, redeem, noop, refused","type":"string"},"placement_id":{"type":"string"},"reason":{"type":"string"},"redemption_id":{"type":"string"}},"required":["amount","blockers","operation","reason"],"type":"object"},"SweepState":{"description":"Lifecycle is separate from immutable review, acceptance and run evidence. A pause needs a new current customer acceptance before execution resumes.","properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"consent_id":{"type":"string"},"mandate_id":{"type":"string"},"reason":{"type":"string"},"revision":{"format":"int64","type":"integer"},"status":{"type":"string"}},"required":["actor","at","mandate_id","reason","revision","status"],"type":"object"},"SweepStateRequest":{"properties":{"action":{"description":"pause or cancel; acceptance is a separate customer action","type":"string"},"reason":{"type":"string"}},"required":["action","reason"],"type":"object"},"SweepTerms":{"description":"SweepTerms authorize one demand program and full-position redemption only. The source service must prove this is an open USD DDA with exactly one owner.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"full_position_redemption":{"type":"boolean"},"high_watermark":{"format":"int64","type":"integer"},"low_watermark":{"format":"int64","type":"integer"},"max_daily_outward_amount":{"format":"int64","type":"integer"},"program_id":{"type":"string"},"target_balance":{"format":"int64","type":"integer"},"target_overshoot":{"type":"boolean"},"valid_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"valid_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["account_id","full_position_redemption","high_watermark","low_watermark","max_daily_outward_amount","program_id","target_balance","target_overshoot","valid_from","valid_through"],"type":"object"},"SwiftAddress":{"description":"Address is a postal address in the elements of PostalAddress24.","properties":{"building_name":{"type":"string"},"building_number":{"type":"string"},"country":{"type":"string"},"country_sub_division":{"type":"string"},"department":{"type":"string"},"district_name":{"type":"string"},"floor":{"type":"string"},"lines":{"items":{"type":"string"},"type":"array"},"post_box":{"type":"string"},"post_code":{"type":"string"},"room":{"type":"string"},"street_name":{"type":"string"},"sub_department":{"type":"string"},"town_location_name":{"type":"string"},"town_name":{"type":"string"}},"type":"object"},"SwiftBankTransferRequest":{"description":"SwiftBankTransferRequest sends the bank's own funds to another institution (CBPR+ pacs.009).","properties":{"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"creditor_account":{"type":"string"},"creditor_bic":{"type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"end_to_end_id":{"type":"string"},"gl_code":{"type":"string"},"operator":{"type":"string"},"remittance":{"type":"string"}},"required":["amount","creditor_bic","currency_code","gl_code"],"type":"object"},"SwiftCancellation":{"description":"SwiftCancellation is a cancellation case (camt.056 and its camt.029).","properties":{"assignment_id":{"type":"string"},"case_id":{"example":"case_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"counterparty_bic":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"direction":{"type":"string"},"id":{"type":"string"},"network_ref":{"type":"string"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"requested_by":{"type":"string"},"resolution":{"type":"string"},"resolution_reason":{"type":"string"},"resolution_reason_code":{"type":"string"},"return_payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["assignment_id","case_id","counterparty_bic","created_at","direction","id","payment_id","reason_code","requested_by","status","updated_at"],"type":"object"},"SwiftCancellationRequest":{"description":"SwiftCancellationRequest asks the next agent to cancel or return a payment the bank sent.","properties":{"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"description":"ExternalCancellationReason1Code","type":"string"}},"required":["reason_code"],"type":"object"},"SwiftCorrections":{"description":"SwiftCorrections are what a resend from the repair queue may correct.","properties":{"creditor":{"oneOf":[{"$ref":"#/components/schemas/Party"},{"type":"null"}]},"creditor_agent_bic":{"type":"string"},"remittance":{"oneOf":[{"type":"string"},{"type":"null"}]}},"type":"object"},"SwiftMessage":{"description":"SwiftMessage is a message the bank exchanged with the network.","properties":{"biz_msg_id":{"type":"string"},"cancellation_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"direction":{"type":"string"},"id":{"format":"int64","type":"integer"},"msg_def":{"type":"string"},"network_ref":{"type":"string"},"network_status":{"type":"string"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"possible_duplicate":{"type":"boolean"},"raw_sha256":{"type":"string"},"receiver_bic":{"type":"string"},"refusal_code":{"type":"string"},"refusal_reason":{"type":"string"},"role":{"type":"string"},"sender_bic":{"type":"string"},"uetr":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"violations":{"items":{"$ref":"#/components/schemas/Violation"},"type":"array"}},"required":["biz_msg_id","created_at","direction","id","msg_def","network_status","raw_sha256","receiver_bic","role","sender_bic","updated_at"],"type":"object"},"SwiftNotification":{"description":"Notification is what the network tells the bank about a message it accepted or a payment the bank originated.","properties":{"at":{"format":"date-time","type":"string"},"biz_msg_id":{"type":"string"},"id":{"description":"unique per notification; a redelivered notification repeats it","type":"string"},"kind":{"type":"string"},"msg_def":{"type":"string"},"network_ref":{"type":"string"},"reason":{"type":"string"},"receiver":{"type":"string"},"tracker":{"oneOf":[{"$ref":"#/components/schemas/TrackerEvent"},{"type":"null"}]},"uetr":{"type":"string"}},"required":["at","id","kind"],"type":"object"},"SwiftPayment":{"description":"SwiftPayment is a SWIFT payment in either direction: a customer transfer, a bank transfer or a return.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"the instructed amount","format":"int64","type":"integer"},"approved_by":{"type":"string"},"charge_bearer":{"type":"string"},"correspondent_bic":{"description":"the next agent outbound, the previous one inbound","type":"string"},"cover_bic":{"type":"string"},"cover_msg_id":{"type":"string"},"cover_network_ref":{"type":"string"},"cover_network_status":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"creditor":{"$ref":"#/components/schemas/Party"},"creditor_agent_bic":{"type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"debit_amount":{"description":"outbound: the amount, the bank's fee and prepaid charges","format":"int64","type":"integer"},"debtor":{"$ref":"#/components/schemas/Party"},"debtor_agent_bic":{"type":"string"},"deducted_charges_amount":{"format":"int64","type":"integer"},"direction":{"description":"outbound or inbound","type":"string"},"end_to_end_id":{"type":"string"},"fee_amount":{"format":"int64","type":"integer"},"fx_quote_id":{"type":"string"},"gl_code":{"type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"instr_id":{"type":"string"},"intermediary_bic":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"customer, bank or return","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"msg_id":{"type":"string"},"network_ref":{"type":"string"},"network_status":{"type":"string"},"operator":{"type":"string"},"original_payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"prepaid_charges_amount":{"format":"int64","type":"integer"},"purpose":{"type":"string"},"queued_until":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"reason":{"type":"string"},"remittance":{"type":"string"},"repair_id":{"type":"string"},"return_reason":{"type":"string"},"return_reason_code":{"type":"string"},"returned_amount":{"format":"int64","type":"integer"},"reversal_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"screening_id":{"example":"scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"screening_result":{"type":"string"},"settlement_amount":{"format":"int64","type":"integer"},"settlement_method":{"description":"INDA, INGA or COVE","type":"string"},"status":{"description":"received, held_for_review, queued, sending, sent, completed, repair, rejected, returned, cancelled, credited or blocked","type":"string"},"tracker_reason":{"type":"string"},"tracker_status":{"type":"string"},"uetr":{"type":"string"},"ultimate_creditor":{"$ref":"#/components/schemas/Party"},"ultimate_debtor":{"$ref":"#/components/schemas/Party"},"updated_at":{"format":"date-time","type":"string"},"value_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["amount","created_at","creditor","currency_code","debtor","direction","id","kind","settlement_amount","status","uetr","ultimate_creditor","ultimate_debtor","updated_at"],"type":"object"},"SwiftPaymentDetail":{"description":"SwiftPaymentDetail is a payment with its messages, tracker events, cases and returns.","properties":{"cancellations":{"items":{"$ref":"#/components/schemas/SwiftCancellation"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/SwiftMessage"},"type":"array"},"payment":{"$ref":"#/components/schemas/SwiftPayment"},"returns":{"items":{"$ref":"#/components/schemas/SwiftPayment"},"type":"array"},"tracker":{"items":{"$ref":"#/components/schemas/SwiftTrackerEvent"},"type":"array"}},"required":["cancellations","messages","payment","returns","tracker"],"type":"object"},"SwiftRelease":{"description":"SwiftRelease is what a release of the SWIFT queue did.","properties":{"failed":{"format":"int64","type":"integer"},"payment_ids":{"items":{"type":"string"},"type":"array"},"released":{"format":"int64","type":"integer"},"waiting":{"format":"int64","type":"integer"}},"required":["failed","payment_ids","released","waiting"],"type":"object"},"SwiftRepair":{"description":"SwiftRepair is an item in the SWIFT repair queue.","properties":{"actions":{"items":{"type":"string"},"type":"array"},"cancellation_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"kind":{"type":"string"},"outcome":{"type":"string"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"proposal":{"oneOf":[{"$ref":"#/components/schemas/SwiftRepairProposal"},{"type":"null"}]},"reason":{"type":"string"},"status":{"description":"open, proposed, executing or resolved","type":"string"},"updated_at":{"format":"date-time","type":"string"},"violations":{"items":{"$ref":"#/components/schemas/Violation"},"type":"array"}},"required":["actions","created_at","id","kind","reason","status","updated_at"],"type":"object"},"SwiftRepairDecision":{"description":"SwiftRepairDecision is an entry of a repair's maker-checker record.","properties":{"action":{"type":"string"},"actor":{"type":"string"},"event":{"description":"proposed, approved, rejected, executed or failed","type":"string"},"outcome":{"type":"string"},"proposal":{"additionalProperties":true,"type":"object"},"recorded_at":{"format":"date-time","type":"string"}},"required":["action","actor","event","proposal","recorded_at"],"type":"object"},"SwiftRepairDecisionRequest":{"description":"SwiftRepairDecisionRequest is a checker's decision.","properties":{"decision":{"description":"approve or reject","type":"string"},"operator":{"type":"string"}},"required":["decision"],"type":"object"},"SwiftRepairDetail":{"description":"SwiftRepairDetail is a repair with its record and what it is about.","properties":{"cancellation":{"oneOf":[{"$ref":"#/components/schemas/SwiftCancellation"},{"type":"null"}]},"decisions":{"items":{"$ref":"#/components/schemas/SwiftRepairDecision"},"type":"array"},"payment":{"oneOf":[{"$ref":"#/components/schemas/SwiftPayment"},{"type":"null"}]},"repair":{"$ref":"#/components/schemas/SwiftRepair"}},"required":["decisions","repair"],"type":"object"},"SwiftRepairProposal":{"description":"SwiftRepairProposal is a maker's proposed decision on a repair.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action":{"type":"string"},"amount":{"format":"int64","type":"integer"},"corrections":{"oneOf":[{"$ref":"#/components/schemas/SwiftCorrections"},{"type":"null"}]},"gl_code":{"type":"string"},"maker":{"type":"string"},"note":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["action","maker","proposed_at"],"type":"object"},"SwiftRepairProposalRequest":{"description":"SwiftRepairProposalRequest is a maker's proposal.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"action":{"description":"apply, release, return, reject, resend, cancel, honour or refuse, as the repair allows","type":"string"},"amount":{"format":"int64","type":"integer"},"corrections":{"oneOf":[{"$ref":"#/components/schemas/SwiftCorrections"},{"type":"null"}]},"gl_code":{"type":"string"},"note":{"type":"string"},"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"}},"required":["action"],"type":"object"},"SwiftReturnRequest":{"description":"SwiftReturnRequest proposes returning a credited payment the bank received.","properties":{"amount":{"format":"int64","type":"integer"},"note":{"type":"string"},"operator":{"type":"string"},"reason":{"type":"string"},"reason_code":{"description":"ExternalReturnReason1Code","type":"string"}},"required":["reason_code"],"type":"object"},"SwiftRoute":{"description":"SwiftRoute is a currency route with its window and where it stands now.","properties":{"correspondent_bic":{"type":"string"},"correspondent_name":{"type":"string"},"currency_code":{"type":"string"},"cutoff":{"type":"string"},"debt_charges_amount":{"format":"int64","type":"integer"},"fee_amount":{"format":"int64","type":"integer"},"inbound_fee_amount":{"format":"int64","type":"integer"},"next_opening":{"format":"date-time","type":"string"},"nostro_gl":{"type":"string"},"open":{"type":"boolean"},"opens":{"type":"string"},"value_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"zone":{"type":"string"}},"required":["correspondent_bic","currency_code","cutoff","debt_charges_amount","fee_amount","inbound_fee_amount","next_opening","nostro_gl","open","opens","value_date","zone"],"type":"object"},"SwiftRoutes":{"description":"SwiftRoutes is the bank's SWIFT identity and routing.","properties":{"bic":{"type":"string"},"configured":{"type":"boolean"},"direct_bics":{"items":{"type":"string"},"type":"array"},"embargoed_countries":{"items":{"type":"string"},"type":"array"},"routes":{"items":{"$ref":"#/components/schemas/SwiftRoute"},"type":"array"},"simulated":{"type":"boolean"}},"required":["bic","configured","direct_bics","embargoed_countries","routes","simulated"],"type":"object"},"SwiftTracker":{"description":"SwiftTracker is what the bank recorded on a UETR and what the simulated tracker holds.","properties":{"network":{"oneOf":[{"$ref":"#/components/schemas/TrackerRecord"},{"type":"null"}]},"network_error":{"type":"string"},"recorded":{"items":{"$ref":"#/components/schemas/SwiftTrackerEvent"},"type":"array"},"uetr":{"type":"string"}},"required":["recorded","uetr"],"type":"object"},"SwiftTrackerEvent":{"description":"SwiftTrackerEvent is a status recorded against a UETR.","properties":{"confirmed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"event":{"$ref":"#/components/schemas/TrackerEvent"},"id":{"format":"int64","type":"integer"},"payment_id":{"example":"lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"source":{"description":"network, bank or message","type":"string"}},"required":["event","id","recorded_at","source"],"type":"object"},"SwiftTransferRequest":{"description":"SwiftTransferRequest is an outbound SWIFT customer credit transfer (CBPR+ pacs.008) from an account, in the account's currency.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"charge_bearer":{"description":"DEBT, CRED or SHAR (the default)","type":"string"},"confirm_duplicate":{"type":"boolean"},"creditor":{"allOf":[{"$ref":"#/components/schemas/Party"}],"description":"name, structured or hybrid address (town and country) and account (IBAN or other)"},"creditor_agent_bic":{"type":"string"},"currency_code":{"description":"ISO 4217 code","type":"string"},"end_to_end_id":{"description":"NOTPROVIDED when empty","type":"string"},"fx_quote_id":{"description":"a foreign exchange quote booked elsewhere in the bank","type":"string"},"intermediary_bic":{"type":"string"},"purpose":{"description":"ExternalPurpose1Code","type":"string"},"remittance":{"description":"up to 140 characters","type":"string"},"ultimate_creditor":{"oneOf":[{"$ref":"#/components/schemas/Party"},{"type":"null"}]},"ultimate_debtor":{"oneOf":[{"$ref":"#/components/schemas/Party"},{"type":"null"}]}},"required":["account_id","amount","creditor","creditor_agent_bic","currency_code"],"type":"object"},"SyncPositions":{"description":"SyncPositions is one sync and the positions it wrote.","properties":{"positions":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"sync":{"$ref":"#/components/schemas/SyncRecord"}},"required":["positions","sync"],"type":"object"},"SyncRecord":{"description":"SyncRecord is one sync of a business date: what it read and who asked for it.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"gl_lines":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"kind":{"description":"current or historical","type":"string"},"period":{"type":"string"},"positions":{"format":"int64","type":"integer"},"requested_by":{"type":"string"},"source":{"description":"trial_balance or closing_snapshot","type":"string"},"source_sha256":{"type":"string"},"synced_at":{"format":"date-time","type":"string"},"ties":{"type":"boolean"}},"required":["business_date","gl_lines","id","kind","period","positions","requested_by","source","synced_at","ties"],"type":"object"},"Syndicate":{"description":"Syndicate is the bank's share of a syndicated credit.","properties":{"agent":{"type":"string"},"our_share_bps":{"format":"int64","type":"integer"},"reference":{"type":"string"},"total_commitment_amount":{"format":"int64","type":"integer"}},"required":["agent","our_share_bps","total_commitment_amount"],"type":"object"},"TINNotice":{"description":"TINNotice is a recorded listing and the B notice it calls for. The second B notice is due when the same account was listed with the same TIN in a notice dated in the same or either of the two preceding calendar years.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"b_notice":{"description":"first or second","type":"string"},"b_notice_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cure":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"notice":{"description":"CP2100 or CP2100A","type":"string"},"notice_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"prior_notice_id":{"type":"string"},"received_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"tin_last4":{"description":"the last four digits of the TIN the notice lists","type":"string"},"withholding_due":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["account_id","b_notice","b_notice_due","cure","customer_id","id","notice","notice_date","received_on","recorded_at","recorded_by","tin_last4","withholding_due"],"type":"object"},"TINNoticeRequest":{"description":"TINNoticeRequest records one account the IRS listed on a CP2100 or CP2100A notice as having a name and TIN that do not match its records.","properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"notice":{"description":"CP2100 or CP2100A","type":"string"},"notice_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"received_on":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"tin_last4":{"description":"the last four digits of the TIN the notice lists","type":"string"}},"required":["account_id","customer_id","notice","notice_date","received_on","tin_last4"],"type":"object"},"Target":{"properties":{"service":{"type":"string"},"source":{"type":"string"}},"required":["service","source"],"type":"object"},"TaxAsFiled":{"description":"TaxAsFiled is the payee identity exactly as the original return was filed, taken from the payer's copy of the filed return. The accounts service never stores it.","properties":{"address":{"$ref":"#/components/schemas/DomainTaxRecipientAddress"},"name":{"type":"string"},"tin":{"description":"nine digits, as filed","type":"string"},"tin_type":{"description":"ssn or ein","type":"string"}},"required":["address","name","tin","tin_type"],"type":"object"},"TaxCertification":{"description":"TaxCertification is the W-9 or W-8 furnished by the customer.","properties":{"chapter3_status":{"description":"W-8BEN-E only","type":"string"},"chapter4_status":{"description":"W-8BEN-E only","type":"string"},"foreign_tin":{"description":"on a W-8 only; sealed by the customers service","type":"string"},"form":{"description":"w9, w8ben or w8bene","type":"string"},"giin":{"description":"W-8BEN-E only: required for chapter 4 status 05-09, 32 or 35, refused otherwise","type":"string"},"received_at":{"description":"YYYY-MM-DD","type":"string"},"tax_id":{"description":"W-9 only: the TIN, recorded when the customers service holds none sealed","type":"string"},"tin_certified":{"type":"boolean"},"tin_validation":{"description":"TINValidation (ssa7028 for an individual, letter147c for an entity) and its document\nreference accompany a certified W-9 curing a second B notice.","type":"string"},"tin_validation_ref":{"type":"string"},"treaty_country":{"type":"string"}},"required":["form","received_at","tin_certified"],"type":"object"},"TaxCorrection":{"description":"TaxCorrection is one payee's correction. Error is the kind of error in the return as filed: - amounts: incorrect amounts (a one-transaction \"G\" correction with the figures as they should have been); - not_reportable: the return should not have been filed (\"G\", every amount zero); - tin_or_name: an incorrect or missing TIN or payee name (a two-transaction correction: a \"G\" record repeating the return exactly as filed, from AsFiled, with every amount zero, then a \"C\" record with the current TIN, name and figures).","properties":{"as_filed":{"oneOf":[{"$ref":"#/components/schemas/TaxAsFiled"},{"type":"null"}]},"as_filed_identity_id":{"description":"customers vault snapshot for this payee, form and tax year","type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"error":{"type":"string"}},"required":["customer_id","error"],"type":"object"},"TaxCorrectionRequest":{"description":"TaxCorrectionRequest asks for a corrected Form 1099-INT file for one tax year (Publication 1220 Part A Sec. 11).","properties":{"corrections":{"items":{"$ref":"#/components/schemas/TaxCorrection"},"type":"array"},"year":{"format":"int64","type":"integer"}},"required":["corrections","year"],"type":"object"},"TaxDeliveryConsent":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"confirmation":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"policy_id":{"type":"string"},"policy_sha256":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/TaxDeliveryConsentRequest"}},"required":["account_id","confirmation","customer_id","id","policy_id","policy_sha256","recorded_at","request"],"type":"object"},"TaxDeliveryConsentRequest":{"properties":{"acknowledged_can_access":{"type":"boolean"},"capability_proof_id":{"type":"string"},"decision":{"type":"string"},"policy_id":{"type":"string"}},"required":["acknowledged_can_access","decision","policy_id"],"type":"object"},"TaxDeliveryDisclosure":{"properties":{"availability_through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"hardware_software":{"type":"string"},"obtaining_paper":{"type":"string"},"paper_default":{"type":"string"},"scope_and_duration":{"type":"string"},"termination":{"type":"string"},"updating_contact":{"type":"string"},"withdrawal_and_confirmation":{"type":"string"},"withdrawal_confirmation":{"type":"string"}},"required":["availability_through","hardware_software","obtaining_paper","paper_default","scope_and_duration","termination","updating_contact","withdrawal_and_confirmation","withdrawal_confirmation"],"type":"object"},"TaxDepositSchedule":{"description":"TaxDepositSchedule is the deposit plan for an EFTPS recipient's form and tax year, computed from every registered obligation of its kind whose payment date falls in the tax year.","properties":{"deposits":{"items":{"$ref":"#/components/schemas/TaxDepositStatus"},"type":"array"},"form":{"type":"string"},"kind":{"type":"string"},"plan":{"$ref":"#/components/schemas/DepositPlan"},"recipient_id":{"type":"string"},"schedule":{"type":"string"},"tax_year":{"format":"int64","type":"integer"},"through":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"}},"required":["deposits","form","kind","plan","recipient_id","tax_year","through"],"type":"object"},"TaxDepositStatus":{"description":"TaxDepositStatus is one computed deposit and how much of it is still unpaid.","properties":{"deposit":{"$ref":"#/components/schemas/Deposit"},"obligation_ids":{"items":{"type":"string"},"type":"array"},"unpaid_minor":{"format":"int64","type":"integer"}},"required":["deposit","obligation_ids","unpaid_minor"],"type":"object"},"TaxDepositTerms":{"description":"TaxDepositTerms bind the bank's EFTPS ACH credit enrollment for one return and tax year.","properties":{"deposit_schedule":{"type":"string"},"enrollment_evidence_reference":{"type":"string"},"enrollment_evidence_sha256":{"type":"string"},"form":{"type":"string"},"schedule_evidence_reference":{"type":"string"},"schedule_evidence_sha256":{"type":"string"},"tax_year":{"format":"int64","type":"integer"},"taxpayer_ein":{"type":"string"},"taxpayer_name":{"type":"string"}},"required":["enrollment_evidence_reference","enrollment_evidence_sha256","form","tax_year","taxpayer_ein","taxpayer_name"],"type":"object"},"TaxDocumentIdentification":{"properties":{"identity":{"$ref":"#/components/schemas/TaxDocumentIdentity"},"tax_id":{"type":"string"}},"required":["identity","tax_id"],"type":"object"},"TaxDocumentIdentity":{"description":"TaxDocumentIdentity is prepared-document evidence; it makes no filing or furnishing claim and reveals only the last four of its retained encrypted TIN.","properties":{"address":{"$ref":"#/components/schemas/Address"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"document_ref":{"type":"string"},"id":{"type":"string"},"legal_name":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"type":"string"},"recorded_for":{"type":"string"},"tax_id_last4":{"type":"string"},"tax_year":{"format":"int64","type":"integer"},"tin_type":{"type":"string"}},"required":["address","customer_id","document_ref","id","legal_name","recorded_at","recorded_by","tax_id_last4","tax_year","tin_type"],"type":"object"},"TaxDocumentIdentityRequest":{"properties":{"document_ref":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["document_ref","tax_year"],"type":"object"},"TaxForm":{"description":"TaxForm is one customer's information return for a year.","properties":{"accounts":{"items":{"type":"string"},"type":"array"},"address":{"oneOf":[{"$ref":"#/components/schemas/TaxRecipientAddress"},{"type":"null"}]},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"form":{"description":"1099-INT, 1042-S or none","type":"string"},"interest_amount":{"format":"int64","type":"integer"},"name":{"type":"string"},"note":{"type":"string"},"reportable":{"type":"boolean"},"tin_last4":{"type":"string"},"tin_status":{"description":"on_file, collect_again or not_required","type":"string"},"tin_type":{"description":"ssn or ein","type":"string"},"withheld_amount":{"format":"int64","type":"integer"}},"required":["accounts","customer_id","form","interest_amount","reportable","withheld_amount"],"type":"object"},"TaxFurnishing":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"consent_id":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"late_forms":{"items":{"type":"string"},"type":"array"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/TaxFurnishingRequest"},"status":{"type":"string"}},"required":["account_id","customer_id","id","late_forms","proposed_at","proposed_by","request","status"],"type":"object"},"TaxFurnishingRequest":{"properties":{"delivery_reference":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"method":{"type":"string"},"notification_evidence_sha256":{"type":"string"},"packet_id":{"type":"string"},"reason":{"type":"string"},"recipient_sha256":{"type":"string"},"sent_at":{"format":"date-time","type":"string"}},"required":["delivery_reference","evidence_ref","evidence_sha256","method","notification_evidence_sha256","packet_id","reason","recipient_sha256","sent_at"],"type":"object"},"TaxIdentification":{"description":"TaxIdentification is the full tax id for information returns, with the W-8 details: the foreign TIN and, for an entity on a W-8BEN-E, its chapter 3 and chapter 4 status codes and, for the chapter 4 statuses that need one (05-09, 32, 35), its GIIN. TaxID is empty when the customers service holds no sealed U.S. tax id.","properties":{"chapter3_status":{"type":"string"},"chapter4_status":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"foreign_tin":{"type":"string"},"foreign_tin_key_id":{"type":"string"},"giin":{"type":"string"},"key_id":{"type":"string"},"tax_id":{"type":"string"}},"required":["customer_id","key_id","tax_id"],"type":"object"},"TaxIssuer":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"ein":{"type":"string"},"legal_name":{"type":"string"},"telephone":{"type":"string"}},"required":["address","ein","legal_name","telephone"],"type":"object"},"TaxPacket":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"content_sha256":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"forms":{"items":{"$ref":"#/components/schemas/RetirementTaxForm"},"type":"array"},"id":{"type":"string"},"identity":{"$ref":"#/components/schemas/TaxDocumentIdentity"},"issuer":{"$ref":"#/components/schemas/TaxIssuer"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"recipient_html":{"type":"string"},"recipient_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/TaxPacketRequest"},"source_sha256":{"type":"string"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["account_id","content_sha256","customer_id","forms","id","identity","issuer","proposed_at","proposed_by","recipient_html","recipient_sha256","request","source_sha256","status","version"],"type":"object"},"TaxPacketExport":{"properties":{"packet":{"$ref":"#/components/schemas/TaxPacket"},"recipient_tin":{"type":"string"}},"required":["packet","recipient_tin"],"type":"object"},"TaxPacketRequest":{"properties":{"annual_position_id":{"type":"string"},"beneficiary_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"corrects_packet_id":{"type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"policy_id":{"type":"string"},"reason":{"type":"string"},"rmd_review_id":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["annual_position_id","evidence_ref","evidence_sha256","expected_version","policy_id","reason","tax_year"],"type":"object"},"TaxPolicy":{"properties":{"content_sha256":{"type":"string"},"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"id":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"request":{"$ref":"#/components/schemas/TaxPolicyRequest"},"status":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["content_sha256","id","proposed_at","proposed_by","request","status","version"],"type":"object"},"TaxPolicyRequest":{"properties":{"delivery_disclosure":{"$ref":"#/components/schemas/TaxDeliveryDisclosure"},"effective_at":{"format":"date-time","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"expected_version":{"format":"int64","type":"integer"},"fmv_and_rmd_deadline":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"instructions":{"additionalProperties":{"type":"string"},"type":"object"},"instructions_version":{"type":"string"},"issuer":{"$ref":"#/components/schemas/TaxIssuer"},"reason":{"type":"string"},"recipient_deadlines":{"additionalProperties":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"type":"object"},"schema_revision":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["delivery_disclosure","effective_at","evidence_ref","evidence_sha256","expected_version","fmv_and_rmd_deadline","instructions","instructions_version","issuer","reason","recipient_deadlines","schema_revision","tax_year"],"type":"object"},"TaxRecipientAddress":{"description":"TaxRecipientAddress is the recipient's address as the customers service holds it.","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"TaxRecord":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"cash_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"cash_date_source":{"type":"string"},"command_id":{"type":"string"},"contribution_box":{"type":"string"},"contribution_minor":{"format":"int64","type":"integer"},"contribution_tax_year":{"format":"int64","type":"integer"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"distribution_code":{"type":"string"},"earnings_minor":{"format":"int64","type":"integer"},"executed_at":{"format":"date-time","type":"string"},"form":{"type":"string"},"gross_minor":{"format":"int64","type":"integer"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"tax_year":{"format":"int64","type":"integer"},"taxable_minor":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"taxable_undetermined":{"type":"boolean"},"withheld_minor":{"format":"int64","type":"integer"}},"required":["account_id","cash_date","cash_date_source","command_id","customer_id","executed_at","form","gross_minor","journal_id","tax_year","taxable_undetermined"],"type":"object"},"TaxRecords":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"next_cursor":{"type":"string"},"records":{"items":{"$ref":"#/components/schemas/TaxRecord"},"type":"array"},"tax_year":{"format":"int64","type":"integer"}},"required":["account_id","records","tax_year"],"type":"object"},"TaxYear":{"description":"TaxYear is the year's 1099-INT and 1042-S figures.","properties":{"forms":{"items":{"$ref":"#/components/schemas/TaxForm"},"type":"array"},"note":{"type":"string"},"tax_year":{"format":"int64","type":"integer"}},"required":["forms","note","tax_year"],"type":"object"},"TaxonomyManifest":{"properties":{"archive":{"$ref":"#/components/schemas/AssetDigest"},"dependencies":{"items":{"$ref":"#/components/schemas/AssetDigest"},"type":"array"},"entry_point":{"type":"string"},"files":{"items":{"$ref":"#/components/schemas/AssetDigest"},"type":"array"},"form":{"type":"string"},"namespace":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"retrieved_on":{"type":"string"},"source":{"type":"string"},"version":{"type":"string"}},"required":["archive","dependencies","entry_point","files","form","namespace","report_date","retrieved_on","source","version"],"type":"object"},"TaxonomyReference":{"properties":{"column":{"type":"string"},"line":{"type":"string"},"schedule":{"type":"string"}},"required":["column","line","schedule"],"type":"object"},"Term":{"description":"Term is a certificate of deposit's contract.","properties":{"at_maturity":{"description":"rollover or pay_out","type":"string"},"broker":{"description":"the deposit broker of record","type":"string"},"brokered":{"description":"deposits taken through an intermediary (RC-E memoranda)","type":"boolean"},"early_withdrawal_penalty":{"description":"days_of_interest","type":"string"},"grace_days":{"description":"days after maturity to withdraw without penalty","format":"int64","type":"integer"},"minimum_deposit_minor":{"description":"the smallest opening deposit, in minor units; 0 means none. Enforced by accounts at funding","format":"int64","type":"integer"},"months":{"format":"int64","type":"integer"},"penalty_days":{"description":"days of simple interest forfeited on early withdrawal","format":"int64","type":"integer"},"rollover_product_code":{"description":"the product the balance rolls into (often itself)","type":"string"}},"required":["at_maturity","brokered","early_withdrawal_penalty","grace_days","months","penalty_days","rollover_product_code"],"type":"object"},"Terminal":{"description":"Terminal is a boarded terminal with its active configuration and state.","properties":{"active_version":{"format":"int64","type":"integer"},"cash_unit_id":{"type":"string"},"config":{"oneOf":[{"$ref":"#/components/schemas/TerminalConfig"},{"type":"null"}]},"created_at":{"format":"date-time","type":"string"},"created_by":{"type":"string"},"id":{"type":"string"},"state":{"$ref":"#/components/schemas/TerminalState"},"status":{"description":"pending_review, active, rejected","type":"string"},"terminal_id":{"type":"string"}},"required":["active_version","cash_unit_id","created_at","created_by","id","state","status","terminal_id"],"type":"object"},"TerminalConfig":{"description":"TerminalConfig is one proposed version of a terminal's configuration.","properties":{"cash_ledger_account_id":{"description":"the unit's GL 1020 ledger account, as accounts reported it","example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"maker":{"type":"string"},"request":{"$ref":"#/components/schemas/TerminalRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/AtmReview"},{"type":"null"}]},"terminal_ref":{"description":"the terminal's id (atmt_)","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["cash_ledger_account_id","created_at","id","maker","request","terminal_ref","version"],"type":"object"},"TerminalRequest":{"description":"TerminalRequest boards a terminal or proposes a new configuration for it. Terminal settings that decide what a cardholder pays or can do are controls: each version is independently reviewed before the switch uses it.","properties":{"address":{"$ref":"#/components/schemas/AtmAddress"},"cash_unit_id":{"description":"the accounts ATM custody unit on GL 1020","type":"string"},"cassettes":{"items":{"$ref":"#/components/schemas/Cassette"},"type":"array"},"evidence":{"type":"string"},"low_cash_threshold_amount":{"description":"estimated cassette cash below this requests replenishment","format":"int64","type":"integer"},"max_notes":{"format":"int64","type":"integer"},"max_withdrawal_amount":{"format":"int64","type":"integer"},"name":{"type":"string"},"operations":{"items":{"type":"string"},"type":"array"},"surcharge_amount":{"description":"disclosed on screen to cards other banks issued (12 CFR 1005.16)","format":"int64","type":"integer"},"terminal_id":{"description":"8 characters, the network card acceptor terminal identification","type":"string"}},"required":["address","cash_unit_id","cassettes","evidence","low_cash_threshold_amount","max_notes","max_withdrawal_amount","name","operations","surcharge_amount","terminal_id"],"type":"object"},"TerminalState":{"description":"TerminalState is the terminal's live operating state.","properties":{"available_operations":{"items":{"type":"string"},"type":"array"},"cassettes":{"items":{"$ref":"#/components/schemas/CassetteState"},"type":"array"},"commanded_out_of_service":{"type":"boolean"},"counter_cycle":{"format":"int64","type":"integer"},"devices":{"additionalProperties":{"type":"string"},"type":"object"},"last_sequence":{"format":"int64","type":"integer"},"out_of_cash":{"type":"boolean"},"retract_bin_notes":{"format":"int64","type":"integer"},"sequence_epoch":{"format":"int64","type":"integer"},"supervisor":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["available_operations","cassettes","commanded_out_of_service","counter_cycle","devices","last_sequence","out_of_cash","retract_bin_notes","sequence_epoch","supervisor","updated_at"],"type":"object"},"Terms":{"description":"Terms are reviewed contract requirements. True/false assertions alone cannot establish their legal enforceability; the retained opinions and agreement do.","properties":{"accounting":{"description":"secured_borrowing","type":"string"},"accounting_opinion":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"automatic_renewal":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"bank_entitled_and_obligated":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"concurrent_repurchase_agreement":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"counterparty_may_reuse":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"day_count":{"description":"actual_360 or actual_365","type":"string"},"default_policy":{"description":"preserve_obligation_governed_resolution","type":"string"},"default_procedures":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"early_termination":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"enforceability_opinion":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"floating_rate":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"margin_policy":{"description":"daily_two_sided_review","type":"string"},"margin_procedures":{"$ref":"#/components/schemas/BanksecuritiesEvidence"},"rounding":{"description":"cumulative_half_up_cent","type":"string"},"same_securities_return":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"segregated_collateral":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"substitution":{"oneOf":[{"type":"boolean"},{"type":"null"}]}},"required":["accounting","accounting_opinion","day_count","default_policy","default_procedures","enforceability_opinion","margin_policy","margin_procedures","rounding"],"type":"object"},"TermsRequest":{"description":"TermsRequest proposes an account's terms from an effective date.","properties":{"cutoff":{"$ref":"#/components/schemas/CutoffWindow"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"interest":{"$ref":"#/components/schemas/InterestTerms"},"liquidity":{"$ref":"#/components/schemas/LiquidityTerms"},"monthly_fees":{"items":{"$ref":"#/components/schemas/MonthlyFee"},"type":"array"},"payment_charges":{"items":{"$ref":"#/components/schemas/PaymentCharge"},"type":"array"},"reconciliation":{"$ref":"#/components/schemas/ReconciliationTerms"},"routed_bic_prefixes":{"description":"RoutedBICPrefixes are the destination banks this account reaches, as BIC prefixes at the\nlengths a BIC is meaningful at: four characters for an institution anywhere, six for it in\none country, eight for one of its offices and eleven for one branch. A payment to a\ndestination one of them heads settles through this account rather than the currency's\nprimary one, which is how a currency with more than one correspondent is split by\nwhere the money is going. Empty leaves the account to the primary route.","items":{"type":"string"},"type":"array"},"source_ref":{"type":"string"}},"required":["cutoff","effective_date","interest","liquidity","monthly_fees","payment_charges","reconciliation","source_ref"],"type":"object"},"ThreeDSEvidence":{"description":"ThreeDSEvidence is the 3-D Secure result an e-commerce authorisation carries.","properties":{"authentication_value":{"type":"string"},"eci":{"type":"string"}},"required":["authentication_value","eci"],"type":"object"},"ThresholdChange":{"description":"ThresholdChange is a recorded monitoring or BSA parameter row, or a proposal with its decision.","properties":{"decided_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"decided_by":{"type":"string"},"decision_note":{"type":"string"},"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"id":{"description":"the proposal; zero for a recorded row","format":"int64","type":"integer"},"name":{"type":"string"},"reason":{"type":"string"},"recorded_at":{"format":"date-time","type":"string"},"recorded_by":{"description":"who recorded or proposed the change","type":"string"},"request_id":{"example":"req_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"description":"recorded, pending, approved, rejected or withdrawn","type":"string"},"value":{"format":"int64","type":"integer"}},"required":["effective_from","name","reason","recorded_at","recorded_by","status","value"],"type":"object"},"ThresholdDecision":{"description":"ThresholdDecision approves or rejects another staff member's proposal (operations:approve), or withdraws one's own.","properties":{"decision":{"description":"approved, rejected or withdrawn","type":"string"},"note":{"type":"string"}},"required":["decision","note"],"type":"object"},"ThresholdProposal":{"description":"ThresholdProposal proposes one parameter from a date after today's business date.","properties":{"effective_from":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"name":{"type":"string"},"reason":{"type":"string"},"value":{"format":"int64","type":"integer"}},"required":["effective_from","name","reason","value"],"type":"object"},"ThresholdsView":{"description":"ThresholdsView is the parameters in force on a business date and every recorded change.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"history":{"items":{"$ref":"#/components/schemas/ThresholdChange"},"type":"array"},"parameters":{"additionalProperties":{"format":"int64","type":"integer"},"type":"object"}},"required":["business_date","history","parameters"],"type":"object"},"Tier":{"properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"minimum_balance_minor":{"format":"int64","type":"integer"}},"required":["annual_rate_bps","minimum_balance_minor"],"type":"object"},"Tiering":{"properties":{"method":{"description":"whole_balance (Reg DD method A) or marginal (method B)","type":"string"},"tiers":{"items":{"$ref":"#/components/schemas/Tier"},"type":"array"}},"required":["method","tiers"],"type":"object"},"Token":{"description":"Token is a network token's current state as the bank holds it. It carries no token number.","properties":{"assurance":{"type":"string"},"card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"controls":{"$ref":"#/components/schemas/NetworktokensControls"},"created_at":{"format":"date-time","type":"string"},"decision":{"$ref":"#/components/schemas/NetworktokensDecision"},"device_sha256":{"type":"string"},"domain_controls":{"$ref":"#/components/schemas/DomainControls"},"effective_status":{"type":"string"},"holder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"issuer_status":{"type":"string"},"issuer_suspended_by":{"description":"holder or staff","type":"string"},"last_network_event_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"merchant_id":{"type":"string"},"network":{"type":"string"},"network_status":{"type":"string"},"original_card_id":{"example":"card_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"sequence":{"format":"int64","type":"integer"},"token_expiry_month":{"format":"int64","type":"integer"},"token_expiry_year":{"format":"int64","type":"integer"},"token_last4":{"type":"string"},"token_reference":{"type":"string"},"token_requestor_id":{"type":"string"},"token_requestor_name":{"type":"string"},"token_type":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"use_case":{"type":"string"},"wallet_consent_id":{"type":"string"}},"required":["assurance","card_id","controls","created_at","decision","domain_controls","effective_status","holder_customer_id","id","issuer_status","network","network_status","original_card_id","sequence","token_expiry_month","token_expiry_year","token_last4","token_reference","token_requestor_id","token_requestor_name","token_type","updated_at","use_case"],"type":"object"},"TokenRequest":{"properties":{"consent_id":{"type":"string"}},"required":["consent_id"],"type":"object"},"TokenResponse":{"description":"TokenResponse is an issued service token.","properties":{"access_token":{"description":"the Bearer token, an EdDSA JWT","type":"string"},"expires_in":{"description":"seconds until it expires","format":"int64","type":"integer"},"scope":{"description":"the scopes it carries","type":"string"},"token_type":{"description":"Bearer","type":"string"}},"required":["access_token","expires_in","scope","token_type"],"type":"object"},"Tokens":{"description":"Tokens is an open session: the access token, the refresh token that rotates on use, and the device the session is bound to.","properties":{"access_token":{"type":"string"},"device_id":{"example":"dev_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"expires_in":{"description":"seconds until the access token expires","format":"int64","type":"integer"},"is_known_device":{"description":"the device was seen before and is trusted","type":"boolean"},"refresh_token":{"type":"string"},"session_id":{"example":"sess_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"token_type":{"description":"Bearer","type":"string"},"user":{"$ref":"#/components/schemas/User"}},"required":["access_token","device_id","expires_in","is_known_device","refresh_token","session_id","token_type","user"],"type":"object"},"Totals":{"description":"Totals are a file's trailer control totals.","properties":{"credit_count":{"format":"int64","type":"integer"},"credit_minor":{"format":"int64","type":"integer"},"debit_count":{"format":"int64","type":"integer"},"debit_minor":{"format":"int64","type":"integer"},"interchange_minor":{"format":"int64","type":"integer"},"net_settlement_minor":{"description":"signed: positive is paid to the issuer","format":"int64","type":"integer"},"scheme_fee_minor":{"format":"int64","type":"integer"},"transaction_count":{"format":"int64","type":"integer"}},"required":["credit_count","credit_minor","debit_count","debit_minor","interchange_minor","net_settlement_minor","scheme_fee_minor","transaction_count"],"type":"object"},"TrackerEvent":{"description":"TrackerEvent is one status a party in the chain recorded against a UETR.","properties":{"agent_bic":{"description":"who reported the status","type":"string"},"amount":{"description":"the amount the agent confirmed (credited, or forwarded)","format":"int64","type":"integer"},"charges_amount":{"description":"charges the agent deducted","format":"int64","type":"integer"},"charges_currency_code":{"type":"string"},"currency_code":{"type":"string"},"exchange_rate":{"type":"string"},"forwarded_to_bic":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"reason":{"description":"a G code on ACSP, an ExternalStatusReason1Code on RJCT","type":"string"},"source_message":{"description":"the message definition behind the status, when there is one","type":"string"},"status":{"description":"ACSP, ACSC, ACCC or RJCT","type":"string"},"uetr":{"type":"string"}},"required":["agent_bic","occurred_at","status","uetr"],"type":"object"},"TrackerRecord":{"description":"TrackerRecord is what the tracker holds on a payment: every event, oldest first.","properties":{"events":{"items":{"$ref":"#/components/schemas/TrackerEvent"},"type":"array"},"originator_bic":{"type":"string"},"uetr":{"type":"string"}},"required":["events","originator_bic","uetr"],"type":"object"},"Transaction":{"properties":{"accounting_plans":{"items":{"$ref":"#/components/schemas/AccountingPlan"},"type":"array"},"accrued_to_date":{"description":"exclusive start boundary","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"actor":{"type":"string"},"admissions":{"items":{"$ref":"#/components/schemas/Admission"},"type":"array"},"cancellation":{"oneOf":[{"$ref":"#/components/schemas/Cancellation"},{"type":"null"}]},"collateral":{"items":{"$ref":"#/components/schemas/Collateral"},"type":"array"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"custody_proofs":{"items":{"$ref":"#/components/schemas/CustodyProof"},"type":"array"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"exceptions":{"items":{"type":"string"},"type":"array"},"funding":{"oneOf":[{"$ref":"#/components/schemas/Funding"},{"type":"null"}]},"funding_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"instruction":{"oneOf":[{"$ref":"#/components/schemas/BankrepoInstruction"},{"type":"null"}]},"program":{"$ref":"#/components/schemas/BankrepoControl"},"repayment":{"oneOf":[{"$ref":"#/components/schemas/Repayment"},{"type":"null"}]},"repayment_hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"repayment_instruction":{"oneOf":[{"$ref":"#/components/schemas/RepaymentInstruction"},{"type":"null"}]},"repayment_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"request":{"$ref":"#/components/schemas/CreateRequest"},"request_sha256":{"type":"string"},"status":{"type":"string"}},"required":["actor","admissions","collateral","content_sha256","created_at","custody_proofs","exceptions","id","program","request","request_sha256","status"],"type":"object"},"Transactions":{"description":"Transactions is an account's activity with running balance.","properties":{"account":{"$ref":"#/components/schemas/AccountsAccount"},"closing_amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/StatementLine"},"type":"array"},"opening_amount":{"format":"int64","type":"integer"}},"required":["account","closing_amount","currency_code","lines","opening_amount"],"type":"object"},"Transfer":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"change_id":{"description":"the notification of change applied at origination","type":"string"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string"},"effective_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"file_id":{"example":"achf_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"hold_id":{"example":"hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"iat":{"oneOf":[{"$ref":"#/components/schemas/IATDetails"},{"type":"null"}]},"id":{"example":"acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"originator_id":{"description":"the Originator whose exposure limit the entry counts against","type":"string"},"prenote":{"type":"boolean"},"prenote_status":{"description":"pending, verified, returned or changed","type":"string"},"return_code":{"type":"string"},"return_reason":{"type":"string"},"reversal_journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"same_day":{"description":"settles in a Same Day ACH window on the effective date","type":"boolean"},"screening_result":{"type":"string"},"sec_code":{"type":"string"},"status":{"type":"string"},"trace_number":{"type":"string"}},"required":["account_id","amount","counterparty","created_at","currency_code","description","direction","effective_date","file_id","hold_id","id","journal_id","return_code","return_reason","reversal_journal_id","same_day","sec_code","status","trace_number"],"type":"object"},"TransferLimit":{"description":"TransferLimit is the convenient-transfer limit of a savings or money market product. Reg D's six-per-month rule was suspended in April 2020; banks that keep one make it a product setting.","properties":{"enforcement":{"description":"refuse or fee","type":"string"},"excess_fee_minor":{"format":"int64","type":"integer"},"per_statement_cycle":{"description":"0 means no limit","format":"int64","type":"integer"}},"required":["enforcement","excess_fee_minor","per_statement_cycle"],"type":"object"},"TransferLimitStatus":{"description":"TransferLimitStatus is where an account stands against its product's convenient-transfer limit in the current statement cycle.","properties":{"cycle":{"type":"string"},"enforcement":{"description":"refuse or fee","type":"string"},"excess_fee_amount":{"format":"int64","type":"integer"},"per_cycle":{"format":"int64","type":"integer"},"remaining":{"format":"int64","type":"integer"},"used":{"format":"int64","type":"integer"}},"required":["cycle","enforcement","excess_fee_amount","per_cycle","remaining","used"],"type":"object"},"TransferRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"counterparty":{"$ref":"#/components/schemas/Counterparty"},"currency_code":{"description":"ISO 4217 code","type":"string"},"description":{"type":"string"},"direction":{"type":"string"},"effective_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"iat":{"description":"the international addenda; sec_code IAT","oneOf":[{"$ref":"#/components/schemas/IATDetails"},{"type":"null"}]},"prenote":{"description":"a zero-dollar prenotification that verifies the counterparty's account; live entries may follow three banking days after it settles","type":"boolean"},"same_day":{"description":"settle today in the next Same Day ACH window (limit $1,000,000.00 per entry, no IAT)","type":"boolean"},"sec_code":{"type":"string"}},"required":["account_id","amount","counterparty","currency_code","description","direction","sec_code"],"type":"object"},"TransferSummary":{"description":"TransferSummary is the shape every rail shares in the unified list: ACH, book, wire and realtime transfers together, newest first. The rail's own endpoint has the full object.","properties":{"account_id":{"description":"the customer account moved","example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"counterparty_account_id":{"description":"the receiving account of a book transfer","example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"created_at":{"format":"date-time","type":"string"},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"direction":{"description":"outbound, inbound or internal","type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rail":{"description":"fednow or rtp for realtime transfers","type":"string"},"status":{"type":"string"},"type":{"description":"ach, book, wire or realtime","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["account_id","amount","created_at","currency_code","description","direction","id","status","type","updated_at"],"type":"object"},"TrustedKey":{"properties":{"id":{"type":"string"},"network":{"type":"string"},"public_key":{"type":"string"},"valid_from":{"format":"date-time","type":"string"},"valid_through":{"format":"date-time","type":"string"}},"required":["id","network","public_key","valid_from","valid_through"],"type":"object"},"USDEquivalentLine":{"description":"USDEquivalentLine is one GL line held in a foreign currency, as the close translated it. Both amounts are in the GL's normal balance direction, as the trial balance reports balances.","properties":{"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"closing_rate_sheet_id":{"type":"string"},"currency_code":{"type":"string"},"gl_code":{"type":"string"},"native_amount":{"format":"int64","type":"integer"},"normal_balance":{"type":"string"},"usd_equivalent_amount":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["business_date","closing_rate_sheet_id","currency_code","gl_code","native_amount","normal_balance","usd_equivalent_amount","usd_per_foreign_major"],"type":"object"},"UnclaimedPropertyItem":{"description":"UnclaimedPropertyItem is one property of a holder report: the escheat obligation it reports and the owner and property facts copied from the bank's records. The owner's tax identifier is named by a sealed identifier record, never carried in the request.","properties":{"account_number":{"type":"string"},"addition_minor":{"format":"int64","type":"integer"},"addition_type":{"type":"string"},"additional_owners":{"items":{"$ref":"#/components/schemas/NAUPAOwner"},"type":"array"},"check_number":{"type":"string"},"deduction_minor":{"format":"int64","type":"integer"},"deduction_type":{"type":"string"},"description":{"type":"string"},"interest_bearing":{"type":"boolean"},"interest_rate":{"format":"int64","type":"integer"},"last_transaction":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"obligation_id":{"type":"string"},"owner":{"$ref":"#/components/schemas/NAUPAOwner"},"owner_identifier_id":{"type":"string"},"property_type":{"type":"string"},"reported_minor":{"format":"int64","type":"integer"}},"required":["addition_minor","deduction_minor","interest_bearing","interest_rate","last_transaction","obligation_id","owner","property_type","reported_minor"],"type":"object"},"UnclaimedPropertyReport":{"description":"UnclaimedPropertyReport is a proposed holder report, its review, submission and acknowledgments.","properties":{"acknowledgments":{"items":{"$ref":"#/components/schemas/AgencyAcknowledgment"},"type":"array"},"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/PayablesDecision"},{"type":"null"}]},"id":{"type":"string"},"obligations":{"items":{"$ref":"#/components/schemas/Obligation"},"type":"array"},"remittance_reference":{"type":"string"},"remitted_minor":{"format":"int64","type":"integer"},"report_sha256":{"type":"string"},"request":{"$ref":"#/components/schemas/UnclaimedPropertyReportRequest"},"schedule":{"$ref":"#/components/schemas/HolderReportSchedule"},"state":{"type":"string"},"submission":{"oneOf":[{"$ref":"#/components/schemas/AgencySubmission"},{"type":"null"}]},"summary":{"$ref":"#/components/schemas/NAUPASummary"}},"required":["actor","content_sha256","created_at","id","obligations","remitted_minor","report_sha256","request","schedule","state","summary"],"type":"object"},"UnclaimedPropertyReportRequest":{"description":"UnclaimedPropertyReportRequest proposes one holder report for an approved unclaimed property recipient.","properties":{"properties":{"items":{"$ref":"#/components/schemas/UnclaimedPropertyItem"},"type":"array"},"recipient_id":{"type":"string"},"report_number":{"format":"int64","type":"integer"},"report_type":{"type":"string"},"report_year":{"format":"int64","type":"integer"}},"required":["properties","recipient_id","report_number","report_type","report_year"],"type":"object"},"UnclaimedPropertyTerms":{"description":"UnclaimedPropertyTerms bind the bank's holder enrollment with one state administrator.","properties":{"enrollment_evidence_reference":{"type":"string"},"enrollment_evidence_sha256":{"type":"string"},"holder":{"$ref":"#/components/schemas/NAUPAHolder"},"portal_holder_id":{"type":"string"},"state":{"type":"string"}},"required":["enrollment_evidence_reference","enrollment_evidence_sha256","holder","portal_holder_id","state"],"type":"object"},"Unit":{"properties":{"actor":{"type":"string"},"code":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"custodian":{"type":"string"},"evidence":{"type":"string"},"id":{"type":"string"},"kind":{"description":"vault, teller, atm; a device is a custody location, not a device certification","type":"string"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"location":{"type":"string"}},"required":["actor","code","created_at","custodian","evidence","id","kind","ledger_account_id","location"],"type":"object"},"UnitRequest":{"properties":{"code":{"type":"string"},"custodian":{"type":"string"},"evidence":{"type":"string"},"kind":{"description":"vault, teller, atm; a device is a custody location, not a device certification","type":"string"},"location":{"type":"string"}},"required":["code","custodian","evidence","kind","location"],"type":"object"},"Upload":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"parts":{"format":"int64","type":"integer"},"received_parts":{"format":"int64","type":"integer"},"record":{"oneOf":[{"$ref":"#/components/schemas/BankrecordsRecord"},{"type":"null"}]},"record_id":{"type":"string"},"request":{"$ref":"#/components/schemas/DocumentRequest"},"status":{"description":"open, completed or cancelled","type":"string"}},"required":["actor","created_at","parts","received_parts","record_id","request","status"],"type":"object"},"Usage":{"properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"funding_source_sha256":{"type":"string"},"funding_source_snapshot":{"additionalProperties":true,"type":"object"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"monitor_id":{"type":"string"},"plan_id":{"type":"string"},"policy_id":{"type":"string"},"registry_ids":{"items":{"type":"string"},"type":"array"},"request":{"$ref":"#/components/schemas/UseRequest"},"reservation_id":{"type":"string"},"status":{"description":"authorized or committed; unknown posting keeps authorization and capacity","type":"string"}},"required":["actor","created_at","id","plan_id","policy_id","registry_ids","request","reservation_id","status"],"type":"object"},"UseRequest":{"properties":{"amount":{"format":"int64","type":"integer"},"currency_code":{"type":"string"},"destination_amount":{"description":"net borrower credit; affiliate scope currently requires this equal gross Amount","format":"int64","type":"integer"},"destination_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"journal_key":{"type":"string"},"journal_kind":{"type":"string"},"journal_source_ref":{"type":"string"},"source_ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"terms_sha256":{"type":"string"},"transaction_ref":{"type":"string"},"use_ref":{"type":"string"}},"required":["amount","currency_code","destination_amount","destination_ledger_account_id","journal_key","journal_kind","journal_source_ref","source_ledger_account_id","terms_sha256","transaction_ref","use_ref"],"type":"object"},"User":{"description":"User is a customer login.","properties":{"created_at":{"format":"date-time","type":"string"},"customer_bound":{"type":"boolean"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"email":{"type":"string"},"has_pin":{"type":"boolean"},"id":{"example":"user_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"locked_until":{"description":"set while the login is locked after failed attempts","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"description":"active, locked, closed","type":"string"}},"required":["created_at","customer_bound","email","has_pin","id","status"],"type":"object"},"ValidationIssue":{"properties":{"code":{"type":"string"},"level":{"type":"string"},"message":{"type":"string"}},"required":["code","level","message"],"type":"object"},"ValidationReport":{"description":"ValidationReport is the bridge's complete schema + filing-rule result for an immutable configured ruleset. Findings are retained even on failure. The actual validator implementation must run the full schemas and business rules; manifest inspection is not sufficient to issue a successful report.","properties":{"batch_sha256":{"type":"string"},"business_rules_id":{"type":"string"},"business_rules_valid":{"type":"boolean"},"findings":{"items":{"type":"string"},"type":"array"},"form":{"type":"string"},"schema_bundle_sha256":{"type":"string"},"schema_valid":{"type":"boolean"},"validator_version":{"type":"string"}},"required":["batch_sha256","business_rules_id","business_rules_valid","findings","form","schema_bundle_sha256","schema_valid","validator_version"],"type":"object"},"ValidationRequest":{"properties":{"scope":{"type":"string"}},"required":["scope"],"type":"object"},"ValidationResult":{"properties":{"custom_edits_executed":{"format":"int64","type":"integer"},"custom_edits_status":{"type":"string"},"custom_edits_total":{"format":"int64","type":"integer"},"excluded_assets":{"items":{"$ref":"#/components/schemas/AssetDigest"},"type":"array"},"exit_code":{"format":"int64","type":"integer"},"failure":{"type":"string"},"issues":{"items":{"$ref":"#/components/schemas/ValidationIssue"},"type":"array"},"log_sha256":{"type":"string"},"log_xml":{"type":"string"},"process_output":{"type":"string"},"runtime":{"$ref":"#/components/schemas/ValidatorRuntime"},"scope":{"type":"string"},"status":{"type":"string"}},"required":["custom_edits_executed","custom_edits_status","custom_edits_total","excluded_assets","exit_code","issues","runtime","scope","status"],"type":"object"},"ValidatorRuntime":{"properties":{"executable_sha256":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"type":"object"},"Valuation":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"book_id":{"type":"string"},"business_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"content_sha256":{"type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/FxDecision"},{"type":"null"}]},"evidence":{"type":"string"},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"rate_observed_at":{"format":"date-time","type":"string"},"rate_reference":{"type":"string"},"rate_sha256":{"type":"string"},"source":{"$ref":"#/components/schemas/FxPosition"},"target_usd_minor":{"format":"int64","type":"integer"},"usd_per_foreign_major":{"type":"string"}},"required":["actor","at","book_id","business_date","content_sha256","evidence","id","rate_observed_at","rate_reference","rate_sha256","source","target_usd_minor","usd_per_foreign_major"],"type":"object"},"ValuationRecord":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"decision":{"oneOf":[{"$ref":"#/components/schemas/BanksecuritiesDecision"},{"type":"null"}]},"id":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"posting_date":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"request":{"$ref":"#/components/schemas/ValuationRequest"},"result":{"$ref":"#/components/schemas/ValuationState"}},"required":["actor","content_sha256","created_at","id","request","result"],"type":"object"},"ValuationRequest":{"properties":{"inputs":{"$ref":"#/components/schemas/AccountingInputs"},"lot_id":{"type":"string"},"lot_revision":{"format":"int64","type":"integer"},"observation":{"$ref":"#/components/schemas/Observation"},"rationale":{"type":"string"}},"required":["inputs","lot_id","lot_revision","observation","rationale"],"type":"object"},"ValuationState":{"properties":{"accrual_to_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"amortized_cost_amount":{"format":"int64","type":"integer"},"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"credit_allowance_amount":{"format":"int64","type":"integer"},"deferred_tax_asset_amount":{"description":"net of reviewed valuation allowances","format":"int64","type":"integer"},"deferred_tax_liability_amount":{"format":"int64","type":"integer"},"fair_value_adjustment_amount":{"format":"int64","type":"integer"},"fair_value_amount":{"format":"int64","type":"integer"},"net_oci_amount":{"format":"int64","type":"integer"},"pretax_oci_amount":{"format":"int64","type":"integer"},"tax_earnings_amount":{"description":"positive cumulative benefit, negative expense","format":"int64","type":"integer"},"tax_oci_amount":{"format":"int64","type":"integer"}},"required":["accrual_to_date","amortized_cost_amount","as_of","credit_allowance_amount","deferred_tax_asset_amount","deferred_tax_liability_amount","fair_value_adjustment_amount","fair_value_amount","net_oci_amount","pretax_oci_amount","tax_earnings_amount","tax_oci_amount"],"type":"object"},"VerifiedReceipt":{"properties":{"config_sha256":{"type":"string"},"key":{"$ref":"#/components/schemas/SchemesTrustedKey"},"receipt":{"$ref":"#/components/schemas/SchemesReceipt"},"received_at":{"format":"date-time","type":"string"}},"required":["config_sha256","key","receipt","received_at"],"type":"object"},"VersionDisposition":{"properties":{"deleted":{"format":"int64","type":"integer"},"recorded_at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/VersionDispositionRequest"},"request_sha256":{"type":"string"},"service":{"type":"string"}},"required":["deleted","recorded_at","request","request_sha256","service"],"type":"object"},"VersionDispositionRequest":{"description":"VersionDispositionRequest is the hub's independently approved instruction to remove an inventory source's retained row versions superseded on or before Through. It applies only to a source under no acknowledged preservation; the archive keeps what it captured.","properties":{"command_id":{"type":"string"},"evidence_sha256":{"type":"string"},"matter_id":{"type":"string"},"on_behalf_of":{"type":"string"},"purpose":{"type":"string"},"source":{"type":"string"},"through":{"format":"date-time","type":"string"}},"required":["command_id","evidence_sha256","matter_id","on_behalf_of","purpose","source","through"],"type":"object"},"View":{"description":"View is an account with its balances and product.","properties":{"balances":{"$ref":"#/components/schemas/Balances"},"certificate":{"oneOf":[{"$ref":"#/components/schemas/CertificateTerms"},{"type":"null"}]},"closed_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"currency_code":{"type":"string"},"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"default_account_number":{"type":"string"},"default_account_number_id":{"example":"acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"description":{"type":"string"},"id":{"type":"string"},"interest_plan":{"type":"boolean"},"ledger_account_id":{"example":"lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"now_eligibility_id":{"type":"string"},"opened_at":{"format":"date-time","type":"string"},"owners":{"items":{"type":"string"},"type":"array"},"ownership":{"$ref":"#/components/schemas/Ownership"},"ownership_recorded_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"ownership_revision":{"description":"zero means unknown legacy chronology","format":"int64","type":"integer"},"product":{"additionalProperties":true,"type":"object"},"product_code":{"type":"string"},"product_version":{"format":"int64","type":"integer"},"restrictions":{"$ref":"#/components/schemas/Restrictions"},"routing_number":{"type":"string"},"statement_cycle":{"type":"string"},"status":{"type":"string"},"status_reason":{"type":"string"},"type":{"type":"string"}},"required":["balances","currency_code","customer_id","default_account_number","default_account_number_id","description","id","interest_plan","ledger_account_id","opened_at","owners","ownership","product","product_code","product_version","restrictions","routing_number","statement_cycle","status","type"],"type":"object"},"Violation":{"description":"Violation is one breach of a usage guideline rule: the element, the rule as the guideline names it (or the base standard's constraint) and what was wrong.","properties":{"detail":{"type":"string"},"element":{"type":"string"},"rule":{"type":"string"}},"required":["detail","element","rule"],"type":"object"},"Vote":{"properties":{"decision":{"type":"string"},"did_not_participate":{"type":"boolean"},"director_id":{"type":"string"}},"required":["decision","did_not_participate","director_id"],"type":"object"},"WalletsAuthorizationRequest":{"properties":{"receipt":{"$ref":"#/components/schemas/WalletsReceipt"},"transaction":{"$ref":"#/components/schemas/WalletsTransaction"}},"required":["receipt","transaction"],"type":"object"},"WalletsControl":{"properties":{"actor":{"type":"string"},"at":{"format":"date-time","type":"string"},"request":{"$ref":"#/components/schemas/ControlRequest"},"result":{"$ref":"#/components/schemas/WalletsToken"}},"required":["actor","at","request","result"],"type":"object"},"WalletsEvent":{"properties":{"actor":{"type":"string"},"receipt":{"$ref":"#/components/schemas/WalletsReceipt"},"received_at":{"format":"date-time","type":"string"},"result":{"$ref":"#/components/schemas/WalletsToken"},"trust_config_sha256":{"type":"string"},"verification_key":{"$ref":"#/components/schemas/WalletsTrustedKey"}},"required":["actor","receipt","received_at","result","trust_config_sha256","verification_key"],"type":"object"},"WalletsHistory":{"properties":{"local_controls":{"items":{"$ref":"#/components/schemas/WalletsControl"},"type":"array"},"more_local_controls":{"type":"boolean"},"more_network_events":{"type":"boolean"},"network_events":{"items":{"$ref":"#/components/schemas/WalletsEvent"},"type":"array"},"token":{"$ref":"#/components/schemas/WalletsToken"}},"required":["local_controls","more_local_controls","more_network_events","network_events","token"],"type":"object"},"WalletsPayload":{"description":"Payload is the versioned, domain-separated processor receipt. SigningBytes is normative: typed JSON in this field order with the timestamp normalized to UTC. Activate requires issuer_identity_verified; authorize requires cryptogram_verified.","properties":{"action":{"type":"string"},"device_sha256":{"type":"string"},"event_reference":{"type":"string"},"evidence_reference":{"type":"string"},"evidence_sha256":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"key_id":{"type":"string"},"network":{"type":"string"},"network_token_reference":{"type":"string"},"requestor_id":{"type":"string"},"sequence":{"format":"int64","type":"integer"},"token_id":{"type":"string"},"transaction_sha256":{"type":"string"},"verification":{"type":"string"},"version":{"type":"string"}},"required":["action","device_sha256","event_reference","evidence_reference","evidence_sha256","issued_at","key_id","network","network_token_reference","requestor_id","sequence","token_id","version"],"type":"object"},"WalletsReceipt":{"properties":{"payload":{"$ref":"#/components/schemas/WalletsPayload"},"signature":{"description":"standard base64 Ed25519 signature","type":"string"}},"required":["payload","signature"],"type":"object"},"WalletsToken":{"properties":{"consent_device_sha256":{"type":"string"},"consent_session_sha256":{"type":"string"},"consent_step_up_at":{"format":"date-time","type":"string"},"consented_at":{"format":"date-time","type":"string"},"consented_by":{"type":"string"},"effective_status":{"type":"string"},"enrollment":{"$ref":"#/components/schemas/EnrollmentRequest"},"holder_customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"local_sequence":{"format":"int64","type":"integer"},"local_status":{"type":"string"},"network":{"type":"string"},"network_sequence":{"format":"int64","type":"integer"},"network_status":{"type":"string"},"network_token_reference":{"type":"string"}},"required":["consent_device_sha256","consent_session_sha256","consent_step_up_at","consented_at","consented_by","effective_status","enrollment","holder_customer_id","id","local_sequence","local_status","network","network_sequence","network_status"],"type":"object"},"WalletsTransaction":{"properties":{"amount":{"format":"int64","type":"integer"},"channel":{"type":"string"},"country":{"type":"string"},"currency_code":{"type":"string"},"mcc":{"type":"string"},"merchant_id":{"type":"string"},"merchant_location":{"type":"string"},"merchant_name":{"type":"string"},"merchant_postal_code":{"type":"string"},"merchant_region":{"type":"string"},"network_ref":{"type":"string"},"partial_approval_allowed":{"type":"boolean"}},"required":["amount","channel","country","currency_code","mcc","merchant_name","network_ref"],"type":"object"},"WalletsTrustedKey":{"properties":{"id":{"type":"string"},"network":{"type":"string"},"public_key":{"description":"standard base64 Ed25519 public key","type":"string"},"requestor_id":{"type":"string"},"valid_from":{"format":"date-time","type":"string"},"valid_through":{"format":"date-time","type":"string"}},"required":["id","network","public_key","requestor_id","valid_from","valid_through"],"type":"object"},"WebhookDelivery":{"description":"WebhookDelivery is one event on its way to one endpoint.","properties":{"attempts":{"format":"int64","type":"integer"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"endpoint_id":{"example":"whep_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"event_id":{"type":"string"},"id":{"example":"whdl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"last_error":{"type":"string"},"last_status":{"format":"int64","type":"integer"},"next_attempt_at":{"format":"date-time","type":"string"},"status":{"type":"string"}},"required":["attempts","created_at","endpoint_id","event_id","id","next_attempt_at","status"],"type":"object"},"WebhookEndpoint":{"description":"WebhookEndpoint subscribes a URL to event types; Secret is set only on creation.","properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"event_types":{"items":{"type":"string"},"type":"array"},"id":{"example":"whep_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"previous_secret_expires_at":{"description":"the retiring secret still signs until then","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"secret":{"type":"string"},"secret_rotated_at":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"status":{"type":"string"},"url":{"type":"string"}},"required":["created_at","description","event_types","id","status","url"],"type":"object"},"WebhookRotation":{"description":"WebhookRotation is the evidence of one signing-secret rotation.","properties":{"actor":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"endpoint_id":{"example":"whep_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"id":{"type":"string"},"overlap_until":{"format":"date-time","type":"string"}},"required":["actor","created_at","endpoint_id","id","overlap_until"],"type":"object"},"Window":{"description":"Window is the order and deposit-notification cutoff the office publishes.","properties":{"aba":{"description":"9-digit office routing used on FedCash files","type":"string"},"code":{"type":"string"},"deposit_notify_hour":{"description":"0 means no separate electronic notification deadline","format":"int64","type":"integer"},"district":{"type":"string"},"location":{"description":"IANA timezone of the office","type":"string"},"name":{"type":"string"},"order_deadline_hour":{"format":"int64","type":"integer"}},"required":["aba","code","deposit_notify_hour","district","location","name","order_deadline_hour"],"type":"object"},"Wire":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"format":"int64","type":"integer"},"counterparty":{"$ref":"#/components/schemas/WireCounterparty"},"direction":{"type":"string"},"gl_code":{"type":"string"},"id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"imad":{"type":"string"},"journal_id":{"example":"jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"kind":{"description":"customer, bank or return","type":"string"},"local_instrument":{"type":"string"},"memo":{"type":"string"},"omad":{"type":"string"},"operator":{"type":"string"},"original_wire_id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"queued_until":{"description":"while queued: the next opening for customer transfers","oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"reason":{"type":"string"},"return_reason":{"type":"string"},"return_reason_code":{"type":"string"},"screening_result":{"type":"string"},"status":{"type":"string"},"uetr":{"type":"string"},"value_date":{"description":"the Fedwire cycle date it settles on","oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["account_id","amount","counterparty","direction","id","imad","journal_id","kind","omad","reason","screening_result","status"],"type":"object"},"WireCounterparty":{"properties":{"aba":{"type":"string"},"account_number":{"type":"string"},"address":{"description":"free-format lines, up to three of 35 characters","items":{"type":"string"},"type":"array"},"bank_name":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"name":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["aba","account_number","bank_name","name"],"type":"object"},"WireRelease":{"description":"WireRelease is the outcome of sending the queued wires.","properties":{"failed":{"format":"int64","type":"integer"},"fedwire_open":{"type":"boolean"},"next_opening":{"oneOf":[{"format":"date-time","type":"string"},{"type":"null"}]},"queued":{"format":"int64","type":"integer"},"released":{"format":"int64","type":"integer"},"wire_ids":{"items":{"type":"string"},"type":"array"}},"required":["failed","fedwire_open","queued","released","wire_ids"],"type":"object"},"WireRequest":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"amount":{"description":"minor units of the currency (cents for USD)","format":"int64","type":"integer"},"counterparty":{"$ref":"#/components/schemas/WireCounterparty"},"currency_code":{"description":"ISO 4217 code","type":"string"},"memo":{"type":"string"}},"required":["account_id","amount","counterparty","currency_code"],"type":"object"},"WireReturnRequest":{"description":"WireReturnRequest is a request to return a settled wire, sent or received.","properties":{"created_at":{"format":"date-time","type":"string"},"decided_by":{"type":"string"},"direction":{"type":"string"},"id":{"example":"wrrq_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"imad":{"type":"string"},"omad":{"type":"string"},"reason":{"type":"string"},"reason_code":{"type":"string"},"requested_by":{"type":"string"},"response_imad":{"type":"string"},"response_reason":{"type":"string"},"response_reason_code":{"type":"string"},"return_wire_id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"status":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"wire_id":{"example":"wire_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"}},"required":["created_at","direction","id","reason_code","status","updated_at","wire_id"],"type":"object"},"Withdrawal":{"properties":{"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"reason":{"type":"string"}},"required":["evidence_ref","evidence_sha256","reason"],"type":"object"},"WithholdingNotice":{"description":"WithholdingNotice turns backup withholding on or off by hand.","properties":{"reason":{"type":"string"},"withhold":{"type":"boolean"}},"required":["reason","withhold"],"type":"object"},"Work":{"properties":{"analysis_id":{"type":"string"},"loan_id":{"example":"loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"loan_status":{"type":"string"},"needs_analysis":{"type":"boolean"},"needs_closing_statement":{"type":"boolean"},"needs_delivery":{"type":"boolean"},"needs_initial_funding":{"type":"boolean"},"needs_payment_change":{"type":"boolean"},"needs_refund":{"type":"boolean"},"needs_statement":{"type":"boolean"},"next_analysis_on":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"pending_command":{"type":"string"},"refund_deadline":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"submission_deadline":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]}},"required":["loan_id","loan_status","needs_analysis","needs_closing_statement","needs_delivery","needs_initial_funding","needs_payment_change","needs_refund","needs_statement"],"type":"object"},"WorkPass":{"description":"WorkPass is what one ATM worker pass did: aged unanswered dispenses, finished postings and delivered queued reversals.","properties":{"advices_delivered":{"format":"int64","type":"integer"},"advices_outstanding":{"format":"int64","type":"integer"},"settled":{"format":"int64","type":"integer"},"suspect":{"format":"int64","type":"integer"}},"required":["advices_delivered","advices_outstanding","settled","suspect"],"type":"object"},"Workpaper":{"properties":{"content_sha256":{"type":"string"},"figures":{"items":{"$ref":"#/components/schemas/Figure"},"type":"array"},"id":{"type":"string"},"mapping_sha256":{"type":"string"},"missing_schedules":{"items":{"type":"string"},"type":"array"},"profile_sha256":{"type":"string"},"proposed_at":{"format":"date-time","type":"string"},"proposed_by":{"type":"string"},"report_date":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"request":{"$ref":"#/components/schemas/WorkpaperRequest"},"review":{"oneOf":[{"$ref":"#/components/schemas/WorkpaperReview"},{"type":"null"}]},"source_snapshots":{"items":{"$ref":"#/components/schemas/SourceSnapshot"},"type":"array"},"submission_blockers":{"items":{"type":"string"},"type":"array"},"submission_ready":{"type":"boolean"}},"required":["content_sha256","figures","id","mapping_sha256","missing_schedules","profile_sha256","proposed_at","proposed_by","report_date","request","source_snapshots","submission_blockers","submission_ready"],"type":"object"},"WorkpaperRequest":{"properties":{"adjustments":{"items":{"$ref":"#/components/schemas/FigureAdjustment"},"type":"array"},"mapping_ref":{"type":"string"},"mappings":{"items":{"$ref":"#/components/schemas/FigureMapping"},"type":"array"},"profile_id":{"type":"string"},"rationale":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/WorkpaperSource"},"type":"array"},"supersedes":{"type":"string"}},"required":["mapping_ref","mappings","profile_id","rationale","sources"],"type":"object"},"WorkpaperReview":{"properties":{"actor":{"type":"string"},"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"reviewed_at":{"format":"date-time","type":"string"},"scope":{"description":"supplied_figures, never a filing attestation","type":"string"}},"required":["actor","content_sha256","decision","evidence_ref","rationale","reviewed_at","scope"],"type":"object"},"WorkpaperReviewRequest":{"properties":{"content_sha256":{"type":"string"},"decision":{"type":"string"},"evidence_ref":{"type":"string"},"rationale":{"type":"string"},"scope":{"description":"supplied_figures, never a filing attestation","type":"string"}},"required":["content_sha256","decision","evidence_ref","rationale","scope"],"type":"object"},"WorkpaperSource":{"properties":{"as_of":{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},"evidence_ref":{"type":"string"},"evidence_sha256":{"type":"string"},"id":{"type":"string"},"kind":{"description":"gl_positions, gl_income_ytd, imported, or a declared local source kind","type":"string"},"period_start":{"oneOf":[{"description":"a business date, YYYY-MM-DD","format":"date","type":"string"},{"type":"null"}]},"values":{"items":{"$ref":"#/components/schemas/SourceValue"},"type":"array"}},"required":["as_of","id","kind"],"type":"object"},"Yield":{"description":"Yield is the opening disclosure for one balance band. The first marginal tier and every whole-balance tier have one yield; other marginal tiers have ranges.","properties":{"annual_rate_bps":{"format":"int64","type":"integer"},"apy_high_percent":{"type":"string"},"apy_low_percent":{"type":"string"},"assumed_maximum_minor":{"format":"int64","type":"integer"},"maximum_balance_minor":{"oneOf":[{"format":"int64","type":"integer"},{"type":"null"}]},"minimum_balance_minor":{"format":"int64","type":"integer"}},"required":["annual_rate_bps","apy_high_percent","apy_low_percent","minimum_balance_minor"],"type":"object"},"applyWireBody":{"properties":{"account_id":{"example":"acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"operator":{"type":"string"}},"required":["account_id","operator"],"type":"object"},"decisionBody":{"properties":{"actor":{"type":"string"},"decision":{"description":"approve or reject","type":"string"}},"required":["actor","decision"],"type":"object"},"depositScreenRequest":{"properties":{"customer_id":{"example":"cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm","type":"string"},"identity":{"$ref":"#/components/schemas/ScreeningIdentity"}},"required":["customer_id","identity"],"type":"object"},"furnishingPurge":{"properties":{"purged":{"format":"int64","type":"integer"}},"required":["purged"],"type":"object"},"operatorBody":{"properties":{"operator":{"description":"who acted","type":"string"}},"required":["operator"],"type":"object"},"reasonBody":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"}},"securitySchemes":{"bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}}}