Pave Bank
[Beta] Collateral

Get Collateral Agreement

Lender or BorrowerViewer Access

Retrieves a single collateral agreement your legal entity is party to

GET
/v1/collateral/agreements/{agreementID}

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Path Parameters

agreementIDRequiredstring

Agreement ID

Response Body

Success response

idRequiredstring

Agreement ID, prefixed collateral_agreement_

borrower_legal_entity_idRequiredstring

Legal entity whose accounts are pledged under this agreement

lender_legal_entity_idRequiredstring

Legal entity the accounts are pledged to

external_idRequiredstring

The lender's own reference for this agreement, set on approval

statusRequiredstring

Lifecycle status of a collateral agreement. open accepts new pledges; closed no longer does.

Value in: "open" | "closed"
dispute_window_hoursinteger

Length of the enforcement dispute window for this agreement, in hours. A hold's dispute_deadline is this many hours after enforcement starts. Present on agreements created after dispute terms were captured.

created_atRequiredstring
Format: date-time
updated_atRequiredstring
Format: date-time
curl -X GET "https://developer-api-staging.pavebank.dev/v1/collateral/agreements/string" \
  -H "Authorization: Bearer <token>"
{
  "id": "string",
  "borrower_legal_entity_id": "string",
  "lender_legal_entity_id": "string",
  "external_id": "string",
  "status": "open",
  "dispute_window_hours": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

List Collateral Agreements GET

Lists the collateral agreements your legal entity is party to

List Pledges GET

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