Skip to content

Commit 00011ad

Browse files
SP-28 Add JavaDoc to Payout model classes - fix broken styles in annotation
1 parent be7defd commit 00011ad

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

src/main/java/com/bitpay/sdk/model/Payout/Payout.java

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@
1111
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
1212
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
1313

14-
import java.math.BigDecimal;
15-
import java.math.RoundingMode;
1614
import java.util.Collections;
1715
import java.util.List;
18-
import java.util.Map;
1916

2017
/**
2118
* The type Payout.
@@ -74,9 +71,22 @@ public Payout() {
7471
/**
7572
* Constructor, create an instruction-full request Payout object.
7673
*
77-
* @param amount Date when request is effective. Note that the time of day will automatically be set to 09:00:00.000 UTC time for the given day. Only requests submitted before 09:00:00.000 UTC are guaranteed to be processed on the same day.
78-
* @param currency The three digit currency string for the PayoutBatch to use.
79-
* @param ledgerCurrency Ledger currency code set for the payout request (ISO4217 3-character currency code), it indicates on which ledger the payoutrequest will be recorded. If not provided in the request, this parameter will be set by default to the active ledger currency on your account,e.g. your settlement currency. Supported ledger currency codes for payout requestsare EUR, USD, GBP, CAD, NZD, AUD, ZAR, JPY, BTC, BCH, GUSD, USDC, PAX,XRP, BUSD, DOGE,ETH, WBTC, DAI
74+
* @param amount Date when request is effective. Note that the time of
75+
* day will automatically be set to 09:00:00.000 UTC time
76+
* for the given day. Only requests submitted before
77+
* 09:00:00.000 UTC are guaranteed to be processed on the
78+
* same day.
79+
* @param currency The three digit currency string for the PayoutBatch to
80+
* use.
81+
* @param ledgerCurrency Ledger currency code set for the payout request
82+
* (ISO4217 3-character currency code), it indicates on
83+
* which ledger the payoutrequest will be recorded. If not
84+
* provided in the request, this parameter will be set by
85+
* default to the active ledger currency on your
86+
* account,e.g. your settlement currency. Supported ledger
87+
* currency codes for payout requestsare EUR, USD, GBP,
88+
* CAD, NZD, AUD, ZAR, JPY, BTC, BCH, GUSD, USDC, PAX,XRP,
89+
* BUSD, DOGE,ETH, WBTC, DAI
8090
*/
8191
public Payout(Double amount, String currency, String ledgerCurrency) {
8292
this._amount = amount;
@@ -90,9 +100,10 @@ public Payout(Double amount, String currency, String ledgerCurrency) {
90100
/**
91101
* Gets resource token.
92102
* <p>
93-
* This token is actually derived from the API token -
94-
* used to submit the payout and is tied to the specific payout resource id created..
103+
* This token is actually derived from the API token -
104+
* used to submit the payout and is tied to the specific payout resource id created..
95105
* </p>
106+
*
96107
* @return the token
97108
*/
98109
@JsonProperty("token")

0 commit comments

Comments
 (0)