Skip to navigation
Taurus NetworkTaurus Network - Pledge

Create pledge

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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
sharedAddressIDstringOptional
The shared address ID representing the internal address where the pledged funds will be held.
currencyIDstringOptional
amountstringOptional

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)

pledgeDurationSetupobjectOptional
pledgeTypestringOptional

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.

keyValueAttributeslist of objectsOptional

Optional key-value attributes to attach to the pledge.

externalReferenceIdstringOptional
Reference identifier for the pledge that will be shared to the counter participant.
reconciliationNotestringOptional
Reconciliation note used internally, not shared to the counter participant.

Response

A successful response.
resultobjectOptional
pledgeActionIDstringOptional

Errors

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