Skip to content

Commit 89eb523

Browse files
committed
Updated API from documentation release
1 parent 4465506 commit 89eb523

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

api-specs/api/types/common/HighPrecisionMoneyDraft.raml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ properties:
1818
description: |
1919
Amount in 1 / (10 ^ `fractionDigits`) of a currency.
2020
21+
`preciseAmount` is represented as 64-bit integers. If this limit is exceeded, a [MoneyOverflow](/errors#moneyoverflow) error will be returned.
2122
centAmount?:
2223
type: number
2324
format: int64
@@ -26,4 +27,6 @@ properties:
2627
2728
A Price of 1.015 USD can be rounded either to 1.01 USD or 1.02 USD. If it lies outside of this range, an error message stating that centAmount must be rounded correctly will be returned.
2829
30+
`centAmount` is represented as 64-bit integers. If this limit is exceeded, a [MoneyOverflow](/errors#moneyoverflow) error will be returned.
31+
2932
If `centAmount` is not provided, the API calculates the value automatically using the default rounding mode half even.

api-specs/api/types/common/Money.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ properties:
1515
* Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`).
1616
* The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
1717
18+
`centAmount` is represented as 64-bit integers. If this limit is exceeded, a [MoneyOverflow](/errors#moneyoverflow) error will be returned.
1819
currencyCode:
1920
type: CurrencyCode

api-specs/api/types/error/MoneyOverflowError.raml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ type: ErrorObject
44
displayName: MoneyOverflowError
55
discriminatorValue: MoneyOverflow
66
description: |
7-
Returned when a [Money](ctp:api:type:Money) operation overflows the 64-bit integer range.
8-
See [Money usage](/types#usage) for more information.
7+
Returned when a money operation overflows the 64-bit integer range.
98
properties:
109
code:
1110
type: string

api-specs/api/types/error/graphql/GraphQLMoneyOverflowError.raml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ type: GraphQLErrorObject
44
displayName: GraphQLMoneyOverflowError
55
discriminatorValue: MoneyOverflow
66
description: |
7-
Returned when a [Money](ctp:api:type:Money) operation overflows the 64-bit integer range.
8-
See [Money usage](/types#usage) for more information.
7+
Returned when a money operation overflows the 64-bit integer range.
98
properties:
109
code:
1110
type: string

0 commit comments

Comments
 (0)