forked from LiveCarta/PayPal-PHP-Server-SDK
1fc2cf1e07
* Automated commit message * Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
|
|
# Balance Information
|
|
|
|
The Balance information.
|
|
|
|
## Structure
|
|
|
|
`BalanceInformation`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `currency` | `string` | Required | The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.<br><br>**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`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalBalance(): Money | setTotalBalance(Money totalBalance): void |
|
|
| `availableBalance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAvailableBalance(): ?Money | setAvailableBalance(?Money availableBalance): void |
|
|
| `withheldBalance` | [`?Money`](../../doc/models/money.md) | 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)
|
|
|
|
```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"
|
|
}
|
|
}
|
|
```
|
|
|