Pave Bank
[Beta] Collateral

Approve Pledge

Lender onlyAdmin Access Required

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

POST
/v1/collateral/pledges/{pledgeID}/approve

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Request Body

application/jsonRequired
external_idstring

Your own reference, e.g. a loan or facility ID. It is stored on the agreement and returned as the agreement's external_id.

Path Parameters

pledgeIDRequiredstring

Pledge ID

Response Body

A pledge as returned by Approve Pledge and Reject Pledge. List Pledges and Get Pledge return the same fields plus the unit breakdown.

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

created_atRequiredstring
Format: date-time
updated_atRequiredstring
Format: date-time
curl -X POST "https://developer-api-staging.pavebank.dev/v1/collateral/pledges/string/approve" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "string"
  }'
{
  "id": "string",
  "collateral_agreement_id": "string",
  "status": "pending",
  "asset": "string",
  "instrument_type": "string",
  "borrower_account_id": "string",
  "lender_account_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get Pledge GET

Retrieves a single pledge including total, locked and available units

Reject Pledge POST

Rejects a pending pledge.