Skip to main content

Create a withdrawal order

POST 
/api/v1/order/withdrawal

Create a withdrawal order to transfer funds from your balance to an external wallet. Specify the amount, asset type, and the destination wallet address. The integration ID must also be provided to link the withdrawal to a specific integration.

Withdrawal can only be processed if there are sufficient funds in the wallet balance, including fees.

Request​

Body

Details of the withdrawal order to create.

    amount stringrequired

    The amount to withdraw from the balance. It should be a positive decimal number, specified with up to 6 decimal places.

    assetId stringrequired

    Possible values: [TRX, USDT_TRC20]

    The asset type to be withdrawn.

    destinationAddress stringrequired

    The wallet address where the funds will be sent. This must be a valid address compatible with the selected asset.

    integrationId stringrequired

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    The unique identifier of the integration through which the withdrawal is being processed. This ID helps link the withdrawal to a specific integration.

Responses​

Withdrawal order created successfully.

Schema
    orderId stringrequired

    The unique identifier of the created refund or withdrawal order. Use this ID to track the order's status .

Loading...