Show / Hide Table of Contents

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
ITransactionCommon.NetworkID
ITransactionCommon.Account
ITransactionCommon.AccountTxnID
ITransactionCommon.Fee
ITransactionCommon.LastLedgerSequence
ITransactionCommon.Memos
ITransactionCommon.MemoValue
ITransactionCommon.Sequence
ITransactionCommon.Signers
ITransactionCommon.SigningPublicKey
ITransactionCommon.TransactionSignature
ITransactionCommon.TransactionType
ITransactionCommon.TransactionTypeName
ITransactionCommon.SourceTag
ITransactionCommon.TicketSequence
ITransactionCommon.Delegate
ITransactionCommon.OperationLimit
ITransactionCommon.Sponsor
ITransactionCommon.SponsorFlags
ITransactionCommon.SponsorSignature
ITransactionCommon.ToJson()
ITransactionCommon.ToDictionary()
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 Source

CloseInterestRate

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?
| Edit this page View Source

ClosePaymentFee

The fee charged for early loan closure (Number type).

Declaration
XrplNumber? ClosePaymentFee { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

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
| Edit this page View Source

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.

| Edit this page View Source

Data

Arbitrary hex-encoded metadata, limited to 256 bytes.

Declaration
string Data { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Flags

LoanSet transaction flags.

Declaration
LoanSetFlags? Flags { get; set; }
Property Value
Type Description
LoanSetFlags?
| Edit this page View Source

GracePeriod

The grace period before late fees apply, in seconds. Default: 60.

Declaration
uint? GracePeriod { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

LatePaymentFee

The fee charged for late payments (Number type).

Declaration
XrplNumber? LatePaymentFee { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

LoanBrokerID

The ID of the loan broker managing this loan.

Declaration
string LoanBrokerID { get; set; }
Property Value
Type Description
string
| Edit this page View Source

LoanOriginationFee

The origination fee for the loan (Number type).

Declaration
XrplNumber? LoanOriginationFee { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

LoanServiceFee

The service fee for the loan (Number type).

Declaration
XrplNumber? LoanServiceFee { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

PaymentInterval

The interval between payments, in seconds. Default: 60.

Declaration
uint? PaymentInterval { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

PaymentTotal

The total number of payments for the loan. Default: 1.

Declaration
uint? PaymentTotal { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

PrincipalRequested

The principal amount requested for the loan (Number type). Required.

Declaration
XrplNumber? PrincipalRequested { get; set; }
Property Value
Type Description
Nullable

Extension Methods

FeePayerExtensions.GetFeePayer(ITransactionCommon)
FeePayerExtensions.GetFeePayer(ITransactionCommon, ITransactionMetadata)
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX