Facilities
Create a facility
PreviewRecord a financing so Synpute can monitor it: the lender, the borrower, the clusters pledged and the contracts behind it.
post/v1/facilities
facilities:writeBody parameters
- borrowerSynpute IDrequired
- Borrowing operator
- collateralarray of Synpute IDrequired
- Clusters pledged
- contractsarray of Synpute IDrequired
- Supporting contracts
- matures_onstringrequired
- Maturity
- principalobjectrequired
- Committed principal
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
Response 201 · Facility
- borrowerSynpute IDrequired
- Borrowing operator
- collateralarray of Synpute IDrequired
- Clusters pledged
- contractsarray of Synpute IDrequired
- Contracts whose cash flows support the loan
- createdstringrequired
- When the record was created
- idSynpute IDrequired
- Facility ID
- lenderSynpute IDrequired
- Lender (or agent)
- matures_onstringrequired
- Maturity
- objectstringrequired
- Object type
- principalobjectrequired
- Committed principal
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
- statusstringrequired
- Lifecycle
proposedactivein_transferrepaiddefaulted- transfer_programstring | nullrequired
- Transfer program ID, if one is in place
Errors
400403return the standard error shape.