forked from LiveCarta/PayPal-PHP-Server-SDK
Automated commit message
This commit is contained in:
27
doc/models/exchange-rate.md
Normal file
27
doc/models/exchange-rate.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# Exchange Rate
|
||||
|
||||
The exchange rate that determines the amount to convert from one currency to another currency.
|
||||
|
||||
## Structure
|
||||
|
||||
`ExchangeRate`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `sourceCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getSourceCurrency(): ?string | setSourceCurrency(?string sourceCurrency): void |
|
||||
| `targetCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getTargetCurrency(): ?string | setTargetCurrency(?string targetCurrency): void |
|
||||
| `value` | `?string` | Optional | The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point. | getValue(): ?string | setValue(?string value): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"source_currency": "source_currency0",
|
||||
"target_currency": "target_currency2",
|
||||
"value": "value2"
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user