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

# Get withdrawal by ID

> Returns detailed information about a specific withdrawal using its unique identifier.

Returns detailed information about a specific withdrawal using its unique identifier.

Use this endpoint to:

* Check the status of a specific withdrawal
* Retrieve the blockchain transaction hash once available
* View actor metadata (initiator email, comments) on a withdrawal record
* Look up payment reference data (e.g. Fedwire IMAD)

<Note>
  **Payment-method-specific metadata in `paymentDetails`.** The withdrawal record includes an optional `paymentDetails` object that carries payment-rail-specific identifiers. For USD FEDWIRE withdrawals this looks like `{ "FEDWIRE": { "imad": "20240315B1QGC07C002345", "omad": "..." } }`. The field is `null` for methods that don't surface such data, and the same shape is also exposed on each entry of `statusHistory[].paymentDetails` so you can see when an identifier first appeared in the withdrawal's lifecycle.
</Note>

## Errors

| Status | Message                                                                         | Notes                                                                                       |
| ------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| 400    | `Query validation failed`                                                       | Request didn't match schema, or `withdrawalId` not found (v2 surfaces lookup misses as 400) |
| 401    | `The authorization key provided is either invalid or expired, please try again` | Mint a fresh JWT — see [Authentication](/v2/authentication)                                 |
| 409    | `Request with this idempotency key is currently processing`                     | See [Errors → Idempotency](/v2/errors#idempotency-errors)                                   |
| 422    | `Idempotency key reused with different parameters`                              | New body → new key                                                                          |
| 500    | `An internal error has occurred`                                                | Server fault; retry with backoff                                                            |

See the full [v2 error reference](/v2/errors) for retry semantics and idempotency-specific codes.


## OpenAPI

````yaml GET /v2/brokerage/{orgId}/withdrawal/{withdrawalId}
openapi: 3.1.0
info:
  title: Overview of OpenFX APIs
  description: >-
    OpenFX provides a robust and secure API suite engineered for high
    performance and reliability, enabling programmatic access to real-time
    market data, trade execution, and money movement functionalities. This guide
    will walk through the step-by-step process of deposits, quoting, trading,
    settlements and monitoring using OpenFX APIs.
  version: v2.0.0
  termsOfService: https://www.openfx.com/terms
  contact:
    name: OpenFX Support
    email: support@openfx.com
    url: https://www.openfx.com
servers:
  - url: https://api.openfx.com
    description: OpenFX API Server
security:
  - bearerAuth: []
tags:
  - name: MarketData
    description: >-
      This endpoint retrieves a complete list of all tradable fiat and
      stablecoin currency pairs on the OpenFX platform.
  - name: Balances
    description: >-
      The Balance endpoints enable real-time tracking and management of currency
      holdings within an account.
  - name: Trade
    description: >-
      The Trade APIs facilitate programmatic currency exchange through a
      quote-then-trade workflow, ensuring price transparency and guaranteed
      execution at quoted rates.
  - name: Deposits
    description: >-
      Deposit endpoints enable secure funding of trading accounts across
      multiple supported currencies and methods.
  - name: Withdrawals
    description: >-
      The Withdrawal API facilitates secure fund withdrawals for both fiat and
      stablecoins.
paths:
  /v2/brokerage/{orgId}/withdrawal/{withdrawalId}:
    get:
      tags:
        - Withdrawals
      summary: Get withdrawal by ID
      description: >-
        Fetches detailed information about a specific withdrawal using its
        unique identifier.
      operationId: getWithdrawalById
      parameters:
        - schema:
            type: string
          in: path
          name: orgId
          required: true
        - schema:
            type: string
          in: path
          name: withdrawalId
          required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                      - error
                    example: success
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 392cf015-5045-4615-a226-df3543d9c15f
                        description: Unique identifier for the withdrawal record
                      createdAt:
                        type: string
                        example: '2025-02-07T14:04:14.268Z'
                        description: UTC Timestamp when the withdrawal request was created
                      amount:
                        type: number
                        example: 0.5
                        description: Amount of currency requested for withdrawal
                      currency:
                        type: string
                        example: USDT
                        description: Currency symbol of the withdrawn asset
                      network:
                        type: string
                        example: ETHEREUM
                        description: Blockchain network name used to process the withdrawal
                      status:
                        type: string
                        examples:
                          - COMPLETED
                          - PENDING
                        description: Current status of the withdrawal
                      transactionHash:
                        type:
                          - string
                          - 'null'
                        example: null
                        description: >-
                          Blockchain transaction hash if available; null if not
                          yet processed
                      withdrawalAddressId:
                        type: string
                        format: uuid
                        example: 2697eff1-ac30-41db-94b7-d615133a5c9e
                        description: Unique identifier for the withdrawal address used
                      orgId:
                        type: string
                        format: uuid
                        example: c96183a5-2830-4606-9ae2-15dfd058872b
                        description: >-
                          Unique identifier of the organization associated with
                          the withdrawal
                      actorId:
                        type: string
                        format: uuid
                        example: 36bdb6a4-7cc6-4a08-b325-db416dbdd9f5
                        description: >-
                          Unique identifier of the user who initiated the
                          withdrawal
                      actorEmail:
                        type: string
                        format: email
                        example: test-user@example.co
                        description: Email of the actor who initiated the withdrawal
                      comments:
                        type: string
                        example: Client initiated the withdrawal
                        description: >-
                          Optional notes or comments about the withdrawal
                          request
                      paymentDetails:
                        type:
                          - object
                          - 'null'
                        example:
                          FEDWIRE:
                            imad: 20260517KLR00318000742
                        description: >-
                          Contains payment-specific information for the
                          transaction, such as IMAD for USD Fedwire or other
                          reference data depending on the payment method.
                  message:
                    type: string
                    example: Data fetched successfully
              examples:
                default_example:
                  value:
                    status: success
                    data:
                      id: 392cf015-5045-4615-a226-df3543d9c15f
                      createdAt: '2025-02-07T14:04:14.268Z'
                      amount: 0.5
                      currency: USDT
                      network: ETHEREUM
                      status: COMPLETED
                      transactionHash: null
                      withdrawalAddressId: 2697eff1-ac30-41db-94b7-d615133a5c9e
                      orgId: c96183a5-2830-4606-9ae2-15dfd058872b
                      actorId: 36bdb6a4-7cc6-4a08-b325-db416dbdd9f5
                      actorEmail: test-user@example.co
                      comments: Client initiated the withdrawal
                      paymentDetails: null
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                default_example:
                  value:
                    status: error
                    message: Query validation failed
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                default_example:
                  value:
                    status: error
                    message: >-
                      The authorization key provided is either invalid or
                      expired, please try again
        '409':
          description: Conflict
          content:
            application/json:
              examples:
                default_example:
                  value:
                    status: error
                    message: Request with this idempotency key is currently processing
                    error:
                      code: IDEMPOTENCY_IN_FLIGHT
                      details: Please wait for the original request to complete
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              examples:
                default_example:
                  value:
                    status: error
                    message: Idempotency key reused with different parameters
                    error:
                      code: IDEMPOTENCY_MISMATCH
                      details: >-
                        This idempotency key was already used with different
                        request parameters
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples:
                default_example:
                  value:
                    status: error
                    message: An internal error has occurred
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````