com.paypal.sdk.models

Class BalanceInformation

java.lang.Object

com.paypal.sdk.models.BalanceInformation

public class BalanceInformation
extends Object

This is a model class for BalanceInformation type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BalanceInformation.Builder Class to build instances of BalanceInformation.

Constructor Summary

Constructors

Constructor and Description
BalanceInformation() Default constructor.
BalanceInformation(String currency, Money totalBalance, Boolean primary, Money availableBalance, Money withheldBalance) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Money	getAvailableBalance() Getter for AvailableBalance.
String	getCurrency() Getter for Currency.
Boolean	getPrimary() Getter for Primary.
Money	getTotalBalance() Getter for TotalBalance.
Money	getWithheldBalance() Getter for WithheldBalance.
void	setAvailableBalance(Money availableBalance) Setter for AvailableBalance.
void	setCurrency(String currency) Setter for Currency.
void	setPrimary(Boolean primary) Setter for Primary.
void	setTotalBalance(Money totalBalance) Setter for TotalBalance.
void	setWithheldBalance(Money withheldBalance) Setter for WithheldBalance.
BalanceInformation.Builder	toBuilder() Builds a new BalanceInformation.Builder object.
String	toString() Converts this BalanceInformation into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BalanceInformation

public BalanceInformation()

Default constructor.

BalanceInformation

public BalanceInformation(String currency,
                          Money totalBalance,
                          Boolean primary,
                          Money availableBalance,
                          Money withheldBalance)

Initialization constructor.

Parameters:

currency - String value for currency.

totalBalance - Money value for totalBalance.

primary - Boolean value for primary.

availableBalance - Money value for availableBalance.

withheldBalance - Money value for withheldBalance.

Method Detail

getCurrency

public String getCurrency()

Getter for Currency. The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Returns:

Returns the String

setCurrency

public void setCurrency(String currency)

Setter for Currency. The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Parameters:

currency - Value for String

getPrimary

public Boolean getPrimary()

Getter for Primary. Optional field representing if the currency is primary currency or not.

Returns:

Returns the Boolean

setPrimary

public void setPrimary(Boolean primary)

Setter for Primary. Optional field representing if the currency is primary currency or not.

Parameters:

primary - Value for Boolean

getTotalBalance

public Money getTotalBalance()

Getter for TotalBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setTotalBalance

public void setTotalBalance(Money totalBalance)

Setter for TotalBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

totalBalance - Value for Money

getAvailableBalance

public Money getAvailableBalance()

Getter for AvailableBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setAvailableBalance

public void setAvailableBalance(Money availableBalance)

Setter for AvailableBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

availableBalance - Value for Money

getWithheldBalance

public Money getWithheldBalance()

Getter for WithheldBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setWithheldBalance

public void setWithheldBalance(Money withheldBalance)

Setter for WithheldBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

withheldBalance - Value for Money

toString

public String toString()

Converts this BalanceInformation into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BalanceInformation.Builder toBuilder()

Builds a new BalanceInformation.Builder object. Creates the instance with the state of the current model.

Returns:

a new BalanceInformation.Builder object