> ## 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 the autoramp open banking payment for existing payment

> Get the autoramp open banking payment for a given autoramp




## OpenAPI

````yaml /spec.yaml get /autoramps/payments/open-banking/{payment_id}
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/payments/open-banking/{payment_id}:
    get:
      tags:
        - Autoramp
      summary: Get the autoramp open banking payment for existing payment
      description: |
        Get the autoramp open banking payment for a given autoramp
      operationId: getAutorampOpenBankingPayment
      parameters:
        - deprecated: false
          description: The payment ID
          explode: false
          in: path
          name: payment_id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XApiVersion'
      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:
    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
    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
  securitySchemes:
    ApiKeyAuth:
      description: API Key
      in: header
      name: X-API-Key
      type: apiKey

````