Interface ILoanSet
The LoanSet transaction creates a new loan associated with a loan broker.
Two parties sign it: the submitting Account and the counterparty, who co-signs via
CounterpartySignature unless this transaction is part of a Batch. One of them is the
LoanBroker's owner and the other is the borrower, in either role.
Inherited Members
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
public interface ILoanSet : ITransactionCommon
Remarks
Requires the Loan amendment (XLS-66d). This feature is in draft and subject to change.
Properties
| Edit this page View SourceCloseInterestRate
The rate charged for repaying the loan early, in 1/10th of a basis point: 100000 = 100%, 5000 = 5%. Valid range: 0–100000.
Declaration
uint? CloseInterestRate { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
ClosePaymentFee
The fee charged for early loan closure (Number type).
Declaration
XrplNumber? ClosePaymentFee { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable |
Counterparty
The counterparty: the account that co-signs via CounterpartySignature. Optional; when
omitted the counterparty is the LoanBroker's owner. One of Account and the
counterparty must be the broker owner, and the other one is the borrower - so this is
the borrower when the broker owner submits, and the broker owner (or omitted) when the
borrower submits. Required on a LoanSet inside a Batch.
Declaration
string Counterparty { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
CounterpartySignature
The counterparty's co-signature (sfCounterpartySignature) - SigningPubKey and
TxnSignature, or Signers for a multisig counterparty. It is not part of
what either party signs. Absent on a LoanSet inside a Batch, where the counterparty
signs the batch through BatchSigners instead.
Declaration
SignatureObject CounterpartySignature { get; set; }
Property Value
| Type | Description |
|---|---|
| SignatureObject |
Remarks
Produced by LoanSigningHelper and XrplWallet.SignAsLoanCounterparty.
Data
Arbitrary hex-encoded metadata, limited to 256 bytes.
Declaration
string Data { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Flags
LoanSet transaction flags.
Declaration
LoanSetFlags? Flags { get; set; }
Property Value
| Type | Description |
|---|---|
| LoanSetFlags? |
GracePeriod
The grace period before late fees apply, in seconds. Default: 60.
Declaration
uint? GracePeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
InterestRate
The annualized interest rate for the loan, in 1/10th of a basis point: 100000 = 100%, 5000 = 5%. Valid range: 0–100000.
Declaration
uint? InterestRate { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
LateInterestRate
The premium added to the interest rate for late payments, in 1/10th of a basis point: 100000 = 100%, 5000 = 5%. Valid range: 0–100000.
Declaration
uint? LateInterestRate { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
LatePaymentFee
The fee charged for late payments (Number type).
Declaration
XrplNumber? LatePaymentFee { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable |
LoanBrokerID
The ID of the loan broker managing this loan.
Declaration
string LoanBrokerID { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
LoanOriginationFee
The origination fee for the loan (Number type).
Declaration
XrplNumber? LoanOriginationFee { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable |
LoanServiceFee
The service fee for the loan (Number type).
Declaration
XrplNumber? LoanServiceFee { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable |
OverpaymentFee
The fee rate charged on overpayments, in 1/10th of a basis point: 100000 = 100%, 5000 = 5%. Valid range: 0–100000.
Declaration
uint? OverpaymentFee { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
OverpaymentInterestRate
The interest rate charged on overpayments, in 1/10th of a basis point: 100000 = 100%, 5000 = 5%. Valid range: 0–100000.
Declaration
uint? OverpaymentInterestRate { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
PaymentInterval
The interval between payments, in seconds. Default: 60.
Declaration
uint? PaymentInterval { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
PaymentTotal
The total number of payments for the loan. Default: 1.
Declaration
uint? PaymentTotal { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
PrincipalRequested
The principal amount requested for the loan (Number type). Required.
Declaration
XrplNumber? PrincipalRequested { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable |