Create pledge

POST

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

POST

/api/rest/v1/tn/pledges

curl -X POST https://your-protect-instance.example.com/api/rest/v1/tn/pledges \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "result": {
    "id": "string",
    "sharedAddressID": "string",
    "ownerParticipantID": "string",
    "targetParticipantID": "string",
    "currencyID": "string",
    "blockchain": "string",
    "network": "string",
    "arg1": "string",
    "arg2": "string",
    "amount": "string",
    "status": "string",
    "pledgeType": "string",
    "trails": [
      {
        "id": "string",
        "pledgeID": "string",
        "addressCommandID": "string",
        "participantID": "string",
        "pledgeAmount": "string",
        "action": "string",
        "comment": "string",
        "createdAt": "2024-01-15T09:30:00Z"
      }
    ],
    "originCreationDate": "2024-01-15T09:30:00Z",
    "durationSetup": {
      "minimumDuration": "string",
      "endOfMinimumDurationDate": "2024-01-15T09:30:00Z",
      "noticePeriodDuration": "string",
      "endOfNoticePeriodDate": "2024-01-15T09:30:00Z"
    },
    "unpledgeDate": "2024-01-15T09:30:00Z",
    "attributes": [
      {
        "id": "string",
        "key": "string",
        "value": "string",
        "owner": "string",
        "type": "string",
        "subtype": "string",
        "contentType": "string",
        "isTaurusNetworkShared": true
      }
    ],
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "externalReferenceId": "string",
    "reconciliationNote": "string",
    "direction": "string"
  },
  "pledgeActionID": "string"
}

This endpoint creates a pledge of funds from an address that was shared to a Taurus Network participant.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

sharedAddressIDstringOptional

currencyIDstringOptional

amountstringOptional

pledgeDurationSetupobjectOptional

pledgeTypestringOptional

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

keyValueAttributeslist of objectsOptional

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