Withdraw pledge
This endpoint creates a request from the pledgee (target of the pledge) to withdraw from a pledge. Only the pledgee can call this endpoint.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
pledgeID
Request
This endpoint expects an object.
amount
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
pledgeActionID
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error