PayPal-PHP-Server-SDK/doc/models/balance-information.md

Balance Information

The Balance information.

Structure

BalanceInformation

Fields

Name	Type	Tags	Description	Getter	Setter
currency	string	Required	The three-character ISO-4217 currency code that identifies the currency. Constraints: Minimum Length: 3, Maximum Length: 3	getCurrency(): string	setCurrency(string currency): void
primary	?bool	Optional	Optional field representing if the currency is primary currency or not.	getPrimary(): ?bool	setPrimary(?bool primary): void
totalBalance	Money	Required	The currency and amount for a financial transaction, such as a balance or payment due.	getTotalBalance(): Money	setTotalBalance(Money totalBalance): void
availableBalance	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getAvailableBalance(): ?Money	setAvailableBalance(?Money availableBalance): void
withheldBalance	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getWithheldBalance(): ?Money	setWithheldBalance(?Money withheldBalance): void

Example (as JSON)

{
  "currency": "currency4",
  "primary": false,
  "total_balance": {
    "currency_code": "currency_code6",
    "value": "value2"
  },
  "available_balance": {
    "currency_code": "currency_code8",
    "value": "value4"
  },
  "withheld_balance": {
    "currency_code": "currency_code2",
    "value": "value8"
  }
}