Skip to content

Commit 401bf5e

Browse files
author
Adyen Automation
committed
[create-pull-request] automated change
1 parent 6bfb4aa commit 401bf5e

File tree

853 files changed

+17341
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

853 files changed

+17341
-5
lines changed

src/main/java/com/adyen/model/acswebhooks/Amount.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,17 @@
3737

3838
public class Amount {
3939
public static final String JSON_PROPERTY_CURRENCY = "currency";
40+
41+
/**
42+
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
43+
*/
4044
private String currency;
4145

4246
public static final String JSON_PROPERTY_VALUE = "value";
47+
48+
/**
49+
* The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
50+
*/
4351
private Long value;
4452

4553
public Amount() {

src/main/java/com/adyen/model/acswebhooks/AuthenticationInfo.java

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@
5252

5353
public class AuthenticationInfo {
5454
public static final String JSON_PROPERTY_ACS_TRANS_ID = "acsTransId";
55+
56+
/**
57+
* Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.
58+
*/
5559
private String acsTransId;
5660

5761
public static final String JSON_PROPERTY_CHALLENGE = "challenge";
@@ -109,9 +113,17 @@ public static ChallengeIndicatorEnum fromValue(String value) {
109113
}
110114

111115
public static final String JSON_PROPERTY_CHALLENGE_INDICATOR = "challengeIndicator";
116+
117+
/**
118+
* Specifies a preference for receiving a challenge. Possible values: * **01**: No preference * **02**: No challenge requested * **03**: Challenge requested (preference) * **04**: Challenge requested (mandate) * **05**: No challenge requested (transactional risk analysis is already performed) * **07**: No challenge requested (SCA is already performed) * **08**: No challenge requested (trusted beneficiaries exemption of no challenge required) * **09**: Challenge requested (trusted beneficiaries prompt requested if challenge required) * **80**: No challenge requested (secure corporate payment with Mastercard) * **82**: No challenge requested (secure corporate payment with Visa)
119+
*/
112120
private ChallengeIndicatorEnum challengeIndicator;
113121

114122
public static final String JSON_PROPERTY_CREATED_AT = "createdAt";
123+
124+
/**
125+
* Date and time in UTC of the cardholder authentication. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
126+
*/
115127
private OffsetDateTime createdAt;
116128

117129
/**
@@ -152,9 +164,17 @@ public static DeviceChannelEnum fromValue(String value) {
152164
}
153165

154166
public static final String JSON_PROPERTY_DEVICE_CHANNEL = "deviceChannel";
167+
168+
/**
169+
* Indicates the type of channel interface being used to initiate the transaction. Possible values: * **app** * **browser** * **3DSRequestorInitiated** (initiated by a merchant when the cardholder is not available)
170+
*/
155171
private DeviceChannelEnum deviceChannel;
156172

157173
public static final String JSON_PROPERTY_DS_TRANS_I_D = "dsTransID";
174+
175+
/**
176+
* Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction.
177+
*/
158178
private String dsTransID;
159179

160180
/**
@@ -203,9 +223,17 @@ public static ExemptionIndicatorEnum fromValue(String value) {
203223
}
204224

205225
public static final String JSON_PROPERTY_EXEMPTION_INDICATOR = "exemptionIndicator";
226+
227+
/**
228+
* Indicates the exemption type that was applied to the authentication by the issuer, if exemption applied. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** * **acquirerExemption** * **noExemptionApplied** * **visaDAFExemption**
229+
*/
206230
private ExemptionIndicatorEnum exemptionIndicator;
207231

208232
public static final String JSON_PROPERTY_IN_P_S_D2_SCOPE = "inPSD2Scope";
233+
234+
/**
235+
* Indicates if the purchase was in the PSD2 scope.
236+
*/
209237
private Boolean inPSD2Scope;
210238

211239
/**
@@ -244,15 +272,31 @@ public static MessageCategoryEnum fromValue(String value) {
244272
}
245273

246274
public static final String JSON_PROPERTY_MESSAGE_CATEGORY = "messageCategory";
275+
276+
/**
277+
* Identifies the category of the message for a specific use case. Possible values: * **payment** * **nonPayment**
278+
*/
247279
private MessageCategoryEnum messageCategory;
248280

249281
public static final String JSON_PROPERTY_MESSAGE_VERSION = "messageVersion";
282+
283+
/**
284+
* The `messageVersion` value as defined in the 3D Secure 2 specification.
285+
*/
250286
private String messageVersion;
251287

252288
public static final String JSON_PROPERTY_RISK_SCORE = "riskScore";
289+
290+
/**
291+
* Risk score calculated from the transaction rules.
292+
*/
253293
private Integer riskScore;
254294

255295
public static final String JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D = "threeDSServerTransID";
296+
297+
/**
298+
* The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
299+
*/
256300
private String threeDSServerTransID;
257301

258302
/**
@@ -297,6 +341,10 @@ public static TransStatusEnum fromValue(String value) {
297341
}
298342

299343
public static final String JSON_PROPERTY_TRANS_STATUS = "transStatus";
344+
345+
/**
346+
* The `transStatus` value as defined in the 3D Secure 2 specification. Possible values: * **Y**: Authentication / Account verification successful. * **N**: Not Authenticated / Account not verified. Transaction denied. * **U**: Authentication / Account verification could not be performed. * **I**: Informational Only / 3D Secure Requestor challenge preference acknowledged. * **R**: Authentication / Account verification rejected by the Issuer.
347+
*/
300348
private TransStatusEnum transStatus;
301349

302350
/**
@@ -401,6 +449,10 @@ public static TransStatusReasonEnum fromValue(String value) {
401449
}
402450

403451
public static final String JSON_PROPERTY_TRANS_STATUS_REASON = "transStatusReason";
452+
453+
/**
454+
* Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
455+
*/
404456
private TransStatusReasonEnum transStatusReason;
405457

406458
/**
@@ -439,6 +491,10 @@ public static TypeEnum fromValue(String value) {
439491
}
440492

441493
public static final String JSON_PROPERTY_TYPE = "type";
494+
495+
/**
496+
* The type of authentication performed. Possible values: * **frictionless** * **challenge**
497+
*/
442498
private TypeEnum type;
443499

444500
public AuthenticationInfo() {

src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationData.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,24 @@ public class AuthenticationNotificationData {
4646
private AuthenticationInfo authentication;
4747

4848
public static final String JSON_PROPERTY_BALANCE_PLATFORM = "balancePlatform";
49+
50+
/**
51+
* The unique identifier of the balance platform.
52+
*/
4953
private String balancePlatform;
5054

5155
public static final String JSON_PROPERTY_ID = "id";
56+
57+
/**
58+
* Unique identifier of the authentication.
59+
*/
5260
private String id;
5361

5462
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT_ID = "paymentInstrumentId";
63+
64+
/**
65+
* Unique identifier of the payment instrument that was used for the authentication.
66+
*/
5567
private String paymentInstrumentId;
5668

5769
public static final String JSON_PROPERTY_PURCHASE = "purchase";
@@ -95,6 +107,10 @@ public static StatusEnum fromValue(String value) {
95107
}
96108

97109
public static final String JSON_PROPERTY_STATUS = "status";
110+
111+
/**
112+
* Outcome of the authentication. Allowed values: * authenticated * rejected * error
113+
*/
98114
private StatusEnum status;
99115

100116
public AuthenticationNotificationData() {

src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationRequest.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ public class AuthenticationNotificationRequest {
4242
private AuthenticationNotificationData data;
4343

4444
public static final String JSON_PROPERTY_ENVIRONMENT = "environment";
45+
46+
/**
47+
* The environment from which the webhook originated. Possible values: **test**, **live**.
48+
*/
4549
private String environment;
4650

4751
/**
@@ -78,6 +82,10 @@ public static TypeEnum fromValue(String value) {
7882
}
7983

8084
public static final String JSON_PROPERTY_TYPE = "type";
85+
86+
/**
87+
* Type of notification.
88+
*/
8189
private TypeEnum type;
8290

8391
public AuthenticationNotificationRequest() {

src/main/java/com/adyen/model/acswebhooks/BalancePlatformNotificationResponse.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@
3636

3737
public class BalancePlatformNotificationResponse {
3838
public static final String JSON_PROPERTY_NOTIFICATION_RESPONSE = "notificationResponse";
39+
40+
/**
41+
* Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
42+
*/
3943
private String notificationResponse;
4044

4145
public BalancePlatformNotificationResponse() {

src/main/java/com/adyen/model/acswebhooks/ChallengeInfo.java

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ public static ChallengeCancelEnum fromValue(String value) {
8787
}
8888

8989
public static final String JSON_PROPERTY_CHALLENGE_CANCEL = "challengeCancel";
90+
91+
/**
92+
* Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
93+
*/
9094
private ChallengeCancelEnum challengeCancel;
9195

9296
/**
@@ -125,18 +129,38 @@ public static FlowEnum fromValue(String value) {
125129
}
126130

127131
public static final String JSON_PROPERTY_FLOW = "flow";
132+
133+
/**
134+
* The flow used in the challenge. Possible values: * **OTP_SMS**: one-time password (OTP) flow * **OOB**: out-of-band (OOB) flow
135+
*/
128136
private FlowEnum flow;
129137

130138
public static final String JSON_PROPERTY_LAST_INTERACTION = "lastInteraction";
139+
140+
/**
141+
* The last time of interaction with the challenge.
142+
*/
131143
private OffsetDateTime lastInteraction;
132144

133145
public static final String JSON_PROPERTY_PHONE_NUMBER = "phoneNumber";
146+
147+
/**
148+
* The last four digits of the phone number used in the challenge.
149+
*/
134150
private String phoneNumber;
135151

136152
public static final String JSON_PROPERTY_RESENDS = "resends";
153+
154+
/**
155+
* The number of times the one-time password (OTP) was resent during the challenge.
156+
*/
137157
private Integer resends;
138158

139159
public static final String JSON_PROPERTY_RETRIES = "retries";
160+
161+
/**
162+
* The number of retries used in the challenge.
163+
*/
140164
private Integer retries;
141165

142166
public ChallengeInfo() {

src/main/java/com/adyen/model/acswebhooks/PurchaseInfo.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,17 @@
3939

4040
public class PurchaseInfo {
4141
public static final String JSON_PROPERTY_DATE = "date";
42+
43+
/**
44+
* Date of the purchase.
45+
*/
4246
private String date;
4347

4448
public static final String JSON_PROPERTY_MERCHANT_NAME = "merchantName";
49+
50+
/**
51+
* Name of the merchant.
52+
*/
4553
private String merchantName;
4654

4755
public static final String JSON_PROPERTY_ORIGINAL_AMOUNT = "originalAmount";

src/main/java/com/adyen/model/acswebhooks/Resource.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,24 @@
3939

4040
public class Resource {
4141
public static final String JSON_PROPERTY_BALANCE_PLATFORM = "balancePlatform";
42+
43+
/**
44+
* The unique identifier of the balance platform.
45+
*/
4246
private String balancePlatform;
4347

4448
public static final String JSON_PROPERTY_CREATION_DATE = "creationDate";
49+
50+
/**
51+
* The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
52+
*/
4553
private OffsetDateTime creationDate;
4654

4755
public static final String JSON_PROPERTY_ID = "id";
56+
57+
/**
58+
* The ID of the resource.
59+
*/
4860
private String id;
4961

5062
public Resource() {

src/main/java/com/adyen/model/balancecontrol/Amount.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,17 @@
3838

3939
public class Amount {
4040
public static final String JSON_PROPERTY_CURRENCY = "currency";
41+
42+
/**
43+
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
44+
*/
4145
private String currency;
4246

4347
public static final String JSON_PROPERTY_VALUE = "value";
48+
49+
/**
50+
* The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
51+
*/
4452
private Long value;
4553

4654
public Amount() {

src/main/java/com/adyen/model/balancecontrol/BalanceTransferRequest.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,31 @@ public class BalanceTransferRequest {
4646
private Amount amount;
4747

4848
public static final String JSON_PROPERTY_DESCRIPTION = "description";
49+
50+
/**
51+
* A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
52+
*/
4953
private String description;
5054

5155
public static final String JSON_PROPERTY_FROM_MERCHANT = "fromMerchant";
56+
57+
/**
58+
* The unique identifier of the source merchant account from which funds are deducted.
59+
*/
5260
private String fromMerchant;
5361

5462
public static final String JSON_PROPERTY_REFERENCE = "reference";
63+
64+
/**
65+
* A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
66+
*/
5567
private String reference;
5668

5769
public static final String JSON_PROPERTY_TO_MERCHANT = "toMerchant";
70+
71+
/**
72+
* The unique identifier of the destination merchant account from which funds are transferred.
73+
*/
5874
private String toMerchant;
5975

6076
/**
@@ -101,6 +117,10 @@ public static TypeEnum fromValue(String value) {
101117
}
102118

103119
public static final String JSON_PROPERTY_TYPE = "type";
120+
121+
/**
122+
* The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
123+
*/
104124
private TypeEnum type;
105125

106126
public BalanceTransferRequest() {

0 commit comments

Comments
 (0)