> ## Documentation Index
> Fetch the complete documentation index at: https://docs.etherfuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get order details

> Retrieves details for a specific order accessible to your API key.



## OpenAPI

````yaml /openapi.yaml get /ramp/order/{order_id}
openapi: 3.1.0
info:
  title: FX API
  version: 1.0.0
  description: >
    API for managing FX operations including onboarding, quotes, orders, and
    customer management.

    This API provides endpoints for managing customers, bank accounts, crypto
    wallets, orders, and webhooks.
servers:
  - url: https://api.etherfuse.com
    description: Production API
  - url: https://api.sand.etherfuse.com
    description: Sandbox API (for testing)
security: []
tags:
  - name: Lookup
    description: Public endpoints for looking up stablebond and exchange rate data
  - name: Assets
    description: Get available assets for ramping
  - name: Onboarding
    description: Customer onboarding and KYC
  - name: Bank Accounts
    description: Manage customer bank accounts
  - name: Agreements
    description: Handle customer agreements and consents
  - name: Quotes
    description: Get quotes for conversions
  - name: Orders
    description: Create and manage orders
  - name: Swaps
    description: Create and manage swaps
  - name: Customers
    description: Manage customers
  - name: Crypto Wallets
    description: Manage crypto wallets
  - name: Webhooks
    description: Manage webhook subscriptions
  - name: Organizations
    description: Manage organizations and child organizations
paths:
  /ramp/order/{order_id}:
    get:
      tags:
        - Orders
      summary: Get order details
      description: Retrieves details for a specific order accessible to your API key.
      parameters:
        - name: order_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the order to retrieve
      responses:
        '200':
          description: Order details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Order:
      type: object
      description: |
        Order object returned in webhooks and when fetching order details.
        This is the payload you'll receive in `order_updated` webhook events.
      properties:
        orderId:
          type: string
          format: uuid
          description: Unique identifier for the order
        customerId:
          type: string
          format: uuid
          description: >-
            Organization ID associated with the order. In webhook payloads, this
            is the recipient organization's ID.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the order was created
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the order was last updated
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the order was deleted (if applicable)
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the order was completed
        amountInFiat:
          type: number
          format: decimal
          nullable: true
          description: Amount in fiat currency (MXN)
        amountInTokens:
          type: number
          format: decimal
          nullable: true
          description: Amount in crypto tokens
        confirmedTxSignature:
          type: string
          nullable: true
          description: Blockchain transaction hash when crypto transfer is confirmed
        walletId:
          type: string
          format: uuid
          description: ID of the wallet used for the order
        bankAccountId:
          type: string
          format: uuid
          description: ID of the bank account used for the order
        burnTransaction:
          type: string
          nullable: true
          description: Encoded transaction for the user to sign (offramp orders)
        isAnchorOrder:
          type: boolean
          nullable: true
          description: Whether this order uses anchor mode (Stellar only)
        withdrawAnchorAccount:
          type: string
          nullable: true
          description: Stellar anchor account address to send payment to (anchor mode only)
        withdrawMemo:
          type: string
          nullable: true
          description: >-
            Base64-encoded hash memo to include in the payment (anchor mode
            only)
        withdrawMemoType:
          type: string
          nullable: true
          description: Memo type for anchor payments — always "hash" (anchor mode only)
        memo:
          type: string
          nullable: true
          description: Optional memo for the order
        depositClabe:
          type: string
          nullable: true
          description: CLABE number for deposit (onramp orders only)
        depositBankName:
          type: string
          nullable: true
          description: Bank that holds the deposit CLABE, e.g. "STP" (onramp orders only)
        depositAccountHolder:
          type: string
          nullable: true
          description: >-
            Account holder name for the deposit CLABE, e.g. "Etherfuse MX"
            (onramp orders only)
        orderType:
          type: string
          enum:
            - onramp
            - offramp
          description: Type of the order
        status:
          type: string
          enum:
            - created
            - funded
            - completed
            - finalized
            - failed
            - refunded
            - canceled
          description: >-
            Current status of the order. For offramps, `completed` means fiat
            has been sent to the customer. `finalized` means the reversal window
            has passed and the funds cannot be returned.
        statusPage:
          type: string
          format: uri
          description: >-
            URL to an Etherfuse-branded page where the customer can view order
            status and sign transactions (for offramps). Can be used as an
            alternative to handling transaction signing in your application.
        feeBps:
          type: integer
          nullable: true
          description: Fee in basis points (e.g., 20 = 0.20%)
        feeAmountInFiat:
          type: number
          format: decimal
          nullable: true
          description: Actual fee amount collected in fiat currency
        exchangeRate:
          type: string
          nullable: true
          description: >-
            Fee-inclusive exchange rate between source and target assets at the
            time of order creation. This is the rate the user actually received.
            For example, if a user exchanged MXN for CETES with a fee, this
            reflects the rate after the fee was applied. Null for historical
            orders created before this field was added.
        etherfuseMidMarketRate:
          type: string
          nullable: true
          description: >-
            Raw mid-market rate before fees. For stablebond ramps, this is the
            bond price (e.g., MXN per CETE). For FX ramps, this is the forex
            mid-market rate between the underlying fiat currencies. Null for
            historical orders.
        sourceAsset:
          type: string
          nullable: true
          description: >-
            Source asset identifier for this order. For onramps, this is the
            fiat currency (e.g., "MXN"). For offramps, this is the crypto asset
            identifier.
        targetAsset:
          type: string
          nullable: true
          description: >-
            Target asset identifier for this order. For onramps, this is the
            crypto asset identifier. For offramps, this is the fiat currency
            (e.g., "MXN").
        stellarClaimableBalanceId:
          type: string
          nullable: true
          description: >
            Stellar claimable balance ID (hex). Present on completed Stellar
            onramp orders

            where the wallet required setup (no account or no trustline). The
            user must

            sign a claim transaction to receive their tokens. See
            `stellarClaimTransaction`.
        stellarClaimTransaction:
          type: string
          nullable: true
          description: >
            Unsigned Stellar transaction XDR (base64-encoded). Present on
            completed Stellar

            onramp orders that used the claimable balance flow. Contains
            `ChangeTrust` and

            `ClaimClaimableBalance` operations. The user signs this with their
            wallet and

            submits it to Horizon to add the trustline and claim their tokens in
            one step.
        partnerFeeBps:
          type: integer
          nullable: true
          description: >-
            Partner fee in basis points applied to this order (e.g., 100 =
            1.00%). Only present when a partner fee was configured at quote
            time.
        partnerFeeAmountFiat:
          type: number
          format: decimal
          nullable: true
          description: >-
            Partner fee amount collected in fiat currency. Derived from the
            total fee using the partner fee ratio.
        partnerFeeStatus:
          type: string
          enum:
            - none
            - pending
            - disbursed
          nullable: true
          description: >
            Disbursement status of the partner fee. Only present when
            `partnerFeeBps` > 0.

            - `none` — Order not yet completed

            - `pending` — Order completed, partner fee awaiting offline
            disbursement

            - `disbursed` — Partner fee has been paid out
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: Invalid request parameters
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Pass the key directly (e.g., `Authorization:
        your-api-key`). Do not use a `Bearer` prefix.

````