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

# Create Withdraw

> Initiate cryptocurrency withdrawal request. When the destination address routes to the Binance channel, the withdrawal is rejected if the address book entry is missing Travel Rule data; populate it first via Update Address Book.
[  *Stablecoin Account API Publisher Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)




## OpenAPI

````yaml /stablecoin-account/v1.6/ramp.yaml post /v1/ramp/withdraw
openapi: 3.0.2
info:
  title: Stablecoin Account API
  version: 1.0.4
  description: >
    UQPAY Stablecoin Account API provides comprehensive stablecoin account
    management and payment solutions for fiat-cryptocurrency conversion,
    enabling complete fund flow loop functionality.


    ## Key Features

    - Asset Management: Query and manage wallet balances across multiple
    currencies

    - Fiat Transfer: Transfer funds between Stablecoin Account and Global
    Account systems

    - Currency Exchange: Crypto-Fiat mutual conversion with real-time quotes

    - Cryptocurrency Deposit: Receive crypto deposits with address management

    - Cryptocurrency Withdrawal: Initiate and track crypto withdrawals


    ## Authentication

    Use API keys to authenticate your client requests when utilizing UQPAY APIs.

    API keys are unique data strings used to authenticate users and enable
    access to privileged operations.

    Your API key should be kept confidential and secure at all times.


    ## Getting Started

    1. Obtain API credentials (x-client-id and x-api-key)

    2. Request access token via POST /api/v1/connect/token

    3. Set up test environment using sandbox URL

    4. Implement authentication with x-auth-token header

    5. Start with basic operations


    ## Support

    For technical support and integration assistance, contact UQPAY support
    team.
  contact:
    name: UQPAY Support
    url: https://www.uqpay.com/support
    email: ramp.tech@uqpay.com
  license:
    name: Proprietary
    url: https://www.uqpay.com/legal/api-terms
  termsOfService: https://www.uqpay.com/legal/terms
  x-api-id: ramp-api-v1.0.0
  x-logo:
    url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif
    backgroundColor: '#FFFFFF'
    altText: UQPAY Logo
  x-categories:
    - Stablecoin Account
    - Payment Processing
    - Cryptocurrency
    - Fiat Exchange
servers:
  - url: https://api-sandbox.uqpaytech.com/api
    description: Sandbox base URL.
  - url: https://api.uqpay.com/api
    description: Production base URL.
security: []
tags:
  - name: Assets
    description: >-
      Manage stablecoin wallet accounts and query balances across different
      currencies.
  - name: Transfer (Out/In)
    description: Transfer funds between Stablecoin Account and Global Account systems.
  - name: Conversions
    description: Execute currency conversions between cryptocurrency and fiat currencies.
  - name: Deposits
    description: Manage cryptocurrency deposit addresses and track deposit transactions.
  - name: Withdrawals
    description: Create and manage cryptocurrency withdrawal requests.
  - name: Configuration
    description: Query supported assets, networks, and system configuration.
  - name: Address Book
    description: Manage wallet address book entries for withdrawals.
  - name: Travel Rule
    description: >-
      Reference data (VASPs, countries, regions) used to populate Travel Rule
      beneficiary information for address book entries.
paths:
  /v1/ramp/withdraw:
    post:
      tags:
        - Withdrawals
      summary: Create Withdraw
      description: >
        Initiate cryptocurrency withdrawal request. When the destination address
        routes to the Binance channel, the withdrawal is rejected if the address
        book entry is missing Travel Rule data; populate it first via Update
        Address Book.

        [  *Stablecoin Account API Publisher
        Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)
      operationId: create-withdraw
      parameters:
        - $ref: '#/components/parameters/XOnBehalfOf'
        - $ref: '#/components/parameters/XIdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WithdrawCreateRequest'
      responses:
        '200':
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          description: Withdrawal created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawCreateResponse'
                title: WithdrawCreateResponse
      security:
        - XAuthToken: []
      externalDocs:
        description: API Publisher Disclaimer – UQPAY Australia
        url: >-
          /stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer
components:
  parameters:
    XOnBehalfOf:
      in: header
      name: x-on-behalf-of
      schema:
        type: string
      required: false
      description: >
        Specifies the sub-account on whose behalf the request is made. This
        should be set to the `account_id`, which can be retrieved via the List
        Connected Accounts API. If omitted or empty, the request is executed
        using the master account.

        More information at Connected Accounts.
      example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be
    XIdempotencyKey:
      in: header
      name: x-idempotency-key
      schema:
        type: string
        format: uuid
      required: false
      description: >-
        A unique identifier (UUID) used to maintain operation idempotency,
        ensuring that repeated executions of the same operation do not result in
        unintended effects or duplication. It helps preserve data consistency in
        the face of network errors, retries, or failures.
      example: 2adef8e0-9d63-44bc-b975-9b6ae3440dde
  schemas:
    WithdrawCreateRequest:
      type: object
      required:
        - currency
        - network
        - amount
        - withdraw_address
        - reason
      properties:
        currency:
          type: string
          description: Withdrawal currency
          example: USDC
        network:
          type: string
          description: Network code
          example: ETH
        amount:
          type: string
          description: Withdrawal amount
          example: '100'
        withdraw_address:
          type: string
          description: Withdrawal address
          example: '0x0993446fBB19f4e828768515eF7A9408B5F1A000'
        memo:
          type: string
          description: Withdrawal memo
          example: test
        reason:
          type: string
          description: Withdrawal reason
          example: test
    WithdrawCreateResponse:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
          example: 200
        message:
          type: string
          example: Success
        data:
          $ref: '#/components/schemas/WithdrawCreateData'
    WithdrawCreateData:
      description: Response data for Create Withdraw (4.5.1) - 13 fields
      allOf:
        - $ref: '#/components/schemas/WithdrawBase'
    WithdrawBase:
      type: object
      description: Base schema with shared fields for all withdraw responses
      required:
        - order_id
        - short_order_id
        - order_status
        - order_type
        - currency
        - network
        - amount
        - withdraw_address
        - network_fee
        - processing_fee
        - actual_amount
        - reason
        - create_time
      properties:
        order_id:
          type: string
          format: uuid
          description: Order ID (long)
          example: f75fdee5-0cc1-4b52-818e-497dd376cced
        short_order_id:
          type: string
          description: Order ID (short)
          example: WD260124-N1PAAIXX
        order_status:
          type: string
          description: Order status
          enum:
            - Pending
            - Success
            - Failed
          example: Pending
        order_type:
          type: string
          description: Order type
          example: Withdraw
        currency:
          type: string
          description: Withdrawal currency
          example: USDC
        network:
          type: string
          description: Network code
          example: ETH
        amount:
          type: string
          description: Withdrawal amount
          example: '100'
        withdraw_address:
          type: string
          description: Withdrawal address
          example: '0x0993446fBB19f4e828768515eF7A9408B5F1A000'
        network_fee:
          type: string
          description: Network fee
          example: '0.66'
        processing_fee:
          type: string
          description: Processing fee
          example: '0'
        actual_amount:
          type: string
          description: Actual credited amount
          example: '99.34'
        reason:
          type: string
          description: Withdrawal reason
          example: test
        create_time:
          type: string
          description: Creation time
          example: '2026-01-24 11:41:37 +08:00'
  headers:
    XResponseId:
      description: >-
        Universally unique identifier (UUID v4) for the response. Helpful for
        identifying a request when communicating with UQPAY support.
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: The API token for login provided by UQPay.

````