Release Pledge Units

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Request Body

application/jsonRequired

unitsRequiredstring

Units to release, in minor units. Must be greater than zero and no more than the pledge's locked_units.

Hold ID. This is also the transaction ID of the underlying hold transaction. Each lock, release or enforcement action closes the current hold and returns a new one with its own ID, so use the latest hold for a pledge rather than a stored ID.

lender_legal_entity_idRequiredstring

pledge_idRequiredstring

Pledge the hold is placed on

assetRequiredstring

The currency in which the amount is made (e.g. USD, EUR, SGD)

instrument_typestring

Instrument asset the held units belong to, e.g. TBILL. units is denominated in this asset's minor units.

unitsRequiredstring

Units of the pledged instrument in minor units, as a decimal string. Instrument assets such as TBILL, MMF and BONDS have 6 decimals, so 1.5 units is "1500000".

statusRequiredstring

Lifecycle status of a hold. locked units are reserved for the lender; dispute_window means enforcement has started and the borrower may still dispute until dispute_deadline; enforced units were transferred to the lender; released units were returned to the borrower's spendable balance; cancelled means enforcement was cancelled and the units were moved to a new locked hold; failed is terminal with no units reserved.

dispute_deadlinestring

Set when enforcement starts and kept on the hold afterwards. While the status is dispute_window, enforcement completes automatically at this time unless cancelled.

Format: date-time

fee_amountstring

Enforcement fee for this hold, in minor units of fee_asset. Set when enforcement starts and billed to the lender's account separately; it is not deducted from the enforced units. Absent on holds that never entered enforcement, and "0" when no fee applies.

fee_assetstring

Asset of fee_amount. Omitted when no fee applies.

created_atRequiredstring

Format: date-time

updated_atRequiredstring

Format: date-time

curl -X POST "https://developer-api-staging.pavebank.dev/v1/collateral/pledges/string/release" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "units": "string"
  }'

{
  "id": "string",
  "lender_legal_entity_id": "string",
  "pledge_id": "string",
  "asset": "string",
  "instrument_type": "string",
  "units": "string",
  "status": "locked",
  "dispute_deadline": "2019-08-24T14:15:22Z",
  "fee_amount": "string",
  "fee_asset": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Release Pledge Units

Authorization

Request Body

Path Parameters

Response Body