For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This endpoint initiates a withdrawal from the pledgor (owner of the pledge) to send funds from a pledge to the pledgee (target of the pledge). The amount withdrawn will be deducted from the pledge amount. Only the pledgor can call this endpoint. The endpoint will create a pledge action that needs to be approved to finalize the withdrawal.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
pledgeIDstringRequired
The ID of the pledge from which to withdraw funds.
Request
This endpoint expects an object.
amountstringRequired
numeric; Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places)
destinationSharedAddressIDstringOptional
The shared address ID representing the address where the withdrawn funds will be sent. The address must be shared with the participant owning the pledge.
Response
A successful response.
pledgeWithdrawalIDstringOptional
The ID of the pledge withdrawal.
pledgeActionIDstringOptional
The ID of the pledge action to be approved to finalize the withdrawal creation.
