lxbfYeaa/PayPal-PHP-Server-SDK
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-Server-SDK
Code Pull Requests Activity

2.0.0 Release (#58)

Browse Source 
* Automated commit message

* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
This commit is contained in:
Patrick Powers
2025-11-13 16:32:53 -06:00
committed by GitHub
parent 6da8b9b5b8
commit 1fc2cf1e07
488 changed files with 32110 additions and 4157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/models/balance-information.md Normal file
View File

@@ -0,0 +1,40 @@
# 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"
}
}
```