Create pledge

post

https://your-protect-instance.example.com/api/rest/v1/tn/pledges

This endpoint creates a pledge of funds from an internal address that was previously shared to a Taurus-NETWORK participant. The funds will reserved and can't be spend until they are unpledged or withdrawn by the target participant. The endpoint will create a pledge action that needs to be approved to finalize the pledge and transmit it to the other participant.

Body Params

sharedAddressID

string

The shared address ID representing the internal address where the pledged funds will be held.

currencyID

string

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)

pledgeDurationSetup

object

pledgeType

string

The type of the pledge regarding the withdrawal rights. Possible values are: 'NO_WITHDRAWALS_RIGHTS', 'PLEDGEE_WITHDRAWALS_RIGHTS', 'PLEDGEE_AUTO_APPROVED_WITHDRAWALS_RIGHTS'

'NO_WITHDRAWALS_RIGHTS' means that the target participant has no right to withdraw from the pledge.

'PLEDGEE_WITHDRAWALS_RIGHTS' means that the target participant can request withdrawals from the pledge that must be approved by the owner participant.

'PLEDGEE_AUTO_APPROVED_WITHDRAWALS_RIGHTS' means that the target participant can request withdrawals from the pledge that are automatically approved without the owner participant approval, if the owner approved the setuped governance rules.

keyValueAttributes

array of objects

Optional key-value attributes to attach to the pledge.

keyValueAttributes

externalReferenceId

string

Reference identifier for the pledge that will be shared to the counter participant.

reconciliationNote

string

Reconciliation note used internally, not shared to the counter participant.

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.