Create lending agreement

post

https://your-protect-instance.example.com/api/rest/v1/tn/lending/agreements

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.

Body Params

lendingOfferID

string

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.

lenderParticipantID

string

The ID of the lender participant

annualPercentageYield

string

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

currencyID

string

The currency ID of the loan

amount

string

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)

duration

string

collaterals

array of objects

collaterals

borrowerSharedAddressID

string

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.

interestPaymentConfiguration

object

globalConfiguration

object

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.