Withdraw pledge

post

https://your-protect-instance.example.com/api/rest/v1/tn/pledges/{pledgeID}/withdraw

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.

Path Params

pledgeID

string

required

The ID of the pledge from which to withdraw funds.

Body Params

destinationSharedAddressID

string

Use either destinationInternalAddressID or destinationSharedAddressID.

amount

string

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

string

Use either destinationInternalAddressID or destinationSharedAddressID. destinationInternalAddressID should represent an internal address that is shared with the participant owning the pledge.

externalReferenceID

string

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

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.