xrpl
    Preparing search index...

    Interface LoanSet

    The transaction creates a new Loan object.

    interface LoanSet {
        Account: string;
        AccountTxnID?: string;
        CloseInterestRate?: number;
        ClosePaymentFee?: string;
        Counterparty?: string;
        CounterpartySignature?: CounterpartySignature;
        Data?: string;
        Delegate?: string;
        Fee?: string;
        Flags?: number | LoanSetFlagsInterface;
        GracePeriod?: number;
        InterestRate?: number;
        LastLedgerSequence?: number;
        LateInterestRate?: number;
        LatePaymentFee?: string;
        LoanBrokerID: string;
        LoanOriginationFee?: string;
        LoanServiceFee?: string;
        Memos?: Memo[];
        NetworkID?: number;
        OverpaymentFee?: number;
        OverpaymentInterestRate?: number;
        PaymentInterval?: number;
        PaymentTotal?: number;
        PrincipalRequested: string;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "LoanSet";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account: string

    The unique address of the transaction sender.

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    CloseInterestRate?: number

    A Fee 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 an early full repayment is made.

    Counterparty?: string

    The address of the counterparty of the Loan.

    CounterpartySignature?: CounterpartySignature

    The signature of the counterparty over the transaction.

    Data?: string

    Arbitrary metadata in hex format. The field is limited to 512 characters.

    Delegate?: string

    The delegate account that is sending the transaction.

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    Flags?: number | LoanSetFlagsInterface

    Set of bit-flags for this transaction.

    GracePeriod?: number

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

    InterestRate?: number

    Annualized interest rate of the Loan in in 1/10th basis points. Valid values are between 0 and 100000 inclusive. (0 - 100%)

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    LateInterestRate?: number

    A premium added to the interest rate for late payments in 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.

    LoanBrokerID: string

    The Loan Broker ID associated with the loan.

    LoanOriginationFee?: string

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

    LoanServiceFee?: string

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

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    OverpaymentFee?: number

    A fee charged on overpayments 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%)

    PaymentInterval?: number

    Number of seconds between Loan payments.

    PaymentTotal?: number

    The total number of payments to be made against the Loan.

    PrincipalRequested: string

    The principal amount requested by the Borrower.

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    TransactionType: "LoanSet"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.