> ## 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. # Create an open banking payment link > Create an open banking payment link for a given autoramp ## OpenAPI ````yaml /spec.yaml post /autoramps/{autoramp_id}/payments/open-banking 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/{autoramp_id}/payments/open-banking: post: tags: - Autoramp summary: Create an open banking payment link description: | Create an open banking payment link for a given autoramp operationId: createAutorampOpenBankingPayment parameters: - deprecated: false description: a UUID ensuring an Autoramp operation is only processed once explode: true in: header name: IDEMPOTENCY-KEY required: true schema: type: string - deprecated: false description: The autoramp ID explode: false in: path name: autoramp_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/XApiVersion' requestBody: content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/CreateAutorampOpenBankingPayment' description: Open banking payment parameters required: true responses: '201': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ApiAutorampOpenBankingPayment' description: Create autoramp 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 '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: 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 schemas: CreateAutorampOpenBankingPayment: description: | Create Autoramp Payment Link Payload The parameters for creating an autoramp payment link properties: amount_in: $ref: '#/components/schemas/Amount' callback_url: type: string required: - amount_in - callback_url title: CreateAutorampOpenBankingPayment type: object ApiAutorampOpenBankingPayment: description: >- Autoramp Open Banking Payment with link to initiate flow One payment attempt against a provider for an autoramp's open-banking flow. properties: id: description: |- The provider's payment ID (e.g. tokenio's payment ID). Use this with the GET-by-id endpoint to look up the latest status. type: string iron_payment_id: description: |- Iron's internal identifier for this open banking payment. Use this as the pagination cursor when listing payments. format: uuid type: string payment_link: type: string settlement_status: $ref: '#/components/schemas/ApiAutorampOpenBankingPaymentSettlementStatus' status: $ref: '#/components/schemas/ApiAutorampOpenBankingPaymentStatus' required: - id - iron_payment_id - status title: ApiAutorampOpenBankingPayment 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 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 ApiAutorampOpenBankingPaymentSettlementStatus: enum: - InProgress - Completed - Incomplete type: string ApiAutorampOpenBankingPaymentStatus: description: | Autoramp Payment Link Status The status of the autoramp payment link enum: - Pending - Ready - Processing - Completed - Failed type: string 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 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 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 Blockchain: description: | Blockchain A type of blockchain enum: - Solana - Ethereum - Polygon - Arbitrum - Base - Stellar - Citrea - Plasma - Avalanche - Moca - Tempo - Tron - Bsc type: string securitySchemes: ApiKeyAuth: description: API Key in: header name: X-API-Key type: apiKey ````