Interface PathFindCreateRequest

Start sending pathfinding information.

interface PathFindCreateRequest {
    api_version?: number;
    command: "path_find";
    destination_account: string;
    destination_amount: Amount;
    id?: string | number;
    paths?: Path[];
    send_max?: Amount;
    source_account: string;
    subcommand: "create";
    [x: string]: unknown;
}

Hierarchy

  • BasePathFindRequest
    • PathFindCreateRequest

Indexable

  • [x: string]: unknown

Properties

api_version? command destination_account destination_amount id? paths? send_max? source_account subcommand

Properties

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "path_find"

The name of the API method.

destination_account

destination_account: string

Unique address of the account to find a path to.

destination_amount

destination_amount: Amount

Currency Amount that the destination account would receive in a transaction.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Optionalpaths

paths?: Path[]

Array of arrays of objects, representing payment paths to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path.

Optionalsend_max

send_max?: Amount

Currency amount that would be spent in the transaction.

source_account

source_account: string

Unique address of the account to find a path from. In other words, the. Account that would be sending a payment.

subcommand

subcommand: "create"

Settings

Member Visibility

On This Page

Properties