Interface AccountCurrenciesResponse

The expected response from an AccountCurrenciesRequest.

interface AccountCurrenciesResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        ledger_hash?: string;
        ledger_index: number;
        receive_currencies: string[];
        send_currencies: string[];
        validated: boolean;
    };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy (View Summary)

Properties

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

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

result: {
    ledger_hash?: string;
    ledger_index: number;
    receive_currencies: string[];
    send_currencies: string[];
    validated: boolean;
}

Type declaration

  • Optionalledger_hash?: string

    The identifying hash of the ledger version used to retrieve this data, as hex.

  • ledger_index: number

    The ledger index of the ledger version used to retrieve this data.

  • receive_currencies: string[]

    Array of Currency Codes for currencies that this account can receive.

  • send_currencies: string[]

    Array of Currency Codes for currencies that this account can send.

  • validated: boolean

    If true, this data comes from a validated ledger.

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties