Balance Information
August 21, 2026 ยท View on GitHub
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 | String getCurrency() | setCurrency(String currency) |
Primary | Boolean | Optional | Optional field representing if the currency is primary currency or not. | Boolean getPrimary() | setPrimary(Boolean primary) |
TotalBalance | Money | Required | The currency and amount for a financial transaction, such as a balance or payment due. | Money getTotalBalance() | setTotalBalance(Money totalBalance) |
AvailableBalance | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getAvailableBalance() | setAvailableBalance(Money availableBalance) |
WithheldBalance | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getWithheldBalance() | setWithheldBalance(Money withheldBalance) |
Example
import com.paypal.sdk.models.BalanceInformation;
import com.paypal.sdk.models.Money;
BalanceInformation balanceInformation = new BalanceInformation.Builder(
"currency2",
new Money.Builder(
"currency_code6",
"value2"
)
.build()
)
.primary(false)
.availableBalance(new Money.Builder(
"currency_code8",
"value4"
)
.build())
.withheldBalance(new Money.Builder(
"currency_code2",
"value8"
)
.build())
.build();