# GatewayBalancesResponse | xrpl
Documentation for xrpl

# Interface GatewayBalancesResponse

Expected response from a GatewayBalancesRequest.

#### Hierarchy

- BaseResponse
  - GatewayBalancesResponse

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:50

#####
Index

### Properties

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

## Properties

### `Optional` api_version

api_version?: number

Inherited from BaseResponse.api_version

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

### `Optional` forwarded

forwarded?: boolean

Inherited from BaseResponse.forwarded

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

### id

id: string | number

Inherited from BaseResponse.id

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

### result

result: {
account: string;
assets?: {
[address: string]: GatewayBalance [];
};
balances?: {
[address: string]: GatewayBalance [];
};
ledger_current_index?: number;
ledger_hash?: string;
ledger_index?: number;
obligations?: {
[currency: string]: string;
};
}

#### Type declaration

- ##### account: string

  The address of the account that issued the balances.

- ##### `Optional` assets?: {
  [address: string]: GatewayBalance [];
  }

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

  - ##### [address: string]: GatewayBalance []

- ##### `Optional` balances?: {
  [address: string]: GatewayBalance [];
  }

  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]: GatewayBalance []

- ##### `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?: {
  [currency: string]: string;
  }

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

  - ##### [currency: string]: string

Overrides BaseResponse.result

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:51

### `Optional` status

status?: string

Inherited from BaseResponse.status

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

### type

type: string

Inherited from BaseResponse.type

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

### `Optional` warning

warning?: "load"

Inherited from BaseResponse.warning

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

### `Optional` warnings

warnings?: ResponseWarning []

Inherited from BaseResponse.warnings

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:38

Generated using TypeDoc