Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RipplePathFindResponse

Response expected from a RipplePathFindRequest.

Hierarchy

  • BaseResponse
    • RipplePathFindResponse

Index

Properties

Properties

Optional api_version

api_version: number

Optional forwarded

forwarded: boolean

id

id: string | number

result

result: { alternatives: PathOption[]; destination_account: string; destination_currencies: string[] }

Type declaration

  • alternatives: PathOption[]

    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_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"

status

status: string

type

type: string

Optional warning

warning: "load"

Optional warnings

warnings: Warning[]

Generated using TypeDoc