Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayBalancesResponse

Expected response from a GatewayBalancesRequest.

Hierarchy

  • BaseResponse
    • GatewayBalancesResponse

Index

Properties

Optional api_version

api_version: number

Optional forwarded

forwarded: boolean

id

id: string | number

result

result: { account: string; assets?: {}; balances?: {}; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; obligations?: {} }

Type declaration

  • account: string

    The address of the account that issued the balances.

  • Optional assets?: {}

    Total amounts held that are issued by others. In the recommended. configuration, the issuing address should have none.

    • [address: string]: Balance[]
  • Optional balances?: {}

    Amounts issued to the hotwallet addresses from the request. The keys are. addresses and the values are arrays of currency amounts they hold.

    • [address: string]: Balance[]
  • Optional ledger_current_index?: number

    The ledger index of the ledger version that was used to generate this. response.

  • Optional ledger_hash?: string

    The identifying hash of the ledger version that was used to generate. this response.

  • Optional ledger_index?: number

    The ledger index of the current in-progress ledger version, which was. used to retrieve this information.

  • Optional obligations?: {}

    Total amounts issued to addresses not excluded, as a map of currencies. to the total value issued.

    • [currency: string]: string

status

status: string

type

type: string

Optional warning

warning: "load"

Optional warnings

warnings: Warning[]

Generated using TypeDoc