Create an XLM liquidity pool Withdraw request

post

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xlm/withdraw

This endpoint creates an XLM liquidity pool Withdraw request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Body Params

Creates an XLM Liquidity Pool Withdraw Request to withdraw 'amount' of shares from the liquidity pool, and at least 'minAmounts' of asset A and B.

fromAddressId

string

required

poolID

string

required

Hex String representing the Liquidity Pool ID on ledger. Example: 076bbb9f17f8d47209515a345420d40ea1ebcd3cb6a370ea0d56fc12dbf084cb

amount

string

required

minAmountAssetA

string

required

minAmountAssetB

string

required

feeLimit

string

comment

string

externalRequestId

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.