xrpl
    Preparing search index...

    Interface Loan

    A Loan ledger entry captures various Loan terms on-chain. It is an agreement between the Borrower and the loan issuer.

    interface Loan {
        Borrower: string;
        CloseInterestRate?: number;
        ClosePaymentFee?: string;
        Flags: number;
        GracePeriod: number;
        index: string;
        InterestRate?: number;
        LateInterestRate?: number;
        LatePaymentFee?: string;
        LedgerEntryType: "Loan";
        LoanBrokerID: string;
        LoanBrokerNode: string;
        LoanOriginationFee?: string;
        LoanScale?: number;
        LoanSequence: number;
        LoanServiceFee?: string;
        ManagementFeeOutstanding?: string;
        NextPaymentDueDate: number;
        OverpaymentFee?: string;
        OverpaymentInterestRate?: number;
        OwnerNode: string;
        PaymentInterval: number;
        PaymentRemaining: number;
        PeriodicPayment: string;
        PreviousPaymentDueDate?: number;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        PrincipalOutstanding: string;
        StartDate: number;
        TotalValueOutstanding: string;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasPreviousTxnID
      • Loan
    Index

    Properties

    Borrower CloseInterestRate? ClosePaymentFee? Flags GracePeriod index InterestRate? LateInterestRate? LatePaymentFee? LedgerEntryType LoanBrokerID LoanBrokerNode LoanOriginationFee? LoanScale? LoanSequence LoanServiceFee? ManagementFeeOutstanding? NextPaymentDueDate OverpaymentFee? OverpaymentInterestRate? OwnerNode PaymentInterval PaymentRemaining PeriodicPayment PreviousPaymentDueDate? PreviousTxnID PreviousTxnLgrSeq PrincipalOutstanding StartDate TotalValueOutstanding

    Properties

    Borrower: string

    The address of the account that is the borrower.

    CloseInterestRate?: number

    An interest rate charged for repaying the Loan early in 1/10th basis points. Valid values are between 0 and 100000 inclusive. (0 - 100%)

    ClosePaymentFee?: string

    A nominal funds amount paid to the LoanBroker.Owner when a full payment is made.

    Flags: number

    Ledger object flags.

    GracePeriod: number

    The number of seconds after the Payment Due Date that the Loan can be Defaulted.

    index: string
    InterestRate?: number

    Annualized interest rate of the Loan in 1/10th basis points.

    LateInterestRate?: number

    A premium is added to the interest rate for late payments in 1/10th basis points. Valid values are between 0 and 100000 inclusive. (0 - 100%)

    LatePaymentFee?: string

    A nominal funds amount paid to the LoanBroker.Owner when a payment is late.

    LedgerEntryType: "Loan"
    LoanBrokerID: string

    The ID of the LoanBroker associated with this Loan Instance.

    LoanBrokerNode: string

    Identifies the page where this item is referenced in the LoanBrokers owner's directory.

    LoanOriginationFee?: string

    A nominal fee amount paid to the LoanBroker.Owner when the Loan is created.

    LoanScale?: number

    The scale factor that ensures all computed amounts are rounded to the same number of decimal places. It is determined based on the total loan value at creation time.

    LoanSequence: number

    The sequence number of the Loan.

    LoanServiceFee?: string

    A nominal funds amount paid to the LoanBroker.Owner with every Loan payment.

    ManagementFeeOutstanding?: string

    The remaining Management Fee owed to the LoanBroker.

    NextPaymentDueDate: number

    The timestamp of when the next payment is due in Ripple Epoch.

    OverpaymentFee?: string

    A fee charged on over-payments in 1/10th basis points. Valid values are between 0 and 100000 inclusive. (0 - 100%)

    OverpaymentInterestRate?: number

    An interest rate charged on over-payments in 1/10th basis points. Valid values are between 0 and 100000 inclusive. (0 - 100%)

    OwnerNode: string

    Identifies the page where this item is referenced in the Borrower owner's directory.

    PaymentInterval: number

    Number of seconds between Loan payments.

    PaymentRemaining: number

    The number of payments remaining on the Loan.

    PeriodicPayment: string

    The calculated periodic payment amount for each payment interval.

    PreviousPaymentDueDate?: number

    The timestamp of when the previous payment was made in Ripple Epoch.

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    PrincipalOutstanding: string

    The principal amount requested by the Borrower.

    StartDate: number

    The timestamp of when the Loan started Ripple Epoch.

    TotalValueOutstanding: string

    The total outstanding value of the Loan, including all fees and interest.

    Settings

    Member Visibility

    On This Page

    Properties