Skip to navigation
Taurus NetworkTaurus Network - Lending

Create lending agreement

This endpoint creates a lending agreement. Once approved by the lender and the borrower, the agreement will automatically execute the loan lifecycle. This endpoint should be called by the borrower.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
lendingOfferIDstringOptional
The ID of the lending offer used to create the agreement. This parameter is optional if both the lender and the borrower already negotiated the terms of the loan not represented by an existing lending offer.
lenderParticipantIDstringOptional
The ID of the lender participant
annualPercentageYieldstringOptionalformat: "uint64"

The interest rate of the to create lending offer, based on 5 decimals. Example: 525000 corresponds to 5.25% annual percentage yield

currencyIDstringOptional
The currency ID of the loan
amountstringOptional

numeric; Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places)

durationstringOptional
collateralslist of objectsOptional
borrowerSharedAddressIDstringOptional
The shared address ID representing the address owned by the borrower where the lender will sent the funds to. Unless it is updated, it will also be the addres used for repayment.

Response

A successful response.
lendingAgreementIDstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error