Pave Bank
[Beta] Collateral

Get Pledge

Lender or BorrowerViewer Access

Retrieves a single pledge including total, locked and available units

GET
/v1/collateral/pledges/{pledgeID}

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Path Parameters

pledgeIDRequiredstring

Pledge ID

Response Body

A pledge with its current unit breakdown and latest mark-to-market price, as returned by List Pledges and Get Pledge.

idRequiredstring

Pledge ID, prefixed collateral_pledge_

collateral_agreement_idRequiredstring

Agreement this pledge belongs to

statusRequiredstring

Lifecycle status of a pledge. pending awaits approval by the lender or by Pave Bank, approved can be locked against, rejected was declined by the lender and is final, removed was removed by Pave Bank and frees the account to be pledged again.

Value in: "pending" | "approved" | "rejected" | "removed"
assetRequiredstring

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

instrument_typestring

Instrument asset held in the pledged account, e.g. TBILL, MMF or BONDS. Unit fields are denominated in this asset's minor units.

borrower_account_idRequiredstring

The ID of the recipient's account

lender_account_idRequiredstring

The ID of the recipient's account

total_unitsRequiredstring

Total units held in the pledged account, in minor units.

locked_unitsRequiredstring

Units currently reserved by active holds, in minor units.

available_unitsRequiredstring

Units that can still be locked (total_units minus locked_units), in minor units.

market_value_per_unitRequiredstring

Latest mark-to-market price of one unit of instrument_type, quoted in asset as a decimal string (e.g. 0.9985). Empty when no price has been recorded for the instrument yet.

created_atRequiredstring
Format: date-time
updated_atRequiredstring
Format: date-time
curl -X GET "https://developer-api-staging.pavebank.dev/v1/collateral/pledges/string" \
  -H "Authorization: Bearer <token>"
{
  "id": "string",
  "collateral_agreement_id": "string",
  "status": "pending",
  "asset": "string",
  "instrument_type": "string",
  "borrower_account_id": "string",
  "lender_account_id": "string",
  "total_units": "string",
  "locked_units": "string",
  "available_units": "string",
  "market_value_per_unit": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

List Pledges GET

Lists pledges under your agreements, as lender or borrower, with their current unit breakdown

Approve Pledge POST

Approves a pending pledge so its units can be locked. Pave Bank may also approve pledges.