Withdraw pledge
This endpoint creates a request from the pledgee (target of the pledge) to withdraw from a pledge. The amount withdrawn will be deducted from the pledge amount. Only the pledgee 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
pledgeID
The ID of the pledge from which to withdraw funds.
Request
This endpoint expects an object.
amount
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)
destinationInternalAddressID
Use either destinationInternalAddressID or destinationSharedAddressID. destinationInternalAddressID should represent an internal address that is shared with the participant owning the pledge.
externalReferenceID
Identifier for the withdrawal in the user's system. This must be unique. Attempting to create a withdrawal with an existing externalReferenceID will do nothing and return the originally existing withdrawal
Response
A successful response.
pledgeWithdrawalID
The ID of the pledge withdrawal.
pledgeActionID
The ID of the pledge action to be approved to finalize the withdrawal creation.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error