Sign in
Actions

Create Withdraw Interaction Handler

Changed on

Record a withdraw interaction

post/v2/actions/withdraw/{opportunityId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

opportunityIdstring uuid nullable required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Opportunity unique identifier

Request body

amountstring required

Shares to redeem in smallest unit

distributorIdstring required

Distributor ID

slippageBpsinteger

Optional: slippage tolerance in basis points (e.g., 50 = 0.5%). Only applied to opportunities that require it

tokenOutstring

Optional: token to receive after withdrawal (required for Midas, Mellow, Veda)

userAddressstring required

User wallet address (validated by middleware)

Response

OK

actionIdstring uuid nullable

Example response

{
  "actionId": "248df4b7-aa70-47b8-a036-33ac447e668d"
}

Changes

  • v21e37766ac210Revision changes
    • info

      added the optional property /// to the response with the status

  • v260527ba59276Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status