Skip to navigation

Initiate withdraw pledge

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). Only the pledgor can call this endpoint.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pledgeIDstringRequired

Request

This endpoint expects an object.
amountstringRequired
destinationSharedAddressIDstringOptional

Response

A successful response.
pledgeWithdrawalIDstringOptional
pledgeActionIDstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error