> ## Documentation Index > Fetch the complete documentation index at: https://docs.iron.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get a quote for an autoramp > Get a quote for an autoramp with fixed conversion rate, exact amount out or amount in ## OpenAPI ````yaml /spec.yaml get /autoramps/quote openapi: 3.1.0 info: description: The Stablecoin Payment Network title: Iron API - Sandbox version: 1.0-17078 servers: - url: https://api.sandbox.iron.xyz/api security: [] tags: - description: >- Wallet and bank account registration Every wallet address that interacts with Iron must be registered (linked) to a customer **before** it can be used in any flow — onramp, offramp, or swap. This is a regulatory requirement under the **Travel Rule**, which obliges Virtual Asset Service Providers to exchange originator and beneficiary information for crypto transfers. Iron supports two wallet types: - **Self-hosted wallets** — the customer controls the private key. Registration requires a signed proof-of-ownership message. - **Hosted wallets** — the wallet is custodied by another VASP (e.g. Coinbase, Kraken). Registration requires the VASP's DID so Iron can exchange travel-rule data with the custodian. Similarly, fiat bank accounts must be registered before they can receive offramp payouts. name: Addresses - description: Operations on Autoramp name: Autoramp - description: Operations on Chronicle collateral name: ChronicleCollateral - description: Operations on Currencies name: Currencies - description: Operations on Customers name: Customer - description: Operations on Exchange Rate name: ExchangeRate - description: Operations on Fee Profiles name: FeeProfiles - description: Operations for Sandbox Testing name: Sandbox - description: Operations on SSE name: Sse - description: Operations on Terms and Conditions name: TermsAndConditions - description: Operations on Webhooks name: Webhooks paths: /autoramps/quote: get: tags: - Autoramp summary: Get a quote for an autoramp description: >- Get a quote for an autoramp with fixed conversion rate, exact amount out or amount in operationId: getAutorampQuote parameters: - deprecated: false description: >- Optional sub-partner UUID, if provided, the autoramps will be filtered for the sub-partner explode: true in: header name: X-SUB-PARTNER-ID required: false schema: type: string - deprecated: false description: |- The parameters for the quote The customer id explode: true in: query name: customer_id required: true schema: format: uuid type: string - deprecated: false description: The source currency code explode: true in: query name: source_currency_code required: true schema: maxLength: 32 type: string - deprecated: false description: The source currency chain explode: true in: query name: source_currency_chain required: false schema: $ref: '#/components/schemas/Blockchain' - deprecated: false description: The destination currency code explode: true in: query name: destination_currency_code required: true schema: maxLength: 32 type: string - deprecated: false description: The destination currency chain explode: true in: query name: destination_currency_chain required: false schema: $ref: '#/components/schemas/Blockchain' - deprecated: false description: >- The recipient account ID (fiat_address or verified_crypto_address ID) Use this parameter instead of recipient_account. This is the preferred way to provide the recipient account and will be used if both are provided. explode: true in: query name: recipient_account_id required: false schema: default: null format: uuid type: string - deprecated: true description: >- **DEPRECATED**: The recipient account, either a fiat iban or a crypto wallet address Use recipient_account_id instead explode: true in: query name: recipient_account required: false schema: default: null maxLength: 256 type: string - deprecated: false description: The source amount explode: true in: query name: amount_in required: false schema: default: null format: decimal type: string - deprecated: false description: The destination amount explode: true in: query name: amount_out required: false schema: default: null format: decimal type: string - deprecated: false description: The rate lock duration in minutes explode: true in: query name: rate_lock_duration_minutes required: false schema: default: null format: int64 type: integer - deprecated: false description: The rate expiry policy explode: true in: query name: rate_expiry_policy required: true schema: $ref: '#/components/schemas/RateExpiryPolicy' - deprecated: false description: The slippage tolerance in bips explode: true in: query name: slippage_tolerance_in_bips required: false schema: default: null format: decimal type: string - deprecated: false description: >- The autoramp expiry time in hours. Maximum is 24 hours. It is limited to rate lock duration if rate expiry policy is Return explode: true in: query name: expiry_in_hours required: true schema: format: int64 type: integer - deprecated: false description: Is this a third party autoramp explode: true in: query name: is_third_party required: true schema: type: boolean - deprecated: false description: >- Sender Account Number is required when the source currency is African & payment type is Bank transfer explode: true in: query name: sender_account_number required: false schema: default: null maxLength: 256 type: string - deprecated: false description: >- Sender Mobile Number is required when the source currency is African & payment type is Mobile Money explode: true in: query name: sender_mobile_number required: false schema: default: null maxLength: 256 type: string - deprecated: false description: >- Sender Account Financial Institution/Bank is required when the source currency is African explode: true in: query name: sender_bank required: false schema: $ref: '#/components/schemas/Bank' - deprecated: false description: The external id explode: true in: query name: external_id required: false schema: default: null type: string - deprecated: false description: wire_message explode: true in: query name: wire_message required: false schema: default: null type: string - deprecated: false description: swift_payment_reference explode: true in: query name: swift_payment_reference required: false schema: default: null type: string - deprecated: false description: sepa_payment_reference explode: true in: query name: sepa_payment_reference required: false schema: default: null type: string - deprecated: false description: ach_payment_reference explode: true in: query name: ach_payment_reference required: false schema: default: null type: string - deprecated: false description: fps_payment_reference explode: true in: query name: fps_payment_reference required: false schema: default: null type: string - deprecated: false description: The fee profile id to use for the autoramp explode: true in: query name: fee_profile_id required: false schema: default: null format: uuid type: string - deprecated: false description: Whether payouts for this autoramp are batched daily explode: true in: query name: batch_payout required: false schema: default: null type: boolean - deprecated: false description: |- Additional input currency codes to allow on the autoramp beyond `source_currency_code`. Used to enable later per-currency quotes via `POST /autoramps/:id/quotes` on a quote-type autoramp. Must have the same length as `additional_in_currency_chains` and be index-aligned: the chain at position `i` describes the code at position `i`. explode: false in: query name: additional_in_currency_codes required: false schema: default: [] items: type: string maxItems: 16 type: array - deprecated: false description: >- Chains for each entry in `additional_in_currency_codes`, index-aligned. Must have the same length as `additional_in_currency_codes`. explode: false in: query name: additional_in_currency_chains required: false schema: default: [] items: $ref: '#/components/schemas/Blockchain' maxItems: 16 type: array - deprecated: false description: >- If true, a payment reference will be generated for the autoramp on inbound matching (pay-by-reference). Defaults to false if not provided. explode: true in: query name: pay_by_reference required: false schema: default: null type: boolean - $ref: '#/components/parameters/XApiVersion' responses: '200': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/SignedAutorampQuote' description: Get Quote successful '400': content: application/json; charset=utf-8: schema: type: string description: Bad Request '401': content: application/json; charset=utf-8: schema: type: string description: Unauthorized '403': content: application/json; charset=utf-8: schema: type: string description: Forbidden '404': content: application/json; charset=utf-8: schema: type: string description: Not Found '500': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ApiError' description: Internal Error security: - ApiKeyAuth: [] components: schemas: Blockchain: description: | Blockchain A type of blockchain enum: - Solana - Ethereum - Polygon - Arbitrum - Base - Stellar - Citrea - Plasma - Avalanche - Moca - Tempo - Tron - Bsc type: string RateExpiryPolicy: description: | Rate Expiry Policy The policy for the rate expiry enum: - Return - Slippage type: string Bank: enum: - 9JAPAY MICROFINANCE - ABSA Bank Botswana - ACCESS BANK - AFRICAN BANKING CORPORATION - AIRTELMONEYTZ - AZAMPESA - Absa Bank - Absa Bank Kenya Plc - Absa Bank Tanzania Limited - Access Bank - Access Bank (Diamond) - AccessBank Tanzania - African Bank - Airtel - Akiba Commercial Bank - Albaraka Bank - Amana Bank - Azania Bank - BANK OF AFRICA KENYA LTD - BANK OF BARODA - BANK OF INDIA - BARCLAYS BANK - BancABC Tanzania - Bank Gaborone Limited - Bank Of Baroda Botswana - Bank Of Namibia - Bank of Africa Tanzania Limited - Bank of Athens - Bank of Baroda Tanzania Limited - Bank of Tanzania - Barclays Bank - Bidvest Bank - CENTRAL BANK OF KENYA - CHARTERHOUSE BANK LTD - CITIBANK N.A. - CO-OPERATIVE BANK - COMMERCIAL BANK OF AFRICA LTD - CONSOLIDATED BANK OF KENYA LTD - CRDB Bank - CREDIT BANK LTD - Capitec Bank - Central Bank Of Lesotho - China Commercial Bank Limited - Citi Bank - Citibank Nigeria - Citibank Tanzania Ltd - DCB Commercial Bank - DEVELOPMENT BANK OF KENYA - DIAMOND TRUST BANK - DUBAI BANK OF KENYA LTD - Diamond Trust Bank Tanzania - Discovery Bank Limited - ECOBANK KENYA LTD - EQUITORIAL COMMERCIAL BANK LTD - EQUITY BANK - Ecobank - Ecobank Nigeria - Enterprise Bank - Equity Bank (Tanzania) - Exim Bank (Tanzania) - FAMILY BANK LTD - FIDELITY COMMERCIAL BANK - FIRST COMMUNITY BANK - Fairmoney Microfinance Bank Ltd - Fidelity Bank - Finbond Mutual Bank - First Bank of Nigeria - First Capital Bank Botswana - First City Monument Bank - First National Bank - First National Bank (South Africa) - First National Bank Lesotho - First National Bank Namibia - First National Bank Swaziland - First National Bank of Tanzania - FirstRand Bank Limited - GIRO BANK LTD - GT Bank - GUARANTY TRUST (KENYA) LTD - GUARDIAN BANK - GULF AFRICAN BANK LTD - GoMoney - Grinrod Bank - Guaranty Trust Bank - Guaranty Trust Bank (Tanzania) Limited - HABIB BANK A.G. - HABIB BANK LTD - HALOPESA - HOUSING FINANCE CORPORATION OF KENYA - Habib African Bank - Heritage Bank - Hsbc Bank - I&M Bank (Tanzania) - IMPERIAL BANK LIMITED - INVESTMENTS AND MORTGAGES - International Commercial Bank Tanzania - Investec Bank - JAMII BORA BANK LTD - Jaiz Bank - Jp Morgan Chase Bank - K-REP BANK - KENYA COMMERCIAL BANK LTD - Kcb Bank Tanzania Limited - Keystone Bank - Kuda Microfinance Bank - Letshego Bank Tanzania - Lotus Bank - MIDDLE EAST BANK (K) LIMITED - MTN - Maendeleo Bank Ltd - Mainstreet Bank - Meeg Bank - Mercantile Bank Limited - Mkombozi Commercial Bank - MoMo PSB - Mobile Wallet - Mobile Wallet (M-PESA) - Moniepoint Microfinance Bank - Moov money - Mtn Banking - Mtn Mobile Money - Mwalimu Commercial Bank - NATIONAL BANK OF KENYA - NCBA Bank - NCBA Bank Tanzania - NET MFB - National Bank of Commerce (Tanzania) - National Microfinance Bank - Nedbank (South Africa) - Nownow（Contec Global) - OPay - ORIENTAL COMMERCIAL BANK - Old Mutual - Orange Money - PARAMOUNT UNIVERSAL BANK LTD - PRIME BANK LIMITED - Paga - PalmPay - Peach - People's Bank of Zanzibar - Polaris Bank - Postbank - Premium Trust bank - Providus Bank - RMB Private Bank - Rand Merchant Bank - SA Post Bank (Post Office) - STANBIC BANK - STANBIC BANK KENYA LIMITED - STANDARD CHARTERED - Sasfin Bank Limited - South African Bank of Athens Limited - Stanbic Bank Tanzania Limited - Stanbic Ibtc Bank - Standard Bank (South Africa) - Standard Bank Namibia - Standard Chartered Bank - Standard Chartered Bank Botswana Limited - State Bank Of India - Sterling Bank - TIGO - TNM - TPB Bank Plc - TRANS-NATIONAL BANK - Taj Bank - Titan-Paystack - Tyme Bank - UBA KENYA LTD - Ubank - Unibank - Union Bank of Nigeria - United Bank for Africa - Unity Bank - VFD Microfinance Bank - VICTORIA COMMERCIAL BANK LTD - VISA/MasterCard - VODACOM - Vbs Mutual Bank - Wave - Wema Bank - Zamtel - Zenith Bank type: string SignedAutorampQuote: description: | Signed Autoramp Quote The signed autoramp quote properties: ach_payment_reference: description: a message to include in outgoing ACH transfers (max 10 characters) maxLength: 10 minLength: 1 pattern: ^[A-Za-z0-9 /\-?:().+]*$ type: string additional_in_currencies: description: >- Additional input currencies to allow on the autoramp beyond `source_currency`. Each entry must share the same chain as `source_currency` and the list must not include `source_currency` itself. After autoramp creation, further quotes can be obtained for these currencies via `POST /autoramps/:id/quotes`. items: $ref: '#/components/schemas/Currency' type: array amount_in: $ref: '#/components/schemas/Amount' amount_out: $ref: '#/components/schemas/Amount' batch_payout: description: >- If true, payouts for this autoramp will be batched and sent once per day instead of individually. Only supported for fiat destination currencies. type: boolean customer_id: description: The customer id format: uuid type: string deposit_account_type: $ref: '#/components/schemas/DepositAccountType' destination_currency: $ref: '#/components/schemas/Currency' external_id: description: The external id type: string fee: $ref: '#/components/schemas/Fee' fee_profile_id: description: >- The fee profile id to use for the autoramp. If not provided, the default fee profile for the partner will be used. format: uuid type: string fee_settlement: $ref: '#/components/schemas/FeeSettlement' fps_payment_reference: description: a message to include in outgoing FPS transfers (max 18 characters) maxLength: 18 minLength: 6 pattern: ^[A-Za-z]*$ type: string is_third_party: description: Is this a third party autoramp type: boolean pay_by_reference: description: >- If true, a payment reference will be generated for the autoramp on inbound matching (pay-by-reference). Defaults to false if not provided. type: boolean quote_id: description: The id of the quote format: uuid type: string rate: description: The rate format: decimal type: string rate_expiry_policy: $ref: '#/components/schemas/RateExpiryPolicy' rate_lock_valid_until: description: The rate lock valid until format: date-time type: string recipient_account: $ref: '#/components/schemas/Account' sepa_payment_reference: description: a message to include in outgoing SEPA transfers (max 140 characters) maxLength: 140 minLength: 6 pattern: ^[A-Za-z0-9 /\-?:().+]*$ type: string signature: description: The signature type: string slippage_tolerance_in_bips: description: The slippage tolerance in bips format: decimal type: string source_currency: $ref: '#/components/schemas/Currency' swift_payment_reference: description: >- a message to include in outgoing SWIFT transfers (max 4 lines, 35 chars per line) maxLength: 140 minLength: 1 pattern: ^[A-Za-z0-9 /\-?:().+]*$ type: string valid_until: description: The valid until format: date-time type: string wire_message: description: >- a message to include in outgoing wire transfers (max 4 lines, 35 chars per line) maxLength: 140 minLength: 1 pattern: ^[A-Za-z0-9 /\-?:().+]*$ type: string required: - quote_id - source_currency - destination_currency - recipient_account - customer_id - amount_in - amount_out - rate - rate_expiry_policy - fee - fee_settlement - valid_until - signature - is_third_party title: SignedAutorampQuote type: object ApiError: description: |- Standard error response returned to API clients for server errors. Includes a trace_id that clients can reference when reporting issues. properties: message: description: Human-readable error message type: string trace_id: description: Trace ID that can be used to look up request details in logs type: string required: - message - trace_id title: ApiError type: object Currency: anyOf: - $ref: '#/components/schemas/Currency_Crypto' - $ref: '#/components/schemas/Currency_Fiat' description: | Currency Can be either crypto or fiat discriminator: mapping: Crypto: $ref: '#/components/schemas/Currency_Crypto' Fiat: $ref: '#/components/schemas/Currency_Fiat' propertyName: type type: object Amount: description: | An amount of money example: amount: '100.5' currency: code: USD type: Fiat properties: amount: description: The amount, a decimal number format: decimal type: string currency: $ref: '#/components/schemas/Currency' required: - amount - currency title: Amount type: object DepositAccountType: enum: - Iban - Wallet - AchWire - Pix - Spei - AfricanBankTransfer - MobileMoney - ChapsFps type: string Fee: description: | Fee The fee for a given currency pair properties: banking_fee: $ref: '#/components/schemas/Amount' banking_fee_network: $ref: '#/components/schemas/PaymentNetwork' deducted_fee: allOf: - $ref: '#/components/schemas/Amount' - deprecated: true description: >- The amount of the fee that was deducted immediately and charged to the end customer. This is deprecated and will be removed in the future. Use transaction_fee instead. deprecated: true description: >- The amount of the fee that was deducted immediately and charged to the end customer. This is deprecated and will be removed in the future. Use transaction_fee instead. iron_fee: $ref: '#/components/schemas/Amount' iron_fee_settlement: $ref: '#/components/schemas/FeeSettlement' network_fee: $ref: '#/components/schemas/Amount' network_fees: deprecated: true description: The network fees in source currency items: $ref: '#/components/schemas/NetworkFee' type: array network_fees_with_settlement: description: The network fees with settlement items: $ref: '#/components/schemas/NetworkFeeWithSettlement' type: array partner_fee: $ref: '#/components/schemas/Amount' partner_fees: description: The partner fees items: $ref: '#/components/schemas/PartnerFee' type: array total_fee: $ref: '#/components/schemas/Amount' transaction_fee: $ref: '#/components/schemas/Amount' required: - total_fee - iron_fee - partner_fee - network_fees - network_fees_with_settlement - partner_fees - transaction_fee - banking_fee - network_fee title: Fee type: object FeeSettlement: description: | Fee Settlement The settlement type for the fee enum: - deductedImmediately - settledLater type: string Account: anyOf: - $ref: '#/components/schemas/Account_FiatAccount' - $ref: '#/components/schemas/Account_CryptoWallet' - $ref: '#/components/schemas/Account_PixAccount' description: | Account The account for the autoramp discriminator: mapping: Crypto: $ref: '#/components/schemas/Account_CryptoWallet' Fiat: $ref: '#/components/schemas/Account_FiatAccount' Pix: $ref: '#/components/schemas/Account_PixAccount' propertyName: type type: object Currency_Crypto: allOf: - properties: type: enum: - Crypto example: Crypto type: string required: - type type: object - $ref: '#/components/schemas/Crypto' description: | Currency Can be either crypto or fiat Currency_Fiat: allOf: - properties: type: enum: - Fiat example: Fiat type: string required: - type type: object - $ref: '#/components/schemas/Fiat' description: | Currency Can be either crypto or fiat PaymentNetwork: description: | PaymentNetwork A payment network enum: - Sepa - Swift - Fps - Chats - Ach - Wire - Rtp - Fednow - Pix - Spei - AfricanBankTransfer - MobileMoney - Chaps type: string NetworkFee: anyOf: - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' - $ref: '#/components/schemas/NetworkFee_Amount' description: > Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead. discriminator: mapping: AchIn: $ref: '#/components/schemas/NetworkFee_Amount' AchOut: $ref: '#/components/schemas/NetworkFee_Amount' CitreaGas: $ref: '#/components/schemas/NetworkFee_Amount' EthereumGas: $ref: '#/components/schemas/NetworkFee_Amount' RailFee: $ref: '#/components/schemas/NetworkFee_Amount' SepaIn: $ref: '#/components/schemas/NetworkFee_Amount' SepaOut: $ref: '#/components/schemas/NetworkFee_Amount' SolanaTransactionFee: $ref: '#/components/schemas/NetworkFee_Amount' StellarTransactionFee: $ref: '#/components/schemas/NetworkFee_Amount' SwiftIn: $ref: '#/components/schemas/NetworkFee_Amount' SwiftOut: $ref: '#/components/schemas/NetworkFee_Amount' WireIn: $ref: '#/components/schemas/NetworkFee_Amount' WireOut: $ref: '#/components/schemas/NetworkFee_Amount' propertyName: type type: object NetworkFeeWithSettlement: description: | Network Fee with Settlement The network fee with settlement for a given currency properties: fee_amount: $ref: '#/components/schemas/Amount' fee_type: $ref: '#/components/schemas/NetworkFeeType' settlement: $ref: '#/components/schemas/FeeSettlement' required: - fee_type - fee_amount title: NetworkFeeWithSettlement type: object PartnerFee: description: | Partner Fee A partner fee properties: fee: $ref: '#/components/schemas/Amount' label: description: The label of the partner fee type: string settlement: $ref: '#/components/schemas/FeeSettlement' required: - label - fee - settlement title: PartnerFee type: object Account_FiatAccount: allOf: - properties: type: enum: - Fiat example: Fiat type: string required: - type type: object - $ref: '#/components/schemas/FiatAccount' description: | Account The account for the autoramp Account_CryptoWallet: allOf: - properties: type: enum: - Crypto example: Crypto type: string required: - type type: object - $ref: '#/components/schemas/CryptoWallet' description: | Account The account for the autoramp Account_PixAccount: allOf: - properties: type: enum: - Pix example: Pix type: string required: - type type: object - $ref: '#/components/schemas/PixAccount' description: | Account The account for the autoramp Crypto: description: A cryptocurrency example: blockchain: Solana token: USDC properties: blockchain: $ref: '#/components/schemas/Blockchain' token: description: The ticker of the token e.g. 'USDC' type: string required: - token - blockchain title: Crypto type: object Fiat: description: A fiat currency example: code: USD properties: code: description: The code of the currency e.g. 'USD' type: string required: - code title: Fiat type: object NetworkFee_Amount: allOf: - properties: type: enum: - SwiftOut example: SwiftOut type: string required: - type type: object - $ref: '#/components/schemas/Amount' description: > Network Fee The network fee for a given currency. This is deprecated and will be removed in the future. Use NetworkFeeWithSettlement instead. NetworkFeeType: description: | Network Fee Type The type of network fee enum: - SepaIn - SepaOut - EthereumGas - CitreaGas - SolanaTransactionFee - StellarTransactionFee - PolygonGas - BaseGas - AvalancheGas - TronGas - BscGas - RailFee - AchIn - AchOut - WireIn - WireOut - SwiftIn - SwiftOut - FpsIn - FpsOut - ChapsIn - ChapsOut - RtpIn - RtpOut - FednowIn - FednowOut type: string FiatAccount: description: | Fiat Account The fiat account for the autoramp properties: account_identifier: $ref: '#/components/schemas/BankAccountIdentifier' required: - account_identifier title: FiatAccount type: object CryptoWallet: description: | Crypto Wallet The crypto wallet for the autoramp properties: address: description: The address of the crypto account type: string chain: $ref: '#/components/schemas/Blockchain' required: - chain - address title: CryptoWallet type: object PixAccount: description: |- PIX Account References a previously-registered PIX destination by its id. properties: id: description: The id of a previously-registered PIX destination format: uuid type: string required: - id title: PixAccount type: object BankAccountIdentifier: anyOf: - $ref: '#/components/schemas/BankAccountIdentifier_Iban' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountACHIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountWireIdentifier' - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountRTPIdentifier' - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountFedNowIdentifier - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountSWIFTIdentifier - $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountCHAPSIdentifier - $ref: '#/components/schemas/BankAccountIdentifier_BankAccountFPSIdentifier' discriminator: mapping: ACH: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountACHIdentifier CHAPS: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountCHAPSIdentifier FEDNOW: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountFedNowIdentifier FPS: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountFPSIdentifier RTP: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountRTPIdentifier SEPA: $ref: '#/components/schemas/BankAccountIdentifier_Iban' SWIFT: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountSWIFTIdentifier Wire: $ref: >- #/components/schemas/BankAccountIdentifier_BankAccountWireIdentifier propertyName: type type: object BankAccountIdentifier_Iban: allOf: - properties: type: enum: - SEPA example: SEPA type: string required: - type type: object - $ref: '#/components/schemas/Iban' BankAccountIdentifier_BankAccountACHIdentifier: allOf: - properties: type: enum: - ACH example: ACH type: string required: - type type: object - $ref: '#/components/schemas/BankAccountACHIdentifier' BankAccountIdentifier_BankAccountWireIdentifier: allOf: - properties: type: enum: - Wire example: Wire type: string required: - type type: object - $ref: '#/components/schemas/BankAccountWireIdentifier' BankAccountIdentifier_BankAccountRTPIdentifier: allOf: - properties: type: enum: - RTP example: RTP type: string required: - type type: object - $ref: '#/components/schemas/BankAccountRTPIdentifier' BankAccountIdentifier_BankAccountFedNowIdentifier: allOf: - properties: type: enum: - FEDNOW example: FEDNOW type: string required: - type type: object - $ref: '#/components/schemas/BankAccountFedNowIdentifier' BankAccountIdentifier_BankAccountSWIFTIdentifier: allOf: - properties: type: enum: - SWIFT example: SWIFT type: string required: - type type: object - $ref: '#/components/schemas/BankAccountSWIFTIdentifier' BankAccountIdentifier_BankAccountCHAPSIdentifier: allOf: - properties: type: enum: - CHAPS example: CHAPS type: string required: - type type: object - $ref: '#/components/schemas/BankAccountCHAPSIdentifier' BankAccountIdentifier_BankAccountFPSIdentifier: allOf: - properties: type: enum: - FPS example: FPS type: string required: - type type: object - $ref: '#/components/schemas/BankAccountFPSIdentifier' Iban: example: iban: DE89370400440532013000 properties: iban: type: string required: - iban title: Iban type: object BankAccountACHIdentifier: example: account_number: '123456789' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountACHIdentifier type: object BankAccountWireIdentifier: example: account_number: '987654321' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountWireIdentifier type: object BankAccountRTPIdentifier: example: account_number: '456789123' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountRTPIdentifier type: object BankAccountFedNowIdentifier: example: account_number: '456789123' routing_number: '021000021' properties: account_number: description: US account number (4-17 alphanumeric characters) pattern: ^[0-9A-Z]{4,17}$ type: string routing_number: description: US routing number (exactly 9 digits) pattern: ^[0-9]{9}$ type: string required: - routing_number - account_number title: BankAccountFedNowIdentifier type: object BankAccountSWIFTIdentifier: example: account_number: '1234567890' bic: CHASUS33XXX properties: account_number: type: string bic: type: string intermediary_bic: description: >- BIC of an intermediary correspondent bank in the SWIFT routing chain, when the sender wants to override the auto-selected intermediary. Optional — most senders leave this unset and let their provider pick. type: string required: - bic - account_number title: BankAccountSWIFTIdentifier type: object BankAccountCHAPSIdentifier: example: account_number: '12345678' sort_code: 20-00-00 properties: account_number: type: string sort_code: type: string required: - sort_code - account_number title: BankAccountCHAPSIdentifier type: object BankAccountFPSIdentifier: example: account_number: '55779911' sort_code: 20-00-00 properties: account_number: type: string sort_code: type: string required: - sort_code - account_number title: BankAccountFPSIdentifier type: object parameters: XApiVersion: description: >- Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01. in: header name: X-API-Version required: false schema: type: string securitySchemes: ApiKeyAuth: description: API Key in: header name: X-API-Key type: apiKey ````