xrpl
    Preparing search index...

    Interface RipplePathFindResponse

    Response expected from a RipplePathFindRequest.

    interface RipplePathFindResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: {
            alternatives: RipplePathFindPathOption[];
            destination_account: string;
            destination_amount: Amount;
            destination_currencies: string[];
            full_reply?: boolean;
            id?: string | number;
            ledger_current_index?: number;
            source_account: string;
            validated: boolean;
        };
        status?: string;
        type: string;
        warning?: "load";
        warnings?: ResponseWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    api_version? forwarded? id result status? type warning? warnings?

    Properties

    api_version?: number
    forwarded?: boolean
    id: string | number
    result: {
        alternatives: RipplePathFindPathOption[];
        destination_account: string;
        destination_amount: Amount;
        destination_currencies: string[];
        full_reply?: boolean;
        id?: string | number;
        ledger_current_index?: number;
        source_account: string;
        validated: boolean;
    }

    Type declaration

    • alternatives: RipplePathFindPathOption[]

      Array of objects with possible paths to take, as described below. If empty, then there are no paths connecting the source and destination accounts.

    • destination_account: string

      Unique address of the account that would receive a payment transaction.

    • destination_amount: Amount
    • destination_currencies: string[]

      Array of strings representing the currencies that the destination accepts, as 3-letter codes like "USD" or as 40-character hex like "015841551A748AD2C1F76FF6ECB0CCCD00000000".

    • Optionalfull_reply?: boolean
    • Optionalid?: string | number
    • Optionalledger_current_index?: number
    • source_account: string
    • validated: boolean
    status?: string
    type: string
    warning?: "load"
    warnings?: ResponseWarning[]

    Settings

    Member Visibility

    On This Page

    Properties