xrpl
    Preparing search index...

    Interface LoanBrokerSet

    The transaction creates a new LoanBroker object or updates an existing one.

    interface LoanBrokerSet {
        Account: string;
        AccountTxnID?: string;
        CoverRateLiquidation?: number;
        CoverRateMinimum?: number;
        Data?: string;
        DebtMaximum?: string;
        Delegate?: string;
        Fee?: string;
        Flags?: number | GlobalFlagsInterface;
        LastLedgerSequence?: number;
        LoanBrokerID?: string;
        ManagementFeeRate?: number;
        Memos?: Memo[];
        NetworkID?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "LoanBrokerSet";
        TxnSignature?: string;
        VaultID: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? CoverRateLiquidation? CoverRateMinimum? Data? DebtMaximum? Delegate? Fee? Flags? LastLedgerSequence? LoanBrokerID? ManagementFeeRate? Memos? NetworkID? Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TxnSignature? VaultID

    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.

    CoverRateLiquidation?: number

    The 1/10th basis point of minimum required first loss capital liquidated to cover a Loan default. Valid values are between 0 and 100000 inclusive.

    CoverRateMinimum?: number

    The 1/10th basis point DebtTotal that the first loss capital must cover. Valid values are between 0 and 100000 inclusive.

    Data?: string

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

    DebtMaximum?: string

    The maximum amount the protocol can owe the Vault. The default value of 0 means there is no limit to the debt. Must not be negative.

    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 | GlobalFlagsInterface

    Set of bit-flags for this transaction.

    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.

    LoanBrokerID?: string

    The Loan Broker ID that the transaction is modifying.

    ManagementFeeRate?: number

    The 1/10th basis point fee charged by the Lending Protocol Owner. Valid values are between 0 and 10000 inclusive (1% - 10%).

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    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: "LoanBrokerSet"

    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.

    VaultID: string

    The Vault ID that the Lending Protocol will use to access liquidity.

    Settings

    Member Visibility

    On This Page

    Properties